TypeScript API Reference

SDK version: 1.4.3.0

This page is generated from the SDK's code/types/mod/index.d.ts and code/modlib/index.ts files.

Filter API

Summary

Category	Count
event handlers	79
mod functions	431
mod function overloads	570
mod types	41
mod enums	83
modlib functions	31
modlib classes	2

mod Functions

UI

Toggle

AddUIButton

Creates a UI Button Widget.

AddUIButton(name: string, position: Vector, size: Vector, anchor: UIAnchor): void

AddUIButton(
  name: string,
  position: Vector,
  size: Vector,
  anchor: UIAnchor,
  receiver: Player | Team
): void

AddUIButton(
  name: string,
  position: Vector,
  size: Vector,
  anchor: UIAnchor,
  parent: UIWidget,
  visible: boolean,
  padding: number,
  bgColor: Vector,
  bgAlpha: number,
  bgFill: UIBgFill,
  buttonEnabled: boolean,
  baseColor: Vector,
  baseAlpha: number,
  disabledColor: Vector,
  disabledAlpha: number,
  pressedColor: Vector,
  pressedAlpha: number,
  hoverColor: Vector,
  hoverAlpha: number,
  focusedColor: Vector,
  focusedAlpha: number
): void

AddUIButton(
  name: string,
  position: Vector,
  size: Vector,
  anchor: UIAnchor,
  parent: UIWidget,
  visible: boolean,
  padding: number,
  bgColor: Vector,
  bgAlpha: number,
  bgFill: UIBgFill,
  buttonEnabled: boolean,
  baseColor: Vector,
  baseAlpha: number,
  disabledColor: Vector,
  disabledAlpha: number,
  pressedColor: Vector,
  pressedAlpha: number,
  hoverColor: Vector,
  hoverAlpha: number,
  focusedColor: Vector,
  focusedAlpha: number,
  receiver: Player | Team
): void

AddUIButton(
  name: string,
  position: Vector,
  size: Vector,
  anchor: UIAnchor,
  parent: UIWidget,
  visible: boolean,
  padding: number,
  bgColor: Vector,
  bgAlpha: number,
  bgFill: UIBgFill,
  buttonEnabled: boolean,
  baseColor: Vector,
  baseAlpha: number,
  disabledColor: Vector,
  disabledAlpha: number,
  pressedColor: Vector,
  pressedAlpha: number,
  hoverColor: Vector,
  hoverAlpha: number,
  focusedColor: Vector,
  focusedAlpha: number,
  depth: UIDepth
): void

AddUIButton(
  name: string,
  position: Vector,
  size: Vector,
  anchor: UIAnchor,
  parent: UIWidget,
  visible: boolean,
  padding: number,
  bgColor: Vector,
  bgAlpha: number,
  bgFill: UIBgFill,
  buttonEnabled: boolean,
  baseColor: Vector,
  baseAlpha: number,
  disabledColor: Vector,
  disabledAlpha: number,
  pressedColor: Vector,
  pressedAlpha: number,
  hoverColor: Vector,
  hoverAlpha: number,
  focusedColor: Vector,
  focusedAlpha: number,
  depth: UIDepth,
  receiver: Player | Team
): void

AddUIContainer

Creates a new UI Container Widget.

AddUIContainer(name: string, position: Vector, size: Vector, anchor: UIAnchor): void

AddUIContainer(
  name: string,
  position: Vector,
  size: Vector,
  anchor: UIAnchor,
  receiver: Player | Team
): void

AddUIContainer(
  name: string,
  position: Vector,
  size: Vector,
  anchor: UIAnchor,
  parent: UIWidget,
  visible: boolean,
  padding: number,
  bgColor: Vector,
  bgAlpha: number,
  bgFill: UIBgFill
): void

AddUIContainer(
  name: string,
  position: Vector,
  size: Vector,
  anchor: UIAnchor,
  parent: UIWidget,
  visible: boolean,
  padding: number,
  bgColor: Vector,
  bgAlpha: number,
  bgFill: UIBgFill,
  receiver: Player | Team
): void

AddUIContainer(
  name: string,
  position: Vector,
  size: Vector,
  anchor: UIAnchor,
  parent: UIWidget,
  visible: boolean,
  padding: number,
  bgColor: Vector,
  bgAlpha: number,
  bgFill: UIBgFill,
  depth: UIDepth
): void

AddUIContainer(
  name: string,
  position: Vector,
  size: Vector,
  anchor: UIAnchor,
  parent: UIWidget,
  visible: boolean,
  padding: number,
  bgColor: Vector,
  bgAlpha: number,
  bgFill: UIBgFill,
  depth: UIDepth,
  receiver: Player | Team
): void

AddUIGadgetImage

Creates a new UI Image Widget based on a Gadget.

AddUIGadgetImage(
  name: string,
  position: Vector,
  size: Vector,
  anchor: UIAnchor,
  gadget: Gadgets,
  parent: UIWidget
): void

AddUIGadgetImage(
  name: string,
  position: Vector,
  size: Vector,
  anchor: UIAnchor,
  gadget: Gadgets,
  parent: UIWidget,
  visibility: Player | Team
): void

AddUIIcon

Attaches a new UI Icon Widget to an object.

AddUIIcon(
  parentObject: mod.Object,
  image: WorldIconImages,
  verticalOffset: number,
  iconColour: Vector,
  iconText: Message,
  visibility: Player | Team
): void

AddUIIcon(
  parentObject: mod.Object,
  image: WorldIconImages,
  verticalOffset: number,
  iconColour: Vector,
  iconText: Message
): void

AddUIImage

Creates a new UI Image Widget.

AddUIImage(
  name: string,
  position: Vector,
  size: Vector,
  anchor: UIAnchor,
  imageType: UIImageType
): void

AddUIImage(
  name: string,
  position: Vector,
  size: Vector,
  anchor: UIAnchor,
  imageType: UIImageType,
  receiver: Player | Team
): void

AddUIImage(
  name: string,
  position: Vector,
  size: Vector,
  anchor: UIAnchor,
  parent: UIWidget,
  visible: boolean,
  padding: number,
  bgColor: Vector,
  bgAlpha: number,
  bgFill: UIBgFill,
  imageType: UIImageType,
  imageColor: Vector,
  imageAlpha: number
): void

AddUIImage(
  name: string,
  position: Vector,
  size: Vector,
  anchor: UIAnchor,
  parent: UIWidget,
  visible: boolean,
  padding: number,
  bgColor: Vector,
  bgAlpha: number,
  bgFill: UIBgFill,
  imageType: UIImageType,
  imageColor: Vector,
  imageAlpha: number,
  receiver: Player | Team
): void

AddUIImage(
  name: string,
  position: Vector,
  size: Vector,
  anchor: UIAnchor,
  parent: UIWidget,
  visible: boolean,
  padding: number,
  bgColor: Vector,
  bgAlpha: number,
  bgFill: UIBgFill,
  imageType: UIImageType,
  imageColor: Vector,
  imageAlpha: number,
  depth: UIDepth
): void

AddUIImage(
  name: string,
  position: Vector,
  size: Vector,
  anchor: UIAnchor,
  parent: UIWidget,
  visible: boolean,
  padding: number,
  bgColor: Vector,
  bgAlpha: number,
  bgFill: UIBgFill,
  imageType: UIImageType,
  imageColor: Vector,
  imageAlpha: number,
  depth: UIDepth,
  receiver: Player | Team
): void

AddUIText

Creates a new UI Text Widget.

AddUIText(name: string, position: Vector, size: Vector, anchor: UIAnchor, message: Message): void

AddUIText(
  name: string,
  position: Vector,
  size: Vector,
  anchor: UIAnchor,
  message: Message,
  receiver: Player | Team
): void

AddUIText(
  name: string,
  position: Vector,
  size: Vector,
  anchor: UIAnchor,
  parent: UIWidget,
  visible: boolean,
  padding: number,
  bgColor: Vector,
  bgAlpha: number,
  bgFill: UIBgFill,
  message: Message,
  textSize: number,
  textColor: Vector,
  textAlpha: number,
  textAnchor: UIAnchor
): void

AddUIText(
  name: string,
  position: Vector,
  size: Vector,
  anchor: UIAnchor,
  parent: UIWidget,
  visible: boolean,
  padding: number,
  bgColor: Vector,
  bgAlpha: number,
  bgFill: UIBgFill,
  message: Message,
  textSize: number,
  textColor: Vector,
  textAlpha: number,
  textAnchor: UIAnchor,
  receiver: Player | Team
): void

AddUIText(
  name: string,
  position: Vector,
  size: Vector,
  anchor: UIAnchor,
  parent: UIWidget,
  visible: boolean,
  padding: number,
  bgColor: Vector,
  bgAlpha: number,
  bgFill: UIBgFill,
  message: Message,
  textSize: number,
  textColor: Vector,
  textAlpha: number,
  textAnchor: UIAnchor,
  depth: UIDepth
): void

AddUIText(
  name: string,
  position: Vector,
  size: Vector,
  anchor: UIAnchor,
  parent: UIWidget,
  visible: boolean,
  padding: number,
  bgColor: Vector,
  bgAlpha: number,
  bgFill: UIBgFill,
  message: Message,
  textSize: number,
  textColor: Vector,
  textAlpha: number,
  textAnchor: UIAnchor,
  depth: UIDepth,
  receiver: Player | Team
): void

AddUIWeaponImage

Creates a new UI Image Widget based on a Weapon and loadout.

AddUIWeaponImage(
  name: string,
  position: Vector,
  size: Vector,
  anchor: UIAnchor,
  weapon: Weapons,
  parent: UIWidget
): void

AddUIWeaponImage(
  name: string,
  position: Vector,
  size: Vector,
  anchor: UIAnchor,
  weapon: Weapons,
  parent: UIWidget,
  weaponPackage: WeaponPackage
): void

AddUIWeaponImage(
  name: string,
  position: Vector,
  size: Vector,
  anchor: UIAnchor,
  weapon: Weapons,
  parent: UIWidget,
  visibility: Player | Team
): void

AddUIWeaponImage(
  name: string,
  position: Vector,
  size: Vector,
  anchor: UIAnchor,
  weapon: Weapons,
  parent: UIWidget,
  weaponPackage: WeaponPackage,
  visibility: Player | Team
): void

DeleteAllUIWidgets

Deletes all UI Widgets.

DeleteAllUIWidgets(): void

DeleteUIWidget

Deletes a particular UI Widget.

DeleteUIWidget(widget: UIWidget): void

EnableUIButtonEvent

Determines if UI Button Widgets can send events.

EnableUIButtonEvent(widget: UIWidget, buttonEvent: UIButtonEvent, enabled: boolean): void

EnableUIInputMode

Determines if UI Buttons can be interacted with.

EnableUIInputMode(enabled: boolean): void

EnableUIInputMode(enabled: boolean, receiver: Player | Team): void

FindUIWidgetWithName

Returns the UI Widget matching the specified name.

FindUIWidgetWithName(name: string, searchRoot: UIWidget): UIWidget

FindUIWidgetWithName(name: string): Any

GetUIButtonAlphaBase

Returns a number representing the button base alpha of the specified UI Widget.

GetUIButtonAlphaBase(widget: UIWidget): number

GetUIButtonAlphaDisabled

Returns a number representing the button disabled alpha of the specified UI Widget.

GetUIButtonAlphaDisabled(widget: UIWidget): number

GetUIButtonAlphaFocused

Returns a number representing the button focused alpha of the specified UI Widget.

GetUIButtonAlphaFocused(widget: UIWidget): number

GetUIButtonAlphaHover

Returns a number representing the button hover alpha of the specified UI Widget.

GetUIButtonAlphaHover(widget: UIWidget): number

GetUIButtonAlphaPressed

Returns a number representing the button pressed alpha of the specified UI Widget.

GetUIButtonAlphaPressed(widget: UIWidget): number

GetUIButtonColorBase

Returns a vector representing the button base color of the specified UI Widget.

GetUIButtonColorBase(widget: UIWidget): Vector

GetUIButtonColorDisabled

Returns a vector representing the button disabled color of the specified UI Widget.

GetUIButtonColorDisabled(widget: UIWidget): Vector

GetUIButtonColorFocused

Returns a vector representing the button focused color of the specified UI Widget.

GetUIButtonColorFocused(widget: UIWidget): Vector

GetUIButtonColorHover

Returns a vector representing the button hover color of the specified UI Widget.

GetUIButtonColorHover(widget: UIWidget): Vector

GetUIButtonColorPressed

Returns a vector representing the button pressed color of the specified UI Widget.

GetUIButtonColorPressed(widget: UIWidget): Vector

GetUIButtonEnabled

Returns a boolean indicating the button enabled status of the specified UI Widget.

GetUIButtonEnabled(widget: UIWidget): boolean

GetUIImageAlpha

Returns a number representing the image alpha of the specified UI Widget.

GetUIImageAlpha(widget: UIWidget): number

GetUIImageColor

Returns a vector representing the image color of the specified UI Widget.

GetUIImageColor(widget: UIWidget): Vector

GetUIImageType

Returns an enum value representing the image type of the specified UI Widget.

GetUIImageType(widget: UIWidget): UIImageType

GetUIRoot

Returns the UI Root as a UI Widget.

GetUIRoot(): UIWidget

GetUITextAlpha

Returns a number representing the text alpha of the specified UI Widget.

GetUITextAlpha(widget: UIWidget): number

GetUITextAnchor

Returns an enum value representing the text anchor of the specified UI Widget.

GetUITextAnchor(widget: UIWidget): UIAnchor

GetUITextColor

Returns a vector representing the text color of the specified UI Widget.

GetUITextColor(widget: UIWidget): Vector

GetUITextSize

Returns a number representing the text size of the specified UI Widget.

GetUITextSize(widget: UIWidget): number

GetUIWidgetAnchor

Returns an enum value representing the anchor location of the specified UI Widget.

GetUIWidgetAnchor(widget: UIWidget): UIAnchor

GetUIWidgetBgAlpha

Returns the background alpha value of the specified UI Widget.

GetUIWidgetBgAlpha(widget: UIWidget): number

GetUIWidgetBgColor

Returns the background color vector of the specified UI Widget.

GetUIWidgetBgColor(widget: UIWidget): Vector

GetUIWidgetBgFill

Returns an enum value representing the background fill of the specified UI Widget.

GetUIWidgetBgFill(widget: UIWidget): UIBgFill

GetUIWidgetDepth

Returns an enum value representing the depth of the specified UI Widget.

GetUIWidgetDepth(widget: UIWidget): UIDepth

GetUIWidgetName

Returns a string containing the name of the specified UI Widget.

GetUIWidgetName(widget: UIWidget): string

GetUIWidgetPadding

Returns a number representing the padding value of the specified UI Widget.

