S
Index
saveGame
saveIdentity
saveStatus
saveVar
say
say
scopeName
score
scriptDone
scudState
secondaryWeapon
select
select
select
selectionPosition
selectLeader
selectPlayer
selectWeapon
sendSimpleCommand
set
setAccTime
setAirportSide
setAmmoCargo
setAperture
setAttributes
setBehaviour
setCameraEffect
setCameraInterest
setCaptive
setCombatMode
setCurrentWaypoint
setDamage
setDammage
setDate
setDestination
setDir
setDropInterval
setEffectCondition
setFace
setFaceAnimation
setFlagOwner
setFlagSide
setFlagTexture
setFog
setFormation
setFormationTask
setFormDir
setFriend
setFuel
setFuelCargo
setGroupId
setHideBehind
setIdentity
setLightAmbient
setLightBrightness
setLightColor
setMarkerBrush
setMarkerBrushLocal
setMarkerColor
setMarkerColorLocal
setMarkerDir
setMarkerDirLocal
setMarkerPos
setMarkerPosLocal
setMarkerShape
setMarkerShapeLocal
setMarkerSize
setMarkerSizeLocal
setMarkerText
setMarkerTextLocal
setMarkerType
setMarkerTypeLocal
setMimic
setMousePosition
setMusicEffect
setObjectTexture
setOvercast
setParticleCircle
setParticleParams
setParticleRandom
setPlayable
setPos
setPosASL
setRadioMsg
setRain
setRank
setRepairCargo
setSkill
setSkill
setSoundEffect
setSpeedMode
setTargetAge
setTerrainGrid
setTitleEffect
setTriggerActivation
setTriggerArea
setTriggerStatements
setTriggerText
setTriggerTimeout
setTriggerType
setUnitAbility
setUnitPos
setUnitPosWeak
setUnitRank
setVariable
setVectorDir
setVectorUp
setVehicleAmmo
setVehicleArmor
setVehicleId
setVehicleInit
setVehicleLock
setVehiclePosition
setVehicleVarName
setVelocity
setViewDistance
setWaypointBehaviour
setWaypointCombatMode
setWaypointDescriptionr
setWaypointFormation
setWaypointHousePosition
setWaypointPosition
setWaypointScript
setWaypointSpeed
setWaypointStatements
setWaypointTimeout
setWaypointType
setWPPos
showCinemaBorder
showCompass
showGps
showMap
shownCompass
shownGps
shownMap
shownPad
shownRadio
shownWarrant
shownWatch
showPad
showRadio
showWarrant
showWatch
showWaypoint
side
sideChat
sideEnemy
sideFriendlyt
sideLogic
sideRadio
sin
sizeOf
skill
skill
skipTime
sleep
sliderPosition
sliderPosition
sliderRange
sliderRange
sliderSetPosition
sliderSetPosition
sliderSetRange
sliderSetRange
sliderSetSpeed
sliderSetSpeed
sliderSpeed
sliderSpeed
someAmmo
soundVolume
spawn
spawn
speed
speedMode
sqrt
step
stop
stopped
str
supportInfo
surfaceIsWater
surfaceType
switch
switchableUnits
switchCamera
switchLight
switchMove
synchronizeWaypoint
synchronizeWaypoint
saveGame
Operand types:
None
Type of returned value:
Nothing
Description:
Autosave game (used for Retry).
Used In:
ArmA/OFP
--------------------------------------------------------------------------------
person saveIdentity name
Operand types:
Person: Object
Name: String
Type of returned value:
Boolean
Description:
Saves person's identity to objects.savfile in campaign directory as entry name.
Used In:
ArmA/OFP
Example:
player saveIdentity "playerid"
--------------------------------------------------------------------------------
object saveStatus name
Operand types:
Object: Object
Name: String
Type of returned value:
Boolean
Description:
Saves object's properties to objects.sav file in campaign directory as entry name.
Used In:
ArmA/OFP
Example:
player saveStatus "playerstate"
--------------------------------------------------------------------------------
saveVar varname
Operand types:
varname: String
Type of returned value:
Nothing
Description:
Save variable value into the campaign space.
This variable is available to all following missions in the campaign.
Used In:
ArmA/OFP
Example:
saveVar "varOne"
--------------------------------------------------------------------------------
unit say speechname
Operand types:
unit: Object
speechName: Array
Type of returned value:
Nothing
Description:
Format of speechName is [sound, maxTitlesDistance].
Unit will play given sound.
When unit is person, it will also perform corresponding lipsync effect.
If camera is not withing given range, title is not shown.
Sound is defined in description.ext.
Used In:
ArmA/OFP
--------------------------------------------------------------------------------
unit say speechname
Operand types:
unit: Object
speechName: String
Type of returned value:
Nothing
Description:
Unit will play given sound.
When unit is person, it will also perform corresponding lipsync effect.
Sound is defined in description.ext.
Used In:
ArmA/OFP
Example:
soldier1 say "speechid"
--------------------------------------------------------------------------------
scopeName name
Operand types:
Name: String
Type of returned value:
Nothing
Description:
Defines name of current scope.
Name is visible in debugger, and name is also used as reference in some commands.
Scope name can be defined only once per scope.
Used In:
ArmA
--------------------------------------------------------------------------------
score unit
Operand types:
unit: Object
speechName: Array
Type of returned value:
Number
Description:
MP: Check unit score.
Used In:
ArmA/OFP
Example:
pScore = score player
--------------------------------------------------------------------------------
scriptDone script
Operand types:
script: Script
Type of returned value:
Boolean
Description:
Check if script is already finished.
Used In:
ArmA
--------------------------------------------------------------------------------
scudState scudname
Operand types:
scudname: Object
Type of returned value:
Number
Description:
Current state of given Scud launcher.
Following states are recognized:
0 - No activity
1 - Launch preparation
2 - Launch prepared
3 - Ignition
4 - Launched
Note: Non-integral values are used to indicate transition between states.
Used In:
ArmA/OFP
Example:
? scudState scudOne >= 4 : hint "RUN!!!!"
macguba
Note that this command does not make the scud do anything.
It simply checks to see what state the scud is in.
To make the scud be upright or launch you need to use an action.
e.g. scud1 action ["scud launch"]
--------------------------------------------------------------------------------
secondaryWeapon vehicle
Operand types:
vehicle: Object
Type of returned value:
String
Description:
Returns name of vehicle's secondary weapon (empty string if none).
Used In:
ArmA/OFP
Example:
sWeap = secondaryWeapon player
--------------------------------------------------------------------------------
array select index
Operand types:
array: Array
index: Boolean
Type of returned value:
Any Value
Description:
If index is false, select first element of array, if it is true select the second index.
Used In:
ArmA/OFP
--------------------------------------------------------------------------------
array select index
Operand types:
array: Array
index: Number
Type of returned value:
Any Value
Description:
Select index element of array, index 0 denotes the first element, 1 indicates the second.
Used In:
ArmA/OFP
Example:
[1,2,3] select 1: .......Result is 2.
« To Menu
--------------------------------------------------------------------------------
config select index
Operand types:
config: Config
index: Number
Type of returned value:
Config
Description:
Returns subentry with given index.
Used In:
ArmA
Example:
(configFile >> "CfgVehicles") select 0
--------------------------------------------------------------------------------
object selectionPosition selectionName
Operand types:
object: Object
selectionName: String
Type of returned value:
Array
Description:
Search for selection in the object model (first in the memory level, then in other levels). Returns the position in model space.
Used In:
ArmA
--------------------------------------------------------------------------------
group selectLeader unit
Operand types:
group: Group
unit: Object
Type of returned value:
Nothing
Description:
Select group leader.
Used In:
ArmA
Example:
group player selectLeader player
« To Menu
--------------------------------------------------------------------------------
selectPlayer unit
Operand types:
unit: Object
Type of returned value:
Nothing
Description:
Switch player to given unit.
Used In:
ArmA
Example:
selectPlayer aP
--------------------------------------------------------------------------------
unit selectWeapon weapon
Operand types:
unit: Object
weapon: String
Type of returned value:
Nothing
Description:
Select given weapon.
For weapon values see CfgWeapons.
Used In:
ArmA/OFP
Example:
soldier1 selectWeapon "LAWLauncher"
--------------------------------------------------------------------------------
object sendSimpleCommand command
Operand types:
object: Object
command: String
Type of returned value:
Nothing
Description:
Sends a simple command to the vehicle's driver / gunner.
Used In:
ArmA
Example:
vehicle player sendSimpleCommand "STOP"
« To Menu
--------------------------------------------------------------------------------
array set element
Operand types:
array: Array
element: Array
Type of returned value:
Nothing
Description:
Format of element is [index, value].
Changes an element of given array.
It element does not exist, resize index+1 is called to create it.
Used In:
ArmA/OFP
Example:
array set [0, "Hello"]
--------------------------------------------------------------------------------
setAccTime accFactor
Operand types:
accFactor: Number
Type of returned value:
Nothing
Description:
Set time acceleration coefficient.
May be also used to slow time in cutscenes.
A good habit to get into is setting the acctime to 1 at the start of all cutscenes, in case the player is running at 4x speed when the scene starts.
This command does NOT work in multiplayer.
Used In:
ArmA/OFP
Example:
setAccTime 0.1
« To Menu
--------------------------------------------------------------------------------
id setAirportSide side
Operand types:
id: Number
side: Side
Type of returned value:
Nothing
Description:
Assign airport to a particular side.
id is the index number of the airport and is specific to a particular airfield.
Following id numbers apply:
0 - Paraiso
1 - Rahmadi
2 - Pita
3 - Antigua
Used In:
ArmA
Example:
1 setAirportSide west
--------------------------------------------------------------------------------
vehicle setAmmoCargo ammoCargo
Operand types:
vehicle: Object
ammoCargo: Number
Type of returned value:
Nothing
Description:
Set amount or ammo resources in cargo space of rearm vehicle.
Ammo resource is used to resupply vehicles.
Soldiers use individual magazines instead.
Amount: 1 is full cargo.
Used In:
ArmA/OFP
Example:
ammoTruck1 setAmmoCargo 0
--------------------------------------------------------------------------------
setAperture set
Operand types:
set: Number
Type of returned value:
Nothing
Description:
Sets custom camera apreture (-1 to do it automatically).
Used In:
ArmA
--------------------------------------------------------------------------------
text setAttributes [name1, value1, name2, value2, ...]
Operand types:
text: String
[name1, value1, name2, value2, ...]: Array
Type of returned value:
Structured Text
Description:
Returns a structured text created by the given structured or plain text by setting attributes to the given values.
Used In:
ArmA
Example:
txt = img setAttributes ["image", "data\iSoldier.paa"]
« To Menu
--------------------------------------------------------------------------------
group setBehaviour behaviour
Operand types:
group: Object or Group
behaviour: String
Type of returned value:
Nothing
Description:
Set group behaviour mode.
Behaviour is one of:
"CARELESS"
"SAFE"
"AWARE"
"COMBAT"
"STEALTH"
Used In:
ArmA/OFP
Example:
group1 setBehaviour "safe"
--------------------------------------------------------------------------------
trigger or waypoint setCameraEffect [name, position]
Operand types:
trigger or waypoint: Object or Array
[name, position]: Array
Type of returned value:
Nothing
Description:
Name defines the effect type (a subclass of CfgCameraEffects.Array):
"TERMINATE"
"INTERNAL"
"ZOOMIN"
"ZOOMINSLOW"
"AROUND"
"AROUNDSLOW"
"ZOOMANDAROUND"
"AROUNDANDZOOMINSLOW"
"ZOOMINS"
"FIXED"
"FIXEDWITHZOOM"
"EXTERNAL"
Or "$TERMINATE$" to cancel the current effect.
Position is camera placement:
"TOP"
"LEFT"
"RIGHT"
"FRONT"
"BACK"
"LEFT FRONT"
"RIGHT FRONT"
"LEFT BACK"
"RIGHT BACK"
"LEFT TOP"
"RIGHT TOP"
"FRONT TOP"
"BACK TOP"
"BOTTOM"
Used In:
ArmA
Example:
trigger setCameraEffect ["Fixed", "LEFT"]
--------------------------------------------------------------------------------
entity setCamerInterest interest
Operand types:
entity: Object
interest: Number
Type of returned value:
Nothing
Description:
Set camera interest for given entity.
Used In:
ArmA
Example:
_soldier setCameraInterest 50
--------------------------------------------------------------------------------
person setCaptive status
Operand types:
person: Object
status: Boolean
Type of returned value:
Nothing
Description:
Mark unit as captive.
If unit is vehicle, commander is marked.
Captive is neutral to everyone.
Note: This function does not remove unit's weapons.
Note: If you make a unit captive, that unit will still fire on the enemy, but the enemy will not fire back.
Used In:
ArmA/OFP
Example:
soldier1 setCaptive true
« To Menu
--------------------------------------------------------------------------------
group setCombatMode mode
Operand types:
group: Object or Group
mode: String
Type of returned value:
Nothing
Description:
Set group combat mode (engagement rules).
Mode may be one of:
"BLUE" (Never fire)
"GREEN" (Hold fire - defend only)
"WHITE" (Hold fire, engage at will)
"YELLOW" (Fire at will)
"RED" (Fire at will, engage at will)
Used In:
ArmA/OFP
Example:
group1 setCombatMode "BLUE"
--------------------------------------------------------------------------------
group setCurrentWaypoint waypoint
Operand types:
group: Group
waypoint: Array
Type of returned value:
Nothing
Description:
Sets a groups currently active waypoint.
Used In:
ArmA
Example:
group1 setCurrentWaypoint [group1, 1]
« To Menu
--------------------------------------------------------------------------------
object setDamage damage
Operand types:
object: Object
damage: Number
Type of returned value:
Nothing
Description:
Damage / repair object.
Damage 0 means fully functional, damage 1 means completely destroyed / dead.
Note: this function is identical to setDammage.
It was introduced to fix a spelling error in original function name.
Used In:
ArmA/OFP
Example:
soldier1 setDamage 1
--------------------------------------------------------------------------------
object setDammage damage
Operand types:
object: Object
damage: Number
Type of returned value:
Nothing
Description:
Damage / repair object.
Damage 0 means fully functional, damage 1 means completely destroyed / dead.
Used In:
ArmA/OFP
Example:
soldier1 setDammage 1
« To Menu
--------------------------------------------------------------------------------
setDate [year, month, day, hour, minute]
Operand types:
[position, planningMode, forceReplan]: Array
Type of returned value:
Nothing
Description:
Sets the actual mission date and time.
Used In:
ArmA
--------------------------------------------------------------------------------
object setDestination [position, planningMode, forceReplan]
Operand types:
object: Object
[position, planningMode, forceReplan]: Array
Type of returned value:
Nothing
Description:
Set the destination for path planning of the pilot.
Used In:
ArmA
--------------------------------------------------------------------------------
object setDir heading
Operand types:
object: Object
heading: Number
Type of returned value:
Nothing
Description:
Set object heading.
Accepted heading range is 0 to 360.
Used In:
ArmA/OFP
Example:
soldier1 setDir 45
« To Menu
--------------------------------------------------------------------------------
particleSource setDropInterval interval
Operand types:
particleSource: Object
interval: Number
Type of returned value:
Nothing
Description:
Set interval of emitting particles from particle source.
Used In:
ArmA
Example:
_source setDropInterval 0.05
--------------------------------------------------------------------------------
trigger or waypoint setEffectCondition statement
Operand types:
trigger or waypoint: Object Or Array
statement: String
Type of returned value:
Nothing
Description:
The statement is executed when the trigger or waypoint is activated and the effects are launched depending on the result.
If the result is a boolean and true, the effect is launched.
If the result is an object, the effect is launched if the result is the player or the player vehicle.
If the result is an array, the effect is launched if the result contains the player or the player vehicle.
Used In:
ArmA
Example:
trigger setEffectCondition "thisList"
--------------------------------------------------------------------------------
person setFace face
Operand types:
person: Object
face: String
Type of returned value:
Nothing
Description:
Set person's face.
Used In:
ArmA/OFP
Example:
soldier1 setFace "face10"
bedges
For a complete list of all faces that came with the game, click here.
For a tutorial on how to create your own face addon, click here.
« To Menu
--------------------------------------------------------------------------------
person setFaceAnimation blink
Operand types:
person: Object
blink: Number
Type of returned value:
Nothing
Description:
Set facial animation phase (eye blinking), blink in range 0 to 1.
Used In:
ArmA/OFP
Example:
soldier1 setFaceAnimation 0.5
--------------------------------------------------------------------------------
flag setFlagOwner owner
Operand types:
flag: Object
owner: Object
Type of returned value:
Nothing
Description:
Set flag owner.
When owner is set to objNull, flag is returned to theflagpole.
Used In:
ArmA/OFP
Example:
flag1 setFlagOwner soldier1
--------------------------------------------------------------------------------
flag setFlagSide side
Operand types:
flag: Object
side: Side
Type of returned value:
Nothing
Description:
Set flag side.
Used In:
ArmA/OFP
Example:
flag1 setFlagSide east
« To Menu
--------------------------------------------------------------------------------
flag setFlagTexture texture
Operand types:
flag: Object
texture: String
Type of returned value:
Nothing
Description:
Set flag texture.
If texture is "", flag is not drawn.
Used In:
ArmA/OFP
Example:
flag1 setFlagTexture "usa_vlajka.pac"
bedges
Flashpoint comes with an addon called Flags.pbo which contains all the flags of the world. You can find it in the addons folder.
To use a flag texture from there:
flag1 setflagtexture "\flags\usa.jpg" - USA flag
flag1 setflagtexture "\flags\ussr.jpg" - USSR flag
flag1 setflagtexture "\flags\fia.jpg" - Resistance flag
For a reference showing all flags, click here.
--------------------------------------------------------------------------------
time setFog fog-level
Operand types:
time: Number
fog-level: Number
Type of returned value:
Nothing
Description:
Set fog value smoothly during given time (in seconds).
Zero time means immediate change.
Fog-level of 0 is minimum fog, 1 is maximum fog.
Used In:
ArmA/OFP
Example:
15 setFog 0.5
« To Menu
--------------------------------------------------------------------------------
group setFormation formation
Operand types:
group: Object or Group
formation: String
Type of returned value:
Nothing
Description:
Set group formation.
Formation is one of:
"COLUMN"
"STAG COLUMN"
"WEDGE"
"ECH LEFT"
"ECH RIGHT"
"VEE"
"LINE"
Used In:
ArmA/OFP
Example:
groupOne setFormation "LINE"
--------------------------------------------------------------------------------
object setFormationTask task
Operand types:
object: Object
task: String
Type of returned value:
Nothing
Description:
Set the current task of the formation member.
Used In:
ArmA
--------------------------------------------------------------------------------
group setFormDir heading
Operand types:
group: Object or Group
heading: Number
Type of returned value:
Nothing
Description:
Set formation heading.
Accepted heading range is 0 to 360.
Formation is facing this direction unless enemy is seen.
When group is moving, this value is overriden by movement direction.
Used In:
ArmA/OFP
Example:
group1 setFormDir 180
« To Menu
--------------------------------------------------------------------------------
side1 setFriend [side2, value]
Operand types:
side1: Side
[side2, value]: Array
Type of returned value:
Nothing
Description:
Sets how friendly side1 is with side2.
For a value smaller than 0.6 it results in being enemy, otherwise it's friendly.
Used In:
ArmA
--------------------------------------------------------------------------------
vehicle setFuel amount
Operand types:
vehicle: Object
amount: Number
Type of returned value:
Nothing
Description:
Set fuel amount.
Fuel 1 is full gas tank, 0 is empty.
Used In:
ArmA/OFP
Example:
jeepOne setFuel 0
--------------------------------------------------------------------------------
vehicle setFuelCargo amount
Operand types:
vehicle: Object
amount: Number
Type of returned value:
Nothing
Description:
Set fuel amount in cargo space of refuel vehicle.
Fuel 1 is full gas tank, 0 is empty.
Used In:
ArmA/OFP
Example:
refuelTruckOne setFuelCargo 0
« To Menu
--------------------------------------------------------------------------------
group setGroupId [nameFomat, nameParam1, ...]
Operand types:
group: Object or Group
[nameFomat, nameParam1, ...]: Array
Type of returned value:
Nothing
Description:
Set group identity.
Id format is [letter, color, picture] or [letter, color].
Letter is one of:
"Alpha"
"Bravo"
"Charlie"
"Delta"
"Echo"
"Foxtrot"
"Golf"
"Hotel"
"Kilo"
Colour can be one of "GroupColor0" to "GroupColor7"
Used In:
ArmA/OFP
Example:
group1 setGroupId ["Delta","GroupColor4"]
Sefe
Additional values for letter are:
"Yankee"
"Zulu"
"Buffalo"
"Convoy"
"Guardian"
"Two"
"Three"
Color can also be set to "Six"
LCD
You can also set the letter to "November"
macguba
Sol Fire has made a list of the GroupColours:
0 - No colour
1 - Black
2 - Red
3 - Green
4 - Blue
5 - Yellow
6 - Orange
7 - Pink
Note: That this does not name the group.
To call a group "grp1", for example, write this in the init field of the group leader:
grp1 = group this
« To Menu
--------------------------------------------------------------------------------
object setHideBehind [objectWhereHide, hidePosition]
Operand types:
side1: Object
[objectWhereHide, hidePosition]: Array
Type of returned value:
Nothing
Description:
Sets the data for hiding.
ObjectWhereHide can be taken using findCover.
HidePosition can be taken using getHideFrom.
Used In:
ArmA
--------------------------------------------------------------------------------
person setIdentity identity
Operand types:
person: Object
identity: String
Type of returned value:
Nothing
Description:
Set identity of person.
Identities are defined in descripion.ext of the mission or campaign.
Used In:
ArmA/OFP
Example:
soldier1 setIdentity "John_Doe"
sefe
The definition format in the description.ext file is:
class CfgIdentities
{
class John_Doe
{
name="John Bartholemew Doe";
face="Face20";
glasses="None";
speaker="Dan";
pitch=1.1;
};
};
« To Menu
--------------------------------------------------------------------------------
light setLightAmbient [r, g, b]
Operand types:
light: Object
[r, g, b]: Array
Type of returned value:
Nothing
Description:
Set ambient color of light.
Used In:
ArmA
--------------------------------------------------------------------------------
light setLightBrightness brightness
Operand types:
light: Object
brightness: Number
Type of returned value:
Nothing
Description:
Set brightness of light.
Used In:
ArmA
--------------------------------------------------------------------------------
light setLightColor [r, g, b]
Operand types:
light: Object
[r, g, b]: Array
Type of returned value:
Nothing
Description:
Set diffuse color of light.
Used In:
ArmA
--------------------------------------------------------------------------------
name setMarkerBrush brush
Operand types:
name: String
brush: String
Type of returned value:
Nothing
Description:
Selects the fill texture for the global marker ("RECTANGLE" or "ELLIPSE").
Brush is the name of the subclass in CfgMarkerBrushes.
Used In:
ArmA
Example:
"Marker1" setMarkerBrush "DiagGrid"
« To Menu
--------------------------------------------------------------------------------
name setMarkerBrushLocal brush
Operand types:
name: String
brush: String
Type of returned value:
Nothing
Description:
Selects the fill texture for the local marker ("RECTANGLE" or "ELLIPSE").
Brush is the name of the subclass in CfgMarkerBrushes.
Used In:
ArmA
Example:
"Marker1" setMarkerBrushLocal "DiagGrid"
--------------------------------------------------------------------------------
marker setMarkerColor color
Operand types:
marker: String
color: String
Type of returned value:
Nothing
Description:
Set global marker color.
Color is one of:
"Default"
"ColorBlack"
"ColorRed"
"ColorRedAlpha"
"ColorGreen"
"ColorGreenAlpha"
"ColorBlue"
"ColorYellow"
"ColorWhite"
Used In:
ArmA/OFP
Example:
"MarkerOne" setMarkerColor "ColorBlack"
--------------------------------------------------------------------------------
marker setMarkerColorLocal color
Operand types:
marker: String
color: String
Type of returned value:
Nothing
Description:
Set local marker color.
Color is one of:
"Default"
"ColorBlack"
"ColorRed"
"ColorRedAlpha"
"ColorGreen"
"ColorGreenAlpha"
"ColorBlue"
"ColorYellow"
"ColorWhite"
Used In:
ArmA
Example:
"MarkerOne" setMarkerColorLocal "ColorYellow"
« To Menu
--------------------------------------------------------------------------------
name setMarkerDir angle
Operand types:
name: String
angle: Number
Type of returned value:
Nothing
Description:
Sets the orientation of the global marker.
Angle is in degrees.
Used In:
ArmA
Example:
"Marker1" setMarkerDir 90
--------------------------------------------------------------------------------
name setMarkerDirLocal angle
Operand types:
name: String
angle: Number
Type of returned value:
Nothing
Description:
Sets the orientation of the local marker.
Angle is in degrees.
Used In:
ArmA
Example:
"Marker1" setMarkerDirLocal 180
--------------------------------------------------------------------------------
marker setMarkerPos pos
Operand types:
marker: String
pos: Array
Type of returned value:
Nothing
Description:
Moves the global marker.
Pos format is Position2D.
Used In:
ArmA/OFP
Example:
"MarkerOne" setMarkerPos getMarkerPos "MarkerTwo"
« To Menu
--------------------------------------------------------------------------------
marker setMarkerPosLocal pos
Operand types:
marker: String
pos: Array
Type of returned value:
Nothing
Description:
Moves the local marker.
Pos format is Position2D.
Used In:
ArmA
Example:
"MarkerTwo" setMarkerPosLocal getMarkerPos "MarkerThree"
--------------------------------------------------------------------------------
name setMarkerShape shape
Operand types:
name: String
angle: String
Type of returned value:
Nothing
Description:
Selects the shape (type) of the global marker.
Shape can be "ICON", "RECTANGLE" or "ELLIPSE".
Used In:
ArmA
Example:
"Marker1" setMarkerShape "RECTANGLE"
--------------------------------------------------------------------------------
name setMarkerShapeLocal shape
Operand types:
name: String
angle: String
Type of returned value:
Nothing
Description:
Selects the shape (type) of the local marker.
Shape can be "ICON", "RECTANGLE" or "ELLIPSE".
Used In:
ArmA
Example:
"Marker1" setMarkerShapeLocal "ELLIPSE"
« To Menu
--------------------------------------------------------------------------------
marker setMarkerSize size
Operand types:
marker: String
size: Array
Type of returned value:
Nothing
Description:
Set global marker size.
Size is in format [a-axis, b-axis].
Used In:
ArmA/OFP
Example:
"MarkerOne" setMarkerSize [100, 200]
--------------------------------------------------------------------------------
marker setMarkerSizeLocal size
Operand types:
marker: String
size: Array
Type of returned value:
Nothing
Description:
Set local marker size.
Size is in format [a-axis, b-axis].
Used In:
ArmA
Example:
"MarkerOne" setMarkerSizeLocal [120, 230]
--------------------------------------------------------------------------------
name setMarkerText text
Operand types:
name: String
angle: String
Type of returned value:
Nothing
Description:
Sets the text label of an existing global marker.
Used In:
ArmA
Example:
"Marker1" setMarkerText You are here globally.
--------------------------------------------------------------------------------
name setMarkerTextLocal text
Operand types:
name: String
angle: String
Type of returned value:
Nothing
Description:
Sets the text label of an existing local marker.
Used In:
ArmA
Example:
"Marker1" setMarkerTextLocal You are here locally.
« To Menu
--------------------------------------------------------------------------------
marker setMarkerType type
Operand types:
marker: String
type: String
Type of returned value:
Nothing
Description:
Set global marker type.
Type may be any of:
"Flag1"
"Dot"
"Destroy
"Start"
"End"
"Warning"
"Join"
"Pickup"
"Unknown"
"Marker"
"Arrow"
"Empty"
Used In:
ArmA/OFP
Example:
"MarkerOne" setMarkerType "Warning"
--------------------------------------------------------------------------------
marker setMarkerTypeLocal type
Operand types:
marker: String
type: String
Type of returned value:
Nothing
Description:
Set local marker type.
Type may be any of:
"Flag1"
"Dot"
"Destroy
"Start"
"End"
"Warning"
"Join"
"Pickup"
"Unknown"
"Marker"
"Arrow"
"Empty"
Used In:
ArmA
Example:
"MarkerOne" setMarkerTypeLocal "Join"
« To Menu
--------------------------------------------------------------------------------
person setMimic mimic
Operand types:
person: Object
mimic: String
Type of returned value:
Nothing
Description:
Set person's facial expression.
Following values are recognized:
"Normal"
"Smile"
"Hurt"
"Ironic"
"Sad"
"Cynic"
"Surprised"
"Agresive"
"Angry"
Used In:
ArmA/OFP
Example:
soldier1 setmimic "surprised"
--------------------------------------------------------------------------------
setMousePosition [x, y]
Operand types:
[x, y]: Array
Type of returned value:
Nothing
Description:
Move (UI) mouse pointer to specified position on the screen.
Used In:
ArmA
Example:
setMousePosition [0.5, 0.5]
--------------------------------------------------------------------------------
trigger or waypoint setMusicEffect track
Operand types:
trigger or waypoint: Object or Array
track: String
Type of returned value:
Nothing
Description:
Defines the music track played on activation.
Track is a subclass name of CfgMusic.
"$NONE$" (no change) or "$STOP$" (stops the current music track).
Used In:
ArmA
Example:
trigger setMusicEffect "Track1"
--------------------------------------------------------------------------------
object setObjectTexture texture
Operand types:
object: Object
texture: Array
Type of returned value:
Nothing
Description:
Textures object sections with texture named in array.
Array has the form [section,"Texture"].
Used In:
ArmA/OFP
Example:
_objectname setobjecttexture [0,"\pboname\texture.paa"]
_objectname setobjecttexture [1,"\pboname\texture2.paa"]
« To Menu
--------------------------------------------------------------------------------
time setOvercast overcast
Operand types:
time: Number
overcast: Number
Type of returned value:
Nothing
Description:
Set overcast to given value smoothly during given time (in seconds).
Zero time means immediate change.
Zero overcast means clear (sunny) weather, with overcast 1 storms and rain are very likely.
Used In:
ArmA/OFP
Example:
50 setovercast 0.5
macguba
Use setRain if you want to make sure it rains.
--------------------------------------------------------------------------------
particleSource setParticleCircle [radius, velocity]
Operand types:
particleSource: Object
[radius, velocity]: Array
Type of returned value:
Nothing
Description:
Update particle source to create particles on circle with given radius.
Velocity is transformed and added to total velocity.
Used In:
ArmA
--------------------------------------------------------------------------------
particleSource setParticleParams array
Operand types:
particleSource: Object
array: Array
Type of returned value:
Nothing
Description:
Set parameters to particle source.
Array is in format ParticleArray.
Used In:
ArmA
« To Menu
--------------------------------------------------------------------------------
particleSource setParticleRandom [lifeTime, position, moveVelocity, rotationVelocity, size, color, randomDirectionPeriod, randomDirectionIntensity, {angle}]
Operand types:
particleSource: Object
[lifeTime, position, moveVelocity, rotationVelocity, size, color, randomDirectionPeriod, randomDirectionIntensity, {angle}]: Array
Type of returned value:
Nothing
Description:
Set randomization of particle source parameters.
Used In:
ArmA
--------------------------------------------------------------------------------
setPlayable unit
Operand types:
unit: Object
Type of returned value:
Nothing
Description:
Create MP role for the unit.
Used In:
ArmA
Example:
setPlayable aP
--------------------------------------------------------------------------------
obj setPos pos
Operand types:
obj: Object
pos: Array
Type of returned value:
Nothing
Description:
Set object position.
Pos array format is Position.
Used In:
ArmA/OFP
Examples:
player setPos [getPos player select 0, (getPos player select 1) + 10]
player setPos [getPos this select 0, getPos this select 1, (getPos this select 2) +10]
obj1 setpos [getPos obj1 select 0, getPos obj1 select 1, -5] .........Buries obj1 5 metres below bround level.
« To Menu
--------------------------------------------------------------------------------
obj setPosASL pos
Operand types:
obj: Object
pos: Array
Type of returned value:
Nothing
Description:
Sets the object position.
Pos array format is PositionASL.
Used In:
ArmA
Examples:
player setPosASL [getposASL player select 0, getposASL player select 1 + 10, getPosASL select 2]
--------------------------------------------------------------------------------
index setRadioMsg text
Operand types:
index: Number
text: String
Type of returned value:
Nothing
Description:
Set radio message (0, 0, map radio) to given text.
Use "NULL" to disable radio slot.
Used In:
ArmA/OFP
Example:
1 setRadioMsg "Alpha Radio"
LCD
Available channels are 1-8 in OFP:CWC, and added 9 and 10 in OFP:R
--------------------------------------------------------------------------------
time setRain rain
Operand types:
time: Number
rain: Number
Type of returned value:
Nothing
Description:
Set rain density smoothly during given time (in seconds).
Zero time means immediate change.
Rain zero is no rain, rain 1 is maximum rain.
Rain is not possible when overcast is smaller than 0.7.
Used In:
ArmA/OFP
Example:
60 setRain 1
« To Menu
--------------------------------------------------------------------------------
unit setRank rank
Operand types:
obj: Object
pos: String
Type of returned value:
Nothing
Description:
Sets rank of given unit.
Possible values are:
"PRIVATE"
"CORPORAL"
"SERGEANT"
"LIEUTENANT"
"CAPTAIN"
"MAJOR"
"COLONEL"
Used In:
ArmA
Examples:
player setRank "COLONEL"
--------------------------------------------------------------------------------
vehicle setRepairCargo amount
Operand types:
vehicle: Object
amount:Number
Type of returned value:
Nothing
Description:
Set amount of repair resources in cargo space of repair vehicle.
Amount 1 is full cargo.
Used In:
ArmA/OFP
Example:
repairTruck1 setRepairCargo 0
--------------------------------------------------------------------------------
vehicle setSkill skill
Operand types:
vehicle: Object
skill: Number
Type of returned value:
Nothing
Description:
Sets ability level of person (commander unit).
Value of skill may vary from 0 to 1.
Used In:
ArmA/OFP
Example:
hero setskill 1
« To Menu
--------------------------------------------------------------------------------
vehicle setSkill [type, skill]
Operand types:
vehicle: Object
[type, skill]: Array
Type of returned value:
Nothing
Description:
Sets skill of given type of person (commander unit).
Value of skill may vary from 0 to 1.
Used In:
ArmA
Example:
hero setskill ["Endurance", 1]
--------------------------------------------------------------------------------
trigger or waypoint setSoundEffect [sound, voice, soundEnv, soundDet]
Operand types:
trigger or waypoint: Object or Array
[sound, voice, soundEnv, soundDet]: Array
Type of returned value:
Nothing
Description:
Defines the different sound effects.
Sound / voice plays a 2D / 3D sound from CfgSounds.
SoundEnv plays an enviromental sound from CfgEnvSounds.
SoundDet (only for triggers) creates a dynamic sound object attached to a trigger defined in CfgSFX.
Used In:
ArmA
Example:
trigger setSoundEffect ["Alarm", "", "", ""]
--------------------------------------------------------------------------------
group setSpeedMode mode
Operand types:
group: Object or Group
mode: String
Type of returned value:
Nothing
Description:
Set group speed mode.
Mode may be one of:
"LIMITED" (half speed)
"NORMAL" (full speed, maintain formation)
"FULL" (do not wait for any other units in formation)
Used In:
ArmA/OFP
Example:
groupOne setSpeedMode "LIMITED"
« To Menu
--------------------------------------------------------------------------------
object setTargetAge age
Operand types:
trigger or waypoint: Object
age: String
Type of returned value:
Nothing
Description:
Sets how the target is known to the other centers.
They behave like the target was seen age seconds ago.
Possible age values are:
"ACTUAL"
"5 MIN"
"10 MIN"
"15 MIN"
"30 MIN"
"60 MIN"
"120 MIN"
"UNKNOWN"
Used In:
ArmA
Example:
player setTargetAge "10 MIN"
--------------------------------------------------------------------------------
setTerrainGrid grid
Operand types:
grid: Number
Type of returned value:
Nothing
Description:
Operation Flashpoint, VBS1: Set desired terrain resolution (in meters).
For default landscapes, supported resolutions are:
50 - Smoothest, less lag
25 - Default in Multiplayer
12.5 - Default in Singleplayer
6.25
3.125 - Bumpiest, higher lag
If you select unsupported resolution, nearest supported value is used instead.
Armed Assault, VBS2: Terrain resolution is fixed, determined by the world created.
This function controls terrain LOD instead (the distance in which the terrain mesh resolution starts to degrade).
Higher number means less vertices are used for terrain rendering, making distant hills less smooth.
Value 12.5 corresponds to selecting Terrain Detail Normal in Video options, 50 to Very Low, 3.125 to Very High.
Used In:
ArmA/OFP
Example:
setTerrainGrid 12.5
General Barron
Just to clarify what exactly this command does:
This is like opening up your video preferences and changing "terrain detail", i.e.
setTerrainGrid 25 = lowest detail
setTerrainGrid 3.125 = highest detail
It is similar to the command setViewDistance.
« To Menu
--------------------------------------------------------------------------------
trigger or waypoint setTitleEffect [type, effect, text]
Operand types:
grid: Object or Array
[type, effect, text]: Array
Type of returned value:
Nothing
Description:
Defines the title effect.
Type can be:
NONE
OBJECT
RES
TEXT
For "TEXT", the effect defines a subtype:
"PLAIN"
"PLAIN DOWN"
"BLACK"
"BLACK FADED"
"BLACK OUT"
"BLACK IN"
"WHITE OUT"
"WHITE IN"
Text is shown as text itself.
For "OBJECT", text defines the shown object, a subclass of CfgTitles.
For "RES", text defines a resource class, a subclass of RscTitles.
Used In:
ArmA
Example:
trigger setTitleEffect ["TEXT", "PLAIN DOWN", "Hello world."]
--------------------------------------------------------------------------------
trigger setTriggerActivation [by, type, repeating]
Operand types:
trigger: Object
[by, type, repeating]: Array
Type of returned value:
Nothing
Description:
Defines the trigger activation type.
The first argument - who activates trigger (side, radio, vehicle or group member), can be:
"NONE"
"EAST"
"WEST"
"GUER"
"CIV"
"LOGIC"
"ANY"
"ALPHA"
"BRAVO"
"CHARLIE"
"DELTA"
"ECHO"
"FOXTROT"
"GOLF"
"HOTEL"
"INDIA"
"JULIET"
"STATIC"
"VEHICLE"
"GROUP"
"LEADER"
"MEMBER"
The second argument - when is it activated (presention or detection by the specified side):
"PRESENT"
"NOT PRESENT"
"WEST D"
"EAST D"
"GUER D"
"CIV D"
The third argument - whether the activation is repeating.
Used In:
ArmA
Example:
trigger setTriggerActivation ["WEST", "EAST D", true]
« To Menu
--------------------------------------------------------------------------------
trigger setTriggerArea [a, b, angle, rectangle]
Operand types:
trigger: Object
[a, b, angle, rectangle]: Array
Type of returned value:
Nothing
Description:
Defines the area controlled by the trigger.
The area is rectangular or elliptical, the width is 2 * a, the height is 2 * b.
It is rotated angle degrees.
Used In:
ArmA
Example:
trigger setTriggerArea [100, 50, 45, false]
--------------------------------------------------------------------------------
trigger setTriggerStatements [cond, activ, desactiv]
Operand types:
trigger: Object
[cond, activ, desactiv]: Array
Type of returned value:
Nothing
Description:
The first argument can modify the condition of when the trigger is activated.
The result of the activation defined by trigger activation is in variable this.
Variable thisList contains all vehicles which caused the activation.
Activ and desactiv expressions are launched upon trigger activation / deactivation.
Used In:
ArmA
Example:
trigger setTriggerStatements ["this", "ok = true", "ok = false"]
--------------------------------------------------------------------------------
trigger setTriggerText text
Operand types:
trigger: Object
text: String
Type of returned value:
Nothing
Description:
Sets the text label attached to the trigger object.
This is used for example as a radio slot label for radio activated triggers.
Used In:
ArmA
Example:
trigger setTriggerText "Call for support"
« To Menu
--------------------------------------------------------------------------------
trigger setTriggerTimeout [min, mid, max, interruptable]
Operand types:
trigger: Object
[min, mid, max, interruptable]: Array
Type of returned value:
Nothing
Description:
Defines the time between condition satisfaction and trigger activation (randomly from min to max, with an average value mid).
If the last argument is true, the condition must be fullfilled all the time.
Used In:
ArmA
Example:
trigger setTriggerTimeout [5, 10, 7, false]
--------------------------------------------------------------------------------
trigger setTriggerType action
Operand types:
trigger or waypoint: Object
action: String
Type of returned value:
Nothing
Description:
Sets the type of action processed by the trigger after activation (no action, a waypoints switch or an end of mission):
"NONE"
"SWITCH"
"END1"
"END2"
"END3"
"END4"
"END5"
"END6"
"LOOSE"
"WIN"
Used In:
ArmA
Example:
trigger setTriggerType "END1"
« To Menu
--------------------------------------------------------------------------------
unit setUnitAbility skill
Operand types:
unit: Object
skill: Number
Type of returned value:
Nothing
Description:
Sets skill of given unit.
Skill may vary from 0.2 to 1.0.
Used In:
ArmA
Example:
player setUnitSkill 1.0
--------------------------------------------------------------------------------
unit setUnitPos mode
Operand types:
unit: Object
mode: String
Type of returned value:
Nothing
Description:
Set unit position rules.
Mode may be one of:
"DOWN" - Unit goes prone and stays prone.
"UP" - Unit stands and stays standing.
"MIDDLE" - Unit goes into crouch Position.
"AUTO"- Unit chooses mode according to circumstances.
Used In:
ArmA/OFP
Example:
loon1 setUnitPos "UP"
--------------------------------------------------------------------------------
unit setUnitPosWeak mode
Operand types:
unit: Object
mode: String
Type of returned value:
Nothing
Description:
Set unit position rules.
Mode may be one of:
"DOWN" - Unit goes prone and stays prone.
"UP" - Unit stands and stays standing.
"MIDDLE" - Unit goes into crouch Position.
"AUTO"- Unit chooses mode according to circumstances.
This command is the lowest level of priority for setting unit position and to be used in scripted FSM's.
This command will have no affect in regular scripts.
The current priorities are:
1. Unit pos command from the in-game command menu, highest priority.
2. Unit pos scripted with setUnitPos scripting command, medium priority.
3. Unit pos using setUnitPosWeak, used in a formation FSM, lowest priority.
Used In:
ArmA
--------------------------------------------------------------------------------
unit setUnitRank rank
Operand types:
unit: Object
rank: String
Type of returned value:
Nothing
Description:
Sets rank of given unit. Possible values are:
Mode may be one of:
"PRIVATE"
"CORPORAL"
"SERGEANT"
"LIEUTENANT"
"CAPTAIN"
"MAJOR"
"COLONEL"
Used In:
ArmA
Example:
player setUnitRank "COLONEL"
« To Menu
--------------------------------------------------------------------------------
object setVariable [name, value]
Operand types:
object: Object
[name, value]: Array
Type of returned value:
Nothing
Description:
Set variable to given value in the variable space of given object.
If object is not a vehicle (Car, Tank etc) then this will not work.
Used In:
ArmA
Example:
vehiclename setVariable ["variablename", 177]
--------------------------------------------------------------------------------
object setVectorDir [x, z, y]
Operand types:
object: Object
[x, z, y]: Array
Type of returned value:
Nothing
Description:
Set object's direction vector.
Up vector will remain unchanged.
Used In:
ArmA
--------------------------------------------------------------------------------
object setVectorUp [x, z, y]
Operand types:
object: Object
[x, z, y]: Array
Type of returned value:
Nothing
Description:
Set object's up vector.
Direction vector will remain unchanged.
Used In:
ArmA
« To Menu
--------------------------------------------------------------------------------
object setVehicleAmmo value
Operand types:
object: Object
value: Number
Type of returned value:
Nothing
Description:
Sets how much ammunition (compared to a full state defined by the vehicle type) the vehicle has.
The value ranges from 0 to 1.
Used In:
ArmA
Example:
player setVehicleAmmo 0
--------------------------------------------------------------------------------
object setVehicleArmor value
Operand types:
object: Object
value: Number
Type of returned value:
Nothing
Description:
Sets the armor (or health for men) state of the vehicle (a value from 0 to 1).
Used In:
ArmA
Example:
player setVehicleArmor 0.5
--------------------------------------------------------------------------------
object setVehicleId id
Operand types:
object: Object
id: Number
Type of returned value:
Nothing
Description:
Sets id (integer value) to vehicle.
By this id vehicle is referenced by triggers and waypoints.
Used In:
ArmA
Example:
player setVehicleId 1
« To Menu
--------------------------------------------------------------------------------
vehicle setVehicleInit statement
Operand types:
vehicle: Object
statement: String
Type of returned value:
Nothing
Description:
Execute statement attached to vehicle.
This statement is also propagated over network in MP games.
Used In:
ArmA
Example:
soldier3 setVehicleInit "this allowfleeing 0"
--------------------------------------------------------------------------------
vehicle setVehicleLock state
Operand types:
vehicle: Object
state: String
Type of returned value:
Nothing
Description:
Set how vehicle is locked for player.
Possible values:
"UNLOCKED"
"DEFAULT"
"LOCKED"
Used In:
ArmA
Example:
veh1 setVehicleLock "LOCKED"
--------------------------------------------------------------------------------
object setVehiclePosition [position, markers, placement]
Operand types:
object: Object
[position, markers, placement]: Array
Type of returned value:
Nothing
Description:
Changes the object position.
If the markers array contains more than one marker name, the position of a random one is used.
Otherwise, the given position is used.
The object is placed inside a circle with this position as its center and placement as its radius.
Used In:
ArmA
Example:
player setVehiclePosition [[0, 0, 0], ["Marker1"], 0]
« To Menu
--------------------------------------------------------------------------------
object setVehicleVarName name
Operand types:
object: Object
name: String
Type of returned value:
Nothing
Description:
Sets the name of the variable which contains a reference to this object.
It is necessary in MP to change the variable content after a respawn.
Used In:
ArmA
Example:
player setVehicleVarName "aP"
--------------------------------------------------------------------------------
vehicle setVelocity [x, z, y]
Operand types:
vehicle: Object
[x, z, y]: Array
Type of returned value:
Nothing
Description:
Set velocity (speed vector) of vehicle.
Note: This command will not work for man-type units (soldiers, officers, etc) if they are touching the ground.
Used In:
ArmA/OFP
Example:
truck1 setvelocity [20, 0, 0]
--------------------------------------------------------------------------------
setViewDistance distance
Operand types:
distance: Number
Type of returned value:
Nothing
Description:
Set rendering distance, in metres.
Default is 900m, accepted range is 500m to 5000m.
Used In:
ArmA/OFP
Example:
setViewDistance 2250
« To Menu
--------------------------------------------------------------------------------
waypoint setWaypointBehaviour mode
Operand types:
object: Array
mode: String
Type of returned value:
Nothing
Description:
Switches the unit behaviour when the waypoint becomes active.
Possible values are:
"UNCHANGED"
"CARELESS"
"SAFE"
"COMBAT"
"STEALTH"
Used In:
ArmA
Example:
[grp, 2] setWaypointBehaviour "AWARE"
--------------------------------------------------------------------------------
waypoint setWaypointCombatMode mode
Operand types:
waypoint: Array
mode: String
Type of returned value:
Nothing
Description:
The group combat mode is switched when the waypoint becomes active.
Possible values are:
"NO CHANGE"
"BLUE"
"GREEN"
"WHITE"
"YELLOW"
"RED"
Used In:
ArmA
Example:
[grp, 2] setWaypointCombatMode "RED"
« To Menu
--------------------------------------------------------------------------------
waypoint setWaypointDescription text
Operand types:
waypoint: Array
text: String
Type of returned value:
Nothing
Description:
Sets the description shown in the HUD while the waypoint is active.
Used In:
ArmA
Example:
[grp, 2] setWaypointDescription "Move here."
--------------------------------------------------------------------------------
waypoint setWaypointFormation formation
Operand types:
waypoint: Array
formation: String
Type of returned value:
Nothing
Description:
Switches the group formation when the waypoint becomes active.
Possible values are:
"NO CHANGE"
"COLUMN"
"STAG COLUMN"
"WEDGE"
"ECH LEFT"
"ECH RIGHT"
"VEE"
"LINE"
Used In:
ArmA
Example:
[grp, 2] setWaypointFormation "LINE"
--------------------------------------------------------------------------------
waypoint setWaypointHousePosition pos
Operand types:
waypoint: Array
pos: Number
Type of returned value:
Nothing
Description:
For waypoints attached to a house, this defines the target house position.
Used In:
ArmA
Example:
[grp, 2] setWaypointHousePosition 1
« To Menu
--------------------------------------------------------------------------------
waypoint setWaypointPosition [center, radius]
Operand types:
waypoint: Array
[center, radius]: Array
Type of returned value:
Nothing
Description:
Moves the waypoint to a random position in a circle with the given center and radius.
Used In:
ArmA
Example:
[grp, 2] setWaypointPosition [position player, 0]
--------------------------------------------------------------------------------
waypoint setWaypointScript command
Operand types:
waypoint: Array
command: String
Type of returned value:
Nothing
Description:
Attaches a script to a scripted waypoint.
Command consist of a script name and additional script arguments.
Used In:
ArmA
Example:
[grp, 2] setWaypointScript "find.sqs player"
--------------------------------------------------------------------------------
waypoint setWaypointSpeed mode
Operand types:
waypoint: Array
mode: String
Type of returned value:
Nothing
Description:
Switches the group speed mode when the waypoint becomes active.
Possible values are:
"UNCHANGED"
"LIMITED"
"NORMAL"
"FULL"
Used In:
ArmA
Example:
[grp, 2] setWaypointSpeed "FULL"
« To Menu
--------------------------------------------------------------------------------
waypoint setWaypointStatements [condition, statement]
Operand types:
waypoint: Array
[condition, statement]: Array
Type of returned value:
Nothing
Description:
The waypoint is done only when the condition is fulfilled.
When the waypoint is done, the statement expression is executed.
Used In:
ArmA
Example:
[grp, 2] setWaypointStatements ["true", ""]
--------------------------------------------------------------------------------
waypoint setWaypointTimeout [min, mid, max]
Operand types:
waypoint: Array
[min, mid, max]: Array
Type of returned value:
Nothing
Description:
Defines the time between condition satisfaction and waypoint finish (randomly from min to max, with an average value mid).
Used In:
ArmA
Example:
[grp, 2] setWaypointTimeout [5, 10, 6]
--------------------------------------------------------------------------------
waypoint setWaypointType type
Operand types:
waypoint: Array
type: String
Type of returned value:
Nothing
Description:
Changes the waypoint type.
Type can be:
"MOVE"
"DESTROY"
"GETIN"
"SAD"
"JOIN"
"LEADER"
"GETOUT"
"CYCLE"
"LOAD"
"UNLOAD"
"TR UNLOAD"
"HOLD"
"SENTRY"
"GUARD"
"TALK"
"SCRIPTED"
"SUPPORT"
"GETIN NEAREST"
"AND"
"OR"
Used In:
ArmA
Example:
[grp, 2] setWaypointType "HOLD"
« To Menu
--------------------------------------------------------------------------------
waypoint setWPPos position
Operand types:
waypoint: Array
position: Array
Type of returned value:
Nothing
Description:
Set waypoint position.
Waypoint is in format Waypoint.
Position is in format Position2D.
Used In:
ArmA/OFP
Example:
[groupOne, 1] setWPPos getMarkerPos "MarkerOne"
--------------------------------------------------------------------------------
showCinemaBorder show
Operand types:
show: Boolean
Type of returned value:
Nothing
Description:
Force drawing of cinema borders.
This is normally used in cutscenes to indicate player has no control.
Used In:
ArmA/OFP
Example:
showCinemaBorder true
--------------------------------------------------------------------------------
showCompass show
Operand types:
show: Boolean
Type of returned value:
Nothing
Description:
Enable compass (default true)
Used In:
ArmA/OFP
Example:
showCompass false
« To Menu
--------------------------------------------------------------------------------
showGps show
Operand types:
show: Boolean
Type of returned value:
Nothing
Description:
Enable GPS receiver (default false)
Used In:
ArmA/OFP
Example:
showGps true
--------------------------------------------------------------------------------
showMap show
Operand types:
show: Boolean
Type of returned value:
Nothing
Description:
Enable Map (default true)
Used In:
ArmA/OFP
Example:
showMap false
--------------------------------------------------------------------------------
shownCompass
Operand types:
None.
Type of returned value:
Boolean
Description:
Check if player has compass enabled.
Used In:
ArmA/OFP
Example:
? showncompass : hint "You have a compass."
--------------------------------------------------------------------------------
shownGps
Operand types:
None.
Type of returned value:
Boolean
Description:
Check if player has Gps reciever enabled.
Used In:
ArmA/OFP
Example:
? shownGps : hint "You have a Gps reciever."
« To Menu
--------------------------------------------------------------------------------
shownMap
Operand types:
None.
Type of returned value:
Boolean
Description:
Check if player has Map enabled.
Used In:
ArmA/OFP
Example:
? shownMap : hint "You have a Map."
--------------------------------------------------------------------------------
shownPad
Operand types:
None.
Type of returned value:
Boolean
Description:
Check if player has Notebook enabled.
Used In:
ArmA/OFP
Example:
? shownPad : hint "You have a Notebook."
--------------------------------------------------------------------------------
shownRadio
Operand types:
None.
Type of returned value:
Boolean
Description:
Check if player has Radio enabled.
Used In:
ArmA/OFP
Example:
? shownRadio : hint "You have a Radio."
« To Menu
--------------------------------------------------------------------------------
shownWarrant
Operand types:
None.
Type of returned value:
Boolean
Description:
Check if player has ID card enabled.
Obsolete command.
Used In:
ArmA/OFP
--------------------------------------------------------------------------------
shownWatch
Operand types:
None.
Type of returned value:
Boolean
Description:
Check if player has Watch enabled.
Used In:
ArmA/OFP
Example:
? shownWatch : hint "You have a Watch."
--------------------------------------------------------------------------------
showPad show
Operand types:
show: Boolean
Type of returned value:
Nothing
Description:
Enable Notebook (default true)
Used In:
ArmA/OFP
Example:
showPad false
« To Menu
--------------------------------------------------------------------------------
showRadio show
Operand types:
show: Boolean
Type of returned value:
Nothing
Description:
Enable Radio (default true)
Used In:
ArmA/OFP
Example:
showRadio false
--------------------------------------------------------------------------------
showWarrant show
Operand types:
show: Boolean
Type of returned value:
Nothing
Description:
Enable ID card (default false).
Obsolete command.
Used In:
ArmA/OFP
--------------------------------------------------------------------------------
showWatch show
Operand types:
show: Boolean
Type of returned value:
Nothing
Description:
Enable Watch (default true)
Used In:
ArmA/OFP
Example:
showWatch false
« To Menu
--------------------------------------------------------------------------------
waypoint showWaypoint show
Operand types:
waypoint: Array
show: String
Type of returned value:
Nothing
Description:
Sets the condition determining when the waypoint is shown.
Possible values are:
"NEVER"
"EASY"
"ALWAYS"
Used In:
ArmA
Example:
[grp, 2] showWaypoint "ALWAYS"
--------------------------------------------------------------------------------
side unit
Operand types:
unit: Object or Group
Type of returned value:
Side
Description:
Side of unit.
Note: This does not change the side of the unit.
Used In:
ArmA/OFP
Example:
? (side player == west) : hint "You are on the West side."
--------------------------------------------------------------------------------
sideChat chatText
Operand types:
chatText: String
Type of returned value:
Nothing
Description:
Type text to side radio channel.
Note: This function only types text to the list, it does not broadcast the message.
If you want the message to show on all computers, you have to execute it on them.
Used In:
ArmA/OFP
Example:
soldierOne sideChat "Show this text"
« To Menu
--------------------------------------------------------------------------------
sideEnemy
Operand types:
None
Type of returned value:
Side
Description:
The Enemy side (used for renegades).
Used In:
ArmA/OFP
--------------------------------------------------------------------------------
sideFriendly
Operand types:
None
Type of returned value:
Side
Description:
The Friendly side (used for captives).
Used In:
ArmA/OFP
--------------------------------------------------------------------------------
sideLogic
Operand types:
None
Type of returned value:
Side
Description:
The Logic side.
Used In:
ArmA/OFP
--------------------------------------------------------------------------------
sideRadio chatText
Operand types:
radioName: String
Type of returned value:
Nothing
Description:
Send message to side radio channel.
Message is defined in description.ext file.
Used In:
ArmA/OFP
Example:
soldierOne sideRadio "messageOne"
« To Menu
--------------------------------------------------------------------------------
sin x
Operand types:
x: Number
Type of returned value:
Number
Description:
Sine of x, argument in degrees.
Used In:
ArmA/OFP
Example:
sine = sin 30 ..........Result is 0.5
--------------------------------------------------------------------------------
sizeOf typeName
Operand types:
typeName: String
Type of returned value:
Number
Description:
Returns the approximate size of the entity of given type (x-axis, in meters).
Object has to be present in the current mission to be able to read a size (otherwise zero will be returned).
Used In:
ArmA
Example:
sizeOf "T72"
--------------------------------------------------------------------------------
skill person
Operand types:
person: Object
Type of returned value:
Number
Description:
Returns current level of ability of person, in range between 0 and 1.
Skill 1 is highest skill.
Used In:
ArmA/OFP
Example:
_sk = skill loon1
Bremmer
Skill of AI units set via the slider in unit placement screen varies from 0.2 to 1.0.
If superAI is enabled all units have skill of 1.0 regardless of the skill slider.
--------------------------------------------------------------------------------
vehicle skill type
Operand types:
vehicle: Object
type: String
Type of returned value:
Number
Description:
Returns skill of given type of person (commander unit).
Value of skill may vary from 0 to 1.
Used In:
ArmA
Example:
hero skill "Endurance"
« To Menu
--------------------------------------------------------------------------------
skipTime duration
Operand types:
duration: Number
Type of returned value:
Nothing
Description:
Skip time.
Daytime is adjusted, weather change is estimated, no changes in any units are made.
The tide is also adjusted.
Duration is in hours.
Used In:
ArmA/OFP
Example:
skipTime 5
Roni
Very useful function - great for giving a "campaign" feel to a running battle.
Try this in your init.sqs file -
#loop
skiptime 0.00333
~0.1
goto "loop"
This will make each day pass in around 12 minutes - great fun watching sunsets and the night sky!
macguba
Not to be confused with accTime.
--------------------------------------------------------------------------------
sleep delay
Operand types:
delay: Number
Type of returned value:
Nothing
Description:
Suspend execution of script for given time.
Used In:
ArmA
Example:
sleep 0.5
« To Menu
--------------------------------------------------------------------------------
sliderPosition idc
Operand types:
idc: Number
Type of returned value:
Number
Description:
Return current thumb position of slider idc of topmost user dialog.
Used In:
ArmA/OFP
Example:
_slidepos1 = sliderPosition 105
--------------------------------------------------------------------------------
sliderPosition control
Operand types:
control: Control
Type of returned value:
Number
Description:
Returns the current thumb position of the given slider.
Used In:
ArmA
Example:
_pos = sliderPosition _control
--------------------------------------------------------------------------------
sliderRange idc
Operand types:
idc: Number
Type of returned value:
Array
Description:
Return limits, as an array [min, max] of slider idc of topmost user dialog.
Used In:
ArmA/OFP
Example:
_slidelimits1 = sliderRange 105
« To Menu
--------------------------------------------------------------------------------
sliderRange control
Operand types:
control: Control
Type of returned value:
Array
Description:
Returns the limits (as an array [min, max]) of the given slider.
Used In:
ArmA
Example:
_limits = sliderRange _control
--------------------------------------------------------------------------------
sliderSetPosition [idc,pos]
Operand types:
[idc, pos]: Array
Type of returned value:
Nothing
Description:
Set current thumb position of slider idc of topmost user dialog.
Used In:
ArmA/OFP
Example:
sliderSetPosition [101, 50]
--------------------------------------------------------------------------------
control sliderSetPosition pos
Operand types:
control: Control
pos: Number
Type of returned value:
Nothing
Description:
Sets the current thumb position of the given slider.
Used In:
ArmA
Example:
_control sliderSetPosition 0
« To Menu
--------------------------------------------------------------------------------
sliderSetRange [idc,min,max]
Operand types:
[idc, min, max]: Array
Type of returned value:
Nothing
Description:
Set limits of slider idc of topmost user dialog.
Used In:
ArmA/OFP
Example:
sliderSetRange [101, 0, 100]
--------------------------------------------------------------------------------
control sliderSetRange [min,max]
Operand types:
control: Control
[min, max]: Array
Type of returned value:
Nothing
Description:
Sets the limits of the slider with id idc of the given slider.
Used In:
ArmA
Example:
_control sliderSetRange [0, 10]
--------------------------------------------------------------------------------
sliderSetspeed [idc,line,page]
Operand types:
[idc, line, page]: Array
Type of returned value:
Nothing
Description:
Set speed of slider with id idc of topmost user dialog.
Click to arrow = move by line
Click to scale outside thumb = move by page.
Used In:
ArmA/OFP
Example:
sliderSetspeed [101, 0.5, 2]
« To Menu
--------------------------------------------------------------------------------
control sliderSetspeed [line,page]
Operand types:
control: Control
[line, page]: Array
Type of returned value:
Nothing
Description:
Sets the speed (a click on the arrow results in a move per line.
A click on the scale outside the thumb results in a move per page) of the given slider.
Used In:
ArmA
Example:
_control sliderSetspeed [0.5, 2.0]
--------------------------------------------------------------------------------
sliderspeed idc
Operand types:
idc: Number
Type of returned value:
Array
Description:
Return speed, as an array [min, max] of slider idc of topmost user dialog.
Used In:
ArmA/OFP
Example:
_slidespeed1 = sliderspeed 105
--------------------------------------------------------------------------------
sliderspeed control
Operand types:
control: Control
Type of returned value:
Array
Description:
Returns the speed (as an array [line, page]) of the given slider.
Used In:
Arma
Example:
_speed = sliderspeed _control
« To Menu
--------------------------------------------------------------------------------
someAmmo unit
Operand types:
unit: Object
Type of returned value:
Boolean
Description:
Check if unit has some ammo.
Used In:
ArmA/OFP
Example:
? not (someAmmo loon1) : hint "Loon1 is out of ammo!"
--------------------------------------------------------------------------------
soundVolume
Operand types:
None.
Type of returned value:
Number
Description:
Check current sound volume (set by fadeSound).
Used In:
ArmA/OFP
Example:
_vol = soundVolume
--------------------------------------------------------------------------------
spawn code
Operand types:
code: Code
Type of returned value:
Script
Description:
Starts running a new script.
The new script is running in parallel, spawn does not wait for it to be done.
To check if it finished use scriptDone
Used In:
ArmA
--------------------------------------------------------------------------------
arguments spawn script
Operand types:
arguments: Any Value
script: Code
Type of returned value:
Script
Description:
Starts running a new script.
Additional arguments are passed in local _this variable.
The new script is running in parallel, spawn does not wait for it to be done.
To check if it finished use scriptDone
Used In:
ArmA
--------------------------------------------------------------------------------
speed obj
Operand types:
obj: Object
Type of returned value:
Number
Description:
Object speed (in km/h).
Used In:
ArmA/OFP
Example:
? (speed truck1) >= 100 : hint "You're going too fast!"
« To Menu
--------------------------------------------------------------------------------
speedMode grp
Operand types:
grp: Object or Group
Type of returned value:
String
Description:
Returns speed mode of the group, which can be any of the following:
"LIMITED"
"NORMAL"
"FULL"
Used In:
ArmA/OFP
Example:
_grpspeed1 = speedMode grp1
--------------------------------------------------------------------------------
sqrt x
Operand types:
x: Number
Type of returned value:
Number
Description:
Returns square root of x.
Used In:
ArmA/OFP
Example:
_sq = sqrt 9 ..........Result is 3
--------------------------------------------------------------------------------
for /.../ step step
Operand types:
for /.../: For Type
step: Number
Type of returned value:
Script
Description:
Optionally can set step.
If you want to count down, step must be specified, and set negative.
Default value is 1.
Used In:
ArmA
Example:
for "_x" from 20 to 10 step -2 do {..code..}
« To Menu
--------------------------------------------------------------------------------
unit stop stop
Operand types:
unit: Object
stop: Boolean
Type of returned value:
Nothing
Description:
Stop AI unit.
This function is obsolete.
Use disableAI to get better control on stopping unit.
Used In:
ArmA/OFP
Example:
loon1 stop true
--------------------------------------------------------------------------------
stopped unit
Operand types:
unit: Object
Type of returned value:
Boolean
Description:
Check if unit is stopped by "stop" command.
Used In:
ArmA/OFP
Example:
? (stopped loon1) : hint "Loon1 is stopped"
--------------------------------------------------------------------------------
str any value
Operand types:
any value: Anything
Type of returned value:
String
Description:
Converts any variable to a string.
Used In:
Arma
Example:
str (2+3)......result is "5"
« To Menu
--------------------------------------------------------------------------------
supportInfo mask
Operand types:
mask: String
Type of returned value:
Array
Description:
Creates a list of supported operators and types.
Each field of the array has the format: "x:name" where x is:
't' - type
'n' - null operator
'u' - unary operator
'b' - binary operator
"STEALTH"
'name' is operator/type name (in the case of operator, type of input operands is included).
`mask` parameter can be an empty string, or one of field.
In this case, function returns an empty array, if operator is not included in the list.
`mask` can contain wildcards, for example: *:name, t:*, t:name* or *:*
Used In:
Arma
Example:
supportInfo "b:select*"......result is ["b:ARRAY select SCALAR","b:ARRAY select BOOL"]
--------------------------------------------------------------------------------
surfaceIsWater [x, y]
Operand types:
[x, y]: Array
Type of returned value:
Boolean
Description:
Returns whether water is at given position.
Used In:
Arma
--------------------------------------------------------------------------------
surfaceType [x, y]
Operand types:
[x, y]: Array
Type of returned value:
String
Description:
Returns what surface type is at given position.
Used In:
Arma
« To Menu
--------------------------------------------------------------------------------
switch exp
Operand types:
exp: Anything
Type of returned value:
Switch Type
Description:
Begins switch form.
Used In:
Arma
Example:
switch (_a) do { case 1: {block}; case 2 : {block}; default {block};}
--------------------------------------------------------------------------------
switchableUnits
Operand types:
None
Type of returned value:
Array
Description:
Return a list of units accessible through team switch.
Used In:
Arma
--------------------------------------------------------------------------------
unit switchCamera mode
Operand types:
unit: Object
mode: String
Type of returned value:
Nothing
Description:
Switch camera to given vehicle / camera.
Mode is one of:
"INTERNAL" (1st person)
"GUNNER" (optics / sights)
"EXTERNAL"(3rd person)
"GROUP" (group)
Used In:
ArmA/OFP
Example:
loon1 switchCamera "External"
General Barron
If you switchCamera to a group leader, you can control his group as if it were your own.
« To Menu
--------------------------------------------------------------------------------
lamp switchLight mode
Operand types:
lamp: Object
mode: String
Type of returned value:
Nothing
Description:
Controls lampost mode.
Mode may be:
"ON"
"OFF"
"AUTO" ( Lampost is on only during nighttime)
"AUTO" is default.
Used In:
ArmA/OFP
Examples:
(object 12345) switchLight "off"
nearestObject [player, "Streetlamp"] switchLight "OFF"
macguba
Use lightIsOn to check the status of a lamppost.
--------------------------------------------------------------------------------
person switchMove movename
Operand types:
person: Object
movename: String
Type of returned value:
Nothing
Description:
When used on a person, given move is started immediatelly (no transition).
Use switchMove "" to switch back to default movement if there is no transition back, otherwise person may become stuck.
Used In:
ArmA/OFP
Example:
loon1 switchMove "FXStandDip"
macguba
For a smooth transition use playMove.
Animation list here.
« To Menu
--------------------------------------------------------------------------------
waypoint synchronizeWaypoint [waypoint1, waypoint2, ...]
Operand types:
waypoint: Array
[waypoint1, waypoint2, ...]: Array
Type of returned value:
Nothing
Description:
Synchronizes the waypoint with other waypoints.
Each waypoint is given as an array [group, index].
Used In:
ArmA
Example:
[group1, 2] synchronizeWaypoint [[group2, 3]]
--------------------------------------------------------------------------------
trigger synchronizeWaypoint [waypoint1, waypoint2, ...]
Operand types:
trigger: Object
[waypoint1, waypoint2, ...]: Array
Type of returned value:
Nothing
Description:
Synchronizes the trigger with waypoints.
Each waypoint is given as an array [group, index].
Used In:
ArmA
Example:
trigger synchronizeWaypoint []
--------------------------------------------------------------------------------
« To Menu