BIS fnc setHeight: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \|r2=(.*)\|RETURNVALUE=" to " |r2=$1|RETURNVALUE2=")
mNo edit summary
Line 27: Line 27:


|s2= [height, mode] call [[BIS_fnc_setHeight]]
|s2= [height, mode] call [[BIS_fnc_setHeight]]
{{note|Alternative Syntax uses {{Inline code|[[this]]}} and {{Inline code|[[position]] [[this]]}}; this shortened syntax is to be used in init fields.}} |Alternative Syntax=
{{note|Alternative Syntax uses {{Inline code|[[this]]}} and {{Inline code|[[position]] [[this]]}}; this shortened syntax is to be used in init fields.}} |SYNTAX2=


|p21= height: [[Number]] - (Optional, default 0) height to set |PARAMETER21=
|p21= height: [[Number]] - (Optional, default 0) height to set |PARAMETER21=
Line 34: Line 34:
* "ROADWAY": uses [[setPos]]
* "ROADWAY": uses [[setPos]]
* "ASL": uses [[setPosASL]]
* "ASL": uses [[setPosASL]]
* "ATL": uses [[setPosATL]] |PARAMETER2=
* "ATL": uses [[setPosATL]] |PARAMETER22=


|r2= [[Boolean]] - [[true]] when done |RETURNVALUE2=
|r2= [[Boolean]] - [[true]] when done |RETURNVALUE2=

Revision as of 21:52, 24 September 2020

Hover & click on the images for description

Description

Description:
Set an object height.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[target, height, position, mode] call BIS_fnc_setHeight
Parameters:
target: Object - affected object
height: Number - (Optional, default 0) height to set
position: Position - (Optional, default position target) position to place the target with calculated height
mode: String - (Optional, default "ROADWAY") can be:
Return Value:
Boolean - true when done

Alternative Syntax

Syntax:
[height, mode] call BIS_fnc_setHeight Template:note
Parameters:
height: Number - (Optional, default 0) height to set
mode: String - (Optional, default "ROADWAY") can be:
Return Value:
Boolean - true when done

Examples

Example 1:
// will place player's vehicle on "myHeightMarker", 50m above terrain [vehicle player, 50, getMarkerPos "myHeightMarker", "ATL"]]] call BIS_fnc_setHeight;
Example 2:
// will set the this object 50m above sea level at its position // use where this has a value like in an init field [50, "ASL"] call BIS_fnc_setHeight;

Additional Information

See also:
setPossetPosASLsetPosATL

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

Notes

Bottom Section