Osiris/API/DrawSurfaceOnPath - Revision history

Tinkerer: /* See Also = */

2020-07-13T14:11:47Z

Tinkerer at 19:18, 14 March 2018

2018-03-14T19:18:26Z

← Older revision		Revision as of 19:18, 14 March 2018
Line 5:		Line 5:
	===== Return Values =====		===== Return Values =====
	* '''Success/Failure''': Fails if the '''_OwnerObject''' or the '''_FollowObject''' don't exist or are null, or if the '''_SurfaceType''' doesn't exist.		* '''Success/Failure''': Fails if the '''_OwnerObject''' or the '''_FollowObject''' don't exist or are null, or if the '''_SurfaceType''' doesn't exist.
	* '''_SurfaceActionHandle''': The index of the Surface Action. This is an identifier necessary to stop drawing the surface again.		* '''_SurfaceActionHandle''': The index of the Surface Action. This is an identifier necessary to [[Osiris/API/StopDrawSurfaceOnPath\|stop drawing]] the surface again.
	===== Notes =====		===== Notes =====
	* /		* This routine currently does not work correctly if _Radius is >= 2.0
			* The '''_Lifetime''' only starts ticking after [[Osiris/API/StopDrawSurfaceOnPath\|StopDrawSurfaceOnPath]] has been called for the '''_SurfaceActionHandle'''. It can be '''''-1.0''''' to make the surface permanent.
	===== See Also ======		===== See Also ======
	* [[Osiris/API/GetSurfaceSize\|GetSurfaceSize]]		* [[Osiris/API/GetSurfaceSize\|GetSurfaceSize]]

Tinkerer at 20:45, 22 February 2018

2018-02-22T20:45:23Z

← Older revision		Revision as of 20:45, 22 February 2018
Line 7:		Line 7:
	* '''_SurfaceActionHandle''': The index of the Surface Action. This is an identifier necessary to stop drawing the surface again.		* '''_SurfaceActionHandle''': The index of the Surface Action. This is an identifier necessary to stop drawing the surface again.
	===== Notes =====		===== Notes =====
	*/		* /
	===== See Also ======		===== See Also ======
	* [[Osiris/API/GetSurfaceSize\|GetSurfaceSize]]		* [[Osiris/API/GetSurfaceSize\|GetSurfaceSize]]
			* [[Osiris/API/GetSurfaceTurns\|GetSurfaceTurns]]
	* [[Osiris/API/CreatePuddle\|CreatePuddle]]		* [[Osiris/API/CreatePuddle\|CreatePuddle]]
	* [[Osiris/API/CreateSurface\|CreateSurface]]		* [[Osiris/API/CreateSurface\|CreateSurface]]

LarIlya: Created page with "===== Full Definition(s) ===== * query '''DrawSurfaceOnPath'''('''''[in]'''(GUIDSTRING)'''''_OwnerObject''', '''''[in]'''(GUIDSTRING)'''''_FollowObject''', '''''[in]'''(STRING..."

2017-12-20T14:36:38Z

Created page with "===== Full Definition(s) ===== * query '''DrawSurfaceOnPath'''('''''[in]'''(GUIDSTRING)'''''_OwnerObject''', '''''[in]'''(GUIDSTRING)'''''_FollowObject''', '''''[in]'''(STRING..."

New page

===== Full Definition(s) =====
* query '''DrawSurfaceOnPath'''('''''[in]'''(GUIDSTRING)'''''_OwnerObject''', '''''[in]'''(GUIDSTRING)'''''_FollowObject''', '''''[in]'''(STRING)'''''_SurfaceType''', '''''[in]'''(REAL)'''''_Radius''', '''''[in]'''(REAL)'''''_Lifetime''', '''''[out]'''(INTEGER64)'''''_SurfaceActionHandle''')
===== Description =====
Draws a continuous line of width '''_Radius''' of surface type '''_SurfaceType''' behind the '''_FollowObject''' as it moves, with lifetime '''_Lifetime'''. The '''_OwnerObject''' parameter can be used to set the owner of this surface.
===== Return Values =====
* '''Success/Failure''': Fails if the '''_OwnerObject''' or the '''_FollowObject''' don't exist or are null, or if the '''_SurfaceType''' doesn't exist.
* '''_SurfaceActionHandle''': The index of the Surface Action. This is an identifier necessary to stop drawing the surface again.
===== Notes =====
*/
===== See Also ======
* [[Osiris/API/GetSurfaceSize|GetSurfaceSize]]
* [[Osiris/API/CreatePuddle|CreatePuddle]]
* [[Osiris/API/CreateSurface|CreateSurface]]
* [[Osiris/API/CreateSurfaceAtPosition|CreateSurfaceAtPosition]]
* [[Osiris/API/GetSurfaceCloudAt|GetSurfaceCloudAt]]
* [[Osiris/API/GetSurfaceCloudOwnerAt|GetSurfaceCloudOwnerAt]]
* [[Osiris/API/GetSurfaceGroundAt|GetSurfaceGroundAt]]
* [[Osiris/API/GetSurfaceGroundOwnerAt|GetSurfaceGroundOwnerAt]]
* [[Osiris/API/GetSurfaceNameByTypeIndex|GetSurfaceNameByTypeIndex]]
* [[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 Queries|DrawSurfaceOnPath]]

← Older revision		Revision as of 14:11, 13 July 2020
Line 9:		Line 9:
	* This routine currently does not work correctly if _Radius is >= 2.0		* This routine currently does not work correctly if _Radius is >= 2.0
	* The '''_Lifetime''' only starts ticking after [[Osiris/API/StopDrawSurfaceOnPath\|StopDrawSurfaceOnPath]] has been called for the '''_SurfaceActionHandle'''. It can be '''''-1.0''''' to make the surface permanent.		* The '''_Lifetime''' only starts ticking after [[Osiris/API/StopDrawSurfaceOnPath\|StopDrawSurfaceOnPath]] has been called for the '''_SurfaceActionHandle'''. It can be '''''-1.0''''' to make the surface permanent.
	===== See Also ======		===== See Also =====
	* [[Osiris/API/GetSurfaceSize\|GetSurfaceSize]]		* [[Osiris/API/GetSurfaceSize\|GetSurfaceSize]]
	* [[Osiris/API/GetSurfaceTurns\|GetSurfaceTurns]]		* [[Osiris/API/GetSurfaceTurns\|GetSurfaceTurns]]