Functions
Work in Progress
This documentation is a work in progress. Contributions are encouraged. Only pages with a checkmark are complete.
Core Functions
General
Variables & Data Manipulation
AI Functions
AI Behavior
- AIBattlefieldBehavior
- AIDefendPositionBehavior
- AIIdleBehavior
- AILOSMoveToBehavior
- AIMoveToBehavior
- AIParachuteBehavior
- AIValidatedMoveToBehavior
- AIWaypointIdleBehavior
AI Spawning
AI Combat
- AIEnableShooting
- AIEnableTargeting
- AIForceFire
- AIGadgetSettings
- AISetFocusPoint
- AISetTarget
- AIStartUsingGadget
- AIStopUsingGadget
- SetAIToHumanDamageModifier
AI Movement
Audio Functions
Sound Effects
Voice Over
Visual Functions
Camera
Screen Effects
Visual Effects (VFX)
Spawner Functions
Emplacement Spawners
- ForceEmplacementSpawnerSpawn
- SetEmplacementSpawnerAbandonVehicleOutOfCombatArea
- SetEmplacementSpawnerApplyDamageToAbandonVehicle
- SetEmplacementSpawnerAutoSpawn
- SetEmplacementSpawnerKeepAliveAbandonRadius
- SetEmplacementSpawnerRespawnTime
- SetEmplacementSpawnerSpawnerRadius
- SetEmplacementSpawnerTimeUntilAbandon
- SetEmplacementSpawnerType
- GetEmplacementSpawner
Vehicle Spawners
- ForceVehicleSpawnerSpawn
- SetVehicleSpawnerAbandonVehiclesOutOfCombatArea
- SetVehicleSpawnerApplyDamageToAbandonVehicle
- SetVehicleSpawnerAutoSpawn
- SetVehicleSpawnerKeepAliveAbandonRadius
- SetVehicleSpawnerKeepAliveSpawnerRadius
- SetVehicleSpawnerRespawnTime
- SetVehicleSpawnerTimeUntilAbandon
- SetVehicleSpawnerVehicleType
- GetVehicleSpawner
General Spawners
Player Functions
Player Deployment
- DeployAllPlayers
- DeployPlayer
- EnableAllPlayerDeploy
- EnablePlayerDeploy
- SetRedeployTime
- UndeployAllPlayers
- UndeployPlayer
- DisablePlayerJoin
Player Spawning
Player Health & Damage
Player Movement
Player Input
Player Inventory & Equipment
- AddAttachmentToWeaponPackage
- AddEquipment
- ForceSwitchInventory
- RemoveEquipment
- SetInventoryAmmo
- SetInventoryMagazineAmmo
- Resupply
- CreateNewWeaponPackage
- GetInventoryAmmo
- GetInventoryMagazineAmmo
- HasEquipment
- IsInventorySlotActive
Player Queries
- AllPlayers
- ClosestPlayerTo
- FarthestPlayerFrom
- GetPlayerDeaths
- GetPlayerKills
- GetSoldierState
- IsPlayerValid
- EventDamageTypeCompare
- EventDeathTypeCompare
Player Team & Squad
Player Spotting
Game Mode Functions
Game Mode Control
Game Mode Scoring
- SetGameModeScore
- SetGameModeTargetScore
- SetGameModeTimeLimit
- GetGameModeScore
- GetMatchTimeElapsed
- GetMatchTimeRemaining
- GetRoundTime
- GetTargetScore
Faction & Map
Objective Functions
Capture Points
- EnableCapturePointDeploying
- SetCapturePointCapturingTime
- SetCapturePointNeutralizationTime
- SetCapturePointOwner
- SetMaxCaptureMultiplier
- AllCapturePoints
- GetCapturePoint
- GetCaptureProgress
- GetCurrentOwnerTeam
- GetOwnerProgressTeam
- GetPlayersOnPoint
- GetPreviousOwnerTeam
HQ (Headquarters)
MCOM
Sector
General Objectives
World Objects
Area Triggers
Interact Points
Spatial Objects
Object Manipulation
- MoveObject
- MoveObjectOverTime
- OrbitObjectOverTime
- RotateObject
- SetObjectTransform
- SetObjectTransformOverTime
- StopActiveMovementForObject
- UnspawnObject
- SpawnObject
Object Queries
Raycasting
UI Functions
World Icons
- AddUIIcon
- EnableWorldIconImage
- EnableWorldIconText
- RemoveUIIcon
- SetWorldIconColor
- SetWorldIconImage
- SetWorldIconOwner
- SetWorldIconPosition
- SetWorldIconText
- GetWorldIcon
Notifications & Messages
- ClearAllCustomNotificationMessages
- ClearCustomNotificationMessage
- DisplayCustomNotificationMessage
- DisplayHighlightedWorldLogMessage
- DisplayNotificationMessage
- SendErrorReport
- Message
Scoreboard
- SetScoreboardColumnNames
- SetScoreboardColumnWidths
- SetScoreboardHeader
- SetScoreboardPlayerValues
- SetScoreboardSorting
- SetScoreboardType
UI Widgets - Creation
- AddUIButton
- AddUIContainer
- AddUIGadgetImage
- AddUIImage
- AddUIText
- AddUIWeaponImage
- DeleteAllUIWidgets
- DeleteUIWidget
UI Widgets - Button Properties
- EnableUIButtonEvent
- SetUIButtonAlphaBase
- SetUIButtonAlphaDisabled
- SetUIButtonAlphaFocused
- SetUIButtonAlphaHover
- SetUIButtonAlphaPressed
- SetUIButtonColorBase
- SetUIButtonColorDisabled
- SetUIButtonColorFocused
- SetUIButtonColorHover
- SetUIButtonColorPressed
- SetUIButtonEnabled
- GetUIButtonAlphaBase
- GetUIButtonAlphaDisabled
- GetUIButtonAlphaFocused
- GetUIButtonAlphaHover
- GetUIButtonAlphaPressed
- GetUIButtonColorBase
- GetUIButtonColorDisabled
- GetUIButtonColorFocused
- GetUIButtonColorHover
- GetUIButtonColorPressed
- GetUIButtonEnabled
UI Widgets - Image Properties
UI Widgets - Text Properties
- SetUITextAlpha
- SetUITextAnchor
- SetUITextColor
- SetUITextLabel
- SetUITextSize
- GetUITextAlpha
- GetUITextAnchor
- GetUITextColor
- GetUITextSize
UI Widgets - General Properties
- SetUIWidgetAnchor
- SetUIWidgetBgAlpha
- SetUIWidgetBgColor
- SetUIWidgetBgFill
- SetUIWidgetDepth
- SetUIWidgetName
- SetUIWidgetPadding
- SetUIWidgetParent
- SetUIWidgetPosition
- SetUIWidgetSize
- SetUIWidgetVisible
- GetUIWidgetAnchor
- GetUIWidgetBgAlpha
- GetUIWidgetBgColor
- GetUIWidgetBgFill
- GetUIWidgetDepth
- GetUIWidgetName
- GetUIWidgetPadding
- GetUIWidgetParent
- GetUIWidgetPosition
- GetUIWidgetSize
- GetUIWidgetVisible
UI Widgets - Queries
UI Input
Vehicle Functions
Vehicle Control
Vehicle Queries
- AllVehicles
- CompareVehicleName
- GetAllPlayersInVehicle
- GetPlayerFromVehicleSeat
- GetPlayerVehicleSeat
- GetVehicleFromPlayer
- GetVehicleSeatCount
- GetVehicleState
- GetVehicleTeam
- IsVehicleOccupied
- IsVehicleSeatOccupied
Waypoints
Array Functions
- AppendToArray
- ArraySlice
- CountOf
- EmptyArray
- FirstOf
- LastOf
- RandomValueInArray
- RandomizedArray
- SortedArray
- ValueInArray
Logic & Comparison
- And
- Equals
- GreaterThan
- GreaterThanEqualTo
- IfThenElse
- IsType
- LessThan
- LessThanEqualTo
- Not
- NotEqualTo
- Or
- Xor
String Functions
Math Functions
Basic Math
- AbsoluteValue
- Add
- Ceiling
- Divide
- Floor
- Max
- Modulo
- Multiply
- RaiseToPower
- RoundToInteger
- SquareRoot
- Subtract
Trigonometry
- ArccosineInDegrees
- ArccosineInRadians
- ArcsineInDegrees
- ArcsineInRadians
- ArctangentInDegrees
- ArctangentInRadians
- CosineFromDegrees
- CosineFromRadians
- SineFromDegrees
- SineFromRadians
- TangentFromDegrees
- TangentFromRadians
- DegreesToRadians
- RadiansToDegrees
- Pi
Random
Vector & Transform Functions
Vector Creation
Vector Math
- AngleBetweenVectors
- AngleDifference
- CrossProduct
- DirectionFromAngles
- DirectionTowards
- DistanceBetween
- DotProduct
- Normalize
- VectorTowards