Osiris/API/DrawSurfaceOnPath

From Divinity Engine Wiki
Revision as of 21:45, 22 February 2018 by Tinkerer (talk | contribs)
Jump to: navigation, search
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 =