BIS_fnc_setHeight

Description

Set an object's altitude.

Syntax

Syntax 1

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

  • "ROADWAY": uses setPos
  • "ASL": uses setPosASL
  • "ATL": uses setPosATL

Returns: Boolean - true when done

Syntax 2

[height, mode] call BIS_fnc_setHeight

Important

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:

  • "ROADWAY": uses setPos
  • "ASL": uses setPosASL
  • "ATL": uses setPosATL

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

See also

setPos · setPosASL · setPosATL