GetUIWidgetPadding(widget: UIWidget): number

GetUIWidgetParent

Returns the Parent UI Widget of the specified UI Widget.

GetUIWidgetParent(widget: UIWidget): UIWidget

GetUIWidgetPosition

Returns the positional vector of the specified UI Widget.

GetUIWidgetPosition(widget: UIWidget): Vector

GetUIWidgetSize

Returns the scale vector of the specified UI Widget.

GetUIWidgetSize(widget: UIWidget): Vector

GetUIWidgetVisible

Returns a boolean representing the visible state of the specified UI Widget.

GetUIWidgetVisible(widget: UIWidget): boolean

HasUIWidgetWithName

Returns a boolean indicating if the UI Widget exists.

HasUIWidgetWithName(name: string, searchRoot: UIWidget): boolean

RemoveUIIcon

Removes a UI Icon Widget from an object.

RemoveUIIcon(objectWithIcon: mod.Object): void

RemoveUIIcon(objectWithIcon: mod.Object, visibility: Player | Team): void

SetUIButtonAlphaBase

Changes the base alpha (transparency) of an UI Button Widget.

SetUIButtonAlphaBase(widget: UIWidget, value: number): void

SetUIButtonAlphaDisabled

Changes the alpha (transparency) of an UI Button Widget when it is disabled.

SetUIButtonAlphaDisabled(widget: UIWidget, value: number): void

SetUIButtonAlphaFocused

Changes the alpha (transparency) of an UI Button Widget when it is focused.

SetUIButtonAlphaFocused(widget: UIWidget, value: number): void

SetUIButtonAlphaHover

Changes the alpha (transparency) of an UI Button Widget when it is hovered.

SetUIButtonAlphaHover(widget: UIWidget, value: number): void

SetUIButtonAlphaPressed

Changes the alpha (transparency) of an UI Button Widget when it is pressed.

SetUIButtonAlphaPressed(widget: UIWidget, value: number): void

SetUIButtonColorBase

Changes the base color of an UI Button Widget.

SetUIButtonColorBase(widget: UIWidget, value: Vector): void

SetUIButtonColorDisabled

Changes the color of an UI Button Widget when it is disabled.

SetUIButtonColorDisabled(widget: UIWidget, value: Vector): void

SetUIButtonColorFocused

Changes the color of an UI Button Widget when it is focused.

SetUIButtonColorFocused(widget: UIWidget, value: Vector): void

SetUIButtonColorHover

Changes the color of an UI Button Widget when it is hovered.

SetUIButtonColorHover(widget: UIWidget, value: Vector): void

SetUIButtonColorPressed

Changes the color of an UI Button Widget when it is pressed.

SetUIButtonColorPressed(widget: UIWidget, value: Vector): void

SetUIButtonEnabled

Determines if a specific UI Button Widget is enabled.

SetUIButtonEnabled(widget: UIWidget, enabled: boolean): void

SetUIImageAlpha

Changes the alpha (transparency) of the image of an UI Image Widget.

SetUIImageAlpha(widget: UIWidget, value: number): void

SetUIImageColor

Changes the color of the image of an UI Image Widget.

SetUIImageColor(widget: UIWidget, value: Vector): void

SetUIImageType

Changes the image of an UI Image Widget.

SetUIImageType(widget: UIWidget, imageType: UIImageType): void

SetUITextAlpha

Changes the alpha (transparency) of the text of an UI Text Widget.

SetUITextAlpha(widget: UIWidget, value: number): void

SetUITextAnchor

Changes the anchor of the text in an UI Text Widget.

SetUITextAnchor(widget: UIWidget, anchor: UIAnchor): void

SetUITextColor

Changes the font color of an UI Text Widget.

SetUITextColor(widget: UIWidget, value: Vector): void

SetUITextLabel

Changes the message displayed by an UI Text Widget.

SetUITextLabel(widget: UIWidget, message: Message): void

SetUITextSize

Changes the font size of an UI Text Widget.

SetUITextSize(widget: UIWidget, value: number): void

SetUIWidgetAnchor

Changes the anchor of an UI Widget.

SetUIWidgetAnchor(widget: UIWidget, anchor: UIAnchor): void

SetUIWidgetBgAlpha

Changes the alpha (transparency) of an UI Widget.

SetUIWidgetBgAlpha(widget: UIWidget, value: number): void

SetUIWidgetBgColor

Changes the background color of an UI Widget.

SetUIWidgetBgColor(widget: UIWidget, value: Vector): void

SetUIWidgetBgFill

Changes the way the UI Widget's background is rendered.

SetUIWidgetBgFill(widget: UIWidget, bgFill: UIBgFill): void

SetUIWidgetDepth

Changes the draw order of an UI Widget.

SetUIWidgetDepth(widget: UIWidget, depth: UIDepth): void

SetUIWidgetName

Changes the name of an UI Widget.

SetUIWidgetName(widget: UIWidget, name: string): void

SetUIWidgetPadding

Changes the padding of an UI Widget.

SetUIWidgetPadding(widget: UIWidget, value: number): void

SetUIWidgetParent

Changes the parent of an UI Widget.

SetUIWidgetParent(widget: UIWidget, parent: UIWidget): void

SetUIWidgetPosition

Changes the position of an UI Widget.

SetUIWidgetPosition(widget: UIWidget, value: Vector): void

SetUIWidgetSize

Changes the size of an UI Widget.

SetUIWidgetSize(widget: UIWidget, value: Vector): void

SetUIWidgetVisible

Determines if an UI Widget is visible or not.

SetUIWidgetVisible(widget: UIWidget, visible: boolean): void

World Icons

Toggle

EnableWorldIconImage

Enables or disables showing the image of a world icon.

EnableWorldIconImage(worldIcon: WorldIcon, enableImage: boolean): void

EnableWorldIconText

Enables or disables showing the text appearing above a world icon.

EnableWorldIconText(worldIcon: WorldIcon, enableText: boolean): void

GetWorldIcon

Returns the WorldIcon corresponding to the provided id.

GetWorldIcon(objId: number): WorldIcon

MoveObject

Move the Object provided, Euler rotation optional

MoveObject(
  object: | Bomb | EmplacementSpawner | FixedCamera | InteractPoint | LootSpawner | MCOM | SFX | SpatialObject | Spawner | VehicleSpawner | VL7Cloud | VO | WorldIcon | BlockingSphere | Player,
  positionDelta: Vector
): void

MoveObject(
  object: | Bomb | EmplacementSpawner | FixedCamera | InteractPoint | LootSpawner | MCOM | SFX | SpatialObject | Spawner | VehicleSpawner | VL7Cloud | VO | WorldIcon | BlockingSphere | Player,
  positionDelta: Vector,
  rotationDelta: Vector
): void

RotateObject

Rotate the Object provided using Euler angles

RotateObject(
  arg0: | Bomb | EmplacementSpawner | FixedCamera | InteractPoint | LootSpawner | MCOM | SFX | SpatialObject | Spawner | VehicleSpawner | VL7Cloud | VO | WorldIcon | BlockingSphere | Player,
  rotationDelta: Vector
): void

SetBombWorldIconGlobalVisibility

Sets the world Icon global visibility, if set to enabled all teams can see the bomb carrier Icon, if set to disabled only the attacking team can.

SetBombWorldIconGlobalVisibility(bomb: Bomb, Enabled: boolean): void

SetObjectTransform

Sets the transform of the Object provided

SetObjectTransform(
  object: | Bomb | EmplacementSpawner | FixedCamera | InteractPoint | LootSpawner | MCOM | SFX | SpatialObject | Spawner | VehicleSpawner | VL7Cloud | VO | WorldIcon | BlockingSphere | Player,
  transform: Transform
): void

SetObjectTransformOverTime

Sets the transform of the Object provided over the time provided. Options to loop indefinitely and reverse

SetObjectTransformOverTime(
  object: | Bomb | EmplacementSpawner | FixedCamera | InteractPoint | LootSpawner | MCOM | SFX | SpatialObject | Spawner | VehicleSpawner | VL7Cloud | VO | WorldIcon | BlockingSphere | Player,
  transform: Transform,
  timeInSeconds: number,
  shouldLoop: boolean,
  shouldReverse: boolean
): void

SetWorldIconColor

Changes the color of a world icon.

SetWorldIconColor(worldIcon: WorldIcon, newColor: Vector): void

SetWorldIconImage

Changes the image of a world icon.

SetWorldIconImage(worldIcon: WorldIcon, newImage: WorldIconImages): void

SetWorldIconOwner

Restricts a world icon to be visible only to a specific Player or Team.

SetWorldIconOwner(worldIcon: WorldIcon, newTeamOwner: Team): void

SetWorldIconOwner(worldIcon: WorldIcon, newPlayerOwner: Player): void

SetWorldIconPosition

@deprecated The method should not be used

SetWorldIconPosition(worldIcon: WorldIcon, newPosition: Vector): void

SetWorldIconText

Changes the text appearing above a world icon.

SetWorldIconText(worldIcon: WorldIcon, newText: Message): void

StopActiveMovementForObject

Stops the Over Time movement for the provided Object if one is active

StopActiveMovementForObject( object: | Bomb | EmplacementSpawner | FixedCamera | InteractPoint | LootSpawner | MCOM | SFX | SpatialObject | Spawner | VehicleSpawner | VL7Cloud | VO | WorldIcon | BlockingSphere | Player ): void

AI

Toggle

AIBattlefieldBehavior

Sets a player to act independently. They will attempt to complete objectives, fire on enemy players, etc. (Only works for AI players)

AIBattlefieldBehavior(player: Player): void

AIDefendPositionBehavior

Sets a player to defend an area around a location. (Only works for AI players)

AIDefendPositionBehavior(
  player: Player,
  defendPosition: Vector,
  minDistance: number,
  maxDistance: number
): void

AIEnableShooting

Enables or disables shooting for AI. (Only works for AI players)

AIEnableShooting(player: Player): void

AIEnableShooting(player: Player, enable: boolean): void

AIEnableTargeting

Enables or disables targeting for AI. An AI unable to target cannot shoot, but will also not notice other soldiers (Only works for AI players)

AIEnableTargeting(player: Player): void

AIEnableTargeting(player: Player, enable: boolean): void

AIForceFire

Forces an AI player to fire or activate whatever weapon or gadget they are holding in their hands for a length of time.

AIForceFire(player: Player, fireDuration: number): void

AIGadgetSettings

Tweak settings for a player's gadgets. (Only works for AI players)

AIGadgetSettings(
  player: Player,
  applyUsageCriteria: boolean,
  applyCoolDownAfterUse: boolean,
  applyInaccuracy: boolean
): void

AIIdleBehavior

Sets a player's current position as idle point. (Only works for AI players)

AIIdleBehavior(player: Player): void

AILOSMoveToBehavior

Sets a player to move to a location with a line of sight to a specific position. (Only works for AI players)

AILOSMoveToBehavior(player: Player, position: Vector): void

AIMoveToBehavior

Sets a player a destination to move to. (Only works for AI players)

AIMoveToBehavior(player: Player, position: Vector): void

AIParachuteBehavior

Sets a player to use parachute. (Only works for AI players)

AIParachuteBehavior(player: Player): void

AISetFocusPoint

Sets a player's focus point, possibly asking it to fire at it. (Only works for AI players)

AISetFocusPoint(player: Player, point: Vector, isTarget: boolean): void

AISetMoveSpeed

Sets a player's move speed for MoveTo Behaviors. (Only works for AI players)

AISetMoveSpeed(player: Player, moveSpeed: MoveSpeed): void

AISetStance

Sets a player's stance. (Only works for AI players)

AISetStance(player: Player, stance: Stance): void

AISetTarget

Sets player's current target. (Only works for AI players)

AISetTarget(aiPlayer: Player, targetPlayer: Player): void

AISetTarget(player: Player): void

AISetUnspawnOnDead

Use this on a spawner to determine if AI soldiers spawned will leave the game after they are killed.

AISetUnspawnOnDead(spawner: Spawner, enableUnspawnOnDead: boolean): void

AIStartUsingGadget

Gives a player the instruction to use a specific gadget on a target location or player. (Only works for AI players)

AIStartUsingGadget(player: Player, gadget: Gadgets, targetPos: Vector): void

AIStartUsingGadget(player: Player, gadget: Gadgets, targetPlayer: Player): void

AIStopUsingGadget

Clears the player's gadget instructions. (Only works for AI players)

AIStopUsingGadget(player: Player): void

AIValidatedMoveToBehavior

Sets a player to move to a valid position on navmesh near a location. (Only works for AI players)

AIValidatedMoveToBehavior(player: Player, position: Vector): void

AIWaypointIdleBehavior

Sets a player to patrol a waypoint. (Only works for AI players)

AIWaypointIdleBehavior(player: Player, waypointPath: WaypointPath): void

SetAiInput

Trigger AI bots input for the duration. Up to 3 simultaneous inputs (3 channels)

SetAiInput(player: Player, input: AiInput, duration: number): void

SetAIToHumanDamageModifier

Sets the damage multiplier from AI players to actualy players.

SetAIToHumanDamageModifier(damageMultiplier: number): void

SpawnAIFromAISpawner

Spawn one AI soldier from a specific AI Spawner.

SpawnAIFromAISpawner(spawner: Spawner): void

SpawnAIFromAISpawner(spawner: Spawner, classToSpawn: SoldierClass, name: Message): void

SpawnAIFromAISpawner(spawner: Spawner, classToSpawn: SoldierClass): void

SpawnAIFromAISpawner(spawner: Spawner, name: Message): void

SpawnAIFromAISpawner(spawner: Spawner, team: Team): void

SpawnAIFromAISpawner(spawner: Spawner, classToSpawn: SoldierClass, name: Message, team: Team): void

SpawnAIFromAISpawner(spawner: Spawner, classToSpawn: SoldierClass, team: Team): void

SpawnAIFromAISpawner(spawner: Spawner, name: Message, team: Team): void

UnspawnAllAIsFromAISpawner

Unspawns all AIs who were spawned by a specific AI Spawner.

UnspawnAllAIsFromAISpawner(spawner: Spawner): void

Notifications

Toggle

ClearAllCustomNotificationMessages

Clears all custom notification slots for the given player.

ClearAllCustomNotificationMessages(target: Player): void

ClearCustomNotificationMessage

Clears the custom notification slot associated with the given slots for the specified team or player.

ClearCustomNotificationMessage(slot: CustomNotificationSlots): void

ClearCustomNotificationMessage(slot: CustomNotificationSlots, target: Player): void

ClearCustomNotificationMessage(slot: CustomNotificationSlots, target: Team): void

DisplayCustomNotificationMessage

Display a custom notification in one of the slots for the specified team or player.

DisplayCustomNotificationMessage(
  msg: Message,
  slot: CustomNotificationSlots,
  duration: number
): void

