Difference between revisions of "Arma 2: Ambient Combat Manager - Functions"

From Bohemia Interactive Community
Jump to navigation Jump to search
(Patrol types)
m (revert + fix)
(Tag: Undo)
 
(26 intermediate revisions by 7 users not shown)
Line 1: Line 1:
== Introduction ==
+
{{TOC|side}}
This page describes all pre-defined functions available to manipulate the settings of an [[Ambient_Combat_Manager|Ambient Combat Manager]] (ACM).
+
This page describes all pre-defined functions available to manipulate the settings of an [[Ambient Combat Manager]] (ACM).
 +
 
  
 
== Intensity ==
 
== Intensity ==
 +
 
Not all missions require heavy enemy / friendly presence. The ACM's intensity controls how many patrols can be active at a given time and how frequently patrols are spawned. The intensity can be controlled by using the following function call:
 
Not all missions require heavy enemy / friendly presence. The ACM's intensity controls how many patrols can be active at a given time and how frequently patrols are spawned. The intensity can be controlled by using the following function call:
  
  [<intensity | Scalar>, <ACM reference | Object>] call BIS_ACM_setIntensityFunc;
+
[<intensity | Scalar>, <ACM reference | Object>] call BIS_ACM_setIntensityFunc;
  
 
* ''intensity'': a Scalar between 0.0 and 1.0. 1.0 is the maximum intensity and 0.0 will in effect pause the ACM.
 
* ''intensity'': a Scalar between 0.0 and 1.0. 1.0 is the maximum intensity and 0.0 will in effect pause the ACM.
Line 15: Line 17:
 
Sets frequency and number of patrols (values 0-1). BIS_ACM is module name.
 
Sets frequency and number of patrols (values 0-1). BIS_ACM is module name.
  
  [1, BIS_ACM] call BIS_ACM_setIntensityFunc;
+
[1, BIS_ACM] [[call]] [[BIS_ACM_setIntensityFunc]];
 +
 
  
 
== Spawning distances ==
 
== Spawning distances ==
 +
 
It is possible to control the minimum and maximum distance from the group leader at which enemies will be spawned. Be careful not to spawn too close, since it will be obvious to human players.  
 
It is possible to control the minimum and maximum distance from the group leader at which enemies will be spawned. Be careful not to spawn too close, since it will be obvious to human players.  
  
  [<ACM reference | Object>, <minimum | Scalar>, <maximum | Scalar>] call BIS_ACM_setSpawnDistanceFunc;
+
[<ACM reference | Object>, <minimum | Scalar>, <maximum | Scalar>] call BIS_ACM_setSpawnDistanceFunc;
  
 
* Distances with the value -1 will leave the distance as it was.
 
* Distances with the value -1 will leave the distance as it was.
Line 32: Line 36:
 
Min & Max spawn distances included. BIS_ACM is module name.
 
Min & Max spawn distances included. BIS_ACM is module name.
  
  [BIS_ACM, 100, 500] call BIS_ACM_setSpawnDistanceFunc;
+
[BIS_ACM, 100, 500] [[call]] [[BIS_ACM_setSpawnDistanceFunc]];
 +
 
  
 
== Skill range ==
 
== Skill range ==
 +
 
You can control the skill levels of spawned units by defining a range from which a random value is selected for each unit. If you want a very specific value, simply make a range with both minimum and maximum set to that value.
 
You can control the skill levels of spawned units by defining a range from which a random value is selected for each unit. If you want a very specific value, simply make a range with both minimum and maximum set to that value.
  
  [<minimum | Scalar>, <maximum | Scalar>, <ACM reference | Object>] call BIS_ACM_setSkillFunc;
+
[<minimum | Scalar>, <maximum | Scalar>, <ACM reference | Object>] [[call]] [[BIS_ACM_setSkillFunc]];
  
 
* The skill values should be Scalars between 0.0 and 1.0.
 
* The skill values should be Scalars between 0.0 and 1.0.
Line 46: Line 52:
 
Min & Max skill range for spawned units. BIS_ACM is module name.
 
Min & Max skill range for spawned units. BIS_ACM is module name.
  
  [0, 0.6, BIS_ACM] call BIS_ACM_setSkillFunc;
+
[0, 0.6, BIS_ACM] [[call]] [[BIS_ACM_setSkillFunc]];
 +
 
  
 
== Ammunition count range ==
 
== Ammunition count range ==
 +
 
You may define the ammunition count of spawned units by defining a range from which a random value is selected for each unit.
 
You may define the ammunition count of spawned units by defining a range from which a random value is selected for each unit.
  
  [<minimum | Scalar>, <maximum | Scalar>, <ACM reference | Object>] call BIS_ACM_setAmmoFunc;
