Interaction

67 scripting commands. Also as Markdown for agents.

actionMake a unit perform an action. See Category:Actions for action names and syntaxes.
actionIDs
actionKeysReturns Array containing dikCodes of keys, buttons and combos assigned to the given user action. Action names could be found in config class…
actionKeysExGives a broken down version of actionKeys return. Returns an Array containing the breakdowns of the dikCodes of keys, buttons and combos assigned to…
actionKeysImagesReturns a list of button images or names assigned to the given user action. A maximum of *maxKeys* keys is listed. You can find the action names in…
actionKeysNamesReturns a list of button names assigned to the given user action. Action names can be found in config class `ControllerSchemes` or user action names.
actionKeysNamesArrayReturns a list of button names assigned to the given user action. You can find the action names in config class ControllerSchemes or user action…
actionNameReturns localized name of action.
actionNowMake a unit perform an action immediately (without any animation/pre-processing). See the action command for more information.
actionParamsReturns Array with params for given user action id (similar to addAction param array).
addActionAdds an entry to the action menu of an object. The action can only be activated when in proximity to the object and looking at it. Adding an action…
commandingMenuReturns the name of the topmost commanding menu or "" if the menu is closed. For action menu visibility check see isActionMenuVisible. See #Notes for…
disableUserInputDisables or enables the keyboard and mouse input. Usually used during cutscenes.
drawIcon3DDraws an icon at the given position in the game world. This command has to be executed every frame. Use the Draw3D Mission Event Handler (which is…
drawLaserDraws a laserbeam and a lightpoint at the impact location of the laser.
drawLine3DDraws a line of a given colour between two 3D positions in the current frame. To be used mostly in a "Draw3D" mission event handler.
forcedMapReturns if map was forced by using forceMap command or openMap command with force option
forceMapOpens non-interactive main map in background that overrides user screen. To force open interactive map use openMap command.
getUserMFDValueReturns array of user text variables used in MFD.
groupSelectedUnitsReturns selected units in source group for normal commanding mode (individual units). For the High Command equivalent, see hcSelected.
groupSelectUnitSelects a unit from player's group. If player is the leader, the effect of this command is similar to player pressing <kbd>F1</kbd>, <kbd>F2</kbd>,…
hiddenActionsGetter for hideActions, see also shownAction.
hideActionsHides/unhides user UI actions given by their enum number (see shownAction).
hintOutputs a hint message to the right of the screen (left of the screen in Operation Flashpoint) with a sound (except in Armed Assault).
hintCDisplays a very basic message dialog in the center of the screen. Player control is taken away until "Continue" is pressed. The message dialog can be…
hintCadetShows a text hint only when in cadetMode.
hintSilentSame as hint, but without a sound.
HUDMovementLevelsReturns movement borders for HUD
inGameUISetEventHandlerSets given event handler of in-game UI. If EH function returns true, performed action is overridden.
inputActionReturn the state of input devices mapped to given input action.
inputControllerReturns the state of controller inputs. The controller is a standard XBOX controller which is selected with Windows XBOX controller scheme.
inputMouseReturns the state of mouse button action, alone or in combination with key presses.
isActionMenuVisibleReturns true if scroll menu is visible.
openGPSOpens or closes minimap if player has `"ItemGPS"` linked in inventory and `"MinimapDisplayComponent"` is not disabled with enableInfoPanelComponent.…
openMapOpens or closes in-game map.
removeActionRemoves user added action with given ID. This only removes actions added with the addAction command. You cannot remove default game actions, such as…
removeAllActionsRemoves all unit's user added actions.
setCompassDeclinationSets the declination angle of player's compass, which is the difference between magnetic north and true north.
setCompassOscillationThis command sets random heading on the player's compass (both in map and in 3D view) with given frequency, which is also randomised.
setHUDMovementLevelsSet min/max movement borders displayed in HUD gauges. Use -1 to skip some value.
setRadioMsgSets radio trigger menu title text (0 -> 0 -> map radio). Use "NULL" to disable radio slot. Use "" to restore default title.
setUserActionTextChanges user added action (see addAction) menu item text.
setUserMFDValueWhen MFD is using user controllers, this command can set values on them. For example, MFD config for Blackfoot has an entry
showCommandingMenuCreate the commanding menu described by the given config class or menu name. When the name is empty, the current menu is hidden.
showCompassShows or hides the compass on the map screen, if enabled for the mission and you possess the item. (default true)
showGPSShows or hides the GPS receiver on the map screen, if enabled for the mission and you possess the item. (default false).
showHUDEnable / disable showing of HUD. Defines visibility of weapon crosshair and any informational tags that appear when pointing the weapon at an object…
shownActionGet the internal enum of the displayed action (or 0 if none are displayed). Action enums: 1. GetInCommander 1. GetInDriver 1. GetInPilot 1.…
shownCompassChecks if client has Compass enabled in description.ext (*showCompass* param) or force enabled with showCompass command.
shownGPSChecks if client has GPS receiver enabled in description.ext (*showGPS* param) or force enabled with showGPS command.
shownHUDReturns array of Booleans corresponding to the visibility of various HUD elements (see extended showHUD).
shownPadChecks if client has Notepad enabled.
shownRadioCheck if player has Radio enabled.
shownScoretableReturns the state of the score table set with showScoretable command.
shownWarrantCheck if player has ID card enabled. Obsolete command.
shownWatchChecks if client has Watch enabled in description.ext (*showWatch* param) or force enabled with showWatch command.
showPadShows or hides the notebook on the map screen, if enabled for the mission. (default true). It is no longer relevant to Arma 2.
showRadioShows or hides the radio on the map screen, if enabled for the mission and you possess the item. (default true).
showScoretableForces the score table to be shown, hidden or reset to default functionality. Forcing score table will make it show even in SP.
showWarrantEnable ID card.
showWatchShows or hides the watch on the map screen, if enabled for the mission and you possess the item. (default true)
userInputDisabledReturns whether or not user input is disabled.
visibleCompassChecks if the player has compass opened and visible. Keep in mind that the GPS minimap in Arma 3 also shows the direction.
visibleGPSChecks if the player has GPS receiver (minimap) opened and visible.
visibleMapReturn true if the main map is shown (active). In Arma 3 it also returns true if the respawn screen map is visible.
visibleScoretableChecks whether the score table is visible.
visibleWatchChecks if the player has watch opened and visible. Keep in mind that the GPS minimap in Arma 3 also shows the time.