Scripting Commands by Functionality – Category
Jump to navigation
Jump to search
mNo edit summary |
m (sorted table) |
||
| Line 2: | Line 2: | ||
|- | |- | ||
! Command Group !! Description !! Example Commands !! Only Available for | ! Command Group !! Description !! Example Commands !! Only Available for | ||
|- | |||
| [[:Category:Command Group: Animations|Animations]] || Commands used to work with animations || [[moveTime]], [[animateSource]], [[animate]] || | |||
|- | |- | ||
| [[:Category:Command Group: Briefing|Briefing]] || Objectives, tasks and notes. || [[createSimpleTask]], [[setTaskState]], [[createDiaryRecord]] || | | [[:Category:Command Group: Briefing|Briefing]] || Objectives, tasks and notes. || [[createSimpleTask]], [[setTaskState]], [[createDiaryRecord]] || | ||
|- | |||
| [[:Category:Command Group: Broken Commands|Broken Commands]] || Commands that don't work as intended or are not implemented at all || - || | |||
|- | |- | ||
| [[:Category:Command Group: Camera Control|Camera Control]] || Camera functions for intros, outros and cut-scenes. || [[camCreate]], [[camSetDir]] || | | [[:Category:Command Group: Camera Control|Camera Control]] || Camera functions for intros, outros and cut-scenes. || [[camCreate]], [[camSetDir]] || | ||
| Line 18: | Line 22: | ||
|- | |- | ||
| [[:Category:Command Group: Diagnosis|Diagnosis (Diag)]] || Commands helpful for diagnosing issues || [[diag_log]], [[diag_fpsMin]], [[diag_deltaTime]] || | | [[:Category:Command Group: Diagnosis|Diagnosis (Diag)]] || Commands helpful for diagnosing issues || [[diag_log]], [[diag_fpsMin]], [[diag_deltaTime]] || | ||
|- | |||
| [[:Category:Command Group: Dynamic Simulation|Dynamic Simulation]] || Commands related to [[Arma 3 Dynamic Simulation]]. || [[enableDynamicSimulationSystem]], [[setPos]], [[setDynamicSimulationDistance]] || {{arma3}} | |||
|- | |- | ||
| [[:Category:Command Group: DLC|DLC]] || DLC related commands || [[getDLCs]], [[getObjectDLC]], [[isDLCAvailable]] || {{arma3}} | | [[:Category:Command Group: DLC|DLC]] || DLC related commands || [[getDLCs]], [[getObjectDLC]], [[isDLCAvailable]] || {{arma3}} | ||
| Line 28: | Line 34: | ||
|- | |- | ||
| [[:Category:Command Group: Event Handlers|Event Handlers]] || Set, define and use Event Handlers || [[addEventHandler]] || | | [[:Category:Command Group: Event Handlers|Event Handlers]] || Set, define and use Event Handlers || [[addEventHandler]] || | ||
|- | |||
| [[:Category:Command Group: Flags|Flags]] || Commands that are used to work with flags || [[setFlagOwner]], [[flagOwner]], [[flagSide]] || | |||
|- | |- | ||
| [[:Category:Command Group: Groups|Groups]] || Read and set group properties || [[formation]], [[group]], [[setFormation]] || | | [[:Category:Command Group: Groups|Groups]] || Read and set group properties || [[formation]], [[group]], [[setFormation]] || | ||
| Line 34: | Line 42: | ||
|- | |- | ||
| [[:Category:Command Group: Interaction|Interaction]] || On-screen messages, dialogs, menus. || [[hint]], [[titleText]], [[showGPS]] || | | [[:Category:Command Group: Interaction|Interaction]] || On-screen messages, dialogs, menus. || [[hint]], [[titleText]], [[showGPS]] || | ||
|- | |||
| [[:Category:Command Group: LeaderBoards|LeaderBoards]] || Leader board related scripting commands. || [[leaderboardDeInit]], [[leaderboardGetRows]], [[leaderboardInit]] || {{arma3}} | |||
|- | |- | ||
| [[:Category:Command Group: Lights|Lights]] || Create, enable light sources on vehicles, terrain objects or lightpoints. || [[setLightColor]], [[setPilotLight]], [[enableGunLights]] || | | [[:Category:Command Group: Lights|Lights]] || Create, enable light sources on vehicles, terrain objects or lightpoints. || [[setLightColor]], [[setPilotLight]], [[enableGunLights]] || | ||
| Line 54: | Line 64: | ||
|- | |- | ||
| [[:Category:Command Group: Performance Logging|Performance Logging]] || Performance debug and logs. || [[diag_captureFrame]], [[logEntities]] || | | [[:Category:Command Group: Performance Logging|Performance Logging]] || Performance debug and logs. || [[diag_captureFrame]], [[logEntities]] || | ||
|- | |||
| [[:Category:Command Group: Positions|Positions]] || Commands that work with positions. || [[getPos]], [[setPos]], [[position]] || | |||
|- | |- | ||
| [[:Category:Command Group: Program Flow|Program Flow]] || Commands to define loops, conditions, and jumps inside scripts. || [[forEach]], [[execVM]], [[for]] || | | [[:Category:Command Group: Program Flow|Program Flow]] || Commands to define loops, conditions, and jumps inside scripts. || [[forEach]], [[execVM]], [[for]] || | ||
| Line 60: | Line 72: | ||
|- | |- | ||
| [[:Category:Command Group: Remote Control|Remote Control]] || Manipulate and connect to UAVs or remote control units. || [[unitIsUAV]], [[connectTerminalToUAV]], [[remoteControl]] || | | [[:Category:Command Group: Remote Control|Remote Control]] || Manipulate and connect to UAVs or remote control units. || [[unitIsUAV]], [[connectTerminalToUAV]], [[remoteControl]] || | ||
|- | |||
| [[:Category:Command Group: Render Time Scope|Render Time Scope]] || These scripting commands work in render time scope rather than simulation time scope. || [[getDirVisual]], [[getPosVisual]], [[visiblePosition]] || | |||
|- | |- | ||
| [[:Category:Command Group: Ropes and Sling Loading|Ropes and Sling Loading]] || Attach and detach ropes to objects, slingload and drop them. || [[enableRopeAttach]], [[getSlingLoad]], [[ropes]] || {{arma3}} | | [[:Category:Command Group: Ropes and Sling Loading|Ropes and Sling Loading]] || Attach and detach ropes to objects, slingload and drop them. || [[enableRopeAttach]], [[getSlingLoad]], [[ropes]] || {{arma3}} | ||
|- | |- | ||
| [[:Category:Command Group: Sides|Sides]] || Read and set unit affiliations. || [[side]], [[friendly]], [[countEnemy]] || | | [[:Category:Command Group: Sides|Sides]] || Read and set unit affiliations. || [[side]], [[friendly]], [[countEnemy]] || | ||
|- | |||
| [[:Category:Command Group: RTD|RTD]] || Commands related to the [[Arma 3 Advanced Helicopter Flight Model]]. || [[collectiveRTD]], [[isObjectRTD]], [[throttleRTD]] || {{arma3}}, {{tkoh}} | |||
|- | |- | ||
| [[:Category:Command Group: Sounds|Sounds]] || Control in-game sounds. || [[fadeMusic]], [[playSound]], [[say]] || | | [[:Category:Command Group: Sounds|Sounds]] || Control in-game sounds. || [[fadeMusic]], [[playSound]], [[say]] || | ||
| Line 74: | Line 90: | ||
|- | |- | ||
| [[:Category:Command Group: Triggers|Triggers]] || Set, define and use Triggers and Event Handlers. || [[createTrigger]], [[setTriggerArea]], [[trigger]] || | | [[:Category:Command Group: Triggers|Triggers]] || Set, define and use Triggers and Event Handlers. || [[createTrigger]], [[setTriggerArea]], [[trigger]] || | ||
|- | |||
| [[:Category:Command Group: Uncategorised|Uncategorised]] || Commands which have no defined category || - || | |||
|- | |- | ||
| [[:Category:Command Group: Unit Control|Unit Control]] || Controls the behaviour of your troops. || [[action]], [[doMove]], [[setHideBehind]] || | | [[:Category:Command Group: Unit Control|Unit Control]] || Controls the behaviour of your troops. || [[action]], [[doMove]], [[setHideBehind]] || | ||
|- | |- | ||
| [[:Category:Command Group: Variables|Variables]] || Commands to handle arrays and other variables. || [[setVariable]], [[format]], [[isNull]] || | | [[:Category:Command Group: Variables|Variables]] || Commands to handle arrays and other variables. || [[setVariable]], [[format]], [[isNull]] || | ||
|- | |||
| [[:Category:Command Group: Vectors|Vectors]] || Commands which work with vectors. || [[vectorAdd]], [[vectorMultiply]], [[vectorUpVisual]] || | |||
|- | |- | ||
| [[:Category:Command Group: Vehicle Assignment|Vehicle Assignment]] || Vehicle related commands. || [[vehicles]], [[moveInDriver]], [[allowGetIn]] || | | [[:Category:Command Group: Vehicle Assignment|Vehicle Assignment]] || Vehicle related commands. || [[vehicles]], [[moveInDriver]], [[allowGetIn]] || | ||
| Line 89: | Line 109: | ||
| [[:Category:Command Group: Weapons|Weapons]] || Weapon related commands. || [[addMagazine]], [[primaryWeapon]], [[weapons]] || | | [[:Category:Command Group: Weapons|Weapons]] || Weapon related commands. || [[addMagazine]], [[primaryWeapon]], [[weapons]] || | ||
|- | |- | ||
[[Category:Scripting_Topics]] | [[Category:Scripting_Topics]] | ||
[[Category:Scripting Commands Arma 3]] | [[Category:Scripting Commands Arma 3]] | ||
Revision as of 08:25, 16 September 2020
| Command Group | Description | Example Commands | Only Available for |
|---|---|---|---|
| Animations | Commands used to work with animations | moveTime, animateSource, animate | |
| Briefing | Objectives, tasks and notes. | createSimpleTask, setTaskState, createDiaryRecord | |
| Broken Commands | Commands that don't work as intended or are not implemented at all | - | |
| Camera Control | Camera functions for intros, outros and cut-scenes. | camCreate, camSetDir | |
| Config | Commands for working with configs. | configFile, >>, configProperties | |
| Containers | Commands related to containers like backpacks and vests. | vest, canAdd, backpack | |
| Conversations | bikb, topics, etc. | kbTell, kbWasSaid | |
| Zeus (Curator) | Setting up Zeus rules and interface | allCurators, assignCurator, curatorAddons | Arma 3 |
| Custom Panels | Commands to handle custom panels | infoPanel, setInfoPanel, enableInfoPanelComponent | Arma 3 |
| Diagnosis (Diag) | Commands helpful for diagnosing issues | diag_log, diag_fpsMin, diag_deltaTime | |
| Dynamic Simulation | Commands related to Arma 3 Dynamic Simulation. | enableDynamicSimulationSystem, setPos, setDynamicSimulationDistance | Arma 3 |
| DLC | DLC related commands | getDLCs, getObjectDLC, isDLCAvailable | Arma 3 |
| Eden Editor | Commands to work with Eden Editor | get3DENCamera, add3DENEventHandler, get3DENSelected | Arma 3 |
| Editor Control | Commands related to the game 2 editor (Not implemented) | insertEditorObject, updateObjectTree, fromEditor | Not available |
| Environment | Control the environment like weather, time or date | setFog, setRain, date | |
| Event Handlers | Set, define and use Event Handlers | addEventHandler | |
| Flags | Commands that are used to work with flags | setFlagOwner, flagOwner, flagSide | |
| Groups | Read and set group properties | formation, group, setFormation | |
| GUI Control | Customize the look of dialogs and menus in the game. | buttonAction, ctrlCreate, ctrlSetText | |
| Interaction | On-screen messages, dialogs, menus. | hint, titleText, showGPS | |
| LeaderBoards | Leader board related scripting commands. | leaderboardDeInit, leaderboardGetRows, leaderboardInit | Arma 3 |
| Lights | Create, enable light sources on vehicles, terrain objects or lightpoints. | setLightColor, setPilotLight, enableGunLights | |
| Locations | Create, define, use and manipulate locations. | nearestLocation, createLocation, setSize | |
| Markers | Set, define and use markers. | createMarker, getMarkerType, setMarkerPos | |
| Math | Boolean, basic math and trigonometry functions. | abs, atan, vectorAdd | |
| Mission Information | Read and set parameters for the current mission. | addRating, forceEnd, score | |
| Mods and Addons | Commands that are used to get information about mods and addons. | configSourceModList, configSourceMod, addonFiles | |
| Multiplayer | Commands that are specific to Multiplayer games. | remoteExec, remoteExecCall, didJIP | |
| Object Information | Find out things about your troops and other objects. | alive, canMove, damage | |
| Object Manipulation | Create and define troops and other objects. | createVehicle, setBehaviour, setDamage | |
| Performance Logging | Performance debug and logs. | diag_captureFrame, logEntities | |
| Positions | Commands that work with positions. | getPos, setPos, position | |
| Program Flow | Commands to define loops, conditions, and jumps inside scripts. | forEach, execVM, for | |
| Radio Control | Control radio availability and messages. | enableRadio, systemChat, vehicleRadio | |
| Remote Control | Manipulate and connect to UAVs or remote control units. | unitIsUAV, connectTerminalToUAV, remoteControl | |
| Render Time Scope | These scripting commands work in render time scope rather than simulation time scope. | getDirVisual, getPosVisual, visiblePosition | |
| Ropes and Sling Loading | Attach and detach ropes to objects, slingload and drop them. | enableRopeAttach, getSlingLoad, ropes | Arma 3 |
| Sides | Read and set unit affiliations. | side, friendly, countEnemy | |
| RTD | Commands related to the Arma 3 Advanced Helicopter Flight Model. | collectiveRTD, isObjectRTD, throttleRTD | Arma 3, Take On Helicopters |
| Sounds | Control in-game sounds. | fadeMusic, playSound, say | |
| System | Commands that deal with the game as a whole. | benchmark, saveGame, loadGame | |
| Team Switch | Everything to do with the Team Switch feature. | enableTeamSwitch, onTeamSwitch, teamSwitch | |
| Time | Commands related to in-game time or system time. | systemTimeUTC, accTime, timeMultiplier | |
| Triggers | Set, define and use Triggers and Event Handlers. | createTrigger, setTriggerArea, trigger | |
| Uncategorised | Commands which have no defined category | - | |
| Unit Control | Controls the behaviour of your troops. | action, doMove, setHideBehind | |
| Variables | Commands to handle arrays and other variables. | setVariable, format, isNull | |
| Vectors | Commands which work with vectors. | vectorAdd, vectorMultiply, vectorUpVisual | |
| Vehicle Assignment | Vehicle related commands. | vehicles, moveInDriver, allowGetIn | |
| Vehicle Loadout | Arma 3 Vehicle Loadouts related commands. | getCompatiblePylonMagazines, getPylonMagazines | Arma 3 |
| Waypoints | Commands to handle waypoints. | addWaypoint, setWaypointPosition, deleteWaypoint | |
| Weapon Pool | The Weapon Pool enables the player to use weapons from one mission in others. | addMagazinePool, fillWeaponsFromPool, queryMagazinePool | |
| Weapons | Weapon related commands. | addMagazine, primaryWeapon, weapons |
Subcategories
This category has the following 73 subcategories, out of 73 total.
C
- Command Group: AI Behaviour (22 P)
- Command Group: Animations (28 P)
- Command Group: Argo (18 P)
- Command Group: Arrays (36 P)
- Command Group: Artillery (8 P)
- Command Group: Briefing (63 P)
- Command Group: Broken Commands (37 P)
- Command Group: Camera Control (67 P)
- Command Group: Config (28 P)
- Command Group: Containers (46 P)
- Command Group: Conversations (8 P)
- Command Group: Curator (44 P)
- Command Group: Custom Panels (8 P)
- Command Group: Diagnostic (52 P)
- Command Group: Difficulty (11 P)
- Command Group: Eden Editor (56 P)
- Command Group: Environment (66 P)
- Command Group: Event Handlers (48 P)
- Command Group: Flags (11 P)
- Command Group: Game 2 Editor (57 P)
- Command Group: Groups (50 P)
- Command Group: HashMap (19 P)
- Command Group: High Command (27 P)
- Command Group: Interaction (64 P)
- Command Group: Leaderboards (9 P)
- Command Group: Lights (30 P)
- Command Group: Localization (5 P)
- Command Group: Locations (31 P)
- Command Group: Map (14 P)
- Command Group: Markers (49 P)
- Command Group: Mines (10 P)
- Command Group: Mods and Addons (11 P)
- Command Group: Multiplayer (78 P)
- Command Group: Namespaces (16 P)
- Command Group: Object Detection (42 P)
- Command Group: Object Manipulation (273 P)
- Command Group: Particles (8 P)
- Command Group: Pilot Camera (10 P)
- Command Group: Positions (49 P)
- Command Group: Program Flow (49 P)
- Command Group: Remote Control (21 P)
- Command Group: Render Time Scope (17 P)
- Command Group: RTD (46 P)
- Command Group: Sensors (18 P)
- Command Group: Sides (38 P)
- Command Group: Sounds (63 P)
- Command Group: Stamina System (21 P)
- Command Group: Structured Text (11 P)
- Command Group: System (86 P)
- Command Group: Team Switch (8 P)
- Command Group: Teams (22 P)
- Command Group: Time (14 P)
- Command Group: Triggers (33 P)
- Command Group: Turrets (31 P)
- Command Group: Uncategorised (empty)
- Command Group: Unit Control (81 P)
- Command Group: Unit Identity (20 P)
- Command Group: Unit Inventory (127 P)
- Command Group: Variables (62 P)
- Command Group: Vehicle Inventory (38 P)
- Command Group: Waypoints (63 P)
- Command Group: Weapon Pool (14 P)
- Command Group: Weapons (52 P)