Osiris/API/GetSurfaceGroundAt: Difference between revisions

From Divinity Engine Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(2 intermediate revisions by 2 users not shown)
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.
* '''_Surface''': The surface on the ground in the air. Returns SurfaceNone if there is no cloud.
* '''_Surface''': The surface on the ground in the air. Returns SurfaceNone if there is no ground surface.
===== Notes =====
===== Notes =====
* /
* /
Line 18: Line 18:
* [[Osiris/API/GetSurfaceNameByTypeIndex|GetSurfaceNameByTypeIndex]]
* [[Osiris/API/GetSurfaceNameByTypeIndex|GetSurfaceNameByTypeIndex]]
* [[Osiris/API/GetSurfaceSize|GetSurfaceSize]]
* [[Osiris/API/GetSurfaceSize|GetSurfaceSize]]
* [[Osiris/API/GetSurfaceTurns|GetSurfaceTurns]]
* [[Osiris/API/GetSurfaceTypeIndex|GetSurfaceTypeIndex]]
* [[Osiris/API/GetSurfaceTypeIndex|GetSurfaceTypeIndex]]
* [[Osiris/API/StopDrawSurfaceOnPath|StopDrawSurfaceOnPath]]
* [[Osiris/API/StopDrawSurfaceOnPath|StopDrawSurfaceOnPath]]

Latest revision as of 20:46, 22 February 2018

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 ground surface.
Notes
  • /
See Also