Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
I
CBA_fnc_inArea
 INC
CBA_fnc_inheritsFrom
CBA_fnc_inject
CBA_fnc_intToString
 IS_ARRAY
 IS_BOOL
 IS_BOOLEAN
 IS_CODE
 IS_CONFIG
 IS_CONTROL
 IS_DISPLAY
 IS_FUNCTION
 IS_GROUP
 IS_INTEGER
 IS_LOCATION
 IS_NUMBER
 IS_OBJECT
 IS_SCALAR
 IS_SCRIPT
 IS_SIDE
 IS_STRING
 IS_TEXT
 IS_x
CBA_fnc_isAlive
CBA_fnc_isHash
 ISNILS
CBA_fnc_isTurnedOut
CBA_fnc_isUnitGetOutAnim
J
CBA_fnc_join
K
 KEY_PARAM
L
CBA_fnc_leftTrim
CBA_fnc_localEvent
CBA_fnc_locked
CBA_fnc_log
 LOG
M
 Managing Deprecation
 Managing Function Parameters
CBA_fnc_mapDirTo
CBA_fnc_mapGridToPos
CBA_fnc_mapRelPos
 MESSAGE
CBA_fnc_modelHeadDir
N
CBA_fnc_nearPlayer
CBA_fnc_northingReversed
O
CBA_fnc_objectRandom
 OBSOLETE
 OBSOLETE_SYS
 Overview
P
 PARAMS_1(A)
 PARAMS_2(A,B)
 PARAMS_3(A,B,C)
 PARAMS_4(A,B,C,D)
 PARAMS_5(A,B,C,D,E)
 PARAMS_6(A,B,C,D,E,F)
 PARAMS_7(A,B,C,D,E,F,G)
 PARAMS_8(A,B,C,D,E,F,G,H)
 PARAMS_n
CBA_fnc_parseYAML
CBA_fnc_peek
CBA_fnc_players
CBA_fnc_polar2vect
CBA_fnc_publicVariable
 PUSH
R
CBA_fnc_randPos
CBA_fnc_readKeyFromConfig
CBA_fnc_realHeight
CBA_fnc_receiverOnlyEvent
CBA_fnc_reject
 REM
CBA_fnc_remoteEvent
CBA_fnc_removeClientToServerEvent
CBA_fnc_removeDisplayHandler
CBA_fnc_removeEventHandler
CBA_fnc_removeKeyHandler
CBA_fnc_removeLocalEventHandler
CBA_fnc_removeMagazine
CBA_fnc_removeMagazineCargo
CBA_fnc_removeMagazineCargoGlobal
CBA_fnc_removePerFrameHandler
CBA_fnc_removePlayerAction
CBA_fnc_removeReceiverOnlyEvent
CBA_fnc_removeWeapon
CBA_fnc_removeWeaponCargo
CBA_fnc_removeWeaponCargoGlobal
CBA_fnc_replace
 RETNIL
CBA_fnc_rightTrim
S
CBA_fnc_scaleVect
CBA_fnc_scaleVectTo
 SCRIPT
 script_macros_common.hpp
 script_macros_mission.hpp
CBA_fnc_searchNearby
CBA_fnc_select
CBA_fnc_selectWeapon
CBA_fnc_setHeight
CBA_fnc_setMarkerPersistent
CBA_fnc_setPos
CBA_fnc_setVarNet
CBA_fnc_shuffle
CBA_fnc_simplifyAngle
CBA_fnc_simplifyAngle180
CBA_fnc_sortNestedArray
CBA_fnc_split
 STRING
CBA_fnc_strLen
 SUB
CBA_fnc_switchPlayer
CBA_fnc_systemChat
T
CBA_fnc_taskAttack
CBA_fnc_taskDefend
CBA_fnc_taskPatrol
CBA_fnc_test
 TRACE_1(MESSAGE,A)
 TRACE_2(MESSAGE,A,B)
 TRACE_3(MESSAGE,A,B,C)
 TRACE_4(MESSAGE,A,B,C,D)
 TRACE_5(MESSAGE,A,B,C,D,E)
 TRACE_6(MESSAGE,A,B,C,D,E,F)
 TRACE_7(MESSAGE,A,B,C,D,E,F,G)
 TRACE_8(MESSAGE,A,B,C,D,E,F,G,H)
 TRACE_9(MESSAGE,A,B,C,D,E,F,G,H,I)
 TRACE_n
CBA_fnc_trim
V
 VARIABLE
 VARIABLE(1-8)
