Difference between revisions of "Osiris/API/GetSurfaceSize"
From Divinity Engine Wiki
m |
m |
||
| Line 1: | Line 1: | ||
===== Full Definition(s) ===== | ===== Full Definition(s) ===== | ||
| − | * query '''GetSurfaceSize'''('''''[in]'''(GUIDSTRING)'''''_Target''', '''''[in]'''(INTEGER)''''_SurfaceLayer | + | * query '''GetSurfaceSize'''('''''[in]'''(GUIDSTRING)'''''_Target''', '''''[in]'''(INTEGER)'''''_SurfaceLayer''', '''''[out]'''(INTEGER)'''''_SurfaceSize''') |
===== Description ===== | ===== Description ===== | ||
Returns the size of the surface on layer '''_SurfaceLayer''' in which '''_Target''' is standing. Valid values for '''_SurfaceLayer''' are | Returns the size of the surface on layer '''_SurfaceLayer''' in which '''_Target''' is standing. Valid values for '''_SurfaceLayer''' are | ||
| Line 25: | Line 25: | ||
* [[Osiris/API/TransformSurfaceAtPosition|TransformSurfaceAtPosition]] | * [[Osiris/API/TransformSurfaceAtPosition|TransformSurfaceAtPosition]] | ||
| − | [[Category:Osiris Queries]] | + | [[Category:Osiris Queries|GetSurfaceSize]] |
Revision as of 16:31, 19 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
