Osiris/API/GetSurfaceSize

Full Definition(s)

• query GetSurfaceSize([in](GUIDSTRING)_Target, [in](INTEGER)'_SurfaceLayer, [out](INTEGER)_SurfaceSize)

Description

Returns the size of the surface on layer _SurfaceLayer in which _Target is standing. Valid values for _SurfaceLayer are

0 

Ground layer

1 

Cloud layer

Return Values

• Success/Failure: Fails if _Target is NULL or does not have a position (e.g. in an inventory), if no level is currently loaded, if _SurfaceLayer is not valid, or if _Target is not in any surface that belongs to _SurfaceLayer.
• _SurfaceSize: The number of cells occupied by the surface.

Notes

• /

See Also

• CreatePuddle
• CreateSurface
• CreateSurfaceAtPosition
• DrawSurfaceOnPath
• GetSurfaceCloudAt
• GetSurfaceCloudOwnerAt
• GetSurfaceGroundAt
• GetSurfaceGroundOwnerAt
• GetSurfaceNameByTypeIndex
• GetSurfaceTypeIndex
• StopDrawSurfaceOnPath
• TransformSurface
• TransformSurfaceAtPosition