BIS fnc setHeight: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|Game version=" to "|Game version= |gr1 = Object Manipulation |GROUP1=")
m (Remove note template usage)
Line 29: Line 29:


|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.}} |SYNTAX2=
{{Important | This syntax uses {{Inline code|[[this]]}} and is therefore meant to be used in init fields. Not to be used in MP.}} |SYNTAX2=


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


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


|x2= <code>{{codecomment|// will set the ''this'' object 50m above sea level at its position
|x2= <code>{{cc|will set the ''this'' object 50m above sea level at its position}}
// 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=
____________________________________________________________________________________________
____________________________________________________________________________________________
Line 60: Line 60:


<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>
[[Category:Functions|{{uc:setHeight}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:setHeight}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:setHeight}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:setHeight}}]]

Revision as of 19:00, 26 December 2020

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