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...") |
m |
||
| (5 intermediate revisions by one other user not shown) | |||
| 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'''. | ||
===== Return Values ===== | ===== Return Values ===== | ||
| − | * '''Success/Failure''': | + | * '''Success/Failure''': Does not fail. |
* '''_SurfaceName''': The name of the surface. | * '''_SurfaceName''': The name of the surface. | ||
===== Notes ===== | ===== 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 [[Osiris/API/GetVarInteger|GetVarInteger]] and then converted to the strings used in Osiris with this call. | * 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 [[Osiris/API/GetVarInteger|GetVarInteger]] and then converted to the strings used in Osiris with this call. | ||
| − | * The [[Scripting_surface_types|surface types]] page lists the surfaces in the same order as they exist in the internal list, starting at | + | * The [[Scripting_surface_types|surface types]] page lists the surfaces in the same order as they exist in the internal list, starting at -1 for SurfaceNone. |
===== See Also ===== | ===== See Also ===== | ||
| Line 20: | Line 20: | ||
* [[Osiris/API/GetSurfaceGroundOwnerAt|GetSurfaceGroundOwnerAt]] | * [[Osiris/API/GetSurfaceGroundOwnerAt|GetSurfaceGroundOwnerAt]] | ||
* [[Osiris/API/GetSurfaceSize|GetSurfaceSize]] | * [[Osiris/API/GetSurfaceSize|GetSurfaceSize]] | ||
| + | * [[Osiris/API/GetSurfaceTurns|GetSurfaceTurns]] | ||
* [[Osiris/API/GetSurfaceTypeIndex|GetSurfaceTypeIndex]] | * [[Osiris/API/GetSurfaceTypeIndex|GetSurfaceTypeIndex]] | ||
* [[Osiris/API/StopDrawSurfaceOnPath|StopDrawSurfaceOnPath]] | * [[Osiris/API/StopDrawSurfaceOnPath|StopDrawSurfaceOnPath]] | ||
| Line 26: | Line 27: | ||
* [[Scripting_surface_types|List of surface types]] | * [[Scripting_surface_types|List of surface types]] | ||
| − | [[Category:Osiris | + | [[Category:Osiris Queries|GetSurfaceNameByTypeIndex]] |
Latest revision as of 21:46, 22 February 2018
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.
