Mover Class
The Mover handles adding moves to process for an object.
Syntax
[Sansar.Script.Interface]
public class Mover : Sansar.Script.InstanceInterface
public class Mover : Sansar.Script.InstanceInterface
Remarks
The Movable From Script flag must be set to true in the editor to use the Mover. Additionally, player characters and rigid bodies with Static or Dynamic motion types cannot be moved using the Mover. Unlike the RigidBodyComponent movement functions, the Mover can be applied to objects that do not contain Volumes.
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
Members
See Also: Inherited members from Sansar.Script.InstanceInterface.
Public Properties
| [read-only] | IsMoving | bool . Property to check if a move command is currently executing for this Mover. |
| [read-only] | IsValid | bool . Whether or not this interface is valid. (Inherited from Sansar.Script.InstanceInterface.) |
| [read-only] | MoveCount | int . The number of move commands waiting to be excuted and currently executing for this Mover. |
Public Methods
AddMove (Sansar.Vector, Sansar.Quaternion)
Sets the transform of this Mover to a target World Space position and rotation. |
||
AddMove (Sansar.Vector, Sansar.Quaternion, Action<Sansar.Script.OperationCompleteEvent>)
Sets the transform of this Mover to a target World Space position and rotation. |
||
AddMove (Sansar.Vector, Sansar.Quaternion, double, MoveMode)
Translate and rotate the Mover to the target World Space position and rotation over time. |
||
AddMove (Sansar.Vector, Sansar.Quaternion, double, MoveMode, Action<Sansar.Script.OperationCompleteEvent>)
Translate and rotate the Mover to the target World Space position and rotation over time. |
||
AddMoveOffset (Sansar.Vector, Sansar.Quaternion)
Sets the transform of this Mover to a target Local Space position and rotation. |
||
AddMoveOffset (Sansar.Vector, Sansar.Quaternion, Action<Sansar.Script.OperationCompleteEvent>)
Sets the transform of this Mover to a target Local Space position and rotation. |
||
AddMoveOffset (Sansar.Vector, Sansar.Quaternion, double, MoveMode)
Translate and rotate the Mover to the target Local Space position and rotation over time. |
||
AddMoveOffset (Sansar.Vector, Sansar.Quaternion, double, MoveMode, Action<Sansar.Script.OperationCompleteEvent>)
Translate and rotate the Mover to the target Local Space position and rotation over time. |
||
AddPause (double)
Adds a pause of the given length for this Mover. |
||
AddPause (double, Action<Sansar.Script.OperationCompleteEvent>)
Adds a pause of the given length for this Mover. |
||
AddRotate (Sansar.Quaternion)
Sets the rotation of this Mover to a target World Space rotation. |
||
AddRotate (Sansar.Quaternion, Action<Sansar.Script.OperationCompleteEvent>)
Sets the rotation of this Mover to a target World Space rotation. |
||
AddRotate (Sansar.Quaternion, double, MoveMode)
Rotate the Mover to the target World Space rotation over time. |
||
AddRotate (Sansar.Quaternion, double, MoveMode, Action<Sansar.Script.OperationCompleteEvent>)
Rotate the Mover to the target World Space rotation over time. |
||
AddRotateOffset (Sansar.Quaternion)
Sets the rotation of this Mover to a target Local Space rotation. |
||
AddRotateOffset (Sansar.Quaternion, Action<Sansar.Script.OperationCompleteEvent>)
Sets the rotation of this Mover to a target Local Space rotation. |
||
AddRotateOffset (Sansar.Quaternion, double, MoveMode)
Rotate the Mover to the target Local Space rotation over time. |
||
AddRotateOffset (Sansar.Quaternion, double, MoveMode, Action<Sansar.Script.OperationCompleteEvent>)
Rotate the Mover to the target Local Space rotation over time. |
||
AddTranslate (Sansar.Vector)
Sets the position of this Mover to a target World Space position. |
||
AddTranslate (Sansar.Vector, Action<Sansar.Script.OperationCompleteEvent>)
Sets the position of this Mover to a target World Space position. |
||
AddTranslate (Sansar.Vector, double, MoveMode)
Translate the Mover to the target World Space position over time. |
||
AddTranslate (Sansar.Vector, double, MoveMode, Action<Sansar.Script.OperationCompleteEvent>)
Translate the Mover to the target World Space position over time. |
||
AddTranslateOffset (Sansar.Vector)
Sets the position of this Mover to a target Local Space position. |
||
AddTranslateOffset (Sansar.Vector, Action<Sansar.Script.OperationCompleteEvent>)
Sets the position of this Mover to a target Local Space position. |
||
AddTranslateOffset (Sansar.Vector, double, MoveMode)
Translate the Mover to the target Local Space position over time. |
||
AddTranslateOffset (Sansar.Vector, double, MoveMode, Action<Sansar.Script.OperationCompleteEvent>)
Translate the Mover to the target Local Space position over time. |
||
StopAndClear ()
Stops the current movement and clears any further movements for this Mover. |
||
StopAndClear (Action<Sansar.Script.OperationCompleteEvent>)
Stops the current movement and clears any further movements for this Mover. |
||
|
override
|
ToString () : string
A string representation of this object. |
|
Member Details
AddMove Method
Sets the transform of this Mover to a target World Space position and rotation.Syntax
Parameters
- position
- The target position.
- rotation
- The target rotation.
Returns
The return value is an internal event id.Remarks
This asynchronous method queues this command then returns. To block until this move command has been executed and completed, pass this method to Sansar.Script.ScriptBase.WaitFor while in a coroutine.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
AddMove Method
Sets the transform of this Mover to a target World Space position and rotation.Syntax
[Sansar.Script.Interface]
public void AddMove (Sansar.Vector position, Sansar.Quaternion rotation, Action<Sansar.Script.OperationCompleteEvent> handler)Parameters
- position
- The target position.
- rotation
- The target rotation.
- handler
- Handler to be called when the event completes.
Returns
The return value is an internal event id.Remarks
This asynchronous method queues this command then returns. To block until this move command has been executed and completed, pass this method to Sansar.Script.ScriptBase.WaitFor while in a coroutine.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
AddMove Method
Translate and rotate the Mover to the target World Space position and rotation over time.Syntax
[Sansar.Script.Interface]
public void AddMove (Sansar.Vector targetPosition, Sansar.Quaternion targetRotation, double timeInSeconds, MoveMode interpolationMode)Parameters
- targetPosition
- The target position.
- targetRotation
- The target rotation.
- timeInSeconds
- The time in seconds to move over.
- interpolationMode
- The method of interpolation to use when moving
Returns
The return value is an internal event id.Remarks
This asynchronous method queues this command then returns. To block until this move command has been executed and completed, pass this method to Sansar.Script.ScriptBase.WaitFor while in a coroutine.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
AddMove Method
Translate and rotate the Mover to the target World Space position and rotation over time.Syntax
[Sansar.Script.Interface]
public void AddMove (Sansar.Vector targetPosition, Sansar.Quaternion targetRotation, double timeInSeconds, MoveMode interpolationMode, Action<Sansar.Script.OperationCompleteEvent> handler)Parameters
- targetPosition
- The target position.
- targetRotation
- The target rotation.
- timeInSeconds
- The time in seconds to move over.
- interpolationMode
- The method of interpolation to use when moving
- handler
- Handler to be called when the event completes.
Returns
The return value is an internal event id.Remarks
This asynchronous method queues this command then returns. To block until this move command has been executed and completed, pass this method to Sansar.Script.ScriptBase.WaitFor while in a coroutine.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
AddMoveOffset Method
Sets the transform of this Mover to a target Local Space position and rotation.Syntax
[Sansar.Script.Interface]
public void AddMoveOffset (Sansar.Vector positionOffset, Sansar.Quaternion rotationOffset)Parameters
- positionOffset
- The local space position offset.
- rotationOffset
- The local space rotation offset.
Returns
The return value is an internal event id.Remarks
This asynchronous method queues this command then returns. To block until this move command has been executed and completed, pass this method to Sansar.Script.ScriptBase.WaitFor while in a coroutine.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
AddMoveOffset Method
Sets the transform of this Mover to a target Local Space position and rotation.Syntax
[Sansar.Script.Interface]
public void AddMoveOffset (Sansar.Vector positionOffset, Sansar.Quaternion rotationOffset, Action<Sansar.Script.OperationCompleteEvent> handler)Parameters
- positionOffset
- The local space position offset.
- rotationOffset
- The local space rotation offset.
- handler
- Handler to be called when the event completes.
Returns
The return value is an internal event id.Remarks
This asynchronous method queues this command then returns. To block until this move command has been executed and completed, pass this method to Sansar.Script.ScriptBase.WaitFor while in a coroutine.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
AddMoveOffset Method
Translate and rotate the Mover to the target Local Space position and rotation over time.Syntax
[Sansar.Script.Interface]
public void AddMoveOffset (Sansar.Vector positionOffset, Sansar.Quaternion rotationOffset, double timeInSeconds, MoveMode interpolationMode)Parameters
- positionOffset
- The local space position offset.
- rotationOffset
- The local space rotation offset.
- timeInSeconds
- The time in seconds to move over.
- interpolationMode
- The method of interpolation to use when moving
Returns
The return value is an internal event id.Remarks
This asynchronous method queues this command then returns. To block until this move command has been executed and completed, pass this method to Sansar.Script.ScriptBase.WaitFor while in a coroutine.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
AddMoveOffset Method
Translate and rotate the Mover to the target Local Space position and rotation over time.Syntax
[Sansar.Script.Interface]
public void AddMoveOffset (Sansar.Vector positionOffset, Sansar.Quaternion rotationOffset, double timeInSeconds, MoveMode interpolationMode, Action<Sansar.Script.OperationCompleteEvent> handler)Parameters
- positionOffset
- The local space position offset.
- rotationOffset
- The local space rotation offset.
- timeInSeconds
- The time in seconds to move over.
- interpolationMode
- The method of interpolation to use when moving
- handler
- Handler to be called when the event completes.
Returns
The return value is an internal event id.Remarks
This asynchronous method queues this command then returns. To block until this move command has been executed and completed, pass this method to Sansar.Script.ScriptBase.WaitFor while in a coroutine.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
AddPause Method
Adds a pause of the given length for this Mover.Syntax
Parameters
- timeInSeconds
- The amount of time in seconds that the movement should be paused.
Returns
The return value is an internal event id.Remarks
This asynchronous method queues this command then returns. To block until this move command has been executed and completed, pass this method to Sansar.Script.ScriptBase.WaitFor while in a coroutine.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
AddPause Method
Adds a pause of the given length for this Mover.Syntax
[Sansar.Script.Interface]
public void AddPause (double timeInSeconds, Action<Sansar.Script.OperationCompleteEvent> handler)Parameters
- timeInSeconds
- The amount of time in seconds that the movement should be paused.
- handler
- Handler to be called when the event completes.
Returns
The return value is an internal event id.Remarks
This asynchronous method queues this command then returns. To block until this move command has been executed and completed, pass this method to Sansar.Script.ScriptBase.WaitFor while in a coroutine.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
AddRotate Method
Sets the rotation of this Mover to a target World Space rotation.Syntax
Parameters
- rotation
- The target rotation.
Returns
The return value is an internal event id.Remarks
This asynchronous method queues this command then returns. To block until this move command has been executed and completed, pass this method to Sansar.Script.ScriptBase.WaitFor while in a coroutine.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
AddRotate Method
Sets the rotation of this Mover to a target World Space rotation.Syntax
[Sansar.Script.Interface]
public void AddRotate (Sansar.Quaternion rotation, Action<Sansar.Script.OperationCompleteEvent> handler)Parameters
- rotation
- The target rotation.
- handler
- Handler to be called when the event completes.
Returns
The return value is an internal event id.Remarks
This asynchronous method queues this command then returns. To block until this move command has been executed and completed, pass this method to Sansar.Script.ScriptBase.WaitFor while in a coroutine.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
AddRotate Method
Rotate the Mover to the target World Space rotation over time.Syntax
[Sansar.Script.Interface]
public void AddRotate (Sansar.Quaternion targetRotation, double timeInSeconds, MoveMode interpolationMode)Parameters
- targetRotation
- The target rotation.
- timeInSeconds
- The time in seconds to move over.
- interpolationMode
- The method of interpolation to use when moving
Returns
The return value is an internal event id.Remarks
This asynchronous method queues this command then returns. To block until this move command has been executed and completed, pass this method to Sansar.Script.ScriptBase.WaitFor while in a coroutine.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
AddRotate Method
Rotate the Mover to the target World Space rotation over time.Syntax
[Sansar.Script.Interface]
public void AddRotate (Sansar.Quaternion targetRotation, double timeInSeconds, MoveMode interpolationMode, Action<Sansar.Script.OperationCompleteEvent> handler)Parameters
- targetRotation
- The target rotation.
- timeInSeconds
- The time in seconds to move over.
- interpolationMode
- The method of interpolation to use when moving
- handler
- Handler to be called when the event completes.
Returns
The return value is an internal event id.Remarks
This asynchronous method queues this command then returns. To block until this move command has been executed and completed, pass this method to Sansar.Script.ScriptBase.WaitFor while in a coroutine.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
AddRotateOffset Method
Sets the rotation of this Mover to a target Local Space rotation.Syntax
Parameters
- rotationOffset
- The local space rotation offset.
Returns
The return value is an internal event id.Remarks
This asynchronous method queues this command then returns. To block until this move command has been executed and completed, pass this method to Sansar.Script.ScriptBase.WaitFor while in a coroutine.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
AddRotateOffset Method
Sets the rotation of this Mover to a target Local Space rotation.Syntax
[Sansar.Script.Interface]
public void AddRotateOffset (Sansar.Quaternion rotationOffset, Action<Sansar.Script.OperationCompleteEvent> handler)Parameters
- rotationOffset
- The local space rotation offset.
- handler
- Handler to be called when the event completes.
Returns
The return value is an internal event id.Remarks
This asynchronous method queues this command then returns. To block until this move command has been executed and completed, pass this method to Sansar.Script.ScriptBase.WaitFor while in a coroutine.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
AddRotateOffset Method
Rotate the Mover to the target Local Space rotation over time.Syntax
[Sansar.Script.Interface]
public void AddRotateOffset (Sansar.Quaternion rotationOffset, double timeInSeconds, MoveMode interpolationMode)Parameters
- rotationOffset
- The local space rotation offset.
- timeInSeconds
- The time in seconds to move over.
- interpolationMode
- The method of interpolation to use when moving
Returns
The return value is an internal event id.Remarks
This asynchronous method queues this command then returns. To block until this move command has been executed and completed, pass this method to Sansar.Script.ScriptBase.WaitFor while in a coroutine.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
AddRotateOffset Method
Rotate the Mover to the target Local Space rotation over time.Syntax
[Sansar.Script.Interface]
public void AddRotateOffset (Sansar.Quaternion rotationOffset, double timeInSeconds, MoveMode interpolationMode, Action<Sansar.Script.OperationCompleteEvent> handler)Parameters
- rotationOffset
- The local space rotation offset.
- timeInSeconds
- The time in seconds to move over.
- interpolationMode
- The method of interpolation to use when moving
- handler
- Handler to be called when the event completes.
Returns
The return value is an internal event id.Remarks
This asynchronous method queues this command then returns. To block until this move command has been executed and completed, pass this method to Sansar.Script.ScriptBase.WaitFor while in a coroutine.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
AddTranslate Method
Sets the position of this Mover to a target World Space position.Syntax
Parameters
- position
- The target position.
Returns
The return value is an internal event id.Remarks
This asynchronous method queues this command then returns. To block until this move command has been executed and completed, pass this method to Sansar.Script.ScriptBase.WaitFor while in a coroutine.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
AddTranslate Method
Sets the position of this Mover to a target World Space position.Syntax
[Sansar.Script.Interface]
public void AddTranslate (Sansar.Vector position, Action<Sansar.Script.OperationCompleteEvent> handler)Parameters
- position
- The target position.
- handler
- Handler to be called when the event completes.
Returns
The return value is an internal event id.Remarks
This asynchronous method queues this command then returns. To block until this move command has been executed and completed, pass this method to Sansar.Script.ScriptBase.WaitFor while in a coroutine.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
AddTranslate Method
Translate the Mover to the target World Space position over time.Syntax
[Sansar.Script.Interface]
public void AddTranslate (Sansar.Vector targetPosition, double timeInSeconds, MoveMode interpolationMode)Parameters
- targetPosition
- The target position.
- timeInSeconds
- The time in seconds to move over.
- interpolationMode
- The method of interpolation to use when moving.
Returns
The return value is an internal event id.Remarks
This asynchronous method queues this command then returns. To block until this move command has been executed and completed, pass this method to Sansar.Script.ScriptBase.WaitFor while in a coroutine.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
AddTranslate Method
Translate the Mover to the target World Space position over time.Syntax
[Sansar.Script.Interface]
public void AddTranslate (Sansar.Vector targetPosition, double timeInSeconds, MoveMode interpolationMode, Action<Sansar.Script.OperationCompleteEvent> handler)Parameters
- targetPosition
- The target position.
- timeInSeconds
- The time in seconds to move over.
- interpolationMode
- The method of interpolation to use when moving.
- handler
- Handler to be called when the event completes.
Returns
The return value is an internal event id.Remarks
This asynchronous method queues this command then returns. To block until this move command has been executed and completed, pass this method to Sansar.Script.ScriptBase.WaitFor while in a coroutine.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
AddTranslateOffset Method
Sets the position of this Mover to a target Local Space position.Syntax
Parameters
- positionOffset
- The local space position offset.
Returns
The return value is an internal event id.Remarks
This asynchronous method queues this command then returns. To block until this move command has been executed and completed, pass this method to Sansar.Script.ScriptBase.WaitFor while in a coroutine.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
AddTranslateOffset Method
Sets the position of this Mover to a target Local Space position.Syntax
[Sansar.Script.Interface]
public void AddTranslateOffset (Sansar.Vector positionOffset, Action<Sansar.Script.OperationCompleteEvent> handler)Parameters
- positionOffset
- The local space position offset.
- handler
- Handler to be called when the event completes.
Returns
The return value is an internal event id.Remarks
This asynchronous method queues this command then returns. To block until this move command has been executed and completed, pass this method to Sansar.Script.ScriptBase.WaitFor while in a coroutine.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
AddTranslateOffset Method
Translate the Mover to the target Local Space position over time.Syntax
[Sansar.Script.Interface]
public void AddTranslateOffset (Sansar.Vector positionOffset, double timeInSeconds, MoveMode interpolationMode)Parameters
- positionOffset
- The local space position offset.
- timeInSeconds
- The time in seconds to move over.
- interpolationMode
- The method of interpolation to use when moving.
Returns
The return value is an internal event id.Remarks
This asynchronous method queues this command then returns. To block until this move command has been executed and completed, pass this method to Sansar.Script.ScriptBase.WaitFor while in a coroutine.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
AddTranslateOffset Method
Translate the Mover to the target Local Space position over time.Syntax
[Sansar.Script.Interface]
public void AddTranslateOffset (Sansar.Vector positionOffset, double timeInSeconds, MoveMode interpolationMode, Action<Sansar.Script.OperationCompleteEvent> handler)Parameters
- positionOffset
- The local space position offset.
- timeInSeconds
- The time in seconds to move over.
- interpolationMode
- The method of interpolation to use when moving.
- handler
- Handler to be called when the event completes.
Returns
The return value is an internal event id.Remarks
This asynchronous method queues this command then returns. To block until this move command has been executed and completed, pass this method to Sansar.Script.ScriptBase.WaitFor while in a coroutine.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
IsMoving Property
Property to check if a move command is currently executing for this Mover.Syntax
[get: Sansar.Script.Interface]
public bool IsMoving { get; }Value
Whether or not this object is currently executing a move (includes pauses).Remarks
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
MoveCount Property
The number of move commands waiting to be excuted and currently executing for this Mover.Syntax
[get: Sansar.Script.Interface]
public int MoveCount { get; }Value
The number of enqueued move commands. Includes the current active move and any pause commands.Remarks
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
StopAndClear Method
Stops the current movement and clears any further movements for this Mover.Syntax
[Sansar.Script.Interface]
public void StopAndClear ()Returns
The return value is an internal event id.Remarks
This method is not enqueued like other operations on the Mover. To block until the operation has executed, pass this method to Sansar.Script.ScriptBase.WaitFor while in a coroutine.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
StopAndClear Method
Stops the current movement and clears any further movements for this Mover.Syntax
[Sansar.Script.Interface]
public void StopAndClear (Action<Sansar.Script.OperationCompleteEvent> handler)Parameters
- handler
- Handler to be called when the event completes.
Returns
The return value is an internal event id.Remarks
This method is not enqueued like other operations on the Mover. To block until the operation has executed, pass this method to Sansar.Script.ScriptBase.WaitFor while in a coroutine.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
ToString Method
A string representation of this object.Syntax
[Sansar.Script.Interface]
public override string ToString ()Returns
A string representation of this object.Remarks
The format of this string may change between releases.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
0 Comments