BIS fnc setHeight: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{Function " to "{{RV|type=function ")
m (Text replacement - " *\| *PARAMETER[0-9]{1,3} *= * " to " ")
Line 27: Line 27:
{{Important | This syntax uses {{Inline code|[[this]]}} and is therefore meant to be used in init fields. Not to be used in MP.}}
{{Important | This syntax uses {{Inline code|[[this]]}} and is therefore meant to be used in init fields. Not to be used in MP.}}


|p21= height: [[Number]] - (Optional, default 0) height to set |PARAMETER21=
|p21= height: [[Number]] - (Optional, default 0) height to set


|p22= mode: [[String]] - (Optional, default "ROADWAY") can be:
|p22= mode: [[String]] - (Optional, default "ROADWAY") can be:
* "ROADWAY": uses [[setPos]]
* "ROADWAY": uses [[setPos]]
* "ASL": uses [[setPosASL]]
* "ASL": uses [[setPosASL]]
* "ATL": uses [[setPosATL]] |PARAMETER22=
* "ATL": uses [[setPosATL]]


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

Revision as of 18:11, 29 January 2021

Hover & click on the images for description

Description

Description:
Description needed
Execution:
call
Groups:
Object Manipulation

Syntax

Syntax:
Syntax needed
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:
Return value needed

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:
See also needed

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