System
83 scripting commands. Also as Markdown for agents.
- addLiveStatsAdds score to the Xbox Live Statistics score for the given unit (or the commander unit of the given vehicle).
- allExtensionsReturns information about all loaded Extensions
- armoryPointsReturns, stored in [USERNAME].ArmaXProfile, value of *armoryPoints* entry. If the entry doesn't exist, it returns 0.
- benchmarkReturns the value of "3D Performance" in OFP Preferences (flashpoint.cfg). This can be used to estimate the computer performance to adapt CPU and GPU…
- buldozer_enableRoadDiagEnables road diagnostics in buldozer.
- buldozer_isEnabledRoadDiagReturns if road diagnostics are enabled in buldozer.
- buldozer_loadNewRoadsGenerates new roads. Working only in buldozer.
- buldozer_reloadOperMapReload oper map visible in costMap diag tool. Working only in buldozer.
- calculatePlayerVisibilityByFriendlySets if friendly units will calculate player's visibility or not. Default value is false.
- callExtensionCalls custom .dll also known as Extension. The name of the extension is the name of the extension .dll without ".dll" part (or without "_x64.dll"…
- cheatsEnabledChecks whether cheats are enabled (whether the designers' version is running).
- compileScriptThis command is an alias for `compile(Final) (prefixHeader + preprocessFileLineNumbers path)`. See description of preprocessFileLineNumbers for more…
- completedFSMChecks whether the given FSM is completed. The FSM handle is the number returned by the execFSM command.
- connectToServerConnects the client to the provided server.
- copyFromClipboardReturn ANSI content of the (text) clipboard. If Unicode support is desired, see forceUnicode.
- copyToClipboardCopies ANSI text string to the clipboard. If Unicode support is desired, see forceUnicode.
- currentNamespaceReturns the current global namespace the script runs in.
- distributionRegionReturns the numerical index for the distribution region of this copy of Armed Assault. 1. USA 1. Rest of the world
- enableCausticsEnable/disable caustics drawing.
- enableSatNormalOnDetailEnables/Disables satellite normal map or detail maps.
- endLoadingScreenFinishes loading screen started by startLoadingScreen.
- exportLandscapeXYZExports landscape as XYZ file.
- finishMissionInitFinish world initialisation before mission is launched.
- freeExtensionUnloads given extension loaded previously with callExtension so that extension developer could rapidly tweak developed extension without restarting…
- getCalculatePlayerVisibilityByFriendlyReturns true if visibility of player by friendly units is calculated.
- getFieldManualStartPageReturns array of the starting topic and hint the given field manual should display.
- getMissionOptionsReturns various mission options
- getMissionPathReturns mission root plus the filename in a form of filepath to be used with commands requiring absolute path such as playSound3D, drawIcon3D,…
- getObjectViewDistanceGets the values of rendering distances of objects and shadows.
- getPiPViewDistanceGet the set PiP (Picture-in-Picture) view distance (that can be set by setPiPViewDistance).
- getResolutionReturns an array containing all information about current client screen resolution.
- getShadowDistanceGets the shadows rendering distance.
- getStatValueReturns value of the given stat.
- getSteamFriendsServersReturns servers information of Steam friends currently playing the game.
- getTerrainGridA getter for setTerrainGrid, returns the current terrain grid.
- getTextureInfoReturn texture information - resolution in pixels (mipmap level 0) and average colour. Multiply the pixel values by pixelW and pixelH to get screen…
- getVideoOptionsObtain the current system's video settings.
- isAutotestReturns true if game was started with autotest parameter
- isFilePatchingEnabledReturns true if file patching is enabled otherwise false
- isGameFocusedReturns the state of game focus changed by pressing <kbd>ALT</kbd>+<kbd>TAB</kbd> or similar action.
- isGamePausedReturns the state of game simulation. Simulation can get paused by pressing <kbd>Alt</kbd>+<kbd>Tab</kbd> or a system dialog opening (e.g.…
- isPiPEnabledReturns whether Picture-In-Picture video option (Render to Texture) is enabled or not.
- isStreamFriendlyUIEnabledReturns the status of STREAM FRIENDLY UI setting in UI (OPTIONS >> GAME >> GENERAL >> STREAM FRIENDLY UI).
- keyImageReturns a structured text, containing an image or name (if no image is found) of the button, on the keyboard, mouse or joystick, with the given code.
- keyNameReturns the name of a button with extra quotation marks (on the keyboard, mouse or joystick) with the given code.
- languageReturns current game language.
- libraryCreditsReturns the credits for the libraries used by the game.
- libraryDisclaimersReturns the library disclaimers.
- openSteamAppOpens a Steam application, returns false if it was not possible to run the application.
- openYoutubeVideoOpens Steam overlay with given YT video. Video URL is the end part of the YT URL, starting with watch?v=....
- playMissionThe mission is launched (from the main menu).
- playScriptedMissionLoad the given world, launch an empty mission, and execute the given expression. If provided, *config* can reference to the config entry, replacing…
- preprocessFileReads and processes the content of the specified file. Preprocessor is C-like, supports comments using `//` or `/*` and `- /` and PreProcessor…
- preprocessFileLineNumbersReturns the preprocessed content of the given file. The preprocessor is C-like, it supports comments using /* */ and PreProcessor Commands.
- productVersionReturns the product's friendly name, identifier, version and build number.
- profileNameReturns currently chosen user profile name. For Steam profile name see profileNameSteam.
- profileNameSteamReturns name of the current Steam profile. For currently chosen user profile name see profileName
- progressLoadingScreenIf loading screen is shown, sets progress bar to the given value (interval is from 0 to 1]).
- requiredVersionCheck if version of application is available. If the current version is older than the required one, a warning message is shown and false is returned.
- reversedMouseYReturns true if mouse vertical axe is inverted.
- runInitScriptFades in mission screen and re-executes init.sqf and init.sqs scripts. In Eden Editor the code inside the "Init" mission attribute is executed.
- saveJoysticksSaves joysticks key mappings into the joysticks.cfg file. Engine add these joysticks to the Joystick Scheme mapping dialog in options controls…
- screenshotTakes a screenshot of the 3D scene and saves it to the provided filename. - Only the 3D scene is captured, no GUI/cursor - Sampling is taken in…
- setArmoryPointsStores passed number into [USERNAME].ArmaXProfile file, where it assigns it as a value to *armoryPoints* entry. If entry doesn't exist, it is created.
- setDetailMapBlendParsSets the detail texture map blend pars. Allows for smooth transition between detailed and undetailed terrain texture at distance.
- setFSMVariableSet variable to given value in the variable space of given FSM.
- setHorizonParallaxCoefSets coef used to shift horizon position based on camera height (use 0 to disable shifting).
- setMissionOptionsSets various mission options. The options are automatically reset between missions and are saved/restored with the save system.
- setObjectViewDistanceSets the rendering distance of objects and shadows.
- setPiPViewDistanceSet the PiP (Picture-in-Picture) view distance. This has no impact if PiP is disabled (see isPiPEnabled).
- setShadowDistanceSets the shadows rendering distance.
- setStatValueSets a value to a given stat.
- setSystemOfUnitsSet system of units. This will only impact gauges from advanced flight model.
- setTerrainGridSets the desired terrain resolution in meters.
- setViewDistanceSet rendering distance. Setting view distance to <= 0 resets the value to the client's options (set in `Options → Video → General → Visibility →…
- squadParamsReturns data about squad of given unit loaded from squad.xml as well as the unit itself.
- startLoadingScreenShows loading screen with the given text, using the given resource. While loading screen is shown, simulation and scene drawing is disabled, user…
- steamGameRecordingEventTriggers a Steam Timeline event within the Game Recording feature. Read Arma 3: Steam Game Recording for more information and a list of all available…
- supportInfoCreates a list of supported operators and type. Each field of array has the format: "x:name" Where x can be: - 't' - type - 'n' - nullar operator -…
- systemOfUnitsReturns the currently selected system of units. - 0: Metric - 1: Mixed (ground vehicles use Metric / air vehicles use Imperial) - 2: Imperial
- unlockAchievementUnlocks the given achievement. The achievements are listed in CfgAchievements, however none of the currently listed achievements is used in Arma 3,…
- useAIOperMapObstructionTestToggle secondary obstruction test on road paths.
- viewDistanceReturns the rendering distance.