Scripting Commands by Functionality: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Final cleaning)
Tag: Replaced
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
#redirect [[Category:Scripting Commands by Functionality]]
#REDIRECT [[Category:Scripting Commands by Functionality]]
 
 
{{Hatnote|See also: [[Functions by Functionality]]}}
{{Horizontoc}}
__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.).
 
Keep in mind that there can be cases where certain commands may appear in more than one category.
 
<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: Briefing|Briefing]]==
'''Objectives, tasks and notes.'''
;e.g.
:[[createSimpleTask]]
:[[setTaskState]]
:[[createDiaryRecord]]
</div>
 
<div class="floating-box cmd">
==[[:Category:Command Group: Camera Control|Camera Control]]==
'''Camera functions for intros, outros and cut-scenes.'''
;e.g.
:[[camCreate]]
:[[camSetDir]]
</div>
 
<div class="floating-box cmd">
==[[:Category:Command Group: Config|Config]]==
'''Commands for working with configs'''
;e.g.
:[[configFile]]
:[[getText]]
</div>
 
<div class="floating-box cmd">
==[[:Category:Command Group: Containers|Containers]]==
'''backpack, ammobox, etc.'''
;e.g.
:[[backpackSpaceFor]]
:[[vest]]
:[[everyBackpack]]
:[[canAdd]]
</div>
 
<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)]]==
'''Setting up Zeus rules and interface.'''
;e.g.
:[[curatorAddons]]
:[[assignCurator]]
</div>
 
<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: Diagnosis|Diagnosis]]==
'''Commands helpful for diagnosing issues.'''
;e.g.
:[[diag_log]]
:[[diag_fpsMin]]
:[[diag_deltaTime]]
</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: Game 2 Editor|Game 2 Editor]]==
'''Commands to interact with Game 2 Editor.'''
;e.g.
:[[insertEditorObject]]
:[[updateObjectTree]]
:[[execEditorScript]]
:[[fromEditor]]
</div>
 
<div class="floating-box cmd">
==[[:Category:Command Group: Environment|Environment]]==
'''Control the environment's weather, time, etc.'''
;e.g.
:[[setFog]]
:[[setRain]]
</div>
 
<div class="floating-box cmd">
==[[:Category:Command Group: Event Handlers|Event Handlers]]==
'''Set, define and use Event Handlers.'''
;e.g.
:[[addEventHandler]]
</div>
 
<div class="floating-box cmd">
==[[:Category:Command Group: Groups|Groups]]==
'''Read and set group formations and members.'''
;e.g.
:[[formation]]
:[[group]]
:[[units]]
</div>
 
<div class="floating-box cmd">
==[[:Category:Command Group: GUI Control|GUI Control]]==
'''Customize the look of dialogs and menus in the game.'''
;e.g.
:[[buttonAction]]
:[[ctrlShow]]
:[[lbPicture]]
</div>
 
<div class="floating-box cmd">
==[[:Category:Command Group: Interaction|Interaction]]==
'''On-screen messages, dialogs, menus.'''
;e.g.
:[[hint]]
:[[titleText]]
:[[showGPS]]
</div>
 
<div class="floating-box cmd">
==[[:Category:Command Group: Lights|Lights]]==
'''Create, enable light sources on vehicles, terrain objects or lightpoints.'''
;e.g.
:[[setLightColor]]
:[[setPilotLight]]
:[[enableGunLights]]
</div>
 
<div class="floating-box cmd">
==[[:Category:Command Group: Locations|Locations]]==
'''Create, define, use and manipulate locations.'''
;e.g.
:[[createLocation]]
:[[nearestLocation]]
:[[setSize]]
</div>
 
<div class="floating-box cmd">
==[[:Category:Command Group: Markers|Markers]]==
'''Set, define and use markers.'''
;e.g.
:[[createMarker]]
:[[getMarkerType]]
:[[setMarkerPos]]
</div>
 
<div class="floating-box cmd">
==[[:Category:Command Group: Math|Math]]==
'''Boolean, basic math and trigonometry functions.'''
;e.g.
:[[abs]]
:[[atan]]
:[[sin]]
;Also&#58;
:&nbsp;[[Math Commands]]
</div>
 
<div class="floating-box cmd">
==[[:Category:Command Group: Mission Information|Mission Information]]==
'''Read and set parameters for the current mission.'''
;e.g.
:[[addRating]]
:[[forceEnd]]
:[[score]]
</div>
 
