Difference between revisions of "Osiris/API/GetSurfaceTurns"

Latest revision as of 22:44, 22 February 2018

Full Definition(s)

• query GetSurfaceTurns([in](GUIDSTRING)_Target, [in](INTEGER)_SurfaceLayer, [out](INTEGER)_SurfaceTurns)

Description

Returns the number of remaining turns of the surface at _Target's AI-grid position in the layer _SurfaceLayer.

Return Values

• Success/Failure: Fails if no level is currently loaded, if the _Target is outside the AIgrid, if _SurfaceLayer is invalid, or if there is currently no surface at _Target.
• _SurfaceTurns: The remaining number of turns that the surface at that position in that layer has remaining (rounded upwards). Returns -1 for permanent surfaces.

Notes

• See Osiris/API/GetSurfaceSize for valid values for _SurfaceLayer.

See Also

• CreatePuddle
• CreateSurface
• CreateSurfaceAtPosition
• DrawSurfaceOnPath
• GetSurfaceCloudAt
• GetSurfaceCloudOwnerAt
• GetSurfaceGroundAt
• GetSurfaceGroundOwnerAt
• GetSurfaceNameByTypeIndex
• GetSurfaceSize
• GetSurfaceTypeIndex
• StopDrawSurfaceOnPath
• TransformSurface
• TransformSurfaceAtPosition
• List of surface types