DisplayCustomNotificationMessage(
  msg: Message,
  slot: CustomNotificationSlots,
  duration: number,
  target: Player
): void

DisplayCustomNotificationMessage(
  msg: Message,
  slot: CustomNotificationSlots,
  duration: number,
  target: Team
): void

DisplayNotificationMessage

Displays a notification-type Message on the top-right of the screen for 6 seconds.

DisplayNotificationMessage(message: Message): void

DisplayNotificationMessage(message: Message, player: Player): void

DisplayNotificationMessage(message: Message, team: Team): void

Scoreboard

Toggle

SetScoreboardColumnNames

Sets the name displayed at the top of score of each column. Only works for custom scoreboards.

SetScoreboardColumnNames(
  column1Name: Message,
  column2Name: Message,
  column3Name: Message,
  column4Name: Message,
  column5Name: Message
): void

SetScoreboardColumnNames(
  column1Name: Message,
  column2Name: Message,
  column3Name: Message,
  column4Name: Message
): void

SetScoreboardColumnNames(column1Name: Message, column2Name: Message, column3Name: Message): void

SetScoreboardColumnNames(column1Name: Message, column2Name: Message): void

SetScoreboardColumnNames(column1Name: Message): void

SetScoreboardColumnWidths

Sets the relative width of each column. Only works for custom scoreboards.

SetScoreboardColumnWidths(
  column1Width: number,
  column2Width: number,
  column3Width: number,
  column4Width: number,
  column5Width: number
): void

SetScoreboardColumnWidths(
  column1Width: number,
  column2Width: number,
  column3Width: number,
  column4Width: number
): void

SetScoreboardColumnWidths(column1Width: number, column2Width: number, column3Width: number): void

SetScoreboardColumnWidths(column1Width: number, column2Width: number): void

SetScoreboardColumnWidths(column1Width: number): void

SetScoreboardHeader

Sets the name that appears in the top-left corner of the scoreboard

SetScoreboardHeader(team1Name: Message, team2Name: Message): void

SetScoreboardHeader(headerName: Message): void

SetScoreboardPlayerValues

Sets the score in up to five distinct scores for the player. Only works for custom scoreboards.

SetScoreboardPlayerValues(
  player: Player,
  column1Value: number,
  column2Value: number,
  column3Value: number,
  column4Value: number,
  column5Value: number
): void

SetScoreboardPlayerValues(
  player: Player,
  column1Value: number,
  column2Value: number,
  column3Value: number,
  column4Value: number
): void

SetScoreboardPlayerValues(
  player: Player,
  column1Value: number,
  column2Value: number,
  column3Value: number
): void

SetScoreboardPlayerValues(player: Player, column1Value: number, column2Value: number): void

SetScoreboardPlayerValues(player: Player, column1Value: number): void

SetScoreboardSorting

Sets which column the scoreboard is sorted on. Only works for custom scoreboards.

SetScoreboardSorting(sortingColumn: number, reverseSorting: boolean): void

SetScoreboardSorting(sortingColumn: number): void

SetScoreboardType

Allows you to change the type of Scoreboard you want.

SetScoreboardType(scoreboardType: ScoreboardType): void

Messages

Toggle

DisplayHighlightedWorldLogMessage

Displays a message on the world log above the minimap for 6 seconds. If no target is provided, it will display the message to everyone.

DisplayHighlightedWorldLogMessage(message: Message): void

DisplayHighlightedWorldLogMessage(message: Message, player: Player): void

DisplayHighlightedWorldLogMessage(message: Message, team: Team): void

Message

Returns a constructed message object which can be used with event game mode message, notification message, highlighted game mode message, and custom notification message. The message object is created by providing a number, player, or format string (which can take up to 3 format items).

Message(
  msg: string | number | Player,
  msgArg0: string | number | Player,
  msgArg1: string | number | Player,
  msgArg2: string | number | Player
): Message

Message(
  msg: string | number | Player,
  msgArg0: string | number | Player,
  msgArg1: string | number | Player
): Message

Message(msg: string | number | Player, msgArg0: string | number | Player): Message

Message(msg: string | number | Player): Message

SendErrorReport

Displays a provided message as an error in the Admin menu.

SendErrorReport(message: Message): void

Players

Toggle

AddAttachmentToWeaponPackage

Adds an Attachment to a Weapon Package created through CreateWeaponPackage. Will replace existing Attachments of the same type

AddAttachmentToWeaponPackage(attachment: WeaponAttachments, weaponPackage: WeaponPackage): void

AddEquipment

Adds a Weapon or Gadget to a Soldier's loadout.

AddEquipment(player: Player, weapon: Weapons): void

AddEquipment(player: Player, gadget: Gadgets): void

AddEquipment(player: Player, weapon: Weapons, weaponPackage: WeaponPackage): void

AddEquipment(player: Player, arg1: Weapons, desiredInventorySlot: InventorySlots): void

AddEquipment(player: Player, gadget: Gadgets, desiredInventorySlot: InventorySlots): void

AddEquipment(
  player: Player,
  weapon: Weapons,
  weaponPackage: WeaponPackage,
  desiredInventorySlots: InventorySlots
): void

AddEquipment(player: Player, armor: ArmorTypes): void

AllPlayers

Returns an array of all players within a game.

AllPlayers(): Array

ClosestPlayerTo

Returns the closest alive player to a provided position. Can be filtered using a team. Note: If no players are alive when this block is called, the returned player will be invalid.

ClosestPlayerTo(vector: Vector): Player

CreateNewWeaponPackage

Creates and returns a new weapon package.

CreateNewWeaponPackage(): WeaponPackage

DealDamage

Deals a provided amount of damage to a target player. Can optionally specify damage giver..

DealDamage(player: Player, damageAmount: number): void

DealDamage(player: Player, damageAmount: number, damageGiver: Player): void

DeployAllPlayers

Force spawns all players in the deploy screen.

DeployAllPlayers(): void

DeployPlayer

Force a specific to deploy.

DeployPlayer(player: Player): void

DisablePlayerJoin

Using this command prevents anyone from joining this server. There is no way to undo this at the time.

DisablePlayerJoin(): void

EnableAllInputRestrictions

Enables or disables all keyboard and mouse inputs - such as movement, firing, and turning - for a target player.

EnableAllInputRestrictions(player: Player, restrictInput: boolean): void

EnableAllPlayerDeploy

Enables or disables spawning from the deploy screen for all players.

EnableAllPlayerDeploy(enablePlayerDeploy: boolean): void

EnableInputRestriction

Enables or disables a specified Input on a target player.

EnableInputRestriction(
  player: Player,
  inputRestriction: RestrictedInputs,
  restrictInput: boolean
): void

EnablePlayerDeploy

Enables or disables the ability for a target player to deploy.

EnablePlayerDeploy(player: Player, deployAllowed: boolean): void

EndGameMode

Ends the current gamemode and designates the provided Player or Team as the winner. The gamemode ends in draw if Team is set to 0.

EndGameMode(player: Player): void

EventDamageTypeCompare

Returns a boolean indicating if the victim was damaged by the provided damage type.

EventDamageTypeCompare(damageType: DamageType, playerDamageTypes: PlayerDamageTypes): boolean

EventDeathTypeCompare

Returns a boolean indicating if the victim died by the provided death type.

EventDeathTypeCompare(deathType: DeathType, playerDeathTypes: PlayerDeathTypes): boolean

EventWeaponCompare

Returns a boolean indicating if the given weapon unlock is equivalent to the provided ability.

EventWeaponCompare(eventWeapon: WeaponUnlock, weapon: Weapons): boolean

EventWeaponCompare(eventWeapon: WeaponUnlock, gadget: Gadgets): boolean

FarthestPlayerFrom

Returns the farthest alive player from a provided position. Can be filtered using a team. Note: If no players are alive when this block is called, the returned player will be invalid.

FarthestPlayerFrom(vector: Vector): Player

FarthestPlayerFrom(vector: Vector, team: Team): Player

ForceManDown

Puts the target player into the mandown state (unless mandown is disabled).

ForceManDown(player: Player): void

ForceRevive

Revives a target player who is in the mandown state.

ForceRevive(player: Player): void

ForceSwitchInventory

Forces the target player to switch to the provided inventory slot.

ForceSwitchInventory(player: Player, inventorySlot: InventorySlots): void

GetGameModeScore

Returns the current gamemode score of the provided player or team.

GetGameModeScore(player: Player): number

GetInventoryAmmo

Returns the target player loaded ammo of the provided inventory slots.

GetInventoryAmmo(player: Player, inventorySlots: InventorySlots): number

GetInventoryMagazineAmmo

Returns the target player magazine ammo of the provided inventory slots.

GetInventoryMagazineAmmo(player: Player, inventorySlots: InventorySlots): number

GetPlayer

Returns the Player corresponding to the provided id.

GetPlayer(objId: number): Player

GetPlayerDeaths

Returns the total amount of deaths for the target player.

GetPlayerDeaths(player: Player): number

GetPlayerKills

Returns the total amount of kills for the target player.

GetPlayerKills(player: Player): number

GetPlayerVehicleSeat

Returns the seat index number for the target player if they are in a vehicle.

GetPlayerVehicleSeat(player: Player): number

GetSoldierState

Returns the value of the target player state.

GetSoldierState(player: Player, soldierStateNumber: SoldierStateNumber): number

GetSoldierState(player: Player, soldierStateBool: SoldierStateBool): boolean

GetSoldierState(player: Player, soldierStateVector: SoldierStateVector): Vector

GetVehicleFromPlayer

Returns the vehicle used by a player.

GetVehicleFromPlayer(player: Player): Vehicle

GiveBombToPlayer

Gives the Bomb to the chosen Player.

GiveBombToPlayer(player: Player, bomb: Bomb): void

HasEquipment

Returns a boolean indicating if the provided player has the specified ability.

HasEquipment(player: Player, weapon: Weapons): boolean

HasEquipment(player: Player, gadget: Gadgets): boolean

Heal

Instantly adds a given amount of health to the target player. Can optionally specify healing player.

Heal(player: Player, healAmount: number): void

Heal(player: Player, healAmount: number, giver: Player): void

IsInventorySlotActive

Returns true whether or not the active inventory slot of the target player is the provided inventory slots.

IsInventorySlotActive(player: Player, inventorySlots: InventorySlots): boolean

IsPlayerValid

Returns true if the provided player is valid.

IsPlayerValid(player: Player): boolean

IsSoldierClass

Returns true if the provided player is using the specified class.

IsSoldierClass(player: Player, soldierClass: SoldierClass): boolean

IsSquadLeader

Returns a boolean checking to see if provided player is the leader of their squad.

IsSquadLeader(player: Player): boolean

Kill

Kills a target player (skips the Mandown state).

Kill(player: Player): void

LocalPositionOf

Converts the provided world position to the corresponding position in local player space.

LocalPositionOf(vector: Vector, player: Player): Vector

LocalVectorOf

Converts the provided world vector to the corresponding vector in local player space.

LocalVectorOf(vector: Vector, player: Player): Vector

RayCast

Request the system to evaluate if a straight line between two points is interupted or not. Use OnRayCastHit and OnRayCastMissed to read the result.

RayCast(player: Player, start: Vector, stop: Vector): void

RemoveEquipment

Removes a Weapon or Gadget from a Soldier's loadout.

RemoveEquipment(player: Player, inventorySlot: InventorySlots): void

RemoveEquipment(arg0: Player, weapon: Weapons): void

RemoveEquipment(arg0: Player, gadget: Gadgets): void

Resupply

Resupplies the target player using a provided ResupplyType.

Resupply(player: Player, ressuplyType: ResupplyTypes): void

SetCameraTypeForAll

Sets CameraType for all players. CameraIndex optional.

SetCameraTypeForAll(cameraType: Cameras): void

SetCameraTypeForAll(cameraType: Cameras, cameraIndex: number): void

SetCameraTypeForPlayer

Sets CameraType for provided Player. CameraIndex optional.

SetCameraTypeForPlayer(player: Player, cameraType: Cameras): void

SetCameraTypeForPlayer(player: Player, cameraType: Cameras, cameraIndex: number): void

SetFreeCameraCollisionForPlayer

Set whether collision is enabled for the Free Camera. (Default true)

SetFreeCameraCollisionForPlayer(player: Player, enabled: boolean): void

SetGameModeScore

Sets the gamemode score of the provided Player or Team.

SetGameModeScore(player: Player, newScore: number): void

SetGameModeScore(player: Player, newScore: number, gameStageType: GameStageType): void

SetInventoryAmmo

Sets the target player loaded ammo for the provided inventory slot.

SetInventoryAmmo(player: Player, inventorySlots: InventorySlots, ammo: number): void

SetInventoryMagazineAmmo

Sets the target player magazine ammo for the provided inventory slot.

SetInventoryMagazineAmmo(player: Player, inventorySlots: InventorySlots, magAmmo: number): void

SetPlayerBreathTime

Sets the breathing time for the player.

SetPlayerBreathTime(player: Player, factor: number): void

SetPlayerIncomingDamageFactor

Sets damage taken factor on player (Will be rounded to the nearest 5%). The value will be clamped between 0 - 200%.

SetPlayerIncomingDamageFactor(player: Player, amount: number): void

SetPlayerMaxHealth

Sets the max health of a target player from 1 to 500. The value will be multiplied by the target's max health multiplier.

SetPlayerMaxHealth(player: Player, maxHealth: number): void

SetPlayerMovementSpeedMultiplier

Sets a player's movement speed multiplier.

SetPlayerMovementSpeedMultiplier(player: Player, multiplier: number): void

SetRedeployTime

Overrides the time to redeploy for a target player. The redeploy time must be set to a value between 0 and 60 seconds.

SetRedeployTime(player: Player, redeployTime: number): void

SetSpectatingFiltersForPlayer

Sets the spectating filters. SpectatingGroup sets the selectable players in the spectating UI. ownSquadOnly and ownTeamOnly limit whether a player can spectate other squads/teams after currently spectated one is eliminated

SetSpectatingFiltersForPlayer(
  player: Player,
  group: SpectatingGroup,
  ownSquadOnly: boolean,
  ownTeamOnly: boolean
): void

SetThirdPersonCameraPositionForPlayer

Set the FollowDistance, FollowHeight, and ShoulderOffset for the Third Person Camera. (Default 2.5, 0.2, 0.6)

SetThirdPersonCameraPositionForPlayer(
  player: Player,
  followDistance: number,
  followHeight: number,
  shoulderOffset: number
): void

SkipManDown

Sets the target player to skip the mandown state and go directly to the deploy screen when killed.

SkipManDown(player: Player, skipManDown: boolean): void

SpawnPlayerFromSpawnPoint

Force Deploy a soldier from a specific spawn point.

