View source for 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 =====
* This query is new in DOS2 Patch 5
===== See Also =====
* [[Osiris/API/CreatePuddle|CreatePuddle]]
* [[Osiris/API/CreateSurface|CreateSurface]]
* [[Osiris/API/CreateSurfaceAtPosition|CreateSurfaceAtPosition]]
* [[Osiris/API/DrawSurfaceOnPath|DrawSurfaceOnPath]]
* [[Osiris/API/GetSurfaceCloudAt|GetSurfaceCloudAt]]
* [[Osiris/API/GetSurfaceCloudOwnerAt|GetSurfaceCloudOwnerAt]]
* [[Osiris/API/GetSurfaceGroundAt|GetSurfaceGroundAt]]
* [[Osiris/API/GetSurfaceGroundOwnerAt|GetSurfaceGroundOwnerAt]]
* [[Osiris/API/GetSurfaceNameByTypeIndex|GetSurfaceNameByTypeIndex]]
* [[Osiris/API/GetSurfaceTurns|GetSurfaceTurns]]
* [[Osiris/API/GetSurfaceTypeIndex|GetSurfaceTypeIndex]]
* [[Osiris/API/StopDrawSurfaceOnPath|StopDrawSurfaceOnPath]]
* [[Osiris/API/TransformSurface|TransformSurface]]
* [[Osiris/API/TransformSurfaceAtPosition|TransformSurfaceAtPosition]]

[[Category:Osiris Queries|GetSurfaceSize]]