BIS fnc setHeight: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \| *(\[[a-zA-Z,. ]*\] call ('''|\[\[)?BI(N|S)_fnc_[a-zA-Z]+('''|\]\])?) * \|p1=" to " |s1=$1 |p1=")
m (Text replacement - "\|seealso= ([^ ]+)(\]\]|\}\}), *(\[\[|\{\{)" to "|seealso= $1$2 $3")
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{RV|type=function
{{RV|type=function


| tkoh
|game1= tkoh
|version1= 1.00


|1.00
|game2= arma3
|version2= 0.50


|gr1= Object Manipulation
|gr1= Object Manipulation


| Set an object height.
|descr= Set an object height.


|s1=[target, height, position, mode] call [[BIS_fnc_setHeight]]
|s1=[target, height, position, mode] call [[BIS_fnc_setHeight]]
Line 22: Line 24:
* "ATL": uses [[setPosATL]]
* "ATL": uses [[setPosATL]]


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


|s2= [height, mode] call [[BIS_fnc_setHeight]]
|s2= [height, mode] call [[BIS_fnc_setHeight]]
Line 43: Line 45:
[50, "ASL"] [[call]] [[BIS_fnc_setHeight]];</code>
[50, "ASL"] [[call]] [[BIS_fnc_setHeight]];</code>


|seealso= [[setPos]], [[setPosASL]], [[setPosATL]]
|seealso= [[setPos]] [[setPosASL]] [[setPosATL]]
}}
}}
[[Category:{{Name|arma3}}: Functions|{{uc:setHeight}}]]

Revision as of 14:00, 1 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