SpawnPlayerFromSpawnPoint(player: Player, spawnPointId: number): void

SpawnPlayerFromSpawnPoint(player: Player, spawnPoint: SpawnPoint): void

SpotTarget

Spots a target Player for all players for a specified duration of time (in seconds).

SpotTarget(targetplayer: Player, duration: number, spotStatus: SpotStatus): void

SpotTarget(
  targetPlayer: Player,
  spotterPlayer: Player,
  duration: number,
  spotStatus: SpotStatus
): void

SpotTarget(targetplayer: Player, spotStatus: SpotStatus): void

SpotTarget(targetPlayer: Player, spotterPlayer: Player, duration: number): void

SpotTarget(targetplayer: Player, duration: number): void

Teleport

Teleports a target to a provided valid position facing a specified angle (in radians).

Teleport(player: Player, destination: Vector, orientation: number): void

UndeployAllPlayers

Undeploys all players that are alive on the battlefield back to the deploy screen.

UndeployAllPlayers(): void

UndeployPlayer

Undeploys a target player that is alive on the battlefield back to the deploy screen.

UndeployPlayer(player: Player): void

WorldPositionOf

Converts the provided local player position to the corresponding position in the world space.

WorldPositionOf(vector: Vector, player: Player): Vector

WorldVectorOf

Converts the provided local player vector to the corresponding vector in the world space.

WorldVectorOf(vector: Vector, player: Player): Vector

Vehicles

Toggle

AllVehicles

Returns an array of all vehicles within a game.

AllVehicles(): Array

ApplyImpulse

Apply impulse with given world position, direction and magnitude

ApplyImpulse(vehicle: Vehicle, worldPosition: Vector, direction: Vector, magnitude: number): void

CompareVehicleName

Returns a boolean indicating if the target vehicle has the same name as the provided vehicle or if it is the same type as the provided vehicle type.

CompareVehicleName(vehicle: Vehicle, vehicleList: VehicleList): boolean

DealDamage

Deals a provided amount of damage to a target player. Can optionally specify damage giver..

DealDamage(vehicle: Vehicle, damageAmount: number): void

ForceEmplacementSpawnerSpawn

Cause an emplacement spawner to spawn an emplacement of the type it is currently set to.

ForceEmplacementSpawnerSpawn(emplacementSpawner: EmplacementSpawner): void

ForcePlayerExitVehicle

Forces the specified player to exit the target vehicle.

ForcePlayerExitVehicle(player: Player, vehicle: Vehicle): void

ForcePlayerExitVehicle(vehicle: Vehicle): void

ForcePlayerExitVehicle(player: Player): void

ForcePlayerToSeat

Forces the specified player into the target vehicle at the provided seat number. If the provided seat is -1, that player will be forced into the first available seat.

ForcePlayerToSeat(player: Player, vehicle: Vehicle, seatNumber: number): void

ForceVehicleSpawnerSpawn

Cause a vehicle spawner to spawn one vehicle of the type it is currently set to.

ForceVehicleSpawnerSpawn(vehicleSpawner: VehicleSpawner): void

GetAllPlayersInVehicle

Returns a array of all players inside a provided vehicle

GetAllPlayersInVehicle(vehicle: Vehicle): Array

GetEmplacementSpawner

Returns the EmplacementSpawner corresponding to the provided id.

GetEmplacementSpawner(objId: number): EmplacementSpawner

GetPlayerFromVehicleSeat

Returns the player currently occupying the provided seat index number of the provided vehicle. Note: If no players are in the vehicle seat when this block is called, the returned player will be invalid.

GetPlayerFromVehicleSeat(vehicle: Vehicle, number: number): Player

GetVehicle

Returns the Vehicle corresponding to the provided id.

GetVehicle(objId: number): Vehicle

GetVehicleSeatCount

Returns the number of seats in a vehicle.

GetVehicleSeatCount(vehicle: Vehicle): number

GetVehicleSpawner

Returns the VehicleSpawner corresponding to the provided id.

GetVehicleSpawner(objId: number): VehicleSpawner

GetVehicleState

Returns the value of the target vehicle state.

GetVehicleState(vehicle: Vehicle, vehicleStateVector: VehicleStateVector): Vector

GetVehicleTeam

Returns the team of the provided vehicle. Note: A vehicle that is not occupied will have a neutral team.

GetVehicleTeam(vehicle: Vehicle): Team

Heal

Instantly adds a given amount of health to the target player. Can optionally specify healing player.

Heal(vehicle: Vehicle, repairAmount: number): void

IsVehicleOccupied

Returns a boolean indicating if the target vehicle is a occupied by a player.

IsVehicleOccupied(vehicle: Vehicle): boolean

IsVehicleSeatOccupied

Returns a boolean indicating if the target seat index number of target vehicle is a occupied by a player.

IsVehicleSeatOccupied(vehicle: Vehicle, number: number): boolean

Kill

Kills a target player (skips the Mandown state).

Kill(vehicle: Vehicle): void

SetAllVehiclesAllowedInSurroundingArea

Sets whether all vehicles are allowed in the Surrounding Area

SetAllVehiclesAllowedInSurroundingArea(allowed: boolean): void

SetEmplacementSpawnerAbandonVehicleOutOfCombatArea

Enables or disables the feature to destroy emplacement left outside of the combat area.

SetEmplacementSpawnerAbandonVehicleOutOfCombatArea(
  emplacementSpawner: EmplacementSpawner,
  enabled: boolean
): void

SetEmplacementSpawnerApplyDamageToAbandonVehicle

Enables or disables the feature to destroy abandoned emplacements.

SetEmplacementSpawnerApplyDamageToAbandonVehicle(
  emplacementSpawner: EmplacementSpawner,
  enabled: boolean
): void

SetEmplacementSpawnerAutoSpawn

Enables or Disables automatic emplacement respawning from the emplacement spawner.

SetEmplacementSpawnerAutoSpawn(emplacementSpawner: EmplacementSpawner, enabled: boolean): void

SetEmplacementSpawnerKeepAliveAbandonRadius

Sets the distance from the nearest player for an emplacement to consider itself abandoned.

SetEmplacementSpawnerKeepAliveAbandonRadius(
  emplacementSpawner: EmplacementSpawner,
  keepAliveAbandonedRadius: number
): void

SetEmplacementSpawnerRespawnTime

Sets the delay after destruction before an emplacement automatically respawn, if the feature is activated.

SetEmplacementSpawnerRespawnTime(emplacementSpawner: EmplacementSpawner, respawnTime: number): void

SetEmplacementSpawnerSpawnerRadius

Sets the distance its enplacement spawner for an emplacement to consider itself abandoned.

SetEmplacementSpawnerSpawnerRadius(
  emplacementSpawner: EmplacementSpawner,
  keepAliveSpawnerRadius: number
): void

SetEmplacementSpawnerTimeUntilAbandon

Sets the time left idle before an emplacement is considered abandoned.

SetEmplacementSpawnerTimeUntilAbandon(
  emplacementSpawner: EmplacementSpawner,
  timeUntilAbandon: number
): void

SetEmplacementSpawnerType

Sets the type of emplacement that will spawn from the emplacement spawner.

SetEmplacementSpawnerType(
  emplacementSpawner: EmplacementSpawner,
  emplacementType: StationaryEmplacements
): void

SetMaxVehicleHeightLimitScale

Sets a multiplier on the normal map value of how high vehicles can go before their engines stop applying an upwards force.

SetMaxVehicleHeightLimitScale(heightScale: number): void

SetVehicleAllowedInSurroundingArea

Sets whether a vehicle is allowed in the Surrounding Area

SetVehicleAllowedInSurroundingArea(vehicle: VehicleList, allowed: boolean): void

SetVehicleCategoryAllowedInSurroundingArea

Sets whether a vehicle category is allowed in the Surrounding Area

SetVehicleCategoryAllowedInSurroundingArea(
  vehicleCategory: VehicleCategories,
  allowed: boolean
): void

SetVehicleMaxHealthMultiplier

Multiplies the maximum health of target vehicle by the provided number greater than 0 and less than or equal to 4.

SetVehicleMaxHealthMultiplier(vehicle: Vehicle, maxHealthMultiplier: number): void

SetVehicleSpawnerAbandonVehiclesOutOfCombatArea

Enables or disables the feature to destroy vehicles left outside of the combat area.

SetVehicleSpawnerAbandonVehiclesOutOfCombatArea(
  vehicleSpawner: VehicleSpawner,
  enabled: boolean
): void

SetVehicleSpawnerApplyDamageToAbandonVehicle

Enables or disables the feature to destroy abandoned vehicles.

SetVehicleSpawnerApplyDamageToAbandonVehicle(
  vehicleSpawner: VehicleSpawner,
  enabled: boolean
): void

SetVehicleSpawnerAutoSpawn

Enables or Disables automatic vehicle respawning from the vehicle spawner.

SetVehicleSpawnerAutoSpawn(vehicleSpawner: VehicleSpawner, enabled: boolean): void

SetVehicleSpawnerKeepAliveAbandonRadius

Sets the distance from the nearest player for a vehicle to consider itself abandoned.

SetVehicleSpawnerKeepAliveAbandonRadius(
  vehicleSpawner: VehicleSpawner,
  keepAliveAbandonedRadius: number
): void

SetVehicleSpawnerKeepAliveSpawnerRadius

Sets the distance its vehicle spawner for a vehicle to consider itself abandoned.

SetVehicleSpawnerKeepAliveSpawnerRadius(
  vehicleSpawner: VehicleSpawner,
  keepAliveSpawnerRadius: number
): void

SetVehicleSpawnerRespawnTime

Sets the delay after destruction before a vehicle automatically respawn, if the feature is activated.

SetVehicleSpawnerRespawnTime(vehicleSpawner: VehicleSpawner, respawnTime: number): void

SetVehicleSpawnerTimeUntilAbandon

Sets the time left idle before a vehicle is considered abandoned.

SetVehicleSpawnerTimeUntilAbandon(vehicleSpawner: VehicleSpawner, timeUntilAbandon: number): void

SetVehicleSpawnerVehicleType

Sets the type of vehicle that will spawn from the vehicle spawner.

SetVehicleSpawnerVehicleType(vehicleSpawner: VehicleSpawner, vehicleType: VehicleList): void

Teleport

Teleports a target to a provided valid position facing a specified angle (in radians).

Teleport(vehicle: Vehicle, destination: Vector, orientation: number): void

Objects & Spatial

Toggle

ApplyAreaImpulseAndDamage

Apply impulse and damage to objects within set radius of given point. Impulse direction from center point, unless specified with ImpulseDirection

ApplyAreaImpulseAndDamage(
  center: Vector,
  radius: number,
  impulseStrength: number,
  damageAmount: number
): void

ApplyAreaImpulseAndDamage(
  center: Vector,
  radius: number,
  impulseStrength: number,
  damageAmount: number,
  impulseDirection: Vector
): void

GetGolmudTrainLocation

Returns the World Position of the Golmud Moving Train. (Only on Golmud Railway map)

GetGolmudTrainLocation(): Vector

GetObjectPosition

Returns the position vector of the provided object.

GetObjectPosition(object: mod.Object): Vector

GetObjectRotation

Returns the rotation vector of the provided object.

GetObjectRotation(object: mod.Object): Vector

GetObjectTransform

Returns the transform vector of the provided object.

GetObjectTransform(object: mod.Object): Transform

GetObjId

Returns the id corresponding to the provided object.

GetObjId(object: mod.Object): number

GetSpatialObject

Returns the spatial object corresponding to the provided id.

GetSpatialObject(spatialObjectNumber: number): SpatialObject

MoveObjectOverTime

Moves the Object by the delta position and rotation over the time provided. Options to loop indefinitely and reverse

MoveObjectOverTime(
  object: | Bomb | EmplacementSpawner | FixedCamera | InteractPoint | LootSpawner | MCOM | SFX | SpatialObject | Spawner | VehicleSpawner | VL7Cloud | VO | WorldIcon | BlockingSphere | Player,
  positionDelta: Vector,
  rotationDelta: Vector,
  timeInSeconds: number,
  shouldLoop: boolean,
  shouldReverse: boolean
): void

OrbitObjectOverTime

Orbits the Object around the provided transform over time. Optional orbitAxis otherwise transform's up vector is used

OrbitObjectOverTime(
  object: | Bomb | EmplacementSpawner | FixedCamera | InteractPoint | LootSpawner | MCOM | SFX | SpatialObject | Spawner | VehicleSpawner | VL7Cloud | VO | WorldIcon | BlockingSphere | Player,
  orbitTransform: Transform,
  timeInSeconds: number,
  radius: number,
  shouldLoop: boolean,
  shouldReverse: boolean,
  clockwise: boolean
): void

OrbitObjectOverTime(
  object: | Bomb | EmplacementSpawner | FixedCamera | InteractPoint | LootSpawner | MCOM | SFX | SpatialObject | Spawner | VehicleSpawner | VL7Cloud | VO | WorldIcon | BlockingSphere | Player,
  orbitTransform: Transform,
  timeInSeconds: number,
  radius: number,
  shouldLoop: boolean,
  shouldReverse: boolean,
  clockwise: boolean,
  orbitAxis: Vector
): void

RayCast

Request the system to evaluate if a straight line between two points is interupted or not. Use OnRayCastHit and OnRayCastMissed to read the result.

RayCast(start: Vector, stop: Vector): void

SetThirdPersonCameraPositionForAll

Set the FollowDistance, FollowHeight, and ShoulderOffset for the Third Person Camera. (Default 2.5, 0.2, 0.6)

SetThirdPersonCameraPositionForAll(
  followDistance: number,
  followHeight: number,
  shoulderOffset: number
): void

Objectives & Map Features

Toggle

AllCapturePoints

Returns an array of all capture points within a game.

AllCapturePoints(): Array

EnableAreaTrigger

Enables or disables an area trigger. This will prevent the specific Event from being fired.

EnableAreaTrigger(areaTrigger: AreaTrigger, enable: boolean): void

EnableCapturePointDeploying

Enables or disables deploying on provided capture point for the team that owns it.

EnableCapturePointDeploying(capturePoint: CapturePoint, enableDeploying: boolean): void

EnableGameModeObjective

Enables or disables the provided objective.

EnableGameModeObjective(objective: CapturePoint | HQ | Sector | MCOM, enable: boolean): void

EnableHQ

Enables or disables a headquater.

EnableHQ(hq: HQ, enable: boolean): void

EnableInteractPoint

Enables or disables an interact point.

EnableInteractPoint(interactPoint: InteractPoint, enable: boolean): void

GetAreaTrigger

Returns the AreaTrigger corresponding to the provided id.

GetAreaTrigger(objId: number): AreaTrigger

GetCapturePoint

