GetTerrainHeight: Difference between revisions

From Onset Developer Wiki
(Created page with "{{Info|Function|Client|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|GetTerrainHeight(sX, sY, sZ)}} {{FuncParameters}} {{FuncParam|sX|__EDIT_ME__}} {{FuncParam|sY|__ED...")
 
(terriain heiught edit)
 
Line 1: Line 1:
{{Info|Function|Client|1.0}}
{{Info|Function|Client|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Creates a linetrace from the given coordiantes facing downwards and returns the Z value of the first hit object.}}


{{FuncSyntax|GetTerrainHeight(sX, sY, sZ)}}
{{FuncSyntax|GetTerrainHeight(sX, sY, sZ)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|sX|__EDIT_ME__}}
{{FuncParam|sX|X float value}}
{{FuncParam|sY|__EDIT_ME__}}
{{FuncParam|sY|Y float value}}
{{FuncParam|sZ|__EDIT_ME__}}
{{FuncParam|sZ|Z float value}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Returns Z value of first hit object, else returns false}}


== Example ==
== Example ==

Latest revision as of 16:44, 22 December 2019

GetTerrainHeight

Type: Function
Context: Client
Introduced: v1.0

Description

Creates a linetrace from the given coordiantes facing downwards and returns the Z value of the first hit object.

Syntax

GetTerrainHeight(sX, sY, sZ)

Parameters

  • sX
    X float value
  • sY
    Y float value
  • sZ
    Z float value

Return Value

  • Returns Z value of first hit object, else returns false

Example

__EDIT_ME__

See also

__EDIT_ME__