Osiris/API/GetSurfaceNameByTypeIndex

Full Definition(s)

• query GetSurfaceNameByTypeIndex([in](INTEGER)_SurfaceIndex, [out](STRING)_SurfaceName)

Description

Returns the name of the surface that has the index _SurfaceIndex in the internal numbered list of surface types as _SurfaceName.

Return Values

• Success/Failure: Fails if there is no surface with such an index.
• _SurfaceName: The name of the surface.

Notes

• This call is mainly useful if you need to handle surfaces in behaviour script and Osiris simultaneously - the SURFACE type in behaviour script can be queried with GetVarInteger and then converted to the strings used in Osiris with this call.
• The surface types page lists the surfaces in the same order as they exist in the internal list, starting at 0 for SurfaceNone.

See Also

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