Scripting Commands by Functionality: Difference between revisions
mNo edit summary |
Lou Montana (talk | contribs) (Add SideTOC, flexboxes, and categories) |
||
(20 intermediate revisions by 7 users not shown) | |||
Line 1: | Line 1: | ||
==Introduction== | {{Hatnote|See also: [[Functions by Functionality]]}} | ||
{{SideTOC}} | |||
__NOEDITSECTION__ | |||
== Introduction == | |||
This page has been created to help you find the appropriate commands when you are dealing with specific scripting situations (e.g. all commands that have to do with triggers, or to control unit behaviour, etc.). | This page has been created to help you find the appropriate commands when you are dealing with specific scripting situations (e.g. all commands that have to do with triggers, or to control unit behaviour, etc.). | ||
Keep in mind that there can be cases where certain commands may appear in more than one category. | Keep in mind that there can be cases where certain commands may appear in more than one category. | ||
<div class=" | |||
<div style="display: flex; align-content: flex-start; align-items: flex-start; justify-content: center; flex-wrap: wrap"><!-- flex container --> | |||
<div class="floating-box cmd"> | |||
==[[:Category:Command Group: Activators|Activators]]== | ==[[:Category:Command Group: Activators|Activators]]== | ||
'''Set, define and use Triggers and Event Handlers.''' | '''Set, define and use Triggers and Event Handlers.''' | ||
;e.g. | |||
:[[addEventHandler]] | |||
:[[createTrigger]] | |||
:[[setTriggerArea]] | |||
</div> | </div> | ||
<div class=" | <div class="floating-box cmd"> | ||
==[[:Category:Command Group: Briefing|Briefing]]== | ==[[:Category:Command Group: Briefing|Briefing]]== | ||
'''Objectives, tasks and notes.''' | '''Objectives, tasks and notes.''' | ||
;e.g. | |||
:[[createSimpleTask]] | |||
:[[setTaskState]] | |||
:[[createDiaryRecord]] | |||
</div> | </div> | ||
<div class=" | <div class="floating-box cmd"> | ||
==[[:Category:Command Group: Camera Control|Camera Control]]== | ==[[:Category:Command Group: Camera Control|Camera Control]]== | ||
'''Camera functions for intros, outros and cut-scenes.''' | '''Camera functions for intros, outros and cut-scenes.''' | ||
;e.g. | |||
:[[camCreate]] | |||
:[[camSetDir]] | |||
</div> | </div> | ||
<div class=" | <div class="floating-box cmd"> | ||
==[[:Category:Command Group: Conversations|Conversations]]== | |||
'''bikb, topics, etc.''' | |||
;e.g. | |||
:[[kbTell]] | |||
:[[kbWasSaid]] | |||
</div> | |||
<div class="floating-box cmd"> | |||
==[[:Category:Command Group: Curator|Curator (Zeus)]]== | ==[[:Category:Command Group: Curator|Curator (Zeus)]]== | ||
'''Setting up Zeus rules and interface.''' | '''Setting up Zeus rules and interface.''' | ||
;e.g. | |||
:[[curatorAddons]] | |||
:[[assignCurator]] | |||
</div> | </div> | ||
<div class=" | <div class="floating-box cmd"> | ||
==[[:Category:Command Group: Custom Panels|Custom Panels]]== | |||
'''Commands to handle Custom Panels.''' | |||
;e.g. | |||
:[[infoPanel]] | |||
:[[setInfoPanel]] | |||
:[[enableInfoPanelComponent]] | |||
</div> | |||
<div class="floating-box cmd"> | |||
==[[:Category:Command Group: DLC|DLC]]== | |||
'''DLC related commands.''' | |||
;e.g. | |||
:[[getDLCs]] | |||
:[[getObjectDLCs]] | |||
:[[isDLCAvailable]] | |||
</div> | |||
<div class="floating-box cmd"> | |||
==[[:Category:Command Group: 3DEN|Eden Editor]]== | |||
'''3D Editor commands.''' | |||
;e.g. | |||
:[[get3DENCamera]] | |||
:[[add3DENEventHandler]] | |||
:[[do3DENAction]] | |||
</div> | |||
<div class="floating-box cmd"> | |||
==[[:Category:Command Group: Editor Control|Editor Control]]== | ==[[:Category:Command Group: Editor Control|Editor Control]]== | ||
'''Functions to interact with editor.''' | '''Functions to interact with 2D editor.''' | ||
;e.g. | |||
:[[insertEditorObject]] | |||
:[[updateObjectTree]] | |||
:[[execEditorScript]] | |||
:[[fromEditor]] | |||
</div> | </div> | ||
<div class=" | <div class="floating-box cmd"> | ||
==[[:Category:Command Group: Environment|Environment]]== | ==[[:Category:Command Group: Environment|Environment]]== | ||
'''Control the environment's weather, time, etc.''' | '''Control the environment's weather, time, etc.''' | ||
;e.g. | |||
:[[setFog]] | |||
:[[setRain]] | |||
</div> | </div> | ||
<div class=" | <div class="floating-box cmd"> | ||
==[[:Category:Command Group: Groups|Groups]]== | ==[[:Category:Command Group: Groups|Groups]]== | ||
'''Read and set group formations and members.''' | '''Read and set group formations and members.''' | ||
;e.g. | |||
:[[formation]] | |||
:[[group]] | |||
:[[units]] | |||
</div> | </div> | ||
<div class=" | <div class="floating-box cmd"> | ||
==[[:Category:Command Group: GUI Control|GUI Control]]== | ==[[:Category:Command Group: GUI Control|GUI Control]]== | ||
'''Customize the look of | '''Customize the look of dialogs and menus in the game.''' | ||
;e.g. | |||
:[[buttonAction]] | |||
:[[ctrlShow]] | |||
:[[lbPicture]] | |||
</div> | </div> | ||
<div class=" | <div class="floating-box cmd"> | ||
==[[:Category:Command Group: Interaction|Interaction]]== | ==[[:Category:Command Group: Interaction|Interaction]]== | ||
'''On-screen messages, dialogs, menus.''' | '''On-screen messages, dialogs, menus.''' | ||
;e.g. | |||
:[[hint]] | |||
:[[titleText]] | |||
:[[showGPS]] | |||
</div> | </div> | ||
<div class=" | <div class="floating-box cmd"> | ||
==[[:Category:Command Group: Locations|Locations]]== | ==[[:Category:Command Group: Locations|Locations]]== | ||
'''Create, define, use and manipulate locations.''' | '''Create, define, use and manipulate locations.''' | ||
;e.g. | |||
:[[createLocation]] | |||
:[[nearestLocation]] | |||
:[[setSize]] | |||
</div> | </div> | ||
<div class=" | <div class="floating-box cmd"> | ||
==[[:Category:Command Group: Markers|Markers]]== | ==[[:Category:Command Group: Markers|Markers]]== | ||
'''Set, define and use markers.''' | '''Set, define and use markers.''' | ||
;e.g. | |||
:[[createMarker]] | |||
:[[getMarkerType]] | |||
:[[setMarkerPos]] | |||
</div> | </div> | ||
<div class=" | <div class="floating-box cmd"> | ||
==[[:Category:Command Group: Math|Math]]== | ==[[:Category:Command Group: Math|Math]]== | ||
'''Boolean, basic math and trigonometry functions.''' | '''Boolean, basic math and trigonometry functions.''' | ||
;e.g. | |||
:[[abs]] | |||
:[[atan]] | |||
:[[sin]] | |||
;Also: | |||
: [[Math Commands]] | |||
</div> | </div> | ||
<div class=" | <div class="floating-box cmd"> | ||
==[[:Category:Command Group: Mission Information|Mission Information]]== | ==[[:Category:Command Group: Mission Information|Mission Information]]== | ||
'''Read and set parameters for the current mission.''' | '''Read and set parameters for the current mission.''' | ||
;e.g. | |||
:[[addRating]] | |||
:[[forceEnd]] | |||
:[[score]] | |||
</div> | </div> | ||
<div class=" | <div class="floating-box cmd"> | ||
==[[:Category:Command Group: Multiplayer|Multiplayer]]== | ==[[:Category:Command Group: Multiplayer|Multiplayer]]== | ||
'''Commands that are specific to Multiplayer games.''' | '''Commands that are specific to Multiplayer games.''' | ||
;e.g. | |||
:[[didJIP]] | |||
:[[owner]] | |||
:[[onPlayerConnected]] | |||
</div> | </div> | ||
<div class=" | <div class="floating-box cmd"> | ||
==[[:Category:Command Group: Object Information|Object Information]]== | ==[[:Category:Command Group: Object Information|Object Information]]== | ||
'''Find out things about your troops and other objects.''' | '''Find out things about your troops and other objects.''' | ||
;e.g. | |||
:[[alive]] | |||
:[[combatMode]] | |||
:[[fuel]] | |||
:[[isEngineOn]] | |||
:[[nearestObject]] | |||
</div> | </div> | ||
<div class=" | <div class="floating-box cmd"> | ||
==[[:Category:Command Group: Object Manipulation|Object Manipulation]]== | ==[[:Category:Command Group: Object Manipulation|Object Manipulation]]== | ||
'''Create and define troops and other objects.''' | '''Create and define troops and other objects.''' | ||
;e.g. | |||
:[[createVehicle]] | |||
:[[setBehaviour]] | |||
:[[setDamage]] | |||
</div> | </div> | ||
<div class=" | <div class="floating-box cmd"> | ||
==[[:Category:Command Group: Program Flow|Program Flow]]== | ==[[:Category:Command Group: Program Flow|Program Flow]]== | ||
'''Commands to define loops, conditions, and jumps inside scripts.''' | '''Commands to define loops, conditions, and jumps inside scripts.''' | ||
;e.g. | |||
:[[exec]] | |||
:[[do]] | |||
:[[forEach]] | |||
:[[goto]] | |||
</div> | </div> | ||
<div class=" | <div class="floating-box cmd"> | ||
==[[:Category:Command Group: Radio Control|Radio Control]]== | ==[[:Category:Command Group: Radio Control|Radio Control]]== | ||
'''Control radio availability and messages.'''< | '''Control radio availability and messages.''' | ||
;e.g. | |||
:[[enableRadio]] | |||
:[[groupChat]] | |||
:[[vehicleRadio]] | |||
</div> | |||
<div class="floating-box cmd"> | |||
==[[:Category:Command Group: Remote Control|Remote Control]]== | |||
'''Manipulate and connect to UAVs or remote control units.''' | |||
;e.g. | |||
:[[connectTerminalToUAV]] | |||
:[[remoteControl]] | |||
:[[teamSwitch]] | |||
</div> | |||
<div class="floating-box cmd"> | |||
==[[:Category:Command Group: Ropes and Sling Loading|Ropes and Sling Loading]]== | |||
'''Attach and detach ropes to objects, slingload and drop them.''' | |||
;e.g. | |||
:[[enableRopeAttach]] | |||
:[[getSlingLoad]] | |||
:[[ropes]] | |||
</div> | </div> | ||
<div class=" | <div class="floating-box cmd"> | ||
==[[:Category:Command Group: Sides|Sides]]== | ==[[:Category:Command Group: Sides|Sides]]== | ||
'''Read and set unit affiliations.''' | '''Read and set unit affiliations.''' | ||
;e.g. | |||
:[[captive]] | |||
:[[countEnemy]] | |||
:[[friendly]] | |||
</div> | </div> | ||
<div class=" | <div class="floating-box cmd"> | ||
==[[:Category:Command Group: Sounds|Sounds]]== | ==[[:Category:Command Group: Sounds|Sounds]]== | ||
'''Control in-game sounds.''' | '''Control in-game sounds.''' | ||
;e.g. | |||
:[[fadeMusic]] | |||
:[[playSound]] | |||
:[[say]] | |||
</div> | </div> | ||
<div class=" | <div class="floating-box cmd"> | ||
==[[:Category:Command Group: System Commands|System Commands]]== | ==[[:Category:Command Group: System Commands|System Commands]]== | ||
'''Commands that deal with the game as a whole.''' | '''Commands that deal with the game as a whole.''' | ||
;e.g. | |||
:[[benchmark]] | |||
:[[cadetMode]] | |||
:[[loadFile]] | |||
:[[saveGame]] | |||
</div> | </div> | ||
<div class=" | |||
<div class="floating-box cmd"> | |||
==[[:Category:Command Group: Team Switch|Team Switch]]== | |||
'''Everything to do with the Team Switch feature.''' | |||
;e.g. | |||
:[[enableTeamSwitch]] | |||
:[[onTeamSwitch]] | |||
:[[selectPlayer]] | |||
:[[teamSwitch]] | |||
</div> | |||
<div class="floating-box cmd"> | |||
==[[:Category:Command Group: Time Functions|Time Functions]]== | |||
'''Read and set the in-game time.''' | |||
;e.g. | |||
:[[accTime]] | |||
:[[setTimeMultiplier]] | |||
:[[timeMultiplier]] | |||
</div> | |||
<div class="floating-box cmd"> | |||
==[[:Category:Command Group: Unit Control|Unit Control]]== | ==[[:Category:Command Group: Unit Control|Unit Control]]== | ||
'''Controls the behaviour of your troops.''' | '''Controls the behaviour of your troops.''' | ||
;e.g. | |||
:[[action]] | |||
:[[addWaypoint]] | |||
:[[commandFire]] | |||
:[[doMove]] | |||
:[[setHideBehind]] | |||
</div> | </div> | ||
<div class=" | <div class="floating-box cmd"> | ||
==[[:Category:Command Group: Variables|Variables]]== | ==[[:Category:Command Group: Variables|Variables]]== | ||
'''Commands to handle arrays and other variables.''' | '''Commands to handle arrays and other variables.''' | ||
;e.g. | |||
:[[format]] | |||
:[[count]] | |||
:[[isNull]] | |||
:[[select]] | |||
</div> | </div> | ||
<div class=" | <div class="floating-box cmd"> | ||
==[[:Category:Command Group: Vehicle Assignment|Vehicle Assignment]]== | ==[[:Category:Command Group: Vehicle Assignment|Vehicle Assignment]]== | ||
'''Vehicle related commands.''' | '''Vehicle related commands.''' | ||
;e.g. | |||
:[[allowGetIn]] | |||
:[[assignAsCargo]] | |||
:[[moveInDriver]] | |||
</div> | </div> | ||
<div class=" | <div class="floating-box cmd"> | ||
==[[:Category:Scripting Commands Vehicle Loadouts|Vehicle Loadout]]== | |||
'''Vehicle loadout related commands.''' | |||
;e.g. | |||
:[[getCompatiblePylonMagazines]] | |||
:[[getPylonMagazines]] | |||
</div> | |||
<div class="floating-box cmd"> | |||
==[[:Category:Command Group: Waypoints|Waypoints]]== | ==[[:Category:Command Group: Waypoints|Waypoints]]== | ||
'''Commands to handle waypoints.'''< | '''Commands to handle waypoints.''' | ||
;e.g. | |||
:[[addWaypoint]] | |||
:[[deleteWaypoint]] | |||
</div> | |||
<div class="floating-box cmd"> | |||
==[[:Category:Command Group: Weapon Pool|Weapon Pool]]== | |||
'''The ''Weapon Pool'' enables the player to use weapons from one mission in others.''' | |||
;e.g. | |||
:[[addMagazinePool]] | |||
:[[fillWeaponsFromPool]] | |||
:[[queryMagazinePool]] | |||
</div> | </div> | ||
<div class=" | <div class="floating-box cmd"> | ||
==[[:Category:Command Group: Weapons|Weapons]]== | ==[[:Category:Command Group: Weapons|Weapons]]== | ||
'''Weapon related commands.''' | '''Weapon related commands.''' | ||
;e.g. | |||
:[[addMagazine]] | |||
:[[ammo]] | |||
:[[weapons]] | |||
</div> | </div> | ||
</div><!-- end of flex container --> | |||
[[Category:Scripting_Topics]] | [[Category:Scripting_Topics]] | ||
[[Category:Arma | [[Category:Operation Flashpoint: Editing]] | ||
[[Category:ArmA: Editing]] | |||
[[Category:ArmA 2: Editing]] | |||
[[Category:Take On Helicopters: Editing]] | |||
[[Category:Arma 3: Editing]] |
Revision as of 00:42, 9 April 2019
Introduction
This page has been created to help you find the appropriate commands when you are dealing with specific scripting situations (e.g. all commands that have to do with triggers, or to control unit behaviour, etc.).
Keep in mind that there can be cases where certain commands may appear in more than one category.
Activators
Set, define and use Triggers and Event Handlers.
Custom Panels
Commands to handle Custom Panels.
Editor Control
Functions to interact with 2D editor.
GUI Control
Customize the look of dialogs and menus in the game.
Object Information
Find out things about your troops and other objects.
Object Manipulation
Create and define troops and other objects.
Program Flow
Commands to define loops, conditions, and jumps inside scripts.
Remote Control
Manipulate and connect to UAVs or remote control units.
Ropes and Sling Loading
Attach and detach ropes to objects, slingload and drop them.
System Commands
Commands that deal with the game as a whole.
Team Switch
Everything to do with the Team Switch feature.
Unit Control
Controls the behaviour of your troops.
Vehicle Loadout
Vehicle loadout related commands.
Weapon Pool
The Weapon Pool enables the player to use weapons from one mission in others.