+
[<minimum | Scalar>, <maximum | Scalar>, <ACM reference | Object>] call BIS_ACM_setAmmoFunc;
  
 
* The ammo values should be Scalars between 0.0 and 1.0.
 
* The ammo values should be Scalars between 0.0 and 1.0.
Line 59: Line 67:
 
Amount of ammo spawned units possess. BIS_ACM is module name.
 
Amount of ammo spawned units possess. BIS_ACM is module name.
  
  [0.2, 0.5, BIS_ACM] call BIS_ACM_setAmmoFunc;
+
[0.2, 0.5, BIS_ACM] [[call]] [[BIS_ACM_setAmmoFunc]];
 +
 
  
 
== Group types ==
 
== Group types ==
 +
 
By default the ACM will select group types from ''CfgGroups'', but you may want to use only a number of specific group types. You have the possibility of overriding the group type database with your own database, by using two functions.
 
By default the ACM will select group types from ''CfgGroups'', but you may want to use only a number of specific group types. You have the possibility of overriding the group type database with your own database, by using two functions.
  
  {{codecomment|//You can pass both actual CfgGroups Config entries or class name Strings.}}
+
{{cc|You can pass both actual CfgGroups Config entries or class name Strings.}}
  [<ACM reference | Object>, <types | Array of Configs and / or Strings>] call BIS_ACM_addGroupClassesFunc;
+
[<ACM reference | Object>, <types | Array of Configs and / or Strings>] call BIS_ACM_addGroupClassesFunc;
 +
 
 +
{{cc|Passing an empty types Array will completely disable the custom database and switch back to the default.}}
 +
[<ACM reference | Object>, <types | Array of Configs and / or Strings>] [[call]] [[BIS_ACM_removeGroupClassesFunc]];
 +
 
 +
Useable group types: [[Ambient Combat Manager - Group types]]
 +
 
 +
'''Example:'''
 +
[BIS_ACM, ["RU_InfSquad", "RU_InfSection_AA", "RU_SniperTeam", "RU_MechInfSquad_2"]] [[call]] [[BIS_ACM_addGroupClassesFunc]];
  
  {{codecomment|//Passing an empty types Array will completely disable the custom database and switch back to the default.}}
 
  [<ACM reference | Object>, <types | Array of Configs and / or Strings>] call BIS_ACM_removeGroupClassesFunc;
 
  
 
== Factions ==
 
== Factions ==
You are able to control which of the five factions are spawned by the ACM.
 
  
  {{codecomment|//Pick from: "USMC", "CDF", "RU", "INS", "GUE".}}
+
You are able to control which factions are spawned by the ACM.
  [<factions | Array of Strings>, <ACM reference | Object>] call BIS_ACM_setFactionsFunc;
+
 
 +
{{cc|Arma 2 factions: "USMC", "CDF", "RU", "INS", "GUE"}}
 +
{{cc|Operation Arrowhead factions: "BIS_US", "BIS_CZ", "BIS_GER", "BIS_TK", "BIS_TK_INS", "BIS_TK_GUE", "BIS_UN", "BIS_TK_CIV", "BIS_CIV_special"}}
 +
{{cc|DLC/Reinforcements factions: "BIS_BAF", "PMC_BAF", "BIS_CZ"}}
 +
[<factions | Array of Strings>, <ACM reference | Object>] [[call]] [[BIS_ACM_setFactionsFunc]];
  
 
'''Example:'''
 
'''Example:'''
Line 80: Line 99:
 
Factions to be spawned. BIS_ACM is module name.
 
Factions to be spawned. BIS_ACM is module name.
  
  [["USMC", "INS", "CDF", "RU", "GER"], BIS_ACM] call BIS_ACM_setFactionsFunc;
+
[["USMC", "INS", "CDF", "RU", "GUE"], BIS_ACM] [[call]] [[BIS_ACM_setFactionsFunc]];
 +
 
  
 
== Blacklisting areas ==
 
== Blacklisting areas ==
Certain areas of a map can be blacklisted as areas in which the ACM should not spawn units or place their waypoints (although their travel paths may cross these areas). There are a number of methods to define such areas.
+
 
 +
Certain areas of a map can be blacklisted as areas in which the ACM should not spawn units or place their waypoints (although their travel paths may cross these areas).
 +
There are a number of methods to define such areas.
 +
 
 +
=== By markers ===
 +
 
 +
You may place markers with a special naming pattern ''BIS_ACM_X'' (where X has to start at 1 and may not skip any numbers).
 +
The areas defined by these markers are automatically blacklisted and the markers deleted.
  
 
=== By function ===
 
=== By function ===
  {{codecomment|//When passing Arrays, these should contain the top-left and bottom-right coordinates.}}
 
  [<ACM reference | Object>, <types | Array of Arrays and / or Markers and / or triggers>] call BIS_ACM_blacklistAreaFunc;
 
  
=== By markers ===
+
{{cc|When passing Arrays, these should contain the top-left and bottom-right coordinates.}}
You may place markers with a special naming pattern ''BIS_ACM_X'' (where X has to start at 1 and may not skip any numbers). The areas defined by these markers are automatically blacklisted and the markers deleted.
+
[<ACM reference | Object>, <types | Array of Arrays and / or Markers and / or triggers>] [[call]] [[BIS_ACM_blacklistAreaFunc]];
 +
 
 +
'''Examples:'''
 +
{{cc|Example 1: Adding a marker area to ACM called "BIS_ACM" with name "marker_1":}}
 +
[BIS_ACM, ["marker_1"]] [[call]] [[BIS_ACM_blacklistAreaFunc]];
 +
 
 +
{{cc|Example 2: Adding two marker areas to ACM called "BIS_ACM" with names "marker_1" and "marker_2":}}
 +
[BIS_ACM, ["marker_1", "marker_2"]] [[call]] [[BIS_ACM_blacklistAreaFunc]];
 +
<!--
 +
''ToDo: working examples for adding coordinates (via getMarkerPos for example)''
 +
-->
 +
 
  
 
== Patrol types ==
 
== Patrol types ==
 +
 
In some missions you may not want to use all patrol types, or use different chances for said patrol types. A custom pool of types and chances can be defined like so:
 
In some missions you may not want to use all patrol types, or use different chances for said patrol types. A custom pool of types and chances can be defined like so:
  
  {{codecomment|/*type must be one of "", "ground_patrol", "air_patrol".}}
+
{{codecomment|/*
  {{codecomment|Passing an empty type will reset back to the default pool.}}
+
type must be one of "", "ground_patrol", "air_patrol".
  {{codecomment|Weights should normally be between 0 and 1.}}
+
Passing an empty type will reset back to the default pool.
  {{codecomment|A weight of -1 will remove that patrol type from the pool.*/}}
+
Weights should normally be between 0 and 1.
  [<type | String>, <weight / chance | Scalar>, <ACM reference | Object>] call BIS_ACM_setTypeChanceFunc;
+
A weight of -1 will remove that patrol type from the pool.
 +
*/}}
 +
[<type | String>, <weight / chance | Scalar>, <ACM reference | Object>] [[call]] [[BIS_ACM_setTypeChanceFunc]];
  
 
'''Example:'''
 
'''Example:'''
Line 105: Line 144:
 
Type of patrol. With 0 meaning no chance of appearing, and 1 meaning 100% chance. -1 removes patrol type completely. BIS_ACM is module name.
 
Type of patrol. With 0 meaning no chance of appearing, and 1 meaning 100% chance. -1 removes patrol type completely. BIS_ACM is module name.
  
  ["ground_patrol", 1, BIS_ACM] call BIS_ACM_setTypeChanceFunc;
+
["ground_patrol", 1, BIS_ACM] [[call]] [[BIS_ACM_setTypeChanceFunc]];
  ["air_patrol", 1, BIS_ACM] call BIS_ACM_setTypeChanceFunc;
+
["air_patrol", 1, BIS_ACM] [[call]] [[BIS_ACM_setTypeChanceFunc]];
 +
 
 +
 
 +
For further discussion on the ACM: [http://forums.bistudio.com/showthread.php?t=73393 Official Forums thread].
  
  
For further discussion on the ACM: [http://forums.bistudio.com/showthread.php?t=73393].
+
{{GameCategory|arma2|Editing}}
 +
{{GameCategory|arma2|Editor Modules}}

Latest revision as of 18:44, 29 January 2021

This page describes all pre-defined functions available to manipulate the settings of an Ambient Combat Manager (ACM).


Intensity

Not all missions require heavy enemy / friendly presence. The ACM's intensity controls how many patrols can be active at a given time and how frequently patrols are spawned. The intensity can be controlled by using the following function call:

[<intensity | Scalar>, <ACM reference | Object>] call BIS_ACM_setIntensityFunc;
  • intensity: a Scalar between 0.0 and 1.0. 1.0 is the maximum intensity and 0.0 will in effect pause the ACM.
  • ACM reference: a reference to the ACM object itself, or a reference to any unit in the group the ACM is synchronized to.


Example:

Sets frequency and number of patrols (values 0-1). BIS_ACM is module name.

[1, BIS_ACM] call BIS_ACM_setIntensityFunc;


Spawning distances

It is possible to control the minimum and maximum distance from the group leader at which enemies will be spawned. Be careful not to spawn too close, since it will be obvious to human players.

[<ACM reference | Object>, <minimum | Scalar>, <maximum | Scalar>] call BIS_ACM_setSpawnDistanceFunc;
  • Distances with the value -1 will leave the distance as it was.
  • Distances with a value below -1 will reset to their defaults.
  • The default values are 500 meters (minimum) and 1000 meters (maximum).
  • Air patrols are currently excluded from these distances, since they generally require a much large area and they are not spawned on the ground.


Example:

Min & Max spawn distances included. BIS_ACM is module name.

[BIS_ACM, 100, 500] call BIS_ACM_setSpawnDistanceFunc;


Skill range

You can control the skill levels of spawned units by defining a range from which a random value is selected for each unit. If you want a very specific value, simply make a range with both minimum and maximum set to that value.

[<minimum | Scalar>, <maximum | Scalar>, <ACM reference | Object>] call BIS_ACM_setSkillFunc;
  • The skill values should be Scalars between 0.0 and 1.0.


Example:

Min & Max skill range for spawned units. BIS_ACM is module name.

[0, 0.6, BIS_ACM] call BIS_ACM_setSkillFunc;


Ammunition count range

You may define the ammunition count of spawned units by defining a range from which a random value is selected for each unit.

[<minimum | Scalar>, <maximum | Scalar>, <ACM reference | Object>] call BIS_ACM_setAmmoFunc;
  • The ammo values should be Scalars between 0.0 and 1.0.

Example:

Amount of ammo spawned units possess. BIS_ACM is module name.

[0.2, 0.5, BIS_ACM] call BIS_ACM_setAmmoFunc;


Group types

By default the ACM will select group types from CfgGroups, but you may want to use only a number of specific group types. You have the possibility of overriding the group type database with your own database, by using two functions.

// You can pass both actual CfgGroups Config entries or class name Strings.
[<ACM reference | Object>, <types | Array of Configs and / or Strings>] call BIS_ACM_addGroupClassesFunc;
// Passing an empty types Array will completely disable the custom database and switch back to the default.
[<ACM reference | Object>, <types | Array of Configs and / or Strings>] call BIS_ACM_removeGroupClassesFunc;

Useable group types: Ambient Combat Manager - Group types

Example:

[BIS_ACM, ["RU_InfSquad", "RU_InfSection_AA", "RU_SniperTeam", "RU_MechInfSquad_2"]] call BIS_ACM_addGroupClassesFunc;


Factions

You are able to control which factions are spawned by the ACM.

// Arma 2 factions: "USMC", "CDF", "RU", "INS", "GUE"
// Operation Arrowhead factions: "BIS_US", "BIS_CZ", "BIS_GER", "BIS_TK", "BIS_TK_INS", "BIS_TK_GUE", "BIS_UN", "BIS_TK_CIV", "BIS_CIV_special"
// DLC/Reinforcements factions: "BIS_BAF", "PMC_BAF", "BIS_CZ"
[<factions | Array of Strings>, <ACM reference | Object>] call BIS_ACM_setFactionsFunc;

Example:

Factions to be spawned. BIS_ACM is module name.

[["USMC", "INS", "CDF", "RU", "GUE"], BIS_ACM] call BIS_ACM_setFactionsFunc;


Blacklisting areas

Certain areas of a map can be blacklisted as areas in which the ACM should not spawn units or place their waypoints (although their travel paths may cross these areas). There are a number of methods to define such areas.

By markers

You may place markers with a special naming pattern BIS_ACM_X (where X has to start at 1 and may not skip any numbers). The areas defined by these markers are automatically blacklisted and the markers deleted.

By function

// When passing Arrays, these should contain the top-left and bottom-right coordinates.
[<ACM reference | Object>, <types | Array of Arrays and / or Markers and / or triggers>] call BIS_ACM_blacklistAreaFunc;

Examples: // Example 1: Adding a marker area to ACM called "BIS_ACM" with name "marker_1":

[BIS_ACM, ["marker_1"]] call BIS_ACM_blacklistAreaFunc;
  
// Example 2: Adding two marker areas to ACM called "BIS_ACM" with names "marker_1" and "marker_2":
[BIS_ACM, ["marker_1", "marker_2"]] call BIS_ACM_blacklistAreaFunc;


Patrol types

In some missions you may not want to use all patrol types, or use different chances for said patrol types. A custom pool of types and chances can be defined like so:

/*
	type must be one of "", "ground_patrol", "air_patrol".
	Passing an empty type will reset back to the default pool.
	Weights should normally be between 0 and 1.
	A weight of -1 will remove that patrol type from the pool.
*/
[<type | String>, <weight / chance | Scalar>, <ACM reference | Object>] call BIS_ACM_setTypeChanceFunc;

Example:

Type of patrol. With 0 meaning no chance of appearing, and 1 meaning 100% chance. -1 removes patrol type completely. BIS_ACM is module name.

["ground_patrol", 1, BIS_ACM] call BIS_ACM_setTypeChanceFunc;
["air_patrol", 1, BIS_ACM] call BIS_ACM_setTypeChanceFunc;


For further discussion on the ACM: Official Forums thread.