Returns the CapturePoint corresponding to the provided id.

GetCapturePoint(objId: number): CapturePoint

GetCaptureProgress

Returns a number from zero to one corresponding to the capture progress of the provided capture point.

GetCaptureProgress(capturePoint: CapturePoint): number

GetCurrentOwnerTeam

Returns the current owner team corresponding to the provided capture point.

GetCurrentOwnerTeam(capturePoint: CapturePoint): Team

GetHQ

Returns the HQ corresponding to the provided id.

GetHQ(objId: number): HQ

GetInteractPoint

Returns the InteractPoint corresponding to the provided id.

GetInteractPoint(objId: number): InteractPoint

GetLootSpawner

Returns the LootSpawner corresponding to the provided id.

GetLootSpawner(objId: number): LootSpawner

GetMCOM

Returns the MCOM corresponding to the provided id.

GetMCOM(objId: number): MCOM

GetOwnerProgressTeam

Returns the team of the team currently capturing the provided capture point.

GetOwnerProgressTeam(capturePoint: CapturePoint): Team

GetPlayersOnPoint

Returns a array of all players within the boundaries of a provided capture point.

GetPlayersOnPoint(capturePoint: CapturePoint): Array

GetPreviousOwnerTeam

Returns the previous owner team corresponding to the provided capture point.

GetPreviousOwnerTeam(capturePoint: CapturePoint): Team

GetRingOfFire

Returns the RingOfFire corresponding to the provided id.

GetRingOfFire(objId: number): RingOfFire

GetSector

Returns the Sector corresponding to the provided id.

GetSector(objId: number): Sector

GetVL7Cloud

Returns the VL7Cloud corresponding to the provided id.

GetVL7Cloud(objId: number): VL7Cloud

GetWaypointPath

Returns the WaypointPath corresponding to the provided id.

GetWaypointPath(objId: number): WaypointPath

GolmudTrainSendMoveCommand

Sends a move instruction to the Golmud Railway train.

GolmudTrainSendMoveCommand(moveCommand: GolmudTrainMoveCommands): void

RingOfFireStart

Signals the RingOfFire to start shrinking.

RingOfFireStart(ringOfFire: RingOfFire): void

SetCapturePointCapturingTime

Sets the capturing time for target capture point to the provided number.

SetCapturePointCapturingTime(capturePoint: CapturePoint, capturingTime: number): void

SetCapturePointNeutralizationTime

Sets the neutralization time for target capture point to the provided number.

SetCapturePointNeutralizationTime(capturePoint: CapturePoint, neutralizationTime: number): void

SetCapturePointOwner

Change the team controling a capture point.

SetCapturePointOwner(capturePoint: CapturePoint, team: Team): void

SetHQTeam

Sets a HQ to a specific Team.

SetHQTeam(hq: HQ, team: Team): void

SetMaxCaptureMultiplier

Sets the capture time multiplier for target capture point to the provided number.

SetMaxCaptureMultiplier(capturePoint: CapturePoint, multiplier: number): void

SetMCOMArmType

Sets the MCOM arm type, if set to default anyone on the opposing team can arm it, otherwise only the bomb carrier can.

SetMCOMArmType(mcom: MCOM, mcomarmtype: MCOMArmType): void

SetMCOMFuseTime

Determines the time needed by MCOM.

SetMCOMFuseTime(mCOM: MCOM, fuseTime: number): void

SetMCOMOwner

Sets the ownership of the MCOM, swapping teams will flip who can plant and defuse. Only allows for Neutral, Team1 and Team2.

SetMCOMOwner(mcom: MCOM, team: Team): void

SetObjectiveUIEnabled

Enables the HUD UI for an objective (Capture Points and MCOMs)

SetObjectiveUIEnabled(objective: CapturePoint | HQ | Sector | MCOM, enabled: boolean): void

SetRingOfFireDamageAmount

Sets the damage dealt by the RingOfFire to players caught.

SetRingOfFireDamageAmount(ringOfFireId: RingOfFire, ringOfFireDamageAmount: number): void

SetRingOfFireStableTime

Sets the duration the RingOfFire remains stable before Shrinking again.

SetRingOfFireStableTime(ringOfFireId: RingOfFire, ringOfFireStableTime: number): void

SetVL7CloudEffects

Enables or Disables any effect from a designated VL7Cloud object.

SetVL7CloudEffects(
  vl7Cloud: VL7Cloud,
  screenEffect: boolean,
  soldierEffect: boolean,
  visualEffect: boolean
): void

SpawnLoot

Spawns a weapon or gadget at a LootSpawner.

SpawnLoot(lootSpawner: LootSpawner, ammo: AmmoTypes): void

SpawnLoot(lootSpawner: LootSpawner, weapon: Weapons): void

SpawnLoot(lootSpawner: LootSpawner, gadget: Gadgets): void

SpawnLoot(lootSpawner: LootSpawner, armor: ArmorTypes): void

Spawning

Toggle

ForceBombSpawn

Forces the bomb to spawn at the original location.

ForceBombSpawn(bomb: Bomb): void

ForceBombUnspawn

Forces the bomb to unspawn.

ForceBombUnspawn(bomb: Bomb): void

GetSpawner

Returns the Spawner corresponding to the provided id.

GetSpawner(objId: number): Spawner

GetSpawnPoint

Returns the SpawnPoint corresponding to the provided id.

GetSpawnPoint(objId: number): SpawnPoint

SetSpawnMode

Determines if players are spawned automatically or not.

SetSpawnMode(spawnModes: SpawnModes): void

SetUnspawnDelayInSeconds

Sets the time (in seconds) it takes for AI soldiers from the provided Spawner to unspawn after death.

SetUnspawnDelayInSeconds(spawner: Spawner, delay: number): void

SpawnObject

Spawns an object at runtime. Returns an object id if the object supports it, otherwise -1

SpawnObject(
  prefabEnum: | RuntimeSpawn_Common | RuntimeSpawn_Abbasid | RuntimeSpawn_Aftermath | RuntimeSpawn_Badlands | RuntimeSpawn_Battery | RuntimeSpawn_Capstone | RuntimeSpawn_Contaminated | RuntimeSpawn_Dumbo | RuntimeSpawn_Eastwood | RuntimeSpawn_FireStorm | RuntimeSpawn_Limestone | RuntimeSpawn_Outskirts | RuntimeSpawn_Subsurface | RuntimeSpawn_Tungsten | RuntimeSpawn_Granite_Downtown | RuntimeSpawn_Granite_Marina | RuntimeSpawn_Granite_MilitaryRnD | RuntimeSpawn_Granite_MilitaryStorage | RuntimeSpawn_Granite_ResidentialNorth | RuntimeSpawn_Granite_TechCenter | RuntimeSpawn_Granite_Underground | RuntimeSpawn_Sand | RuntimeSpawn_GolmudRailway | RuntimeSpawn_Plaza | RuntimeSpawn_Isolated | RuntimeSpawn_Ocean | RuntimeSpawn_Atoll,
  position: Vector,
  rotation: Vector,
  scale: Vector
): Any

SpawnObject(
  prefabEnum: | RuntimeSpawn_Common | RuntimeSpawn_Abbasid | RuntimeSpawn_Aftermath | RuntimeSpawn_Badlands | RuntimeSpawn_Battery | RuntimeSpawn_Capstone | RuntimeSpawn_Contaminated | RuntimeSpawn_Dumbo | RuntimeSpawn_Eastwood | RuntimeSpawn_FireStorm | RuntimeSpawn_Limestone | RuntimeSpawn_Outskirts | RuntimeSpawn_Subsurface | RuntimeSpawn_Tungsten | RuntimeSpawn_Granite_Downtown | RuntimeSpawn_Granite_Marina | RuntimeSpawn_Granite_MilitaryRnD | RuntimeSpawn_Granite_MilitaryStorage | RuntimeSpawn_Granite_ResidentialNorth | RuntimeSpawn_Granite_TechCenter | RuntimeSpawn_Granite_Underground | RuntimeSpawn_Sand | RuntimeSpawn_GolmudRailway | RuntimeSpawn_Plaza | RuntimeSpawn_Isolated | RuntimeSpawn_Ocean | RuntimeSpawn_Atoll,
  position: Vector,
  rotation: Vector
): Any

UnspawnAllLoot

Removes all existing loot from the world.

UnspawnAllLoot(): void

UnspawnObject

Unspawn an Object spawned using SpawnObject.

UnspawnObject(obj: mod.Object): void

Audio & Effects

Toggle

EnableScreenEffect

Enables or disables a player-specific screen effect.

EnableScreenEffect(player: Player, screenEffect: ScreenEffects, enable: boolean): void

EnableVFX

Enables or disables a visual effect.

EnableVFX(vfx: VFX, enable: boolean): void

GetSFX

Returns the SFX corresponding to the provided id.

GetSFX(objId: number): SFX

GetVFX

Returns the VFX corresponding to the provided id.

GetVFX(objId: number): VFX

GetVO

Returns the VO corresponding to the provided id.

GetVO(objId: number): VO

LoadMusic

Loads a music package to then be triggered with the PlayMusic action.

LoadMusic(musicPackage: MusicPackages): void

MoveVFX

Move a VFX to a new coordinate.

MoveVFX(vfxID: VFX, position: Vector, rotation: Vector): void

PlayMusic

Triggers a music event.

PlayMusic(musicEvent: MusicEvents): void

PlayMusic(musicEvent: MusicEvents, team: Team): void

PlayMusic(musicEvent: MusicEvents, squad: Squad): void

PlayMusic(musicEvent: MusicEvents, player: Player): void

PlaySound

Plays a sound using runtime spawner tech.

PlaySound(sound: SFX, amplitude: number, team: Team): void

PlaySound(sound: SFX, amplitude: number, squad: Squad): void

PlaySound(sound: SFX, amplitude: number, player: Player): void

PlaySound(sound: SFX, amplitude: number): void

PlaySound(
  sound: SFX,
  amplitude: number,
  location: Vector,
  attenuationRange: number,
  team: Team
): void

PlaySound(
  sound: SFX,
  amplitude: number,
  location: Vector,
  attenuationRange: number,
  squad: Squad
): void

PlaySound(
  sound: SFX,
  amplitude: number,
  location: Vector,
  attenuationRange: number,
  player: Player
): void

PlaySound(sound: SFX, amplitude: number, location: Vector, attenuationRange: number): void

PlayVO

Plays a voice-over event clip. VO flags Hotel and India only support a few select VO events.

PlayVO(voiceOver: VO, event: VoiceOverEvents2D, flag: VoiceOverFlags): void

PlayVO(voiceOver: VO, event: VoiceOverEvents2D, flag: VoiceOverFlags, player: Player): void

PlayVO(voiceOver: VO, event: VoiceOverEvents2D, flag: VoiceOverFlags, squad: Squad): void

PlayVO(voiceOver: VO, event: VoiceOverEvents2D, flag: VoiceOverFlags, team: Team): void

SetMusicParam

Updates any parameters that a music package might have.

SetMusicParam(musicParam: MusicParams, paramValue: number): void

SetMusicParam(musicParam: MusicParams, paramValue: number, team: Team): void

SetMusicParam(musicParam: MusicParams, paramValue: number, squad: Squad): void

SetMusicParam(musicParam: MusicParams, paramValue: number, player: Player): void

SetSoldierEffect

Applies an effect to a soldier based on a passed-in player.

SetSoldierEffect(player: Player, soldierEffects: SoldierEffects, isEnabled: boolean): void

SetSoundAmplitude

Sets the amplitude of a given sound.

SetSoundAmplitude(sound: SFX, amplitude: number, team: Team): void

SetSoundAmplitude(sound: SFX, amplitude: number, squad: Squad): void

SetSoundAmplitude(sound: SFX, amplitude: number, player: Player): void

SetSoundAmplitude(sound: SFX, amplitude: number): void

SetVFXColor

Changes the color of a visual effect.

SetVFXColor(vfxID: VFX, color: Vector): void

SetVFXScale

Changes the scale of a visual effect.

SetVFXScale(vfxID: VFX, scale: number): void

SetVFXSpeed

Changes the speed of a visual effect.

SetVFXSpeed(vfxID: VFX, speed: number): void

StopSound

Stops a given sound.

StopSound(sound: SFX, team: Team): void

StopSound(sound: SFX, squad: Squad): void

StopSound(sound: SFX, player: Player): void

StopSound(sound: SFX): void

UnloadMusic

Unloads a music package that is already loaded.

UnloadMusic(musicPackage: MusicPackages): void

Teams & Squads

Toggle

ClosestPlayerTo

Returns the closest alive player to a provided position. Can be filtered using a team. Note: If no players are alive when this block is called, the returned player will be invalid.

ClosestPlayerTo(vector: Vector, team: Team): Player

EndGameMode

Ends the current gamemode and designates the provided Player or Team as the winner. The gamemode ends in draw if Team is set to 0.

EndGameMode(team: Team): void

GetGameModeScore

Returns the current gamemode score of the provided player or team.

GetGameModeScore(team: Team): number

GetSquad

Returns the squad object corresponding to the provided player, or team/squad id.

GetSquad(player: Player): Squad

GetSquad(teamIdNumber: number, squadIdNumber: number): Squad

GetSquadName

Returns a string of the name of the provided squad.

GetSquadName(arg0: Squad): string

GetTeam

Returns the team value of the specified player OR the corresponding team of the provided number.

GetTeam(player: Player): Team

GetTeam(teamId: number): Team

IsFaction

Returns true if the provided team is using soldiers from the specified faction.

IsFaction(team: Team, factions: Factions): boolean

SetBombTeam

Changes the Team that can pick-up the bomb.

SetBombTeam(bomb: Bomb, team: Team): void

SetGameModeInitialScore

Sets the Initial Score for teams.

SetGameModeInitialScore(team: Team, initialscore: number): void

SetGameModeInitialScore(team: Team, initialscore: number, gameStageType: GameStageType): void

SetGameModeScore

Sets the gamemode score of the provided Player or Team.

SetGameModeScore(team: Team, newScore: number): void

SetGameModeScore(team: Team, newScore: number, gameStageType: GameStageType): void

SetGameModeTargetScore

Sets the gamemode target score used to determine victory.

SetGameModeTargetScore(team: Team, newScore: number): void

SetGameModeTargetScore(team: Team, newScore: number, gameStageType: GameStageType): void

SetTeam

Sets the target player's team.

SetTeam(player: Player, team: Team): void

SwitchTeams

Switches players on TeamA and TeamB. Both teams must have the same Human and Bot count.

SwitchTeams(teamA: Team, teamB: Team): void

Game Flow

Toggle

GetMatchTimeElapsed

Returns the amount of time elapsed (seconds) in the current gamemode.

GetMatchTimeElapsed(): number

GetMatchTimeRemaining

