Difference between revisions of "Osiris/API/GetSurfaceSize"

From Divinity Engine Wiki
Jump to: navigation, search
m
m
 
(One intermediate revision by the same user not shown)
Line 2: Line 2:
 
* query '''GetSurfaceSize'''('''''[in]'''(GUIDSTRING)'''''_Target''', '''''[in]'''(INTEGER)'''''_SurfaceLayer''', '''''[out]'''(INTEGER)'''''_SurfaceSize''')
 
* 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 type on layer '''_SurfaceLayer''' in which '''_Target''' is standing. Valid values for '''_SurfaceLayer''' are
 
; 0 : Ground layer
 
; 0 : Ground layer
 
; 1 : Cloud layer
 
; 1 : Cloud layer
Line 20: Line 20:
 
* [[Osiris/API/GetSurfaceGroundOwnerAt|GetSurfaceGroundOwnerAt]]
 
* [[Osiris/API/GetSurfaceGroundOwnerAt|GetSurfaceGroundOwnerAt]]
 
* [[Osiris/API/GetSurfaceNameByTypeIndex|GetSurfaceNameByTypeIndex]]
 
* [[Osiris/API/GetSurfaceNameByTypeIndex|GetSurfaceNameByTypeIndex]]
 +
* [[Osiris/API/GetSurfaceTurns|GetSurfaceTurns]]
 
* [[Osiris/API/GetSurfaceTypeIndex|GetSurfaceTypeIndex]]
 
* [[Osiris/API/GetSurfaceTypeIndex|GetSurfaceTypeIndex]]
 
* [[Osiris/API/StopDrawSurfaceOnPath|StopDrawSurfaceOnPath]]
 
* [[Osiris/API/StopDrawSurfaceOnPath|StopDrawSurfaceOnPath]]

Latest revision as of 10:08, 2 May 2019

Full Definition(s)
  • query GetSurfaceSize([in](GUIDSTRING)_Target, [in](INTEGER)_SurfaceLayer, [out](INTEGER)_SurfaceSize)
Description

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

Ground layer
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