Difference between revisions of "Ambient Combat Manager - Functions"
|Line 69:||Line 69:|
For further discussion on the ACM: [http://forums.bistudio.com/
For further discussion on the ACM: [http://forums.bistudio.com/.php?=].
Revision as of 21:42, 11 June 2009
This page describes all pre-defined functions available to manipulate the settings of an Ambient Combat Manager (ACM).
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.
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.
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.
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.
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;
You are able to control which of the five factions are spawned by the ACM.
//Pick from: "USMC", "CDF", "RU", "INS", "GUE". [<factions | Array of Strings>, <ACM reference | Object>] call BIS_ACM_setFactionsFunc;
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.
//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;
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.
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;
For further discussion on the ACM: .