Function 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
G
CBA_fnc_
getActiveFeatureCamera
CBA_fnc_
getAlive
CBA_fnc_
getAnimType
CBA_fnc_
getArea
CBA_fnc_
getArg
CBA_fnc_
getArrayDiff
CBA_fnc_
getArrayElements
CBA_fnc_
getAspectRatio
CBA_fnc_
getConfigEntry
CBA_fnc_
getDistance
CBA_fnc_
getFirer
CBA_fnc_
getFov
CBA_fnc_
getGroup
CBA_fnc_
getGroupIndex
CBA_fnc_
getItemConfig
CBA_fnc_
getKeybind
CBA_fnc_
getLoadout
CBA_fnc_
getMagazineIndex
CBA_fnc_
getMusicData
CBA_fnc_
getMusicPath
CBA_fnc_
getMusicPlaying
CBA_fnc_
getMuzzles
CBA_fnc_
getNearest
CBA_fnc_
getNearestBuilding
CBA_fnc_
getNonPresetClass
CBA_fnc_
getObjectConfig
CBA_fnc_
getPos
CBA_fnc_
getPosFromString
CBA_fnc_
getSharedGroup
CBA_fnc_
getTerrainProfile
CBA_fnc_
getTurret
CBA_fnc_
getUISize
CBA_fnc_
getUnitAnim
CBA_fnc_
getUnitDeathAnim
CBA_fnc_
getVolume
CBA_fnc_
getWeaponModes
CBA_fnc_
globalEvent
CBA_fnc_
globalEventJIP
CBA_fnc_
globalExecute
CBA_fnc_
globalSay
CBA_fnc_
globalSay3d
H
CBA_fnc_
hashCreate
CBA_fnc_
hashEachPair
CBA_fnc_
hashFilter
CBA_fnc_
hashGet
CBA_fnc_
hashHasKey
CBA_fnc_
hashKeys
CBA_fnc_
hashRem
CBA_fnc_
hashSet
CBA_fnc_
hashSize
CBA_fnc_
hashValues
CBA_fnc_
headDir
I
CBA_fnc_
inheritsFrom
CBA_fnc_
inject
CBA_fnc_
insert
CBA_fnc_
isAlive
CBA_fnc_
isHash
CBA_fnc_
isMusicPlaying
CBA_fnc_
isPerson
CBA_fnc_
isRecompileEnabled
CBA_fnc_
isScheduled
CBA_fnc_
isTerrainObject
CBA_fnc_
isTurnedOut
CBA_fnc_
isUnitGetOutAnim
J
CBA_fnc_
join
L
CBA_fnc_
leftTrim
CBA_fnc_
localEvent
CBA_fnc_
localizeKey
M
CBA_fnc_
mapDirTo
CBA_fnc_
mapGridToPos
CBA_fnc_
mapRelPos
CBA_fnc_
matrixProduct3D
CBA_fnc_
matrixTranspose
CBA_fnc_
modelHeadDir
CBA_fnc_
moduleAttack
CBA_fnc_
moduleDefend
CBA_fnc_
modulePatrol
N
CBA_fnc_
nearPlayer
CBA_fnc_
northingReversed
CBA_fnc_
notify
O
CBA_fnc_
objectRandom
CBA_fnc_
openLobbyManager
CBA_fnc_
ownerEvent
P
CBA_fnc_
parseJSON
CBA_fnc_
parseYAML
CBA_fnc_
players
CBA_fnc_
playMusic
CBA_fnc_
polar2vect
CBA_fnc_
prettyFormat
CBA_fnc_
progressBar
CBA_fnc_
publicVariable
R
CBA_fnc_
randomizeFacewear
CBA_fnc_
randomVector3D
CBA_fnc_
randPos
CBA_fnc_
randPosArea
CBA_fnc_
readKeyFromConfig
CBA_fnc_
realHeight
CBA_fnc_
registerChatCommand
CBA_fnc_
registerFeatureCamera
CBA_fnc_
registerKeybind
CBA_fnc_
registerKeybindModPrettyName
CBA_fnc_
registerKeybindToFleximenu
CBA_fnc_
reject
CBA_fnc_
remoteEvent
CBA_fnc_
removeBackpackCargo
CBA_fnc_
removeBinocularMagazine
CBA_fnc_
removeBISPlayerEventHandler
CBA_fnc_
removeDisplayHandler
CBA_fnc_
removeEventHandler
CBA_fnc_
removeGlobalEventJIP
CBA_fnc_
removeItem
CBA_fnc_
removeItemCargo
CBA_fnc_
removeKeyHandler
CBA_fnc_
removeMagazine
CBA_fnc_
removeMagazineCargo
CBA_fnc_
removeMarkerEventHandler
CBA_fnc_
removePerFrameHandler
CBA_fnc_
removePlayerAction
CBA_fnc_
removePlayerEventHandler
CBA_fnc_
removeUnitTrackProjectiles
CBA_fnc_
removeWeapon
CBA_fnc_
removeWeaponCargo
CBA_fnc_
removeWhitespace
CBA_fnc_
renameInventoryItem
CBA_fnc_
replace
CBA_fnc_
rightTrim
Returns active feature camera.
A function used to find out who is alive in an array or a group.
Used to determine which weapon unit is currently holding and return proper animation type.
Get default named argument from list.
A function used to return the differences between two arrays.
A function used to return the element counts in an array.
Used to determine the Aspect ratio of the screen.
Gets a configuration entry.
A function used to find out the distance between two positions.
A function used to find out which unit exactly fired.
Get current camera’s vertical field of view in radians and zoom.
A function used to find out the group of an object.
Finds out the actual ID number of a person within his group as assigned by the game and used in the squad leader’s command menu.
A function used to return the config of an item.
Checks if a particular mod has already registered a keybind handler for the specified action.
Get a unit’s extended loadout Parameters: _unit - The unit to set the loadout on.
Finds out the magazine ID of all magazines of given type in the inventory of given unit.
A function used to return data from the given music class
A function used to return the config path of a music file
A function used to return the current time on playing music.
Gets the list of possible muzzles for a weapon.
Find out the nearest entity parsed in an array to a position.
Find the nearest building and number of building positions available.
Get ancestor class of a weapon or container which has no preset attachments/contents.
A function used to return the config of an object or class name.
A function used to get the position of an entity.
A function used to get the position of an item when passed as a string.
Returns existing group on side, or newly created group when not existent.
A function used to find the terrain profile between two positions
A function used to find out which config turret is turretpath.
Used to determine the UI size of the screen.
Get information about a unit’s stance and speed.
Get death animation for a unit.
Return the volume of the bounding box of an object’s model.
Gets the list of possible modes for a weapon.
Raises a CBA event on all machines, including the local one.
Raises a CBA event on all machines.
Executes code on given destinations.
Says sound on all clients.
Says sound on all clients in 3D.
Creates a new Hash
Iterate through all keys and values in a Hash.
Iterate through all keys and values in a Hash.
Gets a value for a given key from a Hash.
Check if a Hash has a value defined for a key.
Returns all Keys in a Hash.
Removes given key from given Hash.
Sets a value for a given key in a Hash.
Get number of elements in a Hash.
Returns all values in a Hash.
Get the direction of a unit’s head.
Checks whether a config entry inherits, directly or indirectly, from another one.
Accumulates a value by passing elements of an array “through” a function.
Inserts an array of elements to given array at the specified index.
A function used to find out if the group or object is alive.
Check if a value is a Hash data structure.
Function that checks if music is currently playing
Check if recompiling is enabled.
Check if the current scope is running in scheduled or unscheduled environment.
Check if object is a terrain object.
Checks whether a unit is turned out in a vehicle or not.
Checks whether a unit is turned out in a vehicle or not.
Trims specified characters (all whitespace by default) from the left end of a string.
Raises a CBA event on the local machine.
Translate DIK code and modifier keys to readable keybind.
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.
Returns the resulting matrix from the matrix-matrix product.
Returns the transposed matrix.
Get the direction of any unit’s head.
A function for commanding a group to attack a location with information parsed from a module.
A function for commanding a group to defend a location with information parsed from a module.
A function for commanding a group to patrol a location with information parsed from a module.
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)
Display a text message.
Creates a “random” number 0-9 based on an object’s velocity
Opens the Lobby Manager in 3DEN editor.
Raises a CBA event on the target client ID’s machine.
Deserializes a JSON string.
Parses a YAML file into a nested array/Hash structure.
Reports all (human) player objects.
A function used to play music.
Creates a vector based on a inputted magnitude, direction and elevation
Makes an array easy to read.
Opens a progress bar.
Broadcast a variables value to all machines.
Add config defined weighted random facewear to unit.
Returns a 3 dimensional unit vector that is pointing in a random direction.
A function used to randomize a position around a given center
Find a random (uniformly distributed) position within the given area without rejection sampling.
Reads key setting from config.
Real z coordinate of an object, for placing stuff on roofs, etc.
Register a custom chat command on the local machine.
Registers a feature camera for use with CBA_fnc_getActiveFeatureCamera.
This function is deprecated, please use CBA_fnc_addKeybind.
Associates a pretty name to a keybinding mod entry.
This function is deprecated.
Reject array elements for which the block returns true
Raises a CBA event on all machines, except the local one.
Removes specific backpack(s) from cargo space.
Removes the magazine of the units rangefinder.
Remove event handlers added via CBA_fnc_addBISPlayerEventHandler.
Removes an action from the main display.
Removes an event handler previously registered with CBA_fnc_addEventHandler.
Removes a globalEventJIP ID.
Remove an item.
Removes specific item(s) from cargo space.
Removes an action from a keybind.
Remove a magazine.
Removes specific magazine(s) from cargo space.
Removes an event handler previously registered with ‘CBA_fnc_addMarkerEventHandler’.
Remove a handler that you have added using CBA_fnc_addPerFrameHandler.
Removes player action previously added with CBA_fnc_addPlayerAction.
Removes a player event handler.
Removes projectile tracking from a given unit or vehicle.
Remove a weapon (including binocular).
Removes specific weapon(s) from cargo space.
Removes whitespace (space, tab, newline) from string.
Renames inventory item locally
Replaces substrings within a string.
Trims specified characters (all whitespace by default) from the right end of a string.
Copyright © CBA team and contributors · 2024 ·
Generated by Natural Docs
CBA
Community Base Addons
Overview
Index (Everything)
Index (Functions)
Index (Macros)
Project
Wiki
Reference
Forums
Issues
Download
Functions
Accessory
CBA_accessory_fnc_switchAttachment
CBA_fnc_addAttachmentCondition
CBA_fnc_switchableAttachments
Ai
CBA_fnc_addWaypoint
CBA_fnc_buildingPositions
CBA_fnc_clearWaypoints
CBA_fnc_searchNearby
CBA_fnc_taskAttack
CBA_fnc_taskDefend
CBA_fnc_taskPatrol
CBA_fnc_taskSearchArea
fnc_waypointGarrison
Arrays
CBA_fnc_filter
CBA_fnc_findMax
CBA_fnc_findMin
CBA_fnc_findNil
CBA_fnc_findNull
CBA_fnc_findTypeName
CBA_fnc_findTypeOf
CBA_fnc_getArrayDiff
CBA_fnc_getArrayElements
CBA_fnc_inject
CBA_fnc_insert
CBA_fnc_join
CBA_fnc_reject
CBA_fnc_select
CBA_fnc_selectBest
CBA_fnc_selectRandomArray
CBA_fnc_shuffle
CBA_fnc_sortNestedArray
CBA_fnc_standardDeviation
Common
CBA_fnc_actionArgument
CBA_fnc_addBackpackCargo
CBA_fnc_addBinocularMagazine
CBA_fnc_addItem
CBA_fnc_addItemCargo
CBA_fnc_addMagazine
CBA_fnc_addMagazineCargo
CBA_fnc_addPerFrameHandler
CBA_fnc_addPlayerAction
CBA_fnc_addWeapon
CBA_fnc_addWeaponCargo
CBA_fnc_addWeaponWithoutItems
CBA_fnc_allNamespaces
CBA_fnc_binocularMagazine
CBA_fnc_canAddItem
CBA_fnc_canUseWeapon
CBA_fnc_colorAHEXtoDecimal
CBA_fnc_colorARGBtoDecimal
CBA_fnc_colorHEXAtoDecimal
CBA_fnc_colorHEXtoDecimal
CBA_fnc_colorRGBAtoDecimal
CBA_fnc_colorRGBtoDecimal
CBA_fnc_compatibleMagazines
CBA_fnc_compileFinal
CBA_fnc_createMarker
CBA_fnc_createNamespace
CBA_fnc_createPerFrameHandlerObject
CBA_fnc_createTrigger
CBA_fnc_createUUID
CBA_fnc_cssColorToDecimal
CBA_fnc_cssColorToHEX
CBA_fnc_cssColorToTexture
CBA_fnc_currentMagazineIndex
CBA_fnc_currentUnit
CBA_fnc_deleteEntity
CBA_fnc_deleteNamespace
CBA_fnc_deletePerFrameHandlerObject
CBA_fnc_directCall
CBA_fnc_dropItem
CBA_fnc_dropMagazine
CBA_fnc_dropWeapon
CBA_fnc_escapeRegex
CBA_fnc_execAfterNFrames
CBA_fnc_execNextFrame
CBA_fnc_findEntity
CBA_fnc_getActiveFeatureCamera
CBA_fnc_getAlive
CBA_fnc_getAnimType
CBA_fnc_getArea
CBA_fnc_getArg
CBA_fnc_getConfigEntry
CBA_fnc_getDistance
CBA_fnc_getFirer
CBA_fnc_getGroup
CBA_fnc_getGroupIndex
CBA_fnc_getItemConfig
CBA_fnc_getMagazineIndex
CBA_fnc_getMuzzles
CBA_fnc_getNearest
CBA_fnc_getNearestBuilding
CBA_fnc_getNonPresetClass
CBA_fnc_getObjectConfig
CBA_fnc_getPos
CBA_fnc_getSharedGroup
CBA_fnc_getTerrainProfile
CBA_fnc_getTurret
CBA_fnc_getUnitAnim
CBA_fnc_getUnitDeathAnim
CBA_fnc_getVolume
CBA_fnc_getWeaponModes
CBA_fnc_headDir
CBA_fnc_inheritsFrom
CBA_fnc_isAlive
CBA_fnc_isPerson
CBA_fnc_isTerrainObject
CBA_fnc_isTurnedOut
CBA_fnc_isUnitGetOutAnim
CBA_fnc_mapDirTo
CBA_fnc_mapGridToPos
CBA_fnc_mapRelPos
CBA_fnc_modelHeadDir
CBA_fnc_nearPlayer
CBA_fnc_northingReversed
CBA_fnc_objectRandom
CBA_fnc_players
CBA_fnc_randomizeFacewear
CBA_fnc_randPos
CBA_fnc_randPosArea
CBA_fnc_realHeight
CBA_fnc_registerFeatureCamera
CBA_fnc_removeBackpackCargo
CBA_fnc_removeBinocularMagazine
CBA_fnc_removeItem
CBA_fnc_removeItemCargo
CBA_fnc_removeMagazine
CBA_fnc_removeMagazineCargo
CBA_fnc_removePerFrameHandler
CBA_fnc_removePlayerAction
CBA_fnc_removeWeapon
CBA_fnc_removeWeaponCargo
CBA_fnc_selectWeapon
CBA_fnc_setCallsign
CBA_fnc_setHeight
CBA_fnc_setPos
CBA_fnc_switchPlayer
CBA_fnc_turretDir
CBA_fnc_turretPath
CBA_fnc_turretPathWeapon
CBA_fnc_uniqueUnitItems
CBA_fnc_vehicleRole
CBA_fnc_viewDir
CBA_fnc_waitAndExecute
CBA_fnc_waitUntilAndExecute
CBA_fnc_weaponComponents
CBA_fnc_weekDay
Diagnostic
CBA_diagnostic_fnc_initTargetDebugConsole
CBA_fnc_addUnitTrackProjectiles
CBA_fnc_debug
CBA_fnc_removeUnitTrackProjectiles
CBA_fnc_test
Disposables
CBA_fnc_firedDisposable
Events
CBA_events_fnc_playerEvent
CBA_fnc_addBISEventHandler
CBA_fnc_addBISPlayerEventHandler
CBA_fnc_addDisplayHandler
CBA_fnc_addEventHandler
CBA_fnc_addEventHandlerArgs
CBA_fnc_addKeyHandler
CBA_fnc_addKeyHandlerFromConfig
CBA_fnc_addMarkerEventHandler
CBA_fnc_addPlayerEventHandler
CBA_fnc_changeKeyHandler
CBA_fnc_globalEvent
CBA_fnc_globalEventJIP
CBA_fnc_localEvent
CBA_fnc_ownerEvent
CBA_fnc_readKeyFromConfig
CBA_fnc_registerChatCommand
CBA_fnc_remoteEvent
CBA_fnc_removeBISPlayerEventHandler
CBA_fnc_removeDisplayHandler
CBA_fnc_removeEventHandler
CBA_fnc_removeGlobalEventJIP
CBA_fnc_removeKeyHandler
CBA_fnc_removeMarkerEventHandler
CBA_fnc_removePlayerEventHandler
CBA_fnc_serverEvent
CBA_fnc_targetEvent
CBA_fnc_turretEvent
CBA_fnc_weaponEvents
Hashes
CBA_fnc_deserializeNamespace
CBA_fnc_encodeJSON
CBA_fnc_hashCreate
CBA_fnc_hashEachPair
CBA_fnc_hashFilter
CBA_fnc_hashGet
CBA_fnc_hashHasKey
CBA_fnc_hashKeys
CBA_fnc_hashRem
CBA_fnc_hashSet
CBA_fnc_hashSize
CBA_fnc_hashValues
CBA_fnc_isHash
CBA_fnc_parseJSON
CBA_fnc_parseYAML
CBA_fnc_serializeNamespace
Joint Rails
CBA_fnc_compatibleItems
Keybinding
CBA_fnc_addKeybind
CBA_fnc_addKeybindToFleximenu
CBA_fnc_getKeybind
CBA_fnc_localizeKey
CBA_fnc_registerKeybind
CBA_fnc_registerKeybindModPrettyName
CBA_fnc_registerKeybindToFleximenu
Loadout
CBA_fnc_getLoadout
CBA_fnc_setLoadout
Modules
CBA_fnc_getPosFromString
CBA_fnc_moduleAttack
CBA_fnc_moduleDefend
CBA_fnc_modulePatrol
Music
CBA_fnc_compileMusic
CBA_fnc_findMusic
CBA_fnc_getMusicData
CBA_fnc_getMusicPath
CBA_fnc_getMusicPlaying
CBA_fnc_isMusicPlaying
CBA_fnc_playMusic
CBA_fnc_stopMusic
Network
CBA_fnc_globalExecute
CBA_fnc_globalSay
CBA_fnc_globalSay3d
CBA_fnc_publicVariable
CBA_fnc_setVarNet
Optics
CBA_optics_fnc_setOpticMagnification
CBA_optics_fnc_setOpticMagnificationHelper
CBA_optics_fnc_setOpticMagnificationHelperZeroing
Settings
CBA_fnc_addSetting
Statemachine
CBA_statemachine_fnc_addEventTransition
CBA_statemachine_fnc_addState
CBA_statemachine_fnc_addTransition
CBA_statemachine_fnc_clockwork
CBA_statemachine_fnc_create
CBA_statemachine_fnc_createFromConfig
CBA_statemachine_fnc_delete
CBA_statemachine_fnc_dumpPerformanceCounters
CBA_statemachine_fnc_getCurrentState
CBA_statemachine_fnc_manualTransition
CBA_statemachine_fnc_toString
CBA_statemachine_fnc_updateList
Strings
CBA_fnc_capitalize
CBA_fnc_decodeURL
CBA_fnc_find
CBA_fnc_floatToString
CBA_fnc_formatElapsedTime
CBA_fnc_formatNumber
CBA_fnc_leftTrim
CBA_fnc_prettyFormat
CBA_fnc_removeWhitespace
CBA_fnc_replace
CBA_fnc_rightTrim
CBA_fnc_sanitizeHTML
CBA_fnc_split
CBA_fnc_strLen
CBA_fnc_substr
CBA_fnc_substring
CBA_fnc_trim
Ui
CBA_fnc_addItemContextMenuOption
CBA_fnc_addPauseMenuOption
CBA_fnc_consumeItem
CBA_fnc_getAspectRatio
CBA_fnc_getFov
CBA_fnc_getUISize
CBA_fnc_notify
CBA_fnc_openLobbyManager
CBA_fnc_progressBar
CBA_fnc_renameInventoryItem
Vectors
CBA_fnc_matrixProduct3D
CBA_fnc_matrixTranspose
CBA_fnc_polar2vect
CBA_fnc_randomVector3D
CBA_fnc_scaleVect
CBA_fnc_scaleVectTo
CBA_fnc_simplifyAngle
CBA_fnc_simplifyAngle180
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_vectMap3D
CBA_fnc_vectRotate2D
CBA_fnc_vectRotate3D
CBA_fnc_vectSubtract
Xeh
CBA_fnc_addClassEventHandler
CBA_fnc_compileEventHandlers
CBA_fnc_compileFunction
CBA_fnc_isRecompileEnabled
CBA_fnc_isScheduled
CBA_fnc_supportMonitor
Macros
script_macros_common.hpp
script_macros_mission.hpp
Everything
Functions
Macros
Close