Difference between revisions of "Osiris/API/GetSurfaceCloudAt"

From Divinity Engine Wiki
Jump to: navigation, search
m
 
(One intermediate revision by one other user not shown)
Line 2: Line 2:
 
* query '''GetSurfaceCloudAt'''('''''[in]'''(GUIDSTRING)'''''_Target''', '''''[out]'''(STRING)'''''_Surface''')
 
* query '''GetSurfaceCloudAt'''('''''[in]'''(GUIDSTRING)'''''_Target''', '''''[out]'''(STRING)'''''_Surface''')
 
===== Description =====
 
===== Description =====
Returns the surface in the cloud layer at the current location.
+
Returns the surface in the cloud 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.
Line 9: Line 9:
 
* /
 
* /
 
===== See Also =====
 
===== See Also =====
 +
* [[Osiris/API/GetSurfaceTurns|GetSurfaceTurns]]
 
* [[Osiris/API/CreatePuddle|CreatePuddle]]
 
* [[Osiris/API/CreatePuddle|CreatePuddle]]
 
* [[Osiris/API/CreateSurface|CreateSurface]]
 
* [[Osiris/API/CreateSurface|CreateSurface]]

Latest revision as of 21:45, 22 February 2018

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

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

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