Scripting Commands by Functionality – Category

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Removed redirect to Scripting Commands by Functionality)
Tag: Removed redirect
Line 1: Line 1:
#REDIRECT [[Scripting Commands by Functionality]]
{| class="wikitable sortable" width = "100%"
|-
! Command Group !! Description !! Example Commands !! Only Available for
|-
| [[:Category:Command Group: Briefing|Briefing]] || Objectives, tasks and notes. || [[createSimpleTask]], [[setTaskState]], [[createDiaryRecord]] ||
|-
| [[:Category:Command Group: Camera Control|Camera Control]] || Camera functions for intros, outros and cut-scenes. || [[camCreate]], [[camSetDir]] ||
|-
| [[:Category:Command Group: Config|Config]] || Commands for working with configs. || [[configFile]], [[config greater greater name|>>]], [[configProperties]] ||
|-
| [[:Category:Command Group: Containers|Containers]] || Commands related to containers like backpacks and vests. || [[vest]], [[canAdd]], [[backpack]] ||
|-
| [[:Category:Command Group: Conversations|Conversations]] || bikb, topics, etc.|| [[kbTell]], [[kbWasSaid]] ||
|-
| [[:Category:Command Group: Curator|Zeus (Curator)]] || Setting up [[Arma 3 Curator|Zeus]] rules and interface || [[allCurators]], [[assignCurator]], [[curatorAddons]] || {{arma3}}
|-
| [[:Category:Command Group: Custom Panels|Custom Panels]] || Commands to handle [[Arma 3 Custom Info|custom panels]] || [[infoPanel]], [[setInfoPanel]], [[enableInfoPanelComponent]] || {{arma3}}
|-
| [[:Category:Command Group: Diagnosis|Diagnosis (Diag)]] || Commands helpful for diagnosing issues || [[diag_log]], [[diag_fpsMin]], [[diag_deltaTime]] ||
|-
| [[:Category:Command Group: DLC|DLC]] || DLC related commands || [[getDLCs]], [[getObjectDLC]], [[isDLCAvailable]] || {{arma3}}
|-
| [[:Category:Command Group: Eden Editor|Eden Editor]] || Commands to work with [[Eden Editor]] || [[get3DENCamera]], [[add3DENEventHandler]], [[get3DENSelected]] || {{arma3}}
|-
| [[:Category:Command Group: Editor Control|Editor Control]] || Commands related to the game 2 editor (Not implemented) || [[insertEditorObject]], [[updateObjectTree]], [[fromEditor]] || Not available
|-
| [[:Category:Command Group: Environment|Environment]] || Control the environment like weather, time or date || [[setFog]], [[setRain]], [[date]] ||
|-
| [[:Category:Command Group: Event Handlers|Event Handlers]] || Set, define and use Event Handlers || [[addEventHandler]] ||
|-
| [[:Category:Command Group: Groups|Groups]] || Read and set group properties || [[formation]], [[group]], [[setFormation]] ||
|-
| [[:Category:Command Group: GUI Control|GUI Control]] || Customize the look of dialogs and menus in the game. || [[buttonAction]], [[ctrlCreate]], [[ctrlSetText]] ||
|-
| [[:Category:Command Group: Interaction|Interaction]] || On-screen messages, dialogs, menus. || [[hint]], [[titleText]], [[showGPS]] ||
|-
| [[:Category:Command Group: Lights|Lights]] || Create, enable light sources on vehicles, terrain objects or lightpoints. || [[setLightColor]], [[setPilotLight]], [[enableGunLights]] ||
|-
| [[:Category:Command Group: Locations|Locations]] || Create, define, use and manipulate locations. || [[nearestLocation]], [[createLocation]], [[setSize]] ||
|-
| [[:Category:Command Group: Markers|Markers]] || Set, define and use markers. || [[createMarker]], [[getMarkerType]], [[setMarkerPos]] ||
|-
| [[:Category:Command Group: Math|Math]] || Boolean, basic math and trigonometry functions. || [[abs]], [[atan]], [[vectorAdd]] ||
|-
| [[:Category:Command Group: Mission Information|Mission Information]] || Read and set parameters for the current mission. || [[addRating]], [[forceEnd]], [[score]] ||
|-
| [[:Category:Command Group: Mods and Addons|Mods and Addons]] || Commands that are used to get information about mods and addons. || [[configSourceModList]], [[configSourceMod]], [[addonFiles]] ||
|-
| [[:Category:Command Group: Multiplayer|Multiplayer]] || Commands that are specific to Multiplayer games. || [[remoteExec]], [[remoteExecCall]], [[didJIP]] ||
|-
| [[:Category:Command Group: Object Information|Object Information]] || Find out things about your troops and other objects. || [[alive]], [[canMove]], [[damage]] ||
|-
| [[:Category:Command Group: Object Manipulation|Object Manipulation]] || Create and define troops and other objects. || [[createVehicle]], [[setBehaviour]], [[setDamage]] ||
|-
| [[:Category:Command Group: Performance Logging|Performance Logging]] || Performance debug and logs. || [[diag_captureFrame]], [[logEntities]] ||
|-
| [[:Category:Command Group: Program Flow|Program Flow]] || Commands to define loops, conditions, and jumps inside scripts. || [[forEach]], [[execVM]], [[for]] ||
|-
| [[:Category:Command Group: Radio Control|Radio Control]] || Control radio availability and messages. || [[enableRadio]], [[systemChat]], [[vehicleRadio]] ||
|-
| [[:Category:Command Group: Remote Control|Remote Control]] || Manipulate and connect to UAVs or remote control units. || [[unitIsUAV]], [[connectTerminalToUAV]], [[remoteControl]] ||
|-
| [[: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: Sounds|Sounds]] || Control in-game sounds. || [[fadeMusic]], [[playSound]], [[say]] ||
|-
| [[:Category:Command Group: System|System]] || Commands that deal with the game as a whole. || [[benchmark]], [[saveGame]], [[loadGame]] ||
|-
| [[:Category:Command Group: Team Switch|Team Switch]] || Everything to do with the Team Switch feature. || [[enableTeamSwitch]], [[onTeamSwitch]], [[teamSwitch]] ||
|-
| [[:Category:Command Group: Time|Time]] || Commands related to in-game time or system time. || [[systemTimeUTC]], [[accTime]], [[timeMultiplier]] ||
|-
| [[:Category:Command Group: Triggers|Triggers]] || Set, define and use Triggers and Event Handlers. || [[createTrigger]], [[setTriggerArea]], [[trigger]] ||
|-
| [[: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: Vehicle Assignment|Vehicle Assignment]] || Vehicle related commands. || [[vehicles]], [[moveInDriver]], [[allowGetIn]] ||
|-
| [[:Category:Command Group: Vehicle Loadouts|Vehicle Loadout]] || [[Arma 3 Vehicle Loadouts]] related commands. || [[getCompatiblePylonMagazines]], [[getPylonMagazines]] || {{arma3}}
|-
| [[:Category:Command Group: Waypoints|Waypoints]] || Commands to handle waypoints. || [[addWaypoint]], [[setWaypointPosition]], [[deleteWaypoint]] ||
|-
| [[:Category:Command Group: Weapon Pool|Weapon Pool]] || The Weapon Pool enables the player to use weapons from one mission in others. || [[addMagazinePool]], [[fillWeaponsFromPool]], [[queryMagazinePool]] ||
|-
| [[:Category:Command Group: Weapons|Weapons]] || Weapon related commands. || [[addMagazine]], [[primaryWeapon]], [[weapons]] ||
|-
| [[: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: LeaderBoards|LeaderBoards]] || Leader board related scripting commands. || [[leaderboardDeInit]], [[leaderboardGetRows]], [[leaderboardInit]] || {{arma3}}
|-
| [[:Category:Command Group: RTD|RTD]] || Commands related to the [[Arma 3 Advanced Helicopter Flight Model]]. || [[collectiveRTD]], [[isObjectRTD]], [[throttleRTD]] || {{arma3}}, {{tkoh}}
}

Revision as of 11:18, 15 September 2020

Command Group Description Example Commands Only Available for
Briefing Objectives, tasks and notes. createSimpleTask, setTaskState, createDiaryRecord
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
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
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
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
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
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
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
Unit Control Controls the behaviour of your troops. action, doMove, setHideBehind
Variables Commands to handle arrays and other variables. setVariable, format, isNull
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
Render Time Scope These scripting commands work in render time scope rather than simulation time scope. getDirVisual, getPosVisual, visiblePosition
LeaderBoards Leader board related scripting commands. leaderboardDeInit, leaderboardGetRows, leaderboardInit Arma 3
RTD Commands related to the Arma 3 Advanced Helicopter Flight Model. collectiveRTD, isObjectRTD, throttleRTD Arma 3, Take On Helicopters

}

Subcategories

This category has the following 73 subcategories, out of 73 total.

C

Retrieved from "https://community.bistudio.com/wiki?title=Category:Scripting_Commands_by_Functionality&oldid=157315"