Osiris/API/GetSurfaceNameByTypeIndex - Revision history

Tinkerer at 20:46, 22 February 2018

2018-02-22T20:46:18Z

← Older revision		Revision as of 20:46, 22 February 2018
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]]

LarIlya at 16:35, 20 December 2017

2017-12-20T16:35:49Z

← Older revision		Revision as of 16:35, 20 December 2017
Line 26:		Line 26:
	* [[Scripting_surface_types\|List of surface types]]		* [[Scripting_surface_types\|List of surface types]]

	[[Category:Osiris ~~Calls~~\|GetSurfaceNameByTypeIndex]]		[[Category:Osiris Queries\|GetSurfaceNameByTypeIndex]]

LarIlya at 14:12, 20 December 2017

2017-12-20T14:12:47Z

← Older revision		Revision as of 14:12, 20 December 2017
Line 8:		Line 8:
	===== 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 0 for SurfaceNone.		* 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 =====

LarIlya at 14:10, 20 December 2017

2017-12-20T14:10:50Z

← Older revision		Revision as of 14:10, 20 December 2017
Line 4:		Line 4:
	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''': ~~Fails if there is no surface with such an index~~.		* '''Success/Failure''': Does not fail.
	* '''_SurfaceName''': The name of the surface.		* '''_SurfaceName''': The name of the surface.
	===== Notes =====		===== Notes =====

LarIlya at 14:08, 20 December 2017

2017-12-20T14:08:42Z

← Older revision		Revision as of 14:08, 20 December 2017
Line 4:		Line 4:
	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''': Fails if ~~the _Target~~ is ~~outside the AIgrid~~.		* '''Success/Failure''': Fails if there is no surface with such an index.
	* '''_SurfaceName''': The name of the surface.		* '''_SurfaceName''': The name of the surface.
	===== Notes =====		===== Notes =====

LarIlya at 13:37, 20 December 2017

2017-12-20T13:37:50Z

← Older revision		Revision as of 13:37, 20 December 2017
Line 1:		Line 1:
	===== Full Definition(s) =====		===== Full Definition(s) =====
	* query '''~~GetSurfaceCloudAt~~'''('''''[in]'''(INTEGER)'''''_SurfaceIndex''', '''''[out]'''(STRING)'''''_SurfaceName''')		* 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'''.

LarIlya: Created page with "===== Full Definition(s) ===== * query '''GetSurfaceCloudAt'''('''''[in]'''(INTEGER)'''''_SurfaceIndex''', '''''[out]'''(STRING)'''''_SurfaceName''') ===== Description ===== R..."

2017-12-20T13:37:34Z

Created page with "===== Full Definition(s) ===== * query '''GetSurfaceCloudAt'''('''''[in]'''(INTEGER)'''''_SurfaceIndex''', '''''[out]'''(STRING)'''''_SurfaceName''') ===== Description ===== R..."

New page

===== Full Definition(s) =====
* query '''GetSurfaceCloudAt'''('''''[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 [[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 0 for SurfaceNone.

===== See Also =====
* [[Osiris/API/CreateSurface|CreateSurface]]
* [[Osiris/API/CreatePuddle|CreatePuddle]]
* [[Osiris/API/CreateSurfaceAtPosition|CreateSurfaceAtPosition]]
* [[Osiris/API/DrawSurfaceOnPath|DrawSurfaceOnPath]]
* [[Osiris/API/GetSurfaceCloudAt|GetSurfaceCloudAt]]
* [[Osiris/API/GetSurfaceCloudOwnerAt|GetSurfaceCloudOwnerAt]]
* [[Osiris/API/GetSurfaceGroundAt|GetSurfaceGroundAt]]
* [[Osiris/API/GetSurfaceGroundOwnerAt|GetSurfaceGroundOwnerAt]]
* [[Osiris/API/GetSurfaceSize|GetSurfaceSize]]
* [[Osiris/API/GetSurfaceTypeIndex|GetSurfaceTypeIndex]]
* [[Osiris/API/StopDrawSurfaceOnPath|StopDrawSurfaceOnPath]]
* [[Osiris/API/TransformSurface|TransformSurface]]
* [[Osiris/API/TransformSurfaceAtPosition|TransformSurfaceAtPosition]]
* [[Scripting_surface_types|List of surface types]]

[[Category:Osiris Calls|GetSurfaceNameByTypeIndex]]