Difference between revisions of "Osiris/API/DrawSurfaceOnPath"

From Divinity Engine Wiki
Jump to: navigation, search
(Created page with "===== Full Definition(s) ===== * query '''DrawSurfaceOnPath'''('''''[in]'''(GUIDSTRING)'''''_OwnerObject''', '''''[in]'''(GUIDSTRING)'''''_FollowObject''', '''''[in]'''(STRING...")
 
m
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]]

Revision as of 21:45, 22 February 2018

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 =