<div class="floating-box cmd">
==[[:Category:Command Group: Mods_and_Addons|Mods and Addons]]==
'''Commands that are used to get information about mods and addons.'''
;e.g.
:[[configSourceModList]]
:[[configSourceMod]]
:[[addonFiles]]
</div>
 
<div class="floating-box cmd">
==[[:Category:Command Group: Multiplayer|Multiplayer]]==
'''Commands that are specific to Multiplayer games.'''
;e.g.
:[[didJIP]]
:[[owner]]
:[[onPlayerConnected]]
</div>
 
<div class="floating-box cmd">
==[[:Category:Command Group: Object Information|Object Information]]==
'''Find out things about your troops and other objects.'''
;e.g.
:[[alive]]
:[[combatMode]]
:[[fuel]]
:[[isEngineOn]]
:[[nearestObject]]
</div>
 
<div class="floating-box cmd">
==[[:Category:Command Group: Object Manipulation|Object Manipulation]]==
'''Create and define troops and other objects.'''
;e.g.
:[[createVehicle]]
:[[setBehaviour]]
:[[setDamage]]
</div>
 
<div class="floating-box cmd">
==[[:Category:Command Group: Performance Logging|Performance Logging]]==
'''Performance debug and logs.'''
;e.g.
:[[diag captureFrame]]
:[[logEntities]]
</div>
 
<div class="floating-box cmd">
==[[:Category:Command Group: Program Flow|Program Flow]]==
'''Commands to define loops, conditions, and jumps inside scripts.'''
;e.g.
:[[exec]]
:[[do]]
:[[forEach]]
:[[goto]]
</div>
 
<div class="floating-box cmd">
==[[:Category:Command Group: Radio Control|Radio Control]]==
'''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 class="floating-box cmd">
==[[:Category:Command Group: Sides|Sides]]==
'''Read and set unit affiliations.'''
;e.g.
:[[captive]]
:[[countEnemy]]
:[[friendly]]
</div>
 
<div class="floating-box cmd">
==[[:Category:Command Group: Sounds|Sounds]]==
'''Control in-game sounds.'''
;e.g.
:[[fadeMusic]]
:[[playSound]]
:[[say]]
</div>
 
<div class="floating-box cmd">
==[[:Category:Command Group: System|System]]==
'''Commands that deal with the game as a whole.'''
;e.g.
:[[benchmark]]
:[[cadetMode]]
:[[loadFile]]
:[[saveGame]]
</div>
 
 
<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|Time]]==
'''Commands related to in-game time or system time.'''
;e.g.
:[[accTime]]
:[[setTimeMultiplier]]
:[[timeMultiplier]]
</div>
 
<div class="floating-box cmd">
==[[:Category:Command Group: Triggers|Triggers]]==
'''Set, define and use Triggers and Event Handlers.'''
;e.g.
:[[createTrigger]]
:[[setTriggerArea]]
</div>
 
<div class="floating-box cmd">
==[[:Category:Command Group: Unit Control|Unit Control]]==
'''Controls the behaviour of your troops.'''
;e.g.
:[[action]]
:[[commandFire]]
:[[doMove]]
:[[setHideBehind]]
</div>
 
<div class="floating-box cmd">
==[[:Category:Command Group: Variables|Variables]]==
'''Commands to handle arrays and other variables.'''
;e.g.
:[[format]]
:[[count]]
:[[isNull]]
:[[select]]
</div>
 
<div class="floating-box cmd">
==[[:Category:Command Group: Vehicle Loadouts|Vehicle Loadout]]==
'''Vehicle loadout related commands.'''
;e.g.
:[[getCompatiblePylonMagazines]]
:[[getPylonMagazines]]
</div>
 
<div class="floating-box cmd">
==[[:Category:Command Group: Waypoints|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 class="floating-box cmd">
==[[:Category:Command Group: Weapons|Weapons]]==
'''Weapon related commands.'''
;e.g.
:[[addMagazine]]
:[[ammo]]
:[[weapons]]
</div>
 
</div><!-- end of flex container -->
 
<!--
[[Category:Scripting_Topics]]
[[Category:Operation Flashpoint: Editing]]
[[Category:ArmA: Editing]]
{{GameCategory|arma2|Editing}}
[[Category:Take On Helicopters: Editing]]
{{GameCategory|arma3|Editing}}
-->

Latest revision as of 01:14, 26 December 2020

Redirect to:

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