BIS fnc setHeight: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " |s1=[" to " |s1= [")
m (Text replacement - "\{\{ *cc*\| *([^}]+) *\}\}" to "// $1")
Line 38: Line 38:
|r2= [[Boolean]] - [[true]] when done
|r2= [[Boolean]] - [[true]] when done


|x1= <code>{{cc|will place player's vehicle on "myHeightMarker", 50m above terrain}}
|x1= <code>// will place player's vehicle on "myHeightMarker", 50m above terrain
[<nowiki/>[[vehicle]] [[player]], 50, [[getMarkerPos]] "myHeightMarker", "ATL"]]] [[call]] [[BIS_fnc_setHeight]];</code>
[<nowiki/>[[vehicle]] [[player]], 50, [[getMarkerPos]] "myHeightMarker", "ATL"]]] [[call]] [[BIS_fnc_setHeight]];</code>


|x2= <code>{{cc|will set the ''this'' object 50m above sea level at its position}}
|x2= <code>// will set the ''this'' object 50m above sea level at its position
{{cc|use where '''this''' has a value like in an init field}}
// use where '''this''' has a value like in an init field
[50, "ASL"] call BIS_fnc_setHeight;</code>
[50, "ASL"] call BIS_fnc_setHeight;</code>


|seealso= [[setPos]] [[setPosASL]] [[setPosATL]]
|seealso= [[setPos]] [[setPosASL]] [[setPosATL]]
}}
}}

Revision as of 11:02, 13 July 2022

Hover & click on the images for description

Description

Description:
Set an object height.
Execution:
call
Groups:
Object Manipulation

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
This syntax uses this and is therefore meant to be used in init fields. Not to be used in MP.
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:
setPos setPosASL setPosATL

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