Osiris/API/GetSurfaceNameByTypeIndex

From Divinity Engine Wiki
Revision as of 17:35, 20 December 2017 by LarIlya (talk | contribs)
Jump to: navigation, search
Full Definition(s)
  • query GetSurfaceNameByTypeIndex([in](INTEGER)_SurfaceIndex, [out](STRING)_SurfaceName)
Description

Returns the name of the surface that has the index _SurfaceIndex in the internal numbered list of surface types as _SurfaceName.

Return Values
  • Success/Failure: Does not fail.
  • _SurfaceName: The name of the surface.
Notes
  • This call is mainly useful if you need to handle surfaces in behaviour script and Osiris simultaneously - the SURFACE type in behaviour script can be queried with GetVarInteger and then converted to the strings used in Osiris with this call.
  • The surface types page lists the surfaces in the same order as they exist in the internal list, starting at -1 for SurfaceNone.
See Also