Returns the amount of time left (in seconds) in the current gamemode.

GetMatchTimeRemaining(): number

GetRoundTime

Returns the time limit set for the gamemode (in seconds).

GetRoundTime(): number

PauseGameModeTime

Pauses or unpauses the gamemode timer based on the provided boolean input.

PauseGameModeTime(pauseTimer: boolean): void

ResetGameModeTime

Resets the gamemode time to its starting value.

ResetGameModeTime(): void

SetFriendlyFire

Enables of disables friendly fire.

SetFriendlyFire(enableFriendlyFire: boolean): void

SetGameModeCriteria

Sets the type of criteria used to check the score for winning teams.

SetGameModeCriteria(criteria: ScoreCriteria): void

SetGameModeTargetScore

Sets the gamemode target score used to determine victory.

SetGameModeTargetScore(newScore: number): void

SetGameModeTimeLimit

Sets the duration of the game in seconds.

SetGameModeTimeLimit(newTimeLimit: number): void

SetHUDTicker

Sets the type of HUD ticker to use.

SetHUDTicker(ticker: GameModeTicker): void

SetSpectatingFiltersForAll

SetSpectatingFiltersForAll(
  group: SpectatingGroup,
  ownSquadOnly: boolean,
  ownTeamOnly: boolean
): void

Arrays

Toggle

AppendToArray

Returns a copy of an array with the provided value appended to the end. Note: It is not possible for an array to contain arrays. Attempting to append an array to an array will concatenate them instead.

AppendToArray(array: Array, value: Any): Array

ArraySlice

Returns a copy of the specified array containing only values from a specified index range.

ArraySlice(array: Array, startIndex: number, endIndex: number): Array

CountOf

Returns the number of elements in the specified array.

CountOf(array: Array): number

EmptyArray

Returns an initialized empty Array.

EmptyArray(): Array

FirstOf

Returns the first value of the specified Array.

FirstOf(array: Array): Any

LastOf

Returns the value at the end of the specified Array.

LastOf(array: Array): Any

RandomizedArray

Returns a copy of the specified Array with the values in a random order.

RandomizedArray(array: Array): Array

RandomValueInArray

Returns a random value from the specified Array.

RandomValueInArray(array: Array): Any

SortedArray

Returns a sorted version of the specified Array given a Number value to sort by (ascending). CurrentArrayElement can be utilized to represent each value in the Array. In the following example, CurrentArrayElement is used to represent each Player in AllPlayers. GetGameModeScore is used with CurrentArrayElement to return the score, used as a rank, to sort the Array in ascending order.

SortedArray(array: Array, index: number): Array

ValueInArray

Returns the value found at a provided index of an array.

ValueInArray(array: Array, index: number): Any

Variables

Toggle

ChaseVariableAtRate

Gradually modifies the value of a Variable at a specified rate (value/second) until it reaches the provided limit.

ChaseVariableAtRate(variable: Variable, limit: number, deltaPerSecond: number): void

ChaseVariableOverTime

Gradually modifies the value of a Variable over time (in seconds). The variable's value will reach the limit at the end of the interval.

ChaseVariableOverTime(variable: Variable, limit: number, durationSeconds: number): void

GetVariable

Returns the value of a variable.

GetVariable(variable: Variable): Any

GlobalVariable

Returns the variable specified by a number.

GlobalVariable(variableIndex: number): Variable

ObjectVariable

Returns the variable specified by an object.

ObjectVariable(ownerObject: mod.Object, variableIndex: number): Variable

SetVariable

Sets the value of a Variable.

SetVariable(variable: Variable, value: Any): void

SetVariableAtIndex

Finds or initializes an Array on a provided Variable, and stores a provided value in that Array at the specified index.

SetVariableAtIndex(arrayVariable: Variable, arrayIndex: number, value: Any): void

StopChasingVariable

Stops an in-progress tracking of a Variable from the ChaseVariableOverTime or ChaseVariableAtRate blocks, leaving it at its current value.

StopChasingVariable(variable: Variable): void

Math & Logic

Toggle

AbsoluteValue

Returns the unsigned value of the provided number input.

AbsoluteValue(number: number): number

Add

Returns the sum of two numbers or two vector values.

Add(number0: number, number1: number): number

Add(vector0: Vector, vector1: Vector): Vector

And

Returns a boolean value based on whether both of the provided inputs return true.

And(boolean0: boolean, boolean1: boolean): boolean

AngleBetweenVectors

Returns the angle (in degrees) between two provided vector values.

AngleBetweenVectors(vector0: Vector, vector1: Vector): number

AngleDifference

Returns the difference between two angles (in degrees).

AngleDifference(number0: number, number1: number): number

ArccosineInDegrees

Returns the inverse cosine of a provided number value in degrees.

ArccosineInDegrees(number: number): number

ArccosineInRadians

Returns the inverse cosine of a provided number value in radians.

ArccosineInRadians(number: number): number

ArcsineInDegrees

Returns the inverse sine of a provided number value in degrees.

ArcsineInDegrees(number: number): number

ArcsineInRadians

Returns the inverse sine of a provided number value in radians.

ArcsineInRadians(number: number): number

ArctangentInDegrees

Returns the inverse tangent of a provided number value in degrees.

ArctangentInDegrees(number: number): number

ArctangentInRadians

Returns the inverse tangent of a provided number value in radians.

ArctangentInRadians(number: number): number

BackwardVector

Returns the backward directional vector of (0, 0, 1).

BackwardVector(): Vector

Ceiling

Returns the value rounded up to the nearest integer.

Ceiling(number: number): number

CosineFromDegrees

Returns the cosine value of a specified angle in degrees.

CosineFromDegrees(number: number): number

CosineFromRadians

Returns the cosine value of a specified angle in radians.

CosineFromRadians(number: number): number

CreateTransform

Creates a Transform from Position and Rotation Vectors

CreateTransform(position: Vector, rotation: Vector): Transform

CreateVector

Returns a vector composed of three provided 'X' (left), 'Y' (up), and 'Z' (forward) values.

CreateVector(number0: number, number1: number, number2: number): Vector

CrossProduct

Returns the cross product between two vector values. If the two vector inputs are parallel, the result will be zero.

CrossProduct(vector0: Vector, vector1: Vector): Vector

DegreesToRadians

Returns a value in radians from a specified value in degrees.

DegreesToRadians(number: number): number

DirectionFromAngles

Returns a directional vector from the provided horizontal (yaw) and vertical (pitch) angles (in degrees).

DirectionFromAngles(number0: number, number1: number): Vector

DirectionTowards

Returns the direction, or normalized vector, from a starting position and ending position.

DirectionTowards(vector0: Vector, vector1: Vector): Vector

DistanceBetween

Returns the distance between a starting position and ending position.

DistanceBetween(vector0: Vector, vector1: Vector): number

Divide

Returns the ratio between two number values or a vector and number value. A vector divided by a number will yield a scaled vector.

Divide(number0: number, number1: number): number

Divide(vector: Vector, number: number): Vector

DotProduct

Returns the dot product between two vector values. If the two values are orthogonal to each other, the result will be zero.

DotProduct(vector0: Vector, vector1: Vector): number

DownVector

Returns the downward directional vector of (0, -1, 0).

DownVector(): Vector

Equals

Returns a boolean indicating if two values are equal to each other.

Equals(left: Any, right: Any): boolean

Floor

Returns the value rounded down to the nearest integer.

Floor(number: number): number

ForwardVector

Returns the forward directional vector of (0, 0, -1).

ForwardVector(): Vector

GetTransformPosition

Returns the position of a Transform as a Vector

GetTransformPosition(transform: Transform): Vector

GetTransformRotation

Returns the rotation of a Transform as a Vector

GetTransformRotation(transform: Transform): Vector

GreaterThan

Returns a boolean indicating if the 1st provided value is greater than the 2nd provided value.

GreaterThan(number0: number, number1: number): boolean

GreaterThanEqualTo

Returns a boolean indicating if the 1st provided value is greater than the 2nd provided value.

GreaterThanEqualTo(left: number, right: number): boolean

IfThenElse

Tertiary operator. If condition is true, return the first value. Otherwise return the second value.

IfThenElse(condition: boolean, trueValue: Any, falseValue: Any): Any

LeftVector

Returns the leftward directional vector of (-1, 0, 0).

LeftVector(): Vector

LessThan

Returns a boolean indicating if the 1st provided value is less than the 2nd provided value.

LessThan(left: number, right: number): boolean

LessThanEqualTo

Returns a boolean indicating if the 1st provided value is less than or equal to the 2nd provided value.

LessThanEqualTo(left: number, right: number): boolean

Max

Returns the greater of the two number values provided.

Max(number0: number, number1: number): number

Modulo

Returns the remainder of the 1st provided value divided by the 2nd provided value.

Modulo(number0: number, number1: number): number

Multiply

Returns the product of two number values or the product of a vector and number value.

Multiply(number0: number, number1: number): number

Multiply(vector: Vector, number: number): Vector

Normalize

Returns a unit-length normalization of a vector.

Normalize(vector: Vector): Vector

Not

Return a boolean of the opposite value of the boolean input.

Not(boolean: boolean): boolean

NotEqualTo

Returns a boolean indicating if two values are not equal to each other.

NotEqualTo(left: Any, right: Any): boolean

Or

Returns a boolean based on whether either of the two inputs are true.

Or(boolean0: boolean, boolean1: boolean): boolean

Pi

Returns the constant value 3.14159

Pi(): number

RadiansToDegrees

Returns a value in degrees from a specified value in radians.

RadiansToDegrees(number: number): number

RaiseToPower

Returns the 1st provided value raised to the power of the 2nd provided value.

RaiseToPower(number0: number, number1: number): number

RandomReal

Returns a random number between a specified minimum and maximum value (inclusive).

RandomReal(number0: number, number1: number): number

RightVector

Returns the rightward directional vector of (1, 0, 0).

RightVector(): Vector

RoundToInteger

Returns a whole number rounded from the input value. The value rounds up if the decimal of the number is greater than or equal to 0.5, and rounds down if it is less than 0.5.

RoundToInteger(number: number): number

SineFromDegrees

Returns the sine value of a specified angle in degrees.

SineFromDegrees(number: number): number

SineFromRadians

Returns the sine value of a specified angle in radians.

SineFromRadians(number: number): number

SquareRoot

Returns the square root of a provided number value.

SquareRoot(number: number): number

Subtract

Returns the difference between two number values or two vector values.

Subtract(number0: number, number1: number): number

Subtract(vector0: Vector, vector1: Vector): Vector

TangentFromDegrees

Returns the tangent value of a specified angle in degrees.

TangentFromDegrees(number: number): number

TangentFromRadians

Returns the tangent value of a specified angle in radians.

TangentFromRadians(number: number): number

UpVector

Returns the upward directional vector of (0, 1, 0).

UpVector(): Vector

VectorTowards

Returns the displacement vector from a starting position to an ending position.

VectorTowards(vector0: Vector, vector1: Vector): Vector

XComponentOf

Returns the 'X' component of a provided vector.

XComponentOf(vector: Vector): number

Xor

Returns true if the provided boolean inputs return different values.

Xor(boolean0: boolean, boolean1: boolean): boolean

YComponentOf

Returns the 'Y' component of a provided vector.

YComponentOf(vector: Vector): number

ZComponentOf

Returns the 'Z' component of a provided vector.

ZComponentOf(vector: Vector): number

Other

Toggle

AutoBalanceTeams

Balances Team1 and Team2 while maintaining squad compositions, requires matching team and squad capacities.

AutoBalanceTeams(): void

Concat

Returns a string containing the concatenation of two strings.

Concat(string0: string, string1: string): string

EnableWater

Enables the Water object.

EnableWater(enabled: boolean): void

ForceBombDrop

Forces the bomb drop to be dropped from its carrier.

ForceBombDrop(bomb: Bomb): void

ForceBombReset

Force resets the bomb to its initial location.

ForceBombReset(bomb: Bomb): void

GetArgument

Get argument of subroutine at given index.

GetArgument(subroutineArgIndex: number): Any

GetBlockingSphere

Returns the BlockingSphere corresponding to the provided id.

GetBlockingSphere(objId: number): BlockingSphere

GetBlockingSphereBoolParam

Returns the value of the target BlockingSphere boolean parameter.

GetBlockingSphereBoolParam(
  blockingSphere: BlockingSphere,
  boolParam: BlockingSphereBoolParam
): boolean

GetBlockingSphereRadius

Returns the radius of a BlockingSphere.

GetBlockingSphereRadius(blockingSphere: BlockingSphere): number

GetBomb

Returns the Bomb corresponding to the provided id.

GetBomb(objId: number): Bomb

GetFixedCamera

Returns the FixedCamera corresponding to the provided id.

GetFixedCamera(objId: number): FixedCamera

GetPortalAverageFrameTime

Return the average Portal processing frame time

GetPortalAverageFrameTime(): number

GetServerAverageFrameTime

Return average Server side frame time

GetServerAverageFrameTime(): number

GetTargetScore

Returns the gamemode target score needed for victory.

GetTargetScore(): number

GetWaterBeaufortScale

Returns the beaufort scale of the Water.

GetWaterBeaufortScale(): number

GetWaterHeight

Returns the Water height.

GetWaterHeight(): number

GetWaterIsEnabled

Returns a boolean value based on if water is enabled.

GetWaterIsEnabled(): boolean

GetWaterWaveAmplitude

Returns the wave amplitude of the Water.

GetWaterWaveAmplitude(): number

HasUIWidgetWithName

Returns a boolean indicating if the UI Widget exists.

HasUIWidgetWithName(name: string): boolean

IsCurrentMap

Returns true if the provided map is the name of the current map.

IsCurrentMap(maps: Maps): boolean

IsType

Returns true if the provided value is equal to the specified type.

IsType(value: Any, type: Types): boolean

IsUndefined

Returns whether a value is undefined, such as when a function cannot return a valid value.

IsUndefined(value: Any): boolean

IsValid

Returns whether a value is defined and if object reference is valid for object values.

IsValid(value: Any): boolean

JsAction

Calls a javascript action function.

JsAction(actionName: string, actionArg0: Any, actionArg1: Any): void

JsValue

Calls a javascript value function.

JsValue(valueName: string, valueArg0: Any, valueArg1: Any): Any

SendPortalLogToAdmin

Sends Portal Log to the admin client of the current session when hosting via "Host" (Dedicated Server). For "Host Locally," Portal Log is always available locally, so this will do nothing. Writes to PortalLog.txt on the admin's client. If admin doesn't exist, this will do nothing. Quota applies for valid log sends per session.

SendPortalLogToAdmin(): void

SetAllObjectivesUIEnabled

Enables the HUD UI for all objectives (Capture Points and MCOMs)

