Difference between revisions of "BIS fnc setHeight"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|+$" to "")
m (Some wiki formatting)
 
(12 intermediate revisions by the same user not shown)
Line 9: Line 9:
 
|gr1= Object Manipulation
 
|gr1= Object Manipulation
  
|descr= Set an object height.
+
|descr= Set an object's altitude.
  
|s1=[target, height, position, mode] call [[BIS_fnc_setHeight]]
+
|s1= [target, height, position, mode] call [[BIS_fnc_setHeight]]
  
 
|p1= target: [[Object]] - affected object
 
|p1= target: [[Object]] - affected object
Line 17: Line 17:
 
|p2= height: [[Number]] - (Optional, default 0) height to set
 
|p2= height: [[Number]] - (Optional, default 0) height to set
  
|p3= position: [[Position]] - (Optional, default [[position]] ''target'') position to place the target with calculated height
+
|p3= position: [[Position]] - (Optional, default <sqf inline>position target</sqf>) position to place the target with calculated height
  
 
|p4= mode: [[String]] - (Optional, default "ROADWAY") can be:
 
|p4= mode: [[String]] - (Optional, default "ROADWAY") can be:
Line 27: Line 27:
  
 
|s2= [height, mode] call [[BIS_fnc_setHeight]]
 
|s2= [height, mode] call [[BIS_fnc_setHeight]]
{{Feature | important | This syntax uses {{ic|[[Magic Variables#this_2|this]]}} and is therefore meant to be used in init fields. Not to be used in MP.}}
+
{{Feature|important|This syntax uses <sqf inline>this</sqf> 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
 
|p21= height: [[Number]] - (Optional, default 0) height to set
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= <sqf>
[<nowiki/>[[vehicle]] [[player]], 50, [[getMarkerPos]] "myHeightMarker", "ATL"]]] [[call]] [[BIS_fnc_setHeight]];</code>
+
// will place player's vehicle on "myHeightMarker", 50m above terrain
 +
[vehicle player, 50, getMarkerPos "myHeightMarker", "ATL"]]] call BIS_fnc_setHeight;
 +
</sqf>
  
|x2= <code>{{cc|will set the ''this'' object 50m above sea level at its position}}
+
|x2= <sqf>
{{cc|use where '''this''' has a value like in an init field}}
+
// will set the "this" object 50m above sea level at its position
[50, "ASL"] [[call]] [[BIS_fnc_setHeight]];</code>
+
// use where "this" has a value like in an init field
 +
[50, "ASL"] call BIS_fnc_setHeight;
 +
</sqf>
  
|seealso= [[setPos]], [[setPosASL]], [[setPosATL]]
+
|seealso= [[setPos]] [[setPosASL]] [[setPosATL]]
 
}}
 
}}

Latest revision as of 14:33, 25 July 2022

Hover & click on the images for description

Description

Description:
Set an object's altitude.
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