Difference between revisions of "Osiris/API/GetSurfaceGroundAt"
From Divinity Engine Wiki
(Created page with "===== Full Definition(s) ===== * query '''GetSurfaceGroundAt'''('''''[in]'''(GUIDSTRING)'''''_Target''', '''''[out]'''(STRING)'''''_Surface''') ===== Description ===== Returns...") |
m |
||
| (3 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 | + | 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 | + | * '''_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]] | ||
| Line 25: | Line 26: | ||
| − | [[Category:Osiris Queries| | + | [[Category:Osiris Queries|GetSurfaceGroundAt]] |
Latest revision as of 22: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
- /