SetAllObjectivesUIEnabled(enabled: boolean): void

SetBlockingSphereBoolParam

Enables or disables different functionalities of a BlockingSphere object. This determines what happens to objects within its radius.

SetBlockingSphereBoolParam(
  blockingSphere: BlockingSphere,
  parameter: BlockingSphereBoolParam,
  enabled: boolean
): void

SetBlockingSphereRadius

Sets the radius of a BlockingSphere. This determines the range of influence of all of its enabled functionalities.

SetBlockingSphereRadius(blockingSphere: BlockingSphere, newRadius: number): void

SetBombDropFuseTime

Sets the fuse time for when the bomb is dropped to the ground before it blows up.

SetBombDropFuseTime(bomb: Bomb, dropfusetime: number): void

SetFreeCameraCollisionForAll

Set whether collision is enabled for the Free Camera. (Default true)

SetFreeCameraCollisionForAll(enabled: boolean): void

SetWaterBeaufortScale

Sets the Water beaufort Scale.

SetWaterBeaufortScale(beaufortscale: number): void

SetWaterLevel

Sets the water height.

SetWaterLevel(waterlevel: number): void

SetWaterWaveAmplitude

Sets the Water wave amplitude.

SetWaterWaveAmplitude(waveamplitude: number): void

Wait

Wait(n: number): Promise<void>

Event Handlers

OnAIMoveToFailed

This will trigger when an AI Soldier stops trying to reach a destination.

OnAIMoveToFailed(eventPlayer: mod.Player): void

OnAIMoveToRunning

This will trigger when an AI Soldier starts moving to a target location.

OnAIMoveToRunning(eventPlayer: mod.Player): void

OnAIMoveToSucceeded

This will trigger when an AI Soldier reaches target location.

OnAIMoveToSucceeded(eventPlayer: mod.Player): void

OnAIParachuteRunning

This will trigger when an AI Soldier parachute action is running.

OnAIParachuteRunning(eventPlayer: mod.Player): void

OnAIParachuteSucceeded

This will trigger when an AI Soldier parachute action has succeeded.

OnAIParachuteSucceeded(eventPlayer: mod.Player): void

OnAIWaypointIdleFailed

This will trigger when an AI Soldier stops following a waypoint.

OnAIWaypointIdleFailed(eventPlayer: mod.Player): void

OnAIWaypointIdleRunning

This will trigger when an AI Soldier starts following a waypoint.

OnAIWaypointIdleRunning(eventPlayer: mod.Player): void

OnAIWaypointIdleSucceeded

This will trigger when an AI Soldier finishes following a waypoint.

OnAIWaypointIdleSucceeded(eventPlayer: mod.Player): void

OnBombDropped

This will trigger when a player drops the bomb.

OnBombDropped(eventBomb: mod.Bomb, eventPlayer: mod.Player): void

OnBombPickedUp

This will trigger when a player picks up a bomb.

OnBombPickedUp(eventBomb: mod.Bomb, eventPlayer: mod.Player): void

OnBombStateChanged

This will trigger when a bomb changes state.

OnBombStateChanged(eventBomb: mod.Bomb, eventBombState: mod.BombState): void

OnCapturePointCaptured

This will trigger when a team takes control of a CapturePoint.

OnCapturePointCaptured(eventCapturePoint: mod.CapturePoint): void

OnCapturePointCapturing

This will trigger when a team begins capturing a CapturePoint.

OnCapturePointCapturing(eventCapturePoint: mod.CapturePoint): void

OnCapturePointLost

This will trigger when a team loses control of a CapturePoint.

OnCapturePointLost(eventCapturePoint: mod.CapturePoint): void

OnGameModeEnding

This will trigger when the gamemode ends.

OnGameModeEnding(): void

OnGameModeStarted

This will trigger at the start of the gamemode.

OnGameModeStarted(): void

OngoingAreaTrigger

OngoingAreaTrigger(eventAreaTrigger: mod.AreaTrigger): void

OngoingBlockingSphere

OngoingBlockingSphere(eventBlockingSphere: mod.BlockingSphere): void

OngoingBomb

OngoingBomb(eventBomb: mod.Bomb): void

OngoingCapturePoint

OngoingCapturePoint(eventCapturePoint: mod.CapturePoint): void

OngoingEmplacementSpawner

OngoingEmplacementSpawner(eventEmplacementSpawner: mod.EmplacementSpawner): void

OngoingGlobal

OngoingGlobal(): void

OngoingHQ

OngoingHQ(eventHQ: mod.HQ): void

OngoingInteractPoint

OngoingInteractPoint(eventInteractPoint: mod.InteractPoint): void

OngoingLootSpawner

OngoingLootSpawner(eventLootSpawner: mod.LootSpawner): void

OngoingMCOM

OngoingMCOM(eventMCOM: mod.MCOM): void

OngoingPlayer

OngoingPlayer(eventPlayer: mod.Player): void

OngoingRingOfFire

OngoingRingOfFire(eventRingOfFire: mod.RingOfFire): void

OngoingSector

OngoingSector(eventSector: mod.Sector): void

OngoingSpawner

OngoingSpawner(eventSpawner: mod.Spawner): void

OngoingSpawnPoint

OngoingSpawnPoint(eventSpawnPoint: mod.SpawnPoint): void

OngoingTeam

OngoingTeam(eventTeam: mod.Team): void

OngoingVehicle

OngoingVehicle(eventVehicle: mod.Vehicle): void

OngoingVehicleSpawner

OngoingVehicleSpawner(eventVehicleSpawner: mod.VehicleSpawner): void

OngoingWaypointPath

OngoingWaypointPath(eventWaypointPath: mod.WaypointPath): void

OngoingWorldIcon

OngoingWorldIcon(eventWorldIcon: mod.WorldIcon): void

OnGolmudTrainStopped

This will trigger when the Golmud train stops.

OnGolmudTrainStopped(eventGolmudTrainStopReason: mod.GolmudTrainStopReason): void

OnMandown

This will trigger when a Player is forced into the mandown state.

OnMandown(eventPlayer: mod.Player, eventOtherPlayer: mod.Player): void

OnMCOMArmed

This will trigger when a MCOM is armed.

OnMCOMArmed(eventMCOM: mod.MCOM): void

OnMCOMDefused

This will trigger when a MCOM is defused.

OnMCOMDefused(eventMCOM: mod.MCOM): void

OnMCOMDestroyed

This will trigger when a MCOM detonates.

OnMCOMDestroyed(eventMCOM: mod.MCOM): void

OnPlayerDamaged

This will trigger when a Player takes damage.

OnPlayerDamaged(
  eventPlayer: mod.Player,
  eventOtherPlayer: mod.Player,
  eventDamageType: mod.DamageType,
  eventWeaponUnlock: mod.WeaponUnlock
): void

OnPlayerDeployed

This will trigger whenever a Player deploys.

OnPlayerDeployed(eventPlayer: mod.Player): void

OnPlayerDied

This will trigger whenever a Player dies.

OnPlayerDied(
  eventPlayer: mod.Player,
  eventOtherPlayer: mod.Player,
  eventDeathType: mod.DeathType,
  eventWeaponUnlock: mod.WeaponUnlock
): void

OnPlayerEarnedKill

This will trigger when a Player earns a kill against another Player.

OnPlayerEarnedKill(
  eventPlayer: mod.Player,
  eventOtherPlayer: mod.Player,
  eventDeathType: mod.DeathType,
  eventWeaponUnlock: mod.WeaponUnlock
): void

OnPlayerEarnedKillAssist

This will trigger when a Player earns a kill assist.

OnPlayerEarnedKillAssist(eventPlayer: mod.Player, eventOtherPlayer: mod.Player): void

OnPlayerEmerged

This will trigger when a player emerges from water.

OnPlayerEmerged(eventPlayer: mod.Player): void

OnPlayerEnterAreaTrigger

This will trigger when a Player enters an AreaTrigger.

OnPlayerEnterAreaTrigger(eventPlayer: mod.Player, eventAreaTrigger: mod.AreaTrigger): void

OnPlayerEnterCapturePoint

This will trigger when a Player enters a CapturePoint capturing area.

OnPlayerEnterCapturePoint(eventPlayer: mod.Player, eventCapturePoint: mod.CapturePoint): void

OnPlayerEnteredWater

This will trigger when a player enters water.

OnPlayerEnteredWater(eventPlayer: mod.Player): void

OnPlayerEnterVehicle

This will trigger when a Player enters a Vehicle seat.

OnPlayerEnterVehicle(eventPlayer: mod.Player, eventVehicle: mod.Vehicle): void

OnPlayerEnterVehicleSeat

This will trigger when a Player enters a Vehicle seat.

OnPlayerEnterVehicleSeat(
  eventPlayer: mod.Player,
  eventVehicle: mod.Vehicle,
  eventSeat: mod.Object
): void

OnPlayerEnterVL7Cloud

This will trigger when a Player enters a VL7Cloud volume.

OnPlayerEnterVL7Cloud(eventPlayer: mod.Player, eventVL7Cloud: mod.VL7Cloud): void

OnPlayerExitAreaTrigger

This will trigger when a Player exits an AreaTrigger.

OnPlayerExitAreaTrigger(eventPlayer: mod.Player, eventAreaTrigger: mod.AreaTrigger): void

OnPlayerExitCapturePoint

This will trigger when a Player exits a CapturePoint capturing area.

OnPlayerExitCapturePoint(eventPlayer: mod.Player, eventCapturePoint: mod.CapturePoint): void

OnPlayerExitedWater

This will trigger when a player exits water.

OnPlayerExitedWater(eventPlayer: mod.Player): void

OnPlayerExitVehicle

This will trigger when a Player exits a Vehicle.

OnPlayerExitVehicle(eventPlayer: mod.Player, eventVehicle: mod.Vehicle): void

OnPlayerExitVehicleSeat

This will trigger when a Player exits a Vehicle seat.

OnPlayerExitVehicleSeat(
  eventPlayer: mod.Player,
  eventVehicle: mod.Vehicle,
  eventSeat: mod.Object
): void

OnPlayerExitVL7Cloud

This will trigger when a Player exits a VL7Cloud volume.

OnPlayerExitVL7Cloud(eventPlayer: mod.Player, eventVL7Cloud: mod.VL7Cloud): void

OnPlayerInteract

This will trigger when a Player interacts with InteractPoint.

OnPlayerInteract(eventPlayer: mod.Player, eventInteractPoint: mod.InteractPoint): void

OnPlayerJoinGame

This will trigger when a Player joins the game.

OnPlayerJoinGame(eventPlayer: mod.Player): void

OnPlayerLeaveGame

This will trigger when any player leaves the game.

OnPlayerLeaveGame(eventNumber: number): void

OnPlayerSubmerged

This will trigger when a player submerges in water.

OnPlayerSubmerged(eventPlayer: mod.Player): void

OnPlayerSwitchTeam

This will trigger when a Player changes team.

OnPlayerSwitchTeam(eventPlayer: mod.Player, eventTeam: mod.Team): void

OnPlayerUIButtonEvent

This will trigger when a Player interacts with an UI button.

OnPlayerUIButtonEvent(
  eventPlayer: mod.Player,
  eventUIWidget: mod.UIWidget,
  eventUIButtonEvent: mod.UIButtonEvent
): void

OnPlayerUndeploy

This will trigger when the Player dies and returns to the deploy screen.

OnPlayerUndeploy(eventPlayer: mod.Player): void

OnPortalGadgetAimStart

This will trigger when a Player presses the Zoom button.

OnPortalGadgetAimStart(eventPlayer: mod.Player): void

OnPortalGadgetAimStop

This will trigger when a Player releases the Zoom button.

OnPortalGadgetAimStop(eventPlayer: mod.Player): void

OnPortalGadgetFireStart

This will trigger when a Player presses the Fire button.

OnPortalGadgetFireStart(eventPlayer: mod.Player): void

OnPortalGadgetFireStop

This will trigger when a Player releases the Fire button.

OnPortalGadgetFireStop(eventPlayer: mod.Player): void

OnPortalGadgetLaserToggle

This will trigger when a Player presses the Tactical Device button.

OnPortalGadgetLaserToggle(eventPlayer: mod.Player, eventBoolean: boolean): void

OnRayCastHit

This will trigger when a Raycast hits a target.

OnRayCastHit(eventPlayer: mod.Player, eventPoint: mod.Vector, eventNormal: mod.Vector): void

OnRayCastMissed

This will trigger when a Raycast is called and doesn't hit any target.

OnRayCastMissed(eventPlayer: mod.Player): void

OnRevived

This will trigger when a Player is revived by another Player.

OnRevived(eventPlayer: mod.Player, eventOtherPlayer: mod.Player): void

OnRingOfFireZoneSizeChange

This will trigger when a RingOfFire changes size.

OnRingOfFireZoneSizeChange(eventRingOfFire: mod.RingOfFire, eventNumber: number): void

OnSpawnerSpawned

This will trigger when an AISpawner spawns an AI Soldier.

OnSpawnerSpawned(eventPlayer: mod.Player, eventSpawner: mod.Spawner): void

OnTimeLimitReached

This will trigger when the gamemode time limit has been reached.

OnTimeLimitReached(): void

OnVehicleDestroyed

This will trigger when a Vehicle is destroyed.

OnVehicleDestroyed(eventVehicle: mod.Vehicle): void

OnVehicleSpawned

This will trigger when a Vehicle is called into the map.

OnVehicleSpawned(eventVehicle: mod.Vehicle): void

Types

SDK Object Types

These are opaque SDK handles. You generally only need the type name when reading function signatures.

AreaTrigger
Array
BlockingSphere
Bomb
CapturePoint
DamageType
DeathType
EmplacementSpawner
FixedCamera
HQ
InteractPoint
LootSpawner
MapSpecificFeature
MCOM
Message
Player
PortalEnum
RingOfFire
Sector
SFX
SpatialObject
Spawner
SpawnPoint
Squad
Team
Transform
UIWidget
Variable
Vector
Vehicle
VehicleSpawner
VFX
VL7Cloud
VO
WaypointPath
WeaponPackage
WeaponUnlock
WorldIcon

Type Aliases

Object

Object is a generic SDK object handle. It can refer to any of these Portal object types:

AreaTrigger
BlockingSphere
Bomb
CapturePoint
EmplacementSpawner
FixedCamera
HQ
InteractPoint
LootSpawner
MapSpecificFeature
MCOM
Player
RingOfFire
Sector
SFX
SpatialObject
Spawner
SpawnPoint
Team
Vehicle
VehicleSpawner
VFX
VL7Cloud
VO
WaypointPath
WorldIcon

Enums

AiInput (13 values)

enum AiInput {
  Crouch,
  FireWeapon,
  Interact,
  Jump,
  Prone,
  Reload,
  SelectCharacterGadget,
  SelectOpenGadget,
  SelectPrimary,
  SelectSecondary,
  SelectThrowable,
  Sprint,
  Strafe,
}

