BIS fnc setHeight: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Remove note template usage)
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Function|Comments=
{{Function|Comments=
____________________________________________________________________________________________


| tkoh |Game name=
| tkoh |Game name=
Line 7: Line 6:


|gr1 = Object Manipulation |GROUP1=
|gr1 = Object Manipulation |GROUP1=
____________________________________________________________________________________________


| Set an object height. |DESCRIPTION=
| Set an object height. |DESCRIPTION=
____________________________________________________________________________________________


| [target, height, position, mode] call [[BIS_fnc_setHeight]] |SYNTAX=
| [target, height, position, mode] call [[BIS_fnc_setHeight]] |SYNTAX=
Line 26: Line 23:


| [[Boolean]] - [[true]] when done |RETURNVALUE=
| [[Boolean]] - [[true]] when done |RETURNVALUE=
____________________________________________________________________________________________


|s2= [height, mode] call [[BIS_fnc_setHeight]]
|s2= [height, mode] call [[BIS_fnc_setHeight]]
Line 39: Line 35:


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


|x1= <code>{{cc|will place player's vehicle on "myHeightMarker", 50m above terrain}}
|x1= <code>{{cc|will place player's vehicle on "myHeightMarker", 50m above terrain}}
Line 47: Line 42:
{{cc|use where '''this''' has a value like in an init field}}
{{cc|use where '''this''' has a value like in an init field}}
[50, "ASL"] [[call]] [[BIS_fnc_setHeight]];</code> |EXAMPLE2=
[50, "ASL"] [[call]] [[BIS_fnc_setHeight]];</code> |EXAMPLE2=
____________________________________________________________________________________________


| [[setPos]], [[setPosASL]], [[setPosATL]] |SEEALSO=
| [[setPos]], [[setPosASL]], [[setPosATL]] |SEEALSO=

Revision as of 00:44, 17 January 2021

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:
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