Scripting Commands by Functionality: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Waypoints)
mNo edit summary
Line 5: Line 5:
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="floating_box1">
==[[: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.'''<br/>
(e.g. camCreate, camSetDir)
(e.g. camCreate, camSetDir)
</div>


<div class="floating_box1">
==[[:Category:Command Group: GUI Control|GUI Control]]==
==[[:Category:Command Group: GUI Control|GUI Control]]==
'''Customize the look of the main menus in the game.'''
'''Customize the look of the main menus in the game.'''<br/>
(e.g. buttonAction, ctrlShow, lbPicture)
(e.g. buttonAction, ctrlShow, lbPicture)
</div>


<div class="floating_box1">
==[[:Category:Command Group: Environment|Environment]]==
==[[:Category:Command Group: Environment|Environment]]==
'''Control the environment's weather, time, etc.'''
'''Control the environment's weather, time, etc.'''<br/>
(e.g. setFog, setRain)
(e.g. setFog, setRain)
</div>


<div class="floating_box1">
==[[:Category:Command Group: Groups|Groups]]==
==[[:Category:Command Group: Groups|Groups]]==
'''Read and set group formations and members.'''
'''Read and set group formations and members.'''<br/>
(e.g. formation, group, units)
(e.g. formation, group, units)
</div>


<div class="floating_box1">
==[[:Category:Command Group: Interaction|Interaction]]==
==[[:Category:Command Group: Interaction|Interaction]]==
'''On-screen messages, dialogs, menus.'''
'''On-screen messages, dialogs, menus.'''<br/>
(e.g. hint, titleText, showGps)
(e.g. hint, titleText, showGps)
</div>


<div class="floating_box1">
==[[:Category:Command Group: Markers|Markers]]==
==[[:Category:Command Group: Markers|Markers]]==
'''Set, define and use markers.'''
'''Set, define and use markers.'''<br/>
(e.g. createMarker, getMarkerType, setMarkerPos)
(e.g. createMarker, getMarkerType, setMarkerPos)
</div>


<div class="floating_box1">
==[[:Category:Command Group: Math|Math]]==
==[[:Category:Command Group: Math|Math]]==
'''Boolean, basic math and trigonometry functions.'''
'''Boolean, basic math and trigonometry functions.'''<br/>
(abs, atan, sin)
(abs, atan, sin)
</div>


<div class="floating_box1">
==[[: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.'''<br/>
(e.g. addRating, forceEnd, score)
(e.g. addRating, forceEnd, score)
</div>


<div class="floating_box1">
==[[:Category:Command Group: Multiplayer|Multiplayer]]==
==[[:Category:Command Group: Multiplayer|Multiplayer]]==
'''Commands that are specific to Multiplayer games.'''
'''Commands that are specific to Multiplayer games.'''<br/>
(e.g. enableTeamSwitch, onPlayerConnected)
(e.g. enableTeamSwitch, onPlayerConnected)
</div>


<div class="floating_box1">
==[[: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.'''<br/>
(e.g. alive, combatMode, fuel, isEngineOn, nearestObject)
(e.g. alive, combatMode, fuel, isEngineOn, nearestObject)
</div>


<div class="floating_box1">
==[[: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.'''<br/>
(e.g. createVehicle, setBehaviour, setDamage)
(e.g. createVehicle, setBehaviour, setDamage)
</div>


<div class="floating_box1">
==[[: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.'''<br/>
(e.g. exec, do, forEach, goto)
(e.g. exec, do, forEach, goto)
</div>


<div class="floating_box1">
==[[:Category:Command Group: Radio Control|Radio Control]]==
==[[:Category:Command Group: Radio Control|Radio Control]]==
'''Control radio availability and messages.'''
'''Control radio availability and messages.'''<br/>
(e.g. enableRadio, groupChat, vehicleRadio)
(e.g. enableRadio, groupChat, vehicleRadio)
</div>


<div class="floating_box1">
==[[:Category:Command Group: Sides|Sides]]==
==[[:Category:Command Group: Sides|Sides]]==
'''Read and set unit affiliations.'''
'''Read and set unit affiliations.'''<br/>
(e.g. captive, countEnemy, friendly)
(e.g. captive, countEnemy, friendly)
</div>


<div class="floating_box1">
==[[:Category:Command Group: Sounds|Sounds]]==
==[[:Category:Command Group: Sounds|Sounds]]==
'''Control in-game sounds.'''
'''Control in-game sounds.'''<br/>
(e.g. fadeMusic, playSound, say)
(e.g. fadeMusic, playSound, say)
</div>


<div class="floating_box1">
==[[: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.'''<br/>
(e.g. benchmark, cadetMode, loadFile, saveGame)
(e.g. benchmark, cadetMode, loadFile, saveGame)
</div>


<div class="floating_box1">
==[[: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.'''<br/>
(e.g. addEventHandler, createTrigger, setTriggerPos)
(e.g. addEventHandler, createTrigger, setTriggerPos)
</div>


<div class="floating_box1">
==[[: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.'''<br/>
(e.g. action, addWaypoint, commandFire, doMove, setHideBehind)
(e.g. action, addWaypoint, commandFire, doMove, setHideBehind)
</div>


<div class="floating_box1">
==[[:Category:Command Group: Vehicle Assignment|Vehicle Assignment]]==
==[[:Category:Command Group: Vehicle Assignment|Vehicle Assignment]]==
'''Vehicle related commands.'''
'''Vehicle related commands.'''<br/>
(e.g. allowGetIn, assignAsCargo, moveInDriver)
(e.g. allowGetIn, assignAsCargo, moveInDriver)
</div>


<div class="floating_box1">
==[[:Category:Command Group: Variables|Variables]]==
==[[:Category:Command Group: Variables|Variables]]==
'''Commands to handle arrays and other variables.'''
'''Commands to handle arrays and other variables.'''<br/>
(e.g. format, count, isNull, select)
(e.g. format, count, isNull, select)
</div>


<div class="floating_box1">
==[[:Category:Command Group: Waypoints|Waypoints]]==
==[[:Category:Command Group: Waypoints|Waypoints]]==
'''Commands to handle waypoints.'''
'''Commands to handle waypoints.'''<br/>
(e.g. addWaypoint, deleteWaypoint)
(e.g. addWaypoint, deleteWaypoint)
</div>


<div class="floating_box1">
==[[:Category:Command Group: Weapons|Weapons]]==
==[[:Category:Command Group: Weapons|Weapons]]==
'''Weapon related commands.'''
'''Weapon related commands.'''<br/>
(e.g. addMagazine, ammo, weapons)
(e.g. addMagazine, ammo, weapons)
</div>
__NOTOC__

Revision as of 10:50, 12 December 2006

Template:Stub

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.

Camera Control

Camera functions for intros, outros and cut-scenes.
(e.g. camCreate, camSetDir)

GUI Control

Customize the look of the main menus in the game.
(e.g. buttonAction, ctrlShow, lbPicture)

Environment

Control the environment's weather, time, etc.
(e.g. setFog, setRain)

Groups

Read and set group formations and members.
(e.g. formation, group, units)

Interaction

On-screen messages, dialogs, menus.
(e.g. hint, titleText, showGps)

Markers

Set, define and use markers.
(e.g. createMarker, getMarkerType, setMarkerPos)

Math

Boolean, basic math and trigonometry functions.
(abs, atan, sin)

Mission Information

Read and set parameters for the current mission.
(e.g. addRating, forceEnd, score)

Multiplayer

Commands that are specific to Multiplayer games.
(e.g. enableTeamSwitch, onPlayerConnected)

Object Information

Find out things about your troops and other objects.
(e.g. alive, combatMode, fuel, isEngineOn, nearestObject)

Object Manipulation

Create and define troops and other objects.
(e.g. createVehicle, setBehaviour, setDamage)

Program Flow

Commands to define loops, conditions, and jumps inside scripts.
(e.g. exec, do, forEach, goto)

Radio Control

Control radio availability and messages.
(e.g. enableRadio, groupChat, vehicleRadio)

Sides

Read and set unit affiliations.
(e.g. captive, countEnemy, friendly)

Sounds

Control in-game sounds.
(e.g. fadeMusic, playSound, say)

System Commands

Commands that deal with the game as a whole.
(e.g. benchmark, cadetMode, loadFile, saveGame)

Activators

Set, define and use Triggers and Event Handlers.
(e.g. addEventHandler, createTrigger, setTriggerPos)

Unit Control

Controls the behaviour of your troops.
(e.g. action, addWaypoint, commandFire, doMove, setHideBehind)

Vehicle Assignment

Vehicle related commands.
(e.g. allowGetIn, assignAsCargo, moveInDriver)

Variables

Commands to handle arrays and other variables.
(e.g. format, count, isNull, select)

Waypoints

Commands to handle waypoints.
(e.g. addWaypoint, deleteWaypoint)

Weapons

Weapon related commands.
(e.g. addMagazine, ammo, weapons)