Scripting Commands by Functionality: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (duplicate)
(restructured with categories)
Line 1: Line 1:
{{tool-disclaimer
{{Stub}}
| <center>Disclaimer: Preliminary Layout</center>
| <center>The organization of this list is still under discussion. Please do not add any command links to this page until the categories have been finalized. At that point this notice will be gone.</center>
}}
 


==Introduction==
==Introduction==
Line 10: Line 6:




==AI Attitude==
==[[:Category:Command Group: Camera Control|Camera Control]]==
*[[allowFleeing]]
'''Camera functions for intros and outros.'''
*[[behaviour]]
(e.g. camCreate, camSetDir)
 
==Camera Control==
*[[camCommand]]  
 
==Dialog Control==
*[[buttonAction]]
*[[buttonSetAction]]


==Environment and Weather==
==[[:Category:Command Group: Dialogs Control|Dialogs Control]]==
*[[setFog]]
'''Customize the main menus in the game.'''
*[[setOvercast]]
(e.g. buttonAction, ctrlShow, lbPicture)


==Groups==
==[[:Category:Command Group: Environment and Weather|Environment and Weather]]==
*[[formation]]
'''Control the weather.'''
*[[formLeader]]
(e.g. setFog, setRain)


==Game Control==
==[[:Category:Command Group: Groups|Groups]]==
*[[accTime]]
'''Read and set group formations and members.'''
*[[addEventHandler]]
(e.g. formation, group, units)
*[[saveGame]]


==GUI Interaction==
==[[:Category:Command Group: GUI Interaction|GUI Interaction]]==
*[[addAction]]
'''On-screen messages, dialogs, menus.'''
*[[cutObj]]
(e.g. hint, titleText, showGps)


==Map Control==
==[[:Category:Command Group: Markers|Markers]]==
*[[forceMap]]
'''Set, define and use markers.'''
*[[mapAnimAdd]]
(e.g. createMarker, getMarkerType, setMarkerPos)


==Markers==
==[[:Category:Command Group: Math|Math]]==
*[[createMarker]]  
'''Mainly trigonometry functions.'''
*[[setMarkerText]]
(abs, atan, sin)
*[[setMarkerShape]]


==Math==
==[[:Category:Command Group: Mission Information|Mission Information]]==
*[[abs]]
'''Read and set parameters for the current mission.'''
*[[atan2]]
(e.g. addRating, forceEnd, score)
*[[select]]


==Mission Information==
==[[:Category:Command Group: MP Control|MP Control]]==
*[[addRating]]
'''Commands that are specific to MultiPlayer games.'''
*[[addScore]]
(e.g. enableTeamSwitch, onPlayerConnected)


==Object Information==
==[[:Category:Command Group: Object Information|Object Information]]==
*[[alive]]
'''Find out things about your troops and other objects.'''
*[[animationPhase]]
(e.g. alive, combatMode, fuel, isEngineOn, nearestObject)


==Object Manipulation==
==[[:Category:Command Group: Object Manipulation|Object Manipulation]]==
*[[action]]
'''Create and define troops and other objects.'''
*[[addEventHandler]]
(e.g. action, createVehicle, setBehaviour, setDamage)


==Program Flow==
==[[:Category:Command Group: Program Flow|Program Flow]]==
*[[do]]
'''Commands to define loops, conditions, and jumps inside scripts.'''
*[[if]]
(e.g. exec, do, forEach, goto)
*[[while]]


==Radio Control==
==[[:Category:Command Group: Radio Control|Radio Control]]==
*[[enableRadio]]
'''Control radio availability and messages.'''
*[[globalChat]]
(e.g. enableRadio, groupChat, vehicleRadio)


==Sides==
==[[:Category:Command Group: Sides|Sides]]==
*[[captive]]
'''Read and set unit affiliations.'''
*[[civilian]]
(e.g. captive, countEnemy, friendly)


==Sounds, Effects==
==[[:Category:Command Group: Sounds|Sounds]]==
*[[fadeMusic]]
'''Contol in-game sounds.'''
*[[fadeSound]]
(e.g. fadeMusic, playSound, say)


==System Commands==
==[[:Category:Command Group: System Commands|System Commands]]==
*[[benchmark]]
'''Commands that deal with the game as a whole.'''
*[[cadetMode]]
(e.g. benchmark, cadetMode, loadFile, saveGame)


==Time Functions==
==[[:Category:Command Group: Time Functions|Time Functions]]==
*[[accTime]]
'''Read and set the in-game time.'''
*[[daytime]]
(e.g. accTime, skiptime, time)


==Triggers==
==[[:Category:Command Group: Triggers|Triggers]]==
*[[addEventHandler]]
'''Set, define and use triggers.'''
*[[createTrigger]]
(e.g. addEventHandler, createTrigger, setTriggerPos)
*[[setTriggerArea]]


==Unit Control==
==[[:Category:Command Group: Unit Control|Unit Control]]==
*[[commandFire]]
'''Controls the behaviour of your troops.'''
*[[commandFollow]]
(e.g. commandFire, doMove, setHideBehind)


==Vehicle Assignment==
==[[:Category:Command Group: Vehicle Assignment|Vehicle Assignment]]==
*[[allowGetIn]]
'''Vehicle related commands.'''
*[[assignAsCargo]]
(e.g. allowGetIn, assignAsCargo, moveInDriver)


==Variables==
==[[:Category:Command Group: Variables|Variables]]==
*[[count]]
'''Commands to handle arrays and other variables.'''
*[[forEach]]
(e.g. format, count, isNull, select)
*[[format]]


==Weapons==
==[[:Category:Command Group: Weapons|Weapons]]==
*[[addMagazine]]
'''Weapon related commands.'''
*[[ammo]]
(e.g. addMagazine, ammo, weapons)

Revision as of 16:57, 8 August 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 and outros. (e.g. camCreate, camSetDir)

Dialogs Control

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

Environment and Weather

Control the weather. (e.g. setFog, setRain)

Groups

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

GUI Interaction

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

Markers

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

Math

Mainly trigonometry functions. (abs, atan, sin)

Mission Information

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

MP Control

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. action, 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

Contol 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)

Time Functions

Read and set the in-game time. (e.g. accTime, skiptime, time)

Triggers

Set, define and use triggers. (e.g. addEventHandler, createTrigger, setTriggerPos)

Unit Control

Controls the behaviour of your troops. (e.g. 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)

Weapons

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