CBA_fnc_vect2Polar
CBA_fnc_vectAdd
CBA_fnc_vectCross
CBA_fnc_vectCross2D
CBA_fnc_vectDir
CBA_fnc_vectDot
CBA_fnc_vectElev
CBA_fnc_vectMagn
CBA_fnc_vectMagn2D
CBA_fnc_vectRotate2D
CBA_fnc_vectSubtract
A function used to determine if a position is within a zone.
Increase a number by one.
Checks whether a config entry inherits, directly or indirectly, from another one.
Accumulates a value by passing elements of an array “through” a function.
Faster int to string, uses an integer lookup table if possible
Array
Boolean
UI display handle(synonym for IS_BOOL())
Code block (i.e a compiled function)
Configuration
UI control handle.
UI display handle.
A compiled function (synonym for IS_CODE())
Group.
Is a number a whole number?
World location.
A floating point number (synonym for IS_SCALAR())
World object.
Floating point number.
A script handle (as returned by execVM and spawn commands).
Game side.
World object.
Structured text.
Checking the data types of variables.
A function used to find out if the group or object is alive.
Check if a value is a Hash data structure.
Sets a variable with a value, but only if it is undefined.
Checks whether a unit is turned out in a vehicle or not.
Checks whether a unit is turned out in a vehicle or not.
Joins an array of values into a single string, joining each fragment around a separator string.
Get value from key in _this list, return default when key is not included in list.
Trims white-space (space, tab, newline) from the left end of a string.
Raises a CBA event only on the local machine.
A2/OA/TOH compatible locked function.
Logs a message to the RPT log.
Log a timestamped message into the RPT log.
Gets the direction between two map grid references.
Converts a 2, 4, 6, 8, or 10 digit grid reference into a Position.
Find a position relative to a known position on the map.
Message to add to the trace [String]
Get the direction of any unit’s head.
Check whether these are any players within a certain distance of a unit.
Checks if the maps northing is reversed (like Chernarus & Utes, or any map pre-OA)
Creates a “random” number 0-9 based on an object’s velocity
Replace a function, in the current component, that has become obsolete.
Replace a function that has become obsolete.
Get 1 parameter from the _this array (or _this if it’s not an array).
Get 2 parameters from the _this array.
Get 3 parameters from the _this array.
Get 4 parameters from the _this array.
Get 5 parameters from the _this array.
Get 6 parameters from the _this array.
Get 7 parameters from the _this array.
Get 8 parameters from the _this array.
Setting variables based on parameters passed to a function.
Parses a YAML file into a nested array/Hash structure.
Peek at variable on the server To receive the variable content back, you will have to [“cba_diagnostics_receive_peak”, {_this call myFunction}] call CBA_fnc_addEventHandler;
Get a list of current player objects.
Creates a vector based on a inputted magnitude, direction and elevation
CBA_fnc_publicVariable does only broadcast the new value if it doesn’t exist in missionNamespace or the new value is different to the one in missionNamespace.
Appends a single value onto the end of an ARRAY.
A function used to randomize a position around a given center
Reads key setting from config
Real z coordinate of an object, for placing stuff on roofs, etc.
Raises an CBA event only on the receiver and is only broadcasted there Can be called on any client or on the server.
Reject array elements for which the block returns true
Remove an element from an array each time it occurs.
Raises a CBA event on all machines EXCEPT the local one.
Removes an event handler previously registered with CBA_fnc_addClientToServerEventhandler.
Removes an action to a displayHandler
Removes an event handler previously registered with CBA_fnc_addEventHandler.
Removes an action to a keyhandler
Removes an event handler previously registered with CBA_fnc_addLocalEventHandler.
Remove a magazine.
Function to remove specific items from local cargo space.
Function to remove specific items from global cargo space.
Remove a handler that you have added using CBA_fnc_addPerFrameHandler
Removes player action previously added with CBA_fnc_addPlayerAction.
Removes an event handler previously registered with CBA_fnc_addReceiverOnlyEventhandler.
Remove a weapon.
Function to remove specific items from local cargo space.
Function to remove specific items from global cargo space.
Replaces substrings within a string.
If a variable is undefined, return the value nil.
Trims white-space (space, tab, newline) from the right end of a string.
scales a specified vector by a specified factor.
scales a vector so that its new Magnitude is equivalent to a specified value.
Sets name of script (relies on PREFIX and COMPONENT values being #defined).
A general set of useful macro functions for use by CBA itself or by any module that uses CBA.
Modifies script_common_macros.hpp for compatiblity with missions.
A function for a group to search a nearby building.
Select array elements for which the block returns true
Selects weapon, if the player has the weapon, including correctly selecting a muzzle, if any.
A function used to set the height of an object
Sets or unsets JIP persistency on a global marker.
A function used to set the position of an entity.
Same as setVariable [“name”,var, true] but only broadcasts when the value of var is different to the one which is already saved in the variable space.
Shuffles an array’s contents into random order, returning a new array.
Returns an equivalent angle to the specified angle in the range 0 to 360.
Returns an equivalent angle to the specified angle in the range -180 to 180.
Used to sort a nested array from lowest to highest using quick sort based on the specified column, which must have numerical data.
Splits a string into substrings using a separator.
string used by format
Counts the number of characters in a string.
Subtract a value from a number variable.
Switch player to another unit.
Display a message in the global chat channel.
A function for a group to attack a parsed location.
A function for a group to defend a parsed location.
A function for a group to randomly patrol a parsed radius and location.
Runs unit tests for an addon or component.
Log 1 variable.
Log 2 variables.
Log 3 variables.
Log 4 variables.
Log 5 variables.
Log 6 variables.
Log 7 variables.
Log 8 variables.
Log 9 variables.
Log a message and 1-8 variables to the RPT log.
Trims white-space (space, tab, newline) from the both ends of a string.
Variable to check if it is of a particular type [Any, not nil]
elements for the list
Returns the sum of two vectors.
Returns the cross product vector of two vectors.
Returns the cross product vector of two 2D vectors.
Returns the angle of a vector with the given i and k coordinates in the range 0 to 360.
Returns the dot product of two vectors.
Returns the angle of elevation of a 3D vector with the given i, j and k coordinates in the range -90 to 90.
Returns the magnitude of a 3D vector with the given i, j and k coordinates.
Returns the magnitude of a vector with the given i and k coordinates or the magnitude of the i and k components of a 3D vector.
Rotates a 2D vector around a given center, for rotating of a vector from its origin, use BIS_fnc_rotateVector2D
Returns the difference of two vectors.
Close