AmmoTypes (6 values)

enum AmmoTypes {
  AR_Carbine_Ammo,
  Armor_Plate,
  LMG_Ammo,
  Pistol_SMG_Ammo,
  Shotgun_Ammo,
  Sniper_DMR_Ammo,
}

ArmorTypes (3 values)

enum ArmorTypes {
  CeramicArmor,
  NoArmor,
  SoftArmor,
}

BlockingSphereBoolParam (6 values)

enum BlockingSphereBoolParam {
  BlockLocking,
  BlockSpotting,
  IsCloudBlockingVolume,
  JamIncomingMissiles,
  RemoveLaserPainting,
  RemoveTracerDart,
}

BombState (10 values)

enum BombState {
  Carried,
  Defusing,
  Dropped,
  Inactive,
  ObjectiveCompleted,
  Planted,
  Planting,
  Resetting,
  Spawned,
  Unspawned,
}

Cameras (4 values)

enum Cameras {
  FirstPerson,
  Fixed,
  Free,
  ThirdPerson,
}

CustomNotificationSlots (5 values)

enum CustomNotificationSlots {
  HeaderText,
  MessageText1,
  MessageText2,
  MessageText3,
  MessageText4,
}

EnumTypes (85 values)

enum EnumTypes {
  Enum_AiInput,
  Enum_AmmoTypes,
  Enum_ArmorDurability,
  Enum_ArmorTypes,
  Enum_AwarenessState,
  Enum_BlockingSphereBoolParam,
  Enum_BombState,
  Enum_Cameras,
  Enum_CustomNotificationSlots,
  Enum_EnumTypes,
  Enum_Factions,
  Enum_Gadgets,
  Enum_GameModeTicker,
  Enum_GameStageType,
  Enum_GolmudTrainMoveCommands,
  Enum_GolmudTrainStopReason,
  Enum_GolmudTrainVariants,
  Enum_InventorySlots,
  Enum_Maps,
  Enum_MCOMArmType,
  Enum_MoveSpeed,
  Enum_MusicEvents,
  Enum_MusicPackages,
  Enum_MusicParams,
  Enum_ObjectTypes,
  Enum_PlayerDamageTypes,
  Enum_PlayerDeathTypes,
  Enum_PlayerFilterTypes,
  Enum_PortalTypes,
  Enum_RestrictedInputs,
  Enum_ResupplyTypes,
  Enum_RuntimeSpawn_Abbasid,
  Enum_RuntimeSpawn_Aftermath,
  Enum_RuntimeSpawn_Atoll,
  Enum_RuntimeSpawn_Badlands,
  Enum_RuntimeSpawn_Battery,
  Enum_RuntimeSpawn_Capstone,
  Enum_RuntimeSpawn_Common,
  Enum_RuntimeSpawn_Contaminated,
  Enum_RuntimeSpawn_Dumbo,
  Enum_RuntimeSpawn_Eastwood,
  Enum_RuntimeSpawn_FireStorm,
  Enum_RuntimeSpawn_GolmudRailway,
  Enum_RuntimeSpawn_Granite_Downtown,
  Enum_RuntimeSpawn_Granite_Marina,
  Enum_RuntimeSpawn_Granite_MilitaryRnD,
  Enum_RuntimeSpawn_Granite_MilitaryStorage,
  Enum_RuntimeSpawn_Granite_ResidentialNorth,
  Enum_RuntimeSpawn_Granite_TechCenter,
  Enum_RuntimeSpawn_Granite_Underground,
  Enum_RuntimeSpawn_Isolated,
  Enum_RuntimeSpawn_Limestone,
  Enum_RuntimeSpawn_Ocean,
  Enum_RuntimeSpawn_Outskirts,
  Enum_RuntimeSpawn_Plaza,
  Enum_RuntimeSpawn_Sand,
  Enum_RuntimeSpawn_Subsurface,
  Enum_RuntimeSpawn_Tungsten,
  Enum_ScoreboardType,
  Enum_ScoreCriteria,
  Enum_ScreenEffects,
  Enum_SoldierClass,
  Enum_SoldierEffects,
  Enum_SoldierStateBool,
  Enum_SoldierStateNumber,
  Enum_SoldierStateVector,
  Enum_SpawnModes,
  Enum_SpectatingGroup,
  Enum_SpotStatus,
  Enum_Stance,
  Enum_StationaryEmplacements,
  Enum_Types,
  Enum_UIAnchor,
  Enum_UIBgFill,
  Enum_UIButtonEvent,
  Enum_UIDepth,
  Enum_UIImageType,
  Enum_VehicleCategories,
  Enum_VehicleList,
  Enum_VehicleStateVector,
  Enum_VoiceOverEvents2D,
  Enum_VoiceOverFlags,
  Enum_WeaponAttachments,
  Enum_Weapons,
  Enum_WorldIconImages,
}

Factions (2 values)

enum Factions {
  NATO,
  PaxArmata,
}

Gadgets (63 values)

enum Gadgets {
  CallIn_Air_Strike,
  CallIn_Ammo_Drop,
  CallIn_Anti_Vehicle_Drop,
  CallIn_Artillery_Strike,
  CallIn_Mobile_Redeploy,
  CallIn_Smoke_Screen,
  CallIn_UAV_Overwatch,
  CallIn_Weapon_Drop,
  Class_Adrenaline_Injector,
  Class_Handheld_Jammer,
  Class_Motion_Sensor,
  Class_Repair_Tool,
  Class_Supply_Bag,
  Deployable_Cover,
  Deployable_Deploy_Beacon,
  Deployable_EOD_Bot,
  Deployable_Grenade_Intercept_System,
  Deployable_Missile_Intercept_System,
  Deployable_Portable_Mortar,
  Deployable_Recon_Drone,
  Deployable_Vehicle_Supply_Crate,
  Launcher_Aim_Guided,
  Launcher_Air_Defense,
  Launcher_Auto_Guided,
  Launcher_Breaching_Projectile,
  Launcher_High_Explosive,
  Launcher_IGLA,
  Launcher_Incendiary_Airburst,
  Launcher_Long_Range,
  Launcher_Smoke_Grenade,
  Launcher_Thermobaric_Grenade,
  Launcher_Unguided_Rocket,
  Mask_Gas,
  Mask_NVG,
  Melee_Combat_Knife,
  Melee_EOD_Bot_Arm,
  Melee_Hunting_Knife,
  Melee_Ice_Axe,
  Melee_Serrated_Blade,
  Melee_Sledgehammer,
  Misc_Acoustic_Sensor_AV_Mine,
  Misc_Anti_Personnel_Mine,
  Misc_Anti_Vehicle_Mine,
  Misc_Assault_Ladder,
  Misc_Defibrillator,
  Misc_Demolition_Charge,
  Misc_Incendiary_Round_Shotgun,
  Misc_Laser_Designator,
  Misc_PortalGadget,
  Misc_Sniper_Decoy,
  Misc_Supply_Pouch,
  Misc_Suppression,
  Misc_Tracer_Dart,
  Misc_Tripwire_Sensor_AV_Mine,
  Throwable_Anti_Vehicle_Grenade,
  Throwable_Flash_Grenade,
  Throwable_Fragmentation_Grenade,
  Throwable_Incendiary_Grenade,
  Throwable_Mini_Frag_Grenade,
  Throwable_Proximity_Detector,
  Throwable_Smoke_Grenade,
  Throwable_Stun_Grenade,
  Throwable_Throwing_Knife,
}

GameModeTicker (4 values)

enum GameModeTicker {
  None,
  Ticker_Breakthrough,
  Ticker_Conquest,
  Ticker_TeamDM,
}

GameStageType (2 values)

enum GameStageType {
  Phase,
  Round,
}

GolmudTrainMoveCommands (3 values)

enum GolmudTrainMoveCommands {
  MoveEast,
  MoveWest,
  Stop,
}

GolmudTrainStopReason (3 values)

enum GolmudTrainStopReason {
  ReachedEastTerminal,
  ReachedWestTerminal,
  StoppedInTransit,
}

GolmudTrainVariants (4 values)

enum GolmudTrainVariants {
  MovingTrain,
  None,
  StaticTrain_Breakthrough,
  StaticTrain_Rush,
}

InventorySlots (9 values)

enum InventorySlots {
  Callins,
  ClassGadget,
  GadgetOne,
  GadgetTwo,
  MeleeWeapon,
  MiscGadget,
  PrimaryWeapon,
  SecondaryWeapon,
  Throwable,
}

Maps (26 values)

enum Maps {
  Abbasid,
  Aftermath,
  Atoll,
  Badlands,
  Battery,
  Capstone,
  Contaminated,
  Dumbo,
  Eastwood,
  Firestorm,
  GolmudRailway,
  Granite_ClubHouse,
  Granite_MainStreet,
  Granite_Marina,
  Granite_MilitaryRnD,
  Granite_MilitaryStorage,
  Granite_TechCampus,
  Granite_Underground,
  Isolated,
  Limestone,
  Ocean,
  Outskirts,
  Plaza,
  Sand,
  Subsurface,
  Tungsten,
}

MCOMArmType (2 values)

enum MCOMArmType {
  Bomb,
  Default,
}

MoveSpeed (7 values)

enum MoveSpeed {
  InvestigateRun,
  InvestigateSlowWalk,
  InvestigateWalk,
  Patrol,
  Run,
  Sprint,
  Walk,
}

MusicEvents (46 values)

enum MusicEvents {
  BR_InsertionCinematic_Dropzone_Loop,
  BR_InsertionCinematic_Loop,
  BR_InsertionJump,
  BR_InsertionLanding,
  BR_LastTwoSquads,
  BR_Loss_Early_Loop,
  BR_Loss_EndOfRound_Loop,
  BR_Loss_SecondPlace_Loop,
  BR_Pause,
  BR_RespawnSecondChance,
  BR_RespawnTower,
  BR_Stop,
  BR_Unpause,
  BR_WonRound_Loop,
  BRGauntlet_LobbyFilled,
  BRGauntlet_WaitingForPlayers_Loop,
  Core_Deploy_Loop,
  Core_EndOfRound_Loop,
  Core_LastPhaseBegin,
  Core_Overtime_Loop,
  Core_PauseMenu_Loop,
  Core_PhaseBegin,
  Core_PhaseEnded,
  Core_Stinger_Negative,
  Core_Stinger_Positive,
  Core_Stinger_RankUp,
  Core_Stop,
  Gauntlet_Deploy,
  Gauntlet_Loss_FinalMission_Loop,
  Gauntlet_Loss_Loop,
  Gauntlet_MissionBriefing_Final,
  Gauntlet_MissionBriefing_One,
  Gauntlet_MissionBriefing_Three,
  Gauntlet_MissionBriefing_Two,
  Gauntlet_Pause,
  Gauntlet_Qualified_Loop,
  Gauntlet_Qualified_Outro,
  Gauntlet_Stop,
  Gauntlet_Unpause,
  Gauntlet_Urgency,
  Gauntlet_Urgency_FinalMission,
  Gauntlet_WonOperation_Loop,
  Radio_ClearQueue,
  Radio_NextQueuedTrack,
  Radio_Play,
  Radio_Stop,
}

MusicPackages (4 values)

enum MusicPackages {
  BR,
  Core,
  Gauntlet,
  Radio,
}

MusicParams (14 values)

enum MusicParams {
  BR_Amplitude,
  BRGauntlet_LobbyTimerRemaining,
  Core_Amplitude,
  Core_IsWinning,
  Core_PhaseUrgency,
  Core_Sector,
  Core_Urgency,
  Gauntlet_Amplitude,
  Radio_Amplitude,
  Radio_Biome,
  Radio_Channel,
  Radio_ContinueQueueOnTrackEnd,
  Radio_LoopQueuedTracks,
  Radio_QueueTrackNumber,
}

ObjectTypes (29 values)

enum ObjectTypes {
  AreaTrigger,
  BlockingSphere,
  Bomb,
  CapturePoint,
  EmplacementSpawner,
  FixedCamera,
  HQ,
  InteractPoint,
  LootMissionObjectManager,
  LootSpawner,
  MapSpecificFeature,
  MCOM,
  Player,
  RingOfFire,
  ScreenEffect,
  Sector,
  SFX,
  SpatialObject,
  Spawner,
  SpawnPoint,
  Team,
  Vehicle,
  VehicleSpawner,
  VFX,
  VL7Cloud,
  VO,
  Water,
  WaypointPath,
  WorldIcon,
}

PlayerDamageTypes (6 values)

enum PlayerDamageTypes {
  Default,
  Explosion,
  Fall,
  Fire,
  Headshot,
  Melee,
}

PlayerDeathTypes (11 values)

enum PlayerDeathTypes {
  Deserting,
  Drowning,
  Explosion,
  Fall,
  Fire,
  Headshot,
  Melee,
  Penetration,
  Redeploy,
  Roadkill,
  Weapon,
}

PlayerFilterTypes (4 values)

enum PlayerFilterTypes {
  None,
  Player,
  Squad,
  TeamId,
}

PortalTypes (46 values)

enum PortalTypes {
  AreaTrigger,
  Array,
  BlockingSphere,
  Bomb,
  Boolean,
  CapturePoint,
  DamageType,
  DeathType,
  EmplacementSpawner,
  FixedCamera,
  HQ,
  InteractPoint,
  LootMissionObjectManager,
  LootSpawner,
  MapSpecificFeature,
  MCOM,
  Message,
  Number,
  Object,
  Player,
  PortalEnum,
  RingOfFire,
  ScoreboardType,
  ScreenEffect,
  Sector,
  SFX,
  SpatialObject,
  Spawner,
  SpawnPoint,
  Squad,
  String,
  Team,
  Transform,
  UIWidget,
  Variable,
  Vector,
  Vehicle,
  VehicleSpawner,
  VFX,
  VL7Cloud,
  VO,
  Water,
  WaypointPath,
  WeaponPackage,
  WeaponUnlock,
  WorldIcon,
}

RestrictedInputs (20 values)

enum RestrictedInputs {
  CameraPitch,
  CameraYaw,
  Crouch,
  CycleFire,
  CyclePrimary,
  FireWeapon,
  Interact,
  Jump,
  MoveForwardBack,
  MoveLeftRight,
  Prone,
  Reload,
  SelectCharacterGadget,
  SelectMelee,
  SelectOpenGadget,
  SelectPrimary,
  SelectSecondary,
  SelectThrowable,
  Sprint,
  Zoom,
}

ResupplyTypes (3 values)

enum ResupplyTypes {
  AmmoBox,
  AmmoCrate,
  SupplyBag,
}

RuntimeSpawn_Abbasid (1346 values)