Osiris/API/GetSurfaceSize: Difference between revisions
Jump to navigation
Jump to search
(Documented GetSurfaceSize) |
mNo edit summary |
||
| Line 9: | Line 9: | ||
* '''_SurfaceSize''': The number of cells occupied by the surface. | * '''_SurfaceSize''': The number of cells occupied by the surface. | ||
===== Notes ===== | ===== Notes ===== | ||
* | * This query is new in DOS2 Patch 5 | ||
===== See Also ===== | ===== See Also ===== | ||
* [[Osiris/API/CreatePuddle|CreatePuddle]] | * [[Osiris/API/CreatePuddle|CreatePuddle]] | ||
Revision as of 15:38, 6 December 2017
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