Difference between revisions of "Custom Blacklists"

From ALiVE Wiki
Jump to: navigation, search
 
(17 intermediate revisions by 4 users not shown)
Line 1: Line 1:
The ALiVE modules have blacklists of units, groups and buildings stored in sys_profile. The mission editor and script is able to define which units get blacklisted or blacklisted on top of the current blacklists.
+
ALiVE already has a blacklist of units, groups and buildings that have no business being in a military environment. Mission editors can choose to blacklist additional items using the variables below.  The variables can be entered in any module init field, such as [[ALiVE (Required)]].
  
To add elements to an array [https://community.bistudio.com/wiki/Array#Addition use the method described in the biki].
+
Note that to completely remove things like AA from your mission, you will need to blacklist all AA units, vehicles and any Groups that have those classes as well.
_array1 = [player, 7, "String"]
+
_array2 = [player, 2]
+
_array3 = _array1 + _array2
+
  
  
The arrays are the following, the functions speak for themselves.
+
Syntax:
*'''ALIVE_CQBunitBlackist'''
+
<syntaxhighlight lang="php">
*'''ALIVE_unitBlackist'''
+
ALIVE_MODULE_BLACKLIST = ["classname","classname"];
*'''ALIVE_vehicleBlacklist'''
+
</syntaxhighlight>
*'''ALIVE_groupBlacklist'''
+
  
The elements that have to be used are the classes as defined in the configFile.
 
  
To add buildings for the CQB manager to consider, add elements to '''ALIVE_CQBStrategicTypes'''.
+
'''Variables'''
  
 +
ALiVE_MIL_CQB_CUSTOM_STRATEGICHOUSES - Define your custom strategic house classes for CQB (rest will be regular houses).
  
 +
ALiVE_MIL_CQB_CUSTOM_UNITBLACKLIST - Exclude unit classes from CQB
  
Heres an example from the AS Alamo mission on the website to load and apply your own custom settings
+
ALiVE_PLACEMENT_CUSTOM_UNITBLACKLIST - Exclude unit classes from Military Placement spawns
 +
 
 +
ALiVE_PLACEMENT_CUSTOM_VEHICLEBLACKLIST - Exclude vehicle classes from Military Placement spawns
 +
 
 +
ALiVE_PLACEMENT_CUSTOM_GROUPBLACKLIST - Exclude group classes from Military Placement spawns
 +
 
 +
 
 +
'''Example'''
 +
(Note that classnames here are subject to change)
 +
 
 +
 
 +
To blacklist all AA units in vanilla (NATO CSAT)
  
'''init.sqf'''
 
 
<syntaxhighlight lang="php">
 
<syntaxhighlight lang="php">
if(isServer) then {
+
ALiVE_PLACEMENT_CUSTOM_GROUPBLACKLIST = ["OIA_InfTeam_AA","OIA_MotInf_AA","OIA_MechInf_AA","OIA_TankPlatoon_AA","ORG_InfTeam_AA"];
  
// -------------------------------------------------------------------------------------------------------------
+
ALiVE_PLACEMENT_CUSTOM_VEHICLEBLACKLIST = ["I_Plane_Fighter_03_AA_F","B_APC_Tracked_01_AA_F","O_APC_Tracked_02_AA_F","AA_01_base_F","B_static_
// override default data
+
AA_F","O_static_AA_F","I_static_AA_F","B_AA_01_weapon_F","O_AA_01_weapon_F","I_AA_01_weapon_F"];
// see script/staticData.sqf
+
["MISSION INIT - Waiting"] call ALIVE_fnc_dump;
+
  
waitUntil {!isNil "ALIVE_profileSystemDataLoaded"};
+
ALiVE_PLACEMENT_CUSTOM_UNITBLACKLIST = ["B_soldier_AA_F","B_soldier_AAA_F","I_Soldier_AA_F","I_Soldier_AAA_F","O_Soldier_AA_F","O_Soldier_AAA_F","O_soldierU_AA_F","O_soldierU_AAA_F"];
  
["MISSION INIT - Continue"] call ALIVE_fnc_dump;
+
ALiVE_MIL_CQB_CUSTOM_UNITBLACKLIST = ["B_soldier_AA_F","B_soldier_AAA_F","I_Soldier_AA_F","I_Soldier_AAA_F","O_Soldier_AA_F","O_Soldier_AAA_F","O_soldierU_AA_F","O_soldierU_AAA_F"];
 +
</syntaxhighlight>
  
// override static data settings
 
call compile (preprocessFileLineNumbers "script\staticData.sqf");
 
  
["MISSION INIT - Static data override loaded"] call ALIVE_fnc_dump;
+
To blacklist all AA units from CUP units:
["CUSTOM BLACKLIST LOADED: %1",ALIVE_unitBlackist] call ALIVE_fnc_dump;
+
<syntaxhighlight lang="php">
+
ALiVE_MIL_CQB_CUSTOM_UNITBLACKLIST = ["CUP_O_TK_Soldier_AA","CUP_O_TK_INS_Soldier_AA","CUP_O_TK_InfantrySectionAA","CUP_O_TK_MILITIA_AATeam"];  
// -------------------------------------------------------------------------------------------------------------
+
ALiVE_PLACEMENT_CUSTOM_UNITBLACKLIST = ["CUP_O_TK_Soldier_AA","CUP_O_TK_INS_Soldier_AA"];  
};
+
ALiVE_PLACEMENT_CUSTOM_GROUPBLACKLIST = ["CUP_O_TK_InfantrySectionAA","CUP_O_TK_MILITIA_AATeam"];
 
</syntaxhighlight>
 
</syntaxhighlight>
  
'''script\staticData.sqf'''
+
 
 +
2 new functions to help you find units/vehicles/groups more easily:
 +
 
 
<syntaxhighlight lang="php">
 
<syntaxhighlight lang="php">
/*
+
_groupTypes = ["AA_" (string to searchfor), INDEPENDENT (side or faction)] call ALiVE_fnc_groupFinder;
* CQB Defaults
+
_objectTypes = [configFile >> "cfgVehicles" (config path), "_AA" (string to searchfor)] call ALiVE_fnc_configFindEntries;
*/
+
</syntaxhighlight>
  
 +
those arrays can basically be easily read and copy-pasted to whatever blacklist you like.
  
ALIVE_CQBStrategicTypes =
 
[
 
//A3
 
"Land_Cargo_Patrol_V1_F",
 
"Land_Cargo_Patrol_V2_F",
 
"Land_Cargo_House_V1_F",
 
"Land_Cargo_House_V2_F",
 
"Land_Cargo_Tower_V3_F",
 
"Land_Airport_Tower_F",
 
"Land_Cargo_HQ_V1_F",
 
"Land_Cargo_HQ_V2_F",
 
"Land_MilOffices_V1_F",
 
"Land_Offices_01_V1_F",
 
"Land_Research_HQ_F",
 
"Land_CarService_F",
 
"Land_Hospital_main_F",
 
"Land_dp_smallFactory_F",
 
"Land_Radar_F",
 
"Land_TentHangar_V1_F",
 
 
//A2
 
"Land_A_TVTower_Base",
 
"Land_Dam_ConcP_20",
 
"Land_Ind_Expedice_1",
 
"Land_Ind_SiloVelke_02",
 
"Land_Mil_Barracks",
 
"Land_Mil_Barracks_i",
 
"Land_Mil_Barracks_L",
 
"Land_Mil_Guardhouse",
 
"Land_Mil_House",
 
"Land_Fort_Watchtower",
 
"Land_Vysilac_FM",
 
"Land_SS_hangar",
 
"Land_telek1",
 
"Land_vez",
 
"Land_A_FuelStation_Shed",
 
"Land_watertower1",
 
"Land_trafostanica_velka",
 
"Land_Ind_Oil_Tower_EP1",
 
"Land_A_Villa_EP1",
 
"Land_fortified_nest_small_EP1",
 
"Land_Mil_Barracks_i_EP1",
 
"Land_fortified_nest_big_EP1",
 
"Land_Fort_Watchtower_EP1",
 
"Land_Ind_PowerStation_EP1",
 
"Land_Ind_PowerStation"
 
];
 
  
ALIVE_CQBunitBlackist =
 
[
 
//A3
 
"B_Helipilot_F",
 
"B_diver_F",
 
"B_diver_TL_F",
 
"B_diver_exp_F",
 
"B_RangeMaster_F",
 
"B_crew_F",
 
"B_Pilot_F",
 
"B_helicrew_F",
 
 
"O_helipilot_F",
 
"O_diver_F",
 
"O_diver_TL_F",
 
"O_diver_exp_F",
 
"O_crew_F",
 
"O_Pilot_F",
 
"O_helicrew_F",
 
"O_UAV_AI",
 
 
"I_crew_F",
 
"I_helipilot_F",
 
"I_helicrew_F",
 
"I_diver_F",
 
"I_diver_exp_F",
 
"I_diver_TL_F",
 
"I_pilot_F",
 
"I_Story_Colonel_F"
 
];
 
  
 +
It is possible to overwrite parts of the staticdata.sqf directly (see the Discussion page for more info).  The following example is for overriding the military logistics vehicles.
 +
   
 +
Add the following line to ''Init.sqf''  <syntaxhighlight lang="php">call compile preprocessFile "staticData.sqf";</syntaxhighlight>
 +
 +
Create a file called ''staticData.sqf'' and add the following contents
 +
 +
<syntaxhighlight lang="php">
 +
if (!isServer) exitWith {};
 +
 +
waitUntil {!isNil "ALiVE_STATIC_DATA_LOADED"};
  
 
/*
 
/*
  * MP, CP, ML Defaults
+
  * Mil logistics convoy transport vehicles per faction
 
  */
 
  */
  
 +
[ALIVE_factionDefaultTransport, "OPF_F", ["O_Truck_02_transport_F","O_Truck_02_covered_F"]] call ALIVE_fnc_hashSet;
 +
[ALIVE_factionDefaultTransport, "OPF_G_F", ["O_G_Van_01_transport_F"]] call ALIVE_fnc_hashSet;
 +
[ALIVE_factionDefaultTransport, "IND_F", ["I_Truck_02_covered_F","I_Truck_02_transport_F"]] call ALIVE_fnc_hashSet;
 +
[ALIVE_factionDefaultTransport, "BLU_F", ["B_Truck_01_transport_F","B_Truck_01_covered_F"]] call ALIVE_fnc_hashSet;
 +
[ALIVE_factionDefaultTransport, "BLU_G_F", ["B_G_Van_01_transport_F"]] call ALIVE_fnc_hashSet;
 +
[ALIVE_factionDefaultTransport, "CIV_F", ["C_Van_01_transport_F"]] call ALIVE_fnc_hashSet;
  
ALIVE_unitBlackist =
+
/*
[
+
* Mil logistics air transport vehicles per faction
"O_UAV_AI",
+
*/
"B_UAV_AI"
+
];
+
  
ALIVE_vehicleBlacklist =
+
[ALIVE_factionDefaultAirTransport, "OPF_F", ["O_Heli_Attack_02_F","O_Heli_Light_02_F"]] call ALIVE_fnc_hashSet;
[
+
[ALIVE_factionDefaultAirTransport, "OPF_G_F", ["I_Heli_light_03_unarmed_F"]] call ALIVE_fnc_hashSet;
"O_UAV_02_F",
+
[ALIVE_factionDefaultAirTransport, "IND_F", ["I_Heli_light_03_unarmed_F","I_Heli_Transport_02_F"]] call ALIVE_fnc_hashSet;
"O_UAV_02_CAS_F",
+
[ALIVE_factionDefaultAirTransport, "BLU_F", ["B_Heli_Transport_01_camo_F","B_Heli_Transport_01_camo_F"]] call ALIVE_fnc_hashSet;
"O_UAV_01_F",
+
[ALIVE_factionDefaultAirTransport, "BLU_G_F", ["I_Heli_light_03_unarmed_F"]] call ALIVE_fnc_hashSet;
"O_UGV_01_F",
+
[ALIVE_factionDefaultAirTransport, "CIV_F", []] call ALIVE_fnc_hashSet;
"O_UGV_01_rcws_F",
+
</syntaxhighlight>
"B_UAV_01_F",
+
"B_UAV_02_F",
+
"B_UAV_02_CAS_F",
+
"B_UGV_01_F",
+
"B_UGV_01_rcws_F"
+
];
+
  
ALIVE_groupBlacklist =
+
 
[
+
[[Category: Tutorials]]
"HAF_AttackTeam_UAV",
+
 
"HAF_ReconTeam_UAV",
+
 
"HAF_AttackTeam_UGV",
+
'''C2ISTAR Task Blacklists'''
"HAF_ReconTeam_UGV",
+
 
"HAF_SmallTeam_UAV",
+
To blacklist certain tasks assigned by the C2ISTAR module:
"BUS_AttackTeam_UAV",
+
 
"BUS_ReconTeam_UAV",
+
staticData.sqf should be a file you create in the root of your mission folder
"BUS_AttackTeam_UGV",
+
 
"BUS_ReconTeam_UGV",
+
In your init.sqf put this line:
"BUS_SmallTeam_UAV",
+
 
"OI_AttackTeam_UAV",
+
execVM "staticData.sqf";
"OI_ReconTeam_UAV",
+
 
"OI_AttackTeam_UGV",
+
 
"OI_ReconTeam_UGV",
+
staticData.sqf
"OI_SmallTeam_UAV",
+
 
"BUS_TankPlatoon_AA", // BUG in CfgGroups vehicle name wrong
+
<syntaxhighlight lang="php">
"BUS_MechInf_AA" // BUG in CfgGroups vehicle name wrong
+
waitUntil {!isNil "ALiVE_STATIC_DATA_LOADED"};
];
+
ALIVE_autoGeneratedTasks = ["MilAssault","MilDefence","CivAssault","Assassination","TransportInsertion","DestroyVehicles","DestroyInfantry","SabotageBuilding","InsurgencyPatrol","InsurgencyDestroyAssets","Rescue","CSAR"];
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
 +
Remove an entry from the array to stop that task from being generated.
 +
 +
For example, removing MilAssault (first entry) would look like
 +
 +
<syntaxhighlight lang="php">
 +
ALIVE_autoGeneratedTasks = ["MilDefence","CivAssault","Assassination","TransportInsertion","DestroyVehicles","DestroyInfantry","SabotageBuilding","InsurgencyPatrol","InsurgencyDestroyAssets","Rescue","CSAR"];
 +
</syntaxhighlight>
 +
 +
See here for forum post with more info:
 +
http://alivemod.com/forum/1226-auto-generated-task-editing/
 +
 +
NOTE: Currently you cannot blacklist Strategic tasks

Latest revision as of 07:18, 8 July 2019

ALiVE already has a blacklist of units, groups and buildings that have no business being in a military environment. Mission editors can choose to blacklist additional items using the variables below. The variables can be entered in any module init field, such as ALiVE (Required).

Note that to completely remove things like AA from your mission, you will need to blacklist all AA units, vehicles and any Groups that have those classes as well.


Syntax:

ALIVE_MODULE_BLACKLIST = ["classname","classname"];


Variables

ALiVE_MIL_CQB_CUSTOM_STRATEGICHOUSES - Define your custom strategic house classes for CQB (rest will be regular houses).

ALiVE_MIL_CQB_CUSTOM_UNITBLACKLIST - Exclude unit classes from CQB

ALiVE_PLACEMENT_CUSTOM_UNITBLACKLIST - Exclude unit classes from Military Placement spawns

ALiVE_PLACEMENT_CUSTOM_VEHICLEBLACKLIST - Exclude vehicle classes from Military Placement spawns

ALiVE_PLACEMENT_CUSTOM_GROUPBLACKLIST - Exclude group classes from Military Placement spawns


Example (Note that classnames here are subject to change)


To blacklist all AA units in vanilla (NATO CSAT)

ALiVE_PLACEMENT_CUSTOM_GROUPBLACKLIST = ["OIA_InfTeam_AA","OIA_MotInf_AA","OIA_MechInf_AA","OIA_TankPlatoon_AA","ORG_InfTeam_AA"];
 
ALiVE_PLACEMENT_CUSTOM_VEHICLEBLACKLIST = ["I_Plane_Fighter_03_AA_F","B_APC_Tracked_01_AA_F","O_APC_Tracked_02_AA_F","AA_01_base_F","B_static_
AA_F","O_static_AA_F","I_static_AA_F","B_AA_01_weapon_F","O_AA_01_weapon_F","I_AA_01_weapon_F"];
 
ALiVE_PLACEMENT_CUSTOM_UNITBLACKLIST = ["B_soldier_AA_F","B_soldier_AAA_F","I_Soldier_AA_F","I_Soldier_AAA_F","O_Soldier_AA_F","O_Soldier_AAA_F","O_soldierU_AA_F","O_soldierU_AAA_F"];
 
ALiVE_MIL_CQB_CUSTOM_UNITBLACKLIST = ["B_soldier_AA_F","B_soldier_AAA_F","I_Soldier_AA_F","I_Soldier_AAA_F","O_Soldier_AA_F","O_Soldier_AAA_F","O_soldierU_AA_F","O_soldierU_AAA_F"];


To blacklist all AA units from CUP units:

ALiVE_MIL_CQB_CUSTOM_UNITBLACKLIST = ["CUP_O_TK_Soldier_AA","CUP_O_TK_INS_Soldier_AA","CUP_O_TK_InfantrySectionAA","CUP_O_TK_MILITIA_AATeam"]; 
ALiVE_PLACEMENT_CUSTOM_UNITBLACKLIST = ["CUP_O_TK_Soldier_AA","CUP_O_TK_INS_Soldier_AA"]; 
ALiVE_PLACEMENT_CUSTOM_GROUPBLACKLIST = ["CUP_O_TK_InfantrySectionAA","CUP_O_TK_MILITIA_AATeam"];


2 new functions to help you find units/vehicles/groups more easily:

_groupTypes = ["AA_" (string to searchfor), INDEPENDENT (side or faction)] call ALiVE_fnc_groupFinder;
_objectTypes = [configFile >> "cfgVehicles" (config path), "_AA" (string to searchfor)] call ALiVE_fnc_configFindEntries;

those arrays can basically be easily read and copy-pasted to whatever blacklist you like.


It is possible to overwrite parts of the staticdata.sqf directly (see the Discussion page for more info). The following example is for overriding the military logistics vehicles.

Add the following line to Init.sqf
call compile preprocessFile "staticData.sqf";

Create a file called staticData.sqf and add the following contents

if (!isServer) exitWith {};
 
waitUntil {!isNil "ALiVE_STATIC_DATA_LOADED"};
 
/*
 * Mil logistics convoy transport vehicles per faction
 */
 
[ALIVE_factionDefaultTransport, "OPF_F", ["O_Truck_02_transport_F","O_Truck_02_covered_F"]] call ALIVE_fnc_hashSet;
[ALIVE_factionDefaultTransport, "OPF_G_F", ["O_G_Van_01_transport_F"]] call ALIVE_fnc_hashSet;
[ALIVE_factionDefaultTransport, "IND_F", ["I_Truck_02_covered_F","I_Truck_02_transport_F"]] call ALIVE_fnc_hashSet;
[ALIVE_factionDefaultTransport, "BLU_F", ["B_Truck_01_transport_F","B_Truck_01_covered_F"]] call ALIVE_fnc_hashSet;
[ALIVE_factionDefaultTransport, "BLU_G_F", ["B_G_Van_01_transport_F"]] call ALIVE_fnc_hashSet;
[ALIVE_factionDefaultTransport, "CIV_F", ["C_Van_01_transport_F"]] call ALIVE_fnc_hashSet;
 
/*
 * Mil logistics air transport vehicles per faction
 */
 
[ALIVE_factionDefaultAirTransport, "OPF_F", ["O_Heli_Attack_02_F","O_Heli_Light_02_F"]] call ALIVE_fnc_hashSet;
[ALIVE_factionDefaultAirTransport, "OPF_G_F", ["I_Heli_light_03_unarmed_F"]] call ALIVE_fnc_hashSet;
[ALIVE_factionDefaultAirTransport, "IND_F", ["I_Heli_light_03_unarmed_F","I_Heli_Transport_02_F"]] call ALIVE_fnc_hashSet;
[ALIVE_factionDefaultAirTransport, "BLU_F", ["B_Heli_Transport_01_camo_F","B_Heli_Transport_01_camo_F"]] call ALIVE_fnc_hashSet;
[ALIVE_factionDefaultAirTransport, "BLU_G_F", ["I_Heli_light_03_unarmed_F"]] call ALIVE_fnc_hashSet;
[ALIVE_factionDefaultAirTransport, "CIV_F", []] call ALIVE_fnc_hashSet;


C2ISTAR Task Blacklists

To blacklist certain tasks assigned by the C2ISTAR module:

staticData.sqf should be a file you create in the root of your mission folder

In your init.sqf put this line:

execVM "staticData.sqf";


staticData.sqf

waitUntil {!isNil "ALiVE_STATIC_DATA_LOADED"};
ALIVE_autoGeneratedTasks = ["MilAssault","MilDefence","CivAssault","Assassination","TransportInsertion","DestroyVehicles","DestroyInfantry","SabotageBuilding","InsurgencyPatrol","InsurgencyDestroyAssets","Rescue","CSAR"];

Remove an entry from the array to stop that task from being generated.

For example, removing MilAssault (first entry) would look like

ALIVE_autoGeneratedTasks = ["MilDefence","CivAssault","Assassination","TransportInsertion","DestroyVehicles","DestroyInfantry","SabotageBuilding","InsurgencyPatrol","InsurgencyDestroyAssets","Rescue","CSAR"];

See here for forum post with more info: http://alivemod.com/forum/1226-auto-generated-task-editing/

NOTE: Currently you cannot blacklist Strategic tasks