Scripting Commands by Functionality – Category
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
Line 3: | Line 3: | ||
{| class="wikitable sortable" width = "100%" | {| class="wikitable sortable" width = "100%" | ||
|- | |- | ||
! Command Group !! Description !! Examples !! Available for !! Number of Commands !! Checked | ! Command Group !! Description !! Examples !! Available for !! Number of Commands !! Checked that only commands related to the topic of the group are in the category. Column is to be removed later | ||
|- | |- | ||
| style="width: 10%" | [[:Category:Command Group: Animations|Animations]] || Commands used to work with animations. || [[moveTime]], [[animateSource]], [[animate]] || || {{PAGESINCATEGORY:Command Group: Animations|pages}} || <center>{{task/}}</center> | | style="width: 10%" | [[:Category:Command Group: Animations|Animations]] || Commands used to work with animations. || [[moveTime]], [[animateSource]], [[animate]] || || {{PAGESINCATEGORY:Command Group: Animations|pages}} || <center>{{task/}}</center> | ||
Line 21: | Line 21: | ||
| [[:Category:Command Group: Conversations|Conversations]] || bikb, topics, etc.|| [[kbTell]], [[kbWasSaid]]. || || {{PAGESINCATEGORY:Command Group: Conversations|pages}} || <center>{{task/}}</center> | | [[:Category:Command Group: Conversations|Conversations]] || bikb, topics, etc.|| [[kbTell]], [[kbWasSaid]]. || || {{PAGESINCATEGORY:Command Group: Conversations|pages}} || <center>{{task/}}</center> | ||
|- | |- | ||
| [[:Category:Command Group: Custom Panels|Custom Panels]] || Commands to handle [[Arma 3 Custom Info|custom panels]]. || [[infoPanel]], [[setInfoPanel]], [[enableInfoPanelComponent]] || {{arma3}} || {{PAGESINCATEGORY:Command Group: Custom Panels|pages}} | | [[:Category:Command Group: Custom Panels|Custom Panels]] || Commands to handle [[Arma 3 Custom Info|custom panels]]. || [[infoPanel]], [[setInfoPanel]], [[enableInfoPanelComponent]] || {{arma3}} || {{PAGESINCATEGORY:Command Group: Custom Panels|pages}} || <center>{{task/}}</center> | ||
|- | |- | ||
| [[:Category:Command Group: Diagnosis|Diagnosis (Diag)]] || Commands helpful for diagnosing issues. || [[diag_log]], [[diag_fpsMin]], [[diag_deltaTime]] || || {{PAGESINCATEGORY:Command Group: Diagnosis|pages}} | | [[:Category:Command Group: Diagnosis|Diagnosis (Diag)]] || Commands helpful for diagnosing issues. || [[diag_log]], [[diag_fpsMin]], [[diag_deltaTime]] || || {{PAGESINCATEGORY:Command Group: Diagnosis|pages}} || <center>{{task/}}</center> | ||
|- | |- | ||
| [[:Category:Command Group: Difficulty|Difficulty]] || Commands to change the difficulty of the game. || [[disableMapIndicators]], [[difficulty]], [[difficultyOption]] || || {{PAGESINCATEGORY:Command Group: Difficulty|pages}} | | [[:Category:Command Group: Difficulty|Difficulty]] || Commands to change the difficulty of the game. || [[disableMapIndicators]], [[difficulty]], [[difficultyOption]] || || {{PAGESINCATEGORY:Command Group: Difficulty|pages}} || <center>{{task/}}</center> | ||
|- | |- | ||
| [[:Category:Command Group: DLC|DLC]] || DLC related commands. || [[getDLCs]], [[getObjectDLC]], [[isDLCAvailable]] || {{arma3}} || {{PAGESINCATEGORY:Command Group: DLC|pages}} | | [[:Category:Command Group: DLC|DLC]] || DLC related commands. || [[getDLCs]], [[getObjectDLC]], [[isDLCAvailable]] || {{arma3}} || {{PAGESINCATEGORY:Command Group: DLC|pages}} || <center>{{task/}}</center> | ||
|- | |- | ||
| [[:Category:Command Group: Dynamic Simulation|Dynamic Simulation]] || Commands related to [[Arma 3 Dynamic Simulation]]. || [[enableDynamicSimulationSystem]], [[setDynamicSimulationDistance]] || {{arma3}} || {{PAGESINCATEGORY:Command Group: Dynamic Simulation|pages}} | | [[:Category:Command Group: Dynamic Simulation|Dynamic Simulation]] || Commands related to [[Arma 3 Dynamic Simulation]]. || [[enableDynamicSimulationSystem]], [[setDynamicSimulationDistance]] || {{arma3}} || {{PAGESINCATEGORY:Command Group: Dynamic Simulation|pages}} || <center>{{task/}}</center> | ||
|- | |- | ||
| [[:Category:Command Group: Eden Editor|Eden Editor]] || Commands to work with [[Eden Editor]]. || [[get3DENCamera]], [[add3DENEventHandler]], [[get3DENSelected]] || {{arma3}} || {{PAGESINCATEGORY:Command Group: Eden Editor|pages}} | | [[:Category:Command Group: Eden Editor|Eden Editor]] || Commands to work with [[Eden Editor]]. || [[get3DENCamera]], [[add3DENEventHandler]], [[get3DENSelected]] || {{arma3}} || {{PAGESINCATEGORY:Command Group: Eden Editor|pages}} || <center>{{task/}}</center> | ||
|- | |- | ||
| [[:Category:Command Group: Environment|Environment]] || Commands to manipulate the weather, time, date or traffic. || [[setFog]], [[setRain]], [[date]] || || {{PAGESINCATEGORY:Command Group: Environment|pages}} | | [[:Category:Command Group: Environment|Environment]] || Commands to manipulate the weather, time, date or traffic. || [[setFog]], [[setRain]], [[date]] || || {{PAGESINCATEGORY:Command Group: Environment|pages}} | ||
|- | |- | ||
| [[:Category:Command Group: Event Handlers|Event Handlers]] || Set, define and use Event Handlers. || [[addEventHandler]] || || {{PAGESINCATEGORY:Command Group: Event Handlers|pages}} | | [[:Category:Command Group: Event Handlers|Event Handlers]] || Set, define and use Event Handlers. || [[addEventHandler]] || || {{PAGESINCATEGORY:Command Group: Event Handlers|pages}} || <center>{{task/}}</center> | ||
|- | |- | ||
| [[:Category:Command Group: Flags|Flags]] || Commands that are used to work with flags. || [[setFlagOwner]], [[flagOwner]], [[flagSide]] || || {{PAGESINCATEGORY:Command Group: Flags|pages}} | | [[:Category:Command Group: Flags|Flags]] || Commands that are used to work with flags. || [[setFlagOwner]], [[flagOwner]], [[flagSide]] || || {{PAGESINCATEGORY:Command Group: Flags|pages}} |
Revision as of 10:37, 25 September 2020
Command Group | Description | Examples | Available for | Number of Commands | Checked that only commands related to the topic of the group are in the category. Column is to be removed later |
---|---|---|---|---|---|
Animations | Commands used to work with animations. | moveTime, animateSource, animate | 28 | ||
Artillery | All commands related to artilleries. | commandArtilleryFire, getArtilleryAmmo, inRangeOfArtillery | 8 | ||
Briefing | Objectives, tasks and notes. | createSimpleTask, setTaskState, createDiaryRecord | 63 | ||
Broken Commands | Commands that don't work as intended or are not implemented at all. | - | 37 | ||
Camera Control | Commands to manipulate the camera for intros, outros and cut-scenes. See also Camera Tutorial. Commands related to Eden Editor and Zeus camera are not listed here. See Command Group: Eden Editor and Command Group: Curator. | camCreate, camSetDir | 67 | ||
Config | Commands for working with configs. | configFile, >>, configProperties | 28 | ||
Containers | Commands related to containers like backpacks and vests. | vest, canAdd, backpack | 46 | ||
Conversations | bikb, topics, etc. | kbTell, kbWasSaid. | 8 | ||
Custom Panels | Commands to handle custom panels. | infoPanel, setInfoPanel, enableInfoPanelComponent | Arma 3 | 8 | |
Diagnosis (Diag) | Commands helpful for diagnosing issues. | diag_log, diag_fpsMin, diag_deltaTime | 0 | ||
Difficulty | Commands to change the difficulty of the game. | disableMapIndicators, difficulty, difficultyOption | 11 | ||
DLC | DLC related commands. | getDLCs, getObjectDLC, isDLCAvailable | Arma 3 | 11 | |
Dynamic Simulation | Commands related to Arma 3 Dynamic Simulation. | enableDynamicSimulationSystem, setDynamicSimulationDistance | Arma 3 | 12 | |
Eden Editor | Commands to work with Eden Editor. | get3DENCamera, add3DENEventHandler, get3DENSelected | Arma 3 | 56 | |
Environment | Commands to manipulate the weather, time, date or traffic. | setFog, setRain, date | 66 | ||
Event Handlers | Set, define and use Event Handlers. | addEventHandler | 48 | ||
Flags | Commands that are used to work with flags. | setFlagOwner, flagOwner, flagSide | 11 | ||
Game 2 Editor | Commands related to the Game 2 Editor (Not implemented). | insertEditorObject, updateObjectTree, fromEditor | Not available | 57 | |
Geometry | Commands closely related to geometry. | intersect, distance, distance2D | Not available | 0 | |
Groups | Read and set group properties. | formation, group, setFormation | 50 | ||
GUI Control | Customize the look of dialogs and menus in the game. | buttonAction, ctrlCreate, ctrlSetText | 126 | ||
High Command | Commands for high command. | hcAllGroups, onHCGroupSelectionChanged | 27 | ||
Interaction | On-screen messages, dialogs, menus. | hint, titleText, showGPS | 64 | ||
LeaderBoards | Leader board related scripting commands. | leaderboardDeInit, leaderboardGetRows, leaderboardInit | Arma 3 | 9 | |
Lights | Create, enable light sources on vehicles, terrain objects or lightpoints. | setLightColor, setPilotLight, enableGunLights | 30 | ||
Locations | Create, define, use and manipulate locations. | nearestLocation, createLocation, setSize | 31 | ||
Map | Commands to work with the map. | forceMap, mapGridPosition | 14 | ||
Markers | Set, define and use markers. | createMarker, getMarkerType, setMarkerPos | 49 | ||
Math | General math related commands. Also see Command Group: Geometry and Command Group: Vectors. | abs, +, min | 40 | ||
Mission Information | Read and set parameters for the current mission. | addRating, forceEnd, score | 40 | ||
Mods and Addons | Commands that are used to get information about mods and addons. | configSourceModList, configSourceMod, addonFiles | 11 | ||
Multiplayer | Commands that are specific to Multiplayer games. | remoteExec, remoteExecCall, didJIP | 78 | ||
Object Detection | Commands used to find certain objects. | allUnits, nearestObjects, cursorTarget | 42 | ||
Object Information | Find out things about your troops and other objects. | alive, canMove, damage | 0 | ||
Object Manipulation | Create and define troops and other objects. | createVehicle, setBehaviour, setDamage | 273 | ||
Particles | Commands for working with particles. | drop, particlesQuality | 8 | ||
Performance Logging | Performance debug and logs. | diag_captureFrame, logEntities | 0 | ||
Pilot Camera | Commands used to control a vehicles' pilotCamera. | getPilotCameraTarget, hasPilotCamera | Arma 3 | 10 | |
Positions | Commands that work with positions. | getPos, setPos, position | 49 | ||
Program Flow | Commands to define loops, conditions, and jumps inside scripts. | forEach, execVM, for | 49 | ||
Radio and Chat | Control radio and chat availability and messages. | enableRadio, systemChat, vehicleRadio | 0 | ||
Remote Control | Manipulate and connect to UAVs or remote control units. | unitIsUAV, connectTerminalToUAV, remoteControl | 21 | ||
Render Time Scope | These scripting commands work in render time scope rather than simulation time scope. | getDirVisual, getPosVisual, visiblePosition | 17 | ||
Roads and Airports | All commands related to roads and airports. | allAirports, roadAt | 10 | ||
Ropes and Sling Loading | Attach and detach ropes to objects, slingload and drop them. | enableRopeAttach, getSlingLoad, ropes | Arma 3 | 23 | |
RTD | Commands related to the Arma 3 Advanced Helicopter Flight Model. | collectiveRTD, isObjectRTD, throttleRTD | Arma 3, Take On Helicopters | 46 | |
Sensors | Commands to work with Arma 3 Sensors | setVehicleReceiveRemoteTargets, vehicleReportRemoteTargets | Arma 3 | 18 | |
Sides | Read and set unit affiliations. | side, friendly, countEnemy | 38 | ||
Sounds | Control in-game sounds. | fadeMusic, playSound, say | 63 | ||
Stamina System | Commands related to units stamina and fatigue. See Arma 3 Stamina. | getStamina, setStamina | Only Arma 3 except for forceWalk and isForcedWalk. |
21 | |
Strings | Commands to work with strings. | in, toLower, toUpper | 43 | ||
System | Commands that deal with the game as a whole. | benchmark, saveGame, loadGame | 86 | ||
Team Switch | Everything to do with the Team Switch feature. | enableTeamSwitch, onTeamSwitch, teamSwitch | 8 | ||
Teams | Commands used to work with teams and team members. | createTeam, members | 22 | ||
Time | Commands related to in-game time or system time. | systemTimeUTC, accTime, timeMultiplier | 14 | ||
Triggers | Set, define and use Triggers and Event Handlers. | createTrigger, setTriggerArea, trigger | 33 | ||
Turrets | Commands which work with turrets. | turretLocal, addMagazineTurret, addWeaponTurret | 31 | ||
Uncategorised | Commands which have no defined category. | - | 0 | ||
Unit Control | Controls the behaviour of your troops. | action, doMove, setHideBehind | 81 | ||
Unit Identity | Commands used to change a unit's identity such as rank, voice and name. | setFace, name, setUnitRank | 20 | ||
Unit Inventory | Commands related to an unit's inventory. For working with weapons and magazines, also see Command Group Weapons. | loadUniform, assignItem, addGoggles | 127 | ||
Variables | Commands to handle arrays and other variables. | setVariable, format, isNull | 62 | ||
Vectors | Commands which work with vectors. | vectorAdd, vectorMultiply, vectorUpVisual | 0 | ||
Vehicle Assignment | Vehicle related commands. | vehicles, moveInDriver, allowGetIn | 0 | ||
Vehicle in Vehicle Transport. | Commands related to Arma 3 Vehicle in Vehicle Transport. | canVehicleCargo, vehicleCargoEnabled | Arma 3 | 6 | |
Vehicle Loadout | Arma 3 Vehicle Loadouts related commands. | getCompatiblePylonMagazines, getPylonMagazines | Arma 3 | 9 | |
Waypoints | Commands to handle waypoints. | addWaypoint, setWaypointPosition, deleteWaypoint | 63 | ||
Weapon Pool | The Weapon Pool enables the player to use weapons from one mission in others. | addMagazinePool, fillWeaponsFromPool, queryMagazinePool | 14 | ||
Weapons | Weapon related commands. | addMagazine, primaryWeapon, weapons | 52 | ||
Zeus (Curator) | Setting up Zeus rules and interface. | allCurators, assignCurator, curatorAddons | Arma 3 | 44 |
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)