Difference between revisions of "Osiris/API/DrawSurfaceOnPath"
From Divinity Engine Wiki
m |
m (→See Also =) |
||
| (One intermediate revision by the same user not shown) | |||
| 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 |
| − | ===== See Also | + | * 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 ===== | ||
* [[Osiris/API/GetSurfaceSize|GetSurfaceSize]] | * [[Osiris/API/GetSurfaceSize|GetSurfaceSize]] | ||
* [[Osiris/API/GetSurfaceTurns|GetSurfaceTurns]] | * [[Osiris/API/GetSurfaceTurns|GetSurfaceTurns]] | ||
Latest revision as of 15:11, 13 July 2020
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
- This routine currently does not work correctly if _Radius is >= 2.0
- The _Lifetime only starts ticking after StopDrawSurfaceOnPath has been called for the _SurfaceActionHandle. It can be -1.0 to make the surface permanent.
