Difference between revisions of "Osiris/API/GetSurfaceGroundAt"

From Divinity Engine Wiki
Jump to: navigation, search
Line 2: Line 2:
 
* query '''GetSurfaceGroundAt'''('''''[in]'''(GUIDSTRING)'''''_Target''', '''''[out]'''(STRING)'''''_Surface''')
 
* query '''GetSurfaceGroundAt'''('''''[in]'''(GUIDSTRING)'''''_Target''', '''''[out]'''(STRING)'''''_Surface''')
 
===== Description =====
 
===== Description =====
Returns the surface in the ground layer at the current location.
+
Returns the surface in the ground layer at the '''_Target''''s location.
 
===== Return Values =====
 
===== Return Values =====
 
* '''Success/Failure''': Fails if the _Target is outside the AIgrid.
 
* '''Success/Failure''': Fails if the _Target is outside the AIgrid.

Revision as of 15:17, 20 December 2017

Full Definition(s)
  • query GetSurfaceGroundAt([in](GUIDSTRING)_Target, [out](STRING)_Surface)
Description

Returns the surface in the ground layer at the _Target's location.

Return Values
  • Success/Failure: Fails if the _Target is outside the AIgrid.
  • _Surface: The surface on the ground in the air. Returns SurfaceNone if there is no cloud.
Notes
  • /
See Also