P. 1
comref

comref

|Views: 450|Likes:
Published by Robert Cox

More info:

Published by: Robert Cox on Apr 15, 2011
Copyright:Attribution Non-commercial

Availability:

Read on Scribd mobile: iPhone, iPad and Android.
download as PDF, TXT or read online from Scribd
See more
See less

04/15/2011

pdf

text

original

Operand types:

array: Array

Compatibility:

Version 5501 required.

Type of returned value:

Page 308of 415

BIS Game Engine Scripting Commands

7/11/2010

http://www.arma2.com/comref/full.html

Nothing

Description:

Sets if group icons are visible.

Example:

showGroupIcons [true,true]

Category: OFP

group setGroupid [nameFomat, nameParam1, ...]

Operand types:

group: Object or Group
[nameFomat, nameParam1, ...]: Array

Type of returned value:

Nothing

Description:

Sets the group identity. nameFormat contains strings "%CLASS_NAME" where CLASS_NAME
is name of class in CfgWorlds, parameters are names of subclasses of CLASS_NAME with the
description of the name subpart.

Category: OFP

object setHideBehind [objectWhereHide, hidePosition]

Operand types:

object: Object
[objectWhereHide, hidePosition]: Array

Compatibility:

Version 2.92 required.

Type of returned value:

Nothing

Description:

It sets the data for hiding. ObjectWhereHide can be taken using findCover. HidePosition can be
taken using getHideFrom.

Category: OFP

object setHit [part, damage]

Operand types:

object: Object
[part, damage]: Array

Compatibility:

Version 2.30 required.

Type of returned value:

Nothing

Description:

Page 309of 415

BIS Game Engine Scripting Commands

7/11/2010

http://www.arma2.com/comref/full.html

Damage / repair part of object. Damage 0 means fully functional, damage 1 means completely

destroyed / dead.

Example:

vehicle player setHit ["engine", 1]

Category: OFP

person setIdentity identity

Operand types:

person: Object
identity: String

Type of returned value:

Nothing

Description:

Sets the identity of a person. Identities are defined in the descripion.ext file of the mission or

campaign.

Example:

setIdentity "JohnDoe"

Category: OFP

location setImportance importance

Operand types:

location: Location
importance: Number

Compatibility:

Version 2.90 required.

Type of returned value:

Nothing

Description:

Set a new importance of given location.

Category: Location

light setLightAmbient [r, g, b]

Operand types:

light: Object
[r, g, b]: Array

Compatibility:

Version 2.58 required.

Type of returned value:

Nothing

Description:

Page 310of 415

BIS Game Engine Scripting Commands

7/11/2010

http://www.arma2.com/comref/full.html

Set ambient color of light.

Category: OFP

light setLightBrightness brightness

Operand types:

light: Object
brightness: Number

Compatibility:

Version 2.58 required.

Type of returned value:

Nothing

Description:

Set brightness of light.

Category: OFP

light setLightColor [r, g, b]

Operand types:

light: Object
[r, g, b]: Array

Compatibility:

Version 2.58 required.

Type of returned value:

Nothing

Description:

Set diffuse color of light.

Category: OFP

marker setMarkerAlpha alpha

Operand types:

marker: String
alpha: Number

Compatibility:

Version 5501 required.

Type of returned value:

Nothing

Description:

Sets the marker alpha. The marker is modified on all computers in a network session.

Example:

"MarkerOne" setMarkerAlpha 0.5

Category: OFP

Page 311of 415

BIS Game Engine Scripting Commands

7/11/2010

http://www.arma2.com/comref/full.html

marker setMarkerAlphaLocal alpha

Operand types:

marker: String
alpha: Number

Compatibility:

Version 5501 required.

Type of returned value:

Nothing

Description:

Sets the marker alpha. The marker is only modified on the computer where the command is called.

Example:

"MarkerOne" setMarkerAlpha 0.5

Category: OFP

name setMarkerBrush brush

Operand types:

name: String
brush: String

Compatibility:

Version 1.86 required.

Type of returned value:

Nothing

Description:

Selects the fill texture for the marker ("RECTANGLE" or "ELLIPSE"). Brush is the name of the
subclass in CfgMarkerBrushes. The marker is modified on all computers in a network session.

Example:

"Marker1" setMarkerBrush "DiagGrid"

Category: OFP

name setMarkerBrushLocal brush

Operand types:

name: String
brush: String

Compatibility:

Version 2.92 required.

Type of returned value:

Nothing

Description:

Selects the fill texture for the marker ("RECTANGLE" or "ELLIPSE"). Brush is the name of the
subclass in CfgMarkerBrushes. The marker is only modified on the computer where the command is
called.

Page 312of 415

BIS Game Engine Scripting Commands

7/11/2010

http://www.arma2.com/comref/full.html

Example:

"Marker1" setMarkerBrushLocal "DiagGrid"

Category: OFP

marker setMarkerColor color

Operand types:

marker: String
color: String

Compatibility:

Version 1.21 required.

Type of returned value:

Nothing

Description:

Sets the marker color. Color is one of: "Default", "ColorBlack", "ColorRed", "ColorRedAlpha",
"ColorGreen", "ColorGreenAlpha", "ColorBlue", "ColorYellow" or "ColorWhite". The marker is
modified on all computers in a network session.

Example:

"MarkerOne" setMarkerColor "ColorBlack"

Category: OFP

marker setMarkerColorLocal color

Operand types:

marker: String
color: String

Compatibility:

Version 2.92 required.

Type of returned value:

Nothing

Description:

Sets the marker color. Color is one of: "Default", "ColorBlack", "ColorRed", "ColorRedAlpha",
"ColorGreen", "ColorGreenAlpha", "ColorBlue", "ColorYellow" or "ColorWhite". The marker is
only modified on the computer where the command is called.

Example:

"MarkerOne" setMarkerColorLocal "ColorBlack"

Category: OFP

name setMarkerDir angle

Operand types:

name: String
angle: Number

Page 313of 415

BIS Game Engine Scripting Commands

7/11/2010

http://www.arma2.com/comref/full.html

Compatibility:

Version 1.86 required.

Type of returned value:

Nothing

Description:

Sets the orientation of the marker. Angle is in degrees. The marker is modified on all computers in

a network session.

Example:

"Marker1" setMarkerDir 90

Category: OFP

name setMarkerDirLocal angle

Operand types:

name: String
angle: Number

Compatibility:

Version 2.92 required.

Type of returned value:

Nothing

Description:

Sets the orientation of the marker. Angle is in degrees. The marker is only modified on the
computer where the command is called.

Example:

"Marker1" setMarkerDirLocal 90

Category: OFP

markerName setMarkerPos pos

Operand types:

markerName: String
pos: Array

Type of returned value:

Nothing

Description:

Moves the marker. The format of pos is Position2D. The marker is modified on all computers in a

network session.

Example:

"MarkerOne" setMarkerPos getMarkerPos "MarkerTwo"

Category: OFP

markerName setMarkerPosLocal pos

Page 314of 415

BIS Game Engine Scripting Commands

7/11/2010

http://www.arma2.com/comref/full.html

Operand types:

markerName: String
pos: Array

Compatibility:

Version 2.92 required.

Type of returned value:

Nothing

Description:

Moves the marker. The format of pos is Position2D. The marker is only modified on the computer
where the command is called.

Example:

"MarkerOne" setMarkerPosLocal getMarkerPos "MarkerTwo"

Category: OFP

name setMarkerShape shape

Operand types:

name: String
shape: String

Compatibility:

Version 1.86 required.

Type of returned value:

Nothing

Description:

Selects the shape (type) of the marker. Shape can be "ICON", "RECTANGLE" or "ELLIPSE". The
marker is modified on all computers in a network session.

Example:

"Marker1" setMarkerShape "RECTANGLE"

Category: OFP

name setMarkerShapeLocal shape

Operand types:

name: String
shape: String

Compatibility:

Version 2.92 required.

Type of returned value:

Nothing

Description:

Selects the shape (type) of the marker. Shape can be "ICON", "RECTANGLE" or "ELLIPSE". The
marker is only modified on the computer where the command is called.

Example:

"Marker1" setMarkerShapeLocal "RECTANGLE"

Category: OFP

Page 315of 415

BIS Game Engine Scripting Commands

7/11/2010

http://www.arma2.com/comref/full.html

marker setMarkerSize size

Operand types:

marker: String
size: Array

Compatibility:

Version 1.21 required.

Type of returned value:

Nothing

Description:

Sets the marker size. Size is in format [a-axis, b-axis]. The marker is modified on all computers in a

network session.

Example:

"MarkerOne" setMarkerSize [100, 200]

Category: OFP

marker setMarkerSizeLocal size

Operand types:

marker: String
size: Array

Compatibility:

Version 2.92 required.

Type of returned value:

Nothing

Description:

Sets the marker size. Size is in format [a-axis, b-axis]. The marker is only modified on the
computer where the command is called.

Example:

"MarkerOne" setMarkerSizeLocal [100, 200]

Category: OFP

name setMarkerText text

Operand types:

name: String
text: String

Compatibility:

Version 1.86 required.

Type of returned value:

Nothing

Description:

Sets the text label of an existing marker. The marker is modified on all computers in a network

session.

Page 316of 415

BIS Game Engine Scripting Commands

7/11/2010

http://www.arma2.com/comref/full.html

Example:

"Marker1" setMarkerText You are here.

Category: OFP

name setMarkerTextLocal text

Operand types:

name: String
text: String

Compatibility:

Version 2.92 required.

Type of returned value:

Nothing

Description:

Sets the text label of an existing marker. The marker is only modified on the computer where the

command is called.

Example:

"Marker1" setMarkerTextLocal You are here.

Category: OFP

markerName setMarkerType markerType

Operand types:

markerName: String
markerType: String

Type of returned value:

Nothing

Description:

Sets the marker type. Type may be any of: "Flag", "Flag1", "Dot", "Destroy", "Start", "End",
"Warning", "Join", "Pickup", "Unknown", "Marker", "Arrow" or "Empty". The marker is modified on
all computers in a network session.

Example:

"MarkerOne" setMarkerType "Arrow"

Category: OFP

You're Reading a Free Preview

Download
scribd
/*********** DO NOT ALTER ANYTHING BELOW THIS LINE ! ************/ var s_code=s.t();if(s_code)document.write(s_code)//-->