Difference between revisions of "Osiris/API/GetSurfaceNameByTypeIndex"
From Divinity Engine Wiki
(Created page with "===== Full Definition(s) ===== * query '''GetSurfaceCloudAt'''('''''[in]'''(INTEGER)'''''_SurfaceIndex''', '''''[out]'''(STRING)'''''_SurfaceName''') ===== Description ===== R...") |
|||
| Line 1: | Line 1: | ||
===== Full Definition(s) ===== | ===== Full Definition(s) ===== | ||
| − | * query ''' | + | * query '''GetSurfaceNameByTypeIndex'''('''''[in]'''(INTEGER)'''''_SurfaceIndex''', '''''[out]'''(STRING)'''''_SurfaceName''') |
===== Description ===== | ===== Description ===== | ||
Returns the name of the surface that has the index '''_SurfaceIndex''' in the internal numbered list of surface types as '''_SurfaceName'''. | Returns the name of the surface that has the index '''_SurfaceIndex''' in the internal numbered list of surface types as '''_SurfaceName'''. | ||
Revision as of 14:37, 20 December 2017
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: Fails if the _Target is outside the AIgrid.
- _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 0 for SurfaceNone.
