RigidBodyComponent

RigidBodyComponent Class

The RigidBodyComponent handles interactions with rigid body physics.

Syntax

[Sansar.Script.Interface]
public class RigidBodyComponent : Sansar.Script.InstanceInterface

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

Members

See Also: Inherited members from Sansar.Script.InstanceInterface.

Public Fields

static readonly
ComponentType ComponentType . The RigidBodyComponent.ComponentType of this component

Public Properties

[read-only]
 
ComponentId Sansar.Script.ComponentId . Retrieves the component id for this RigidBodyComponent.
[read-only]
 
IsValid bool . Whether or not this interface is valid. (Inherited from Sansar.Script.InstanceInterface.)

Public Methods

 
AddAngularImpulse (Sansar.Vector) : ulong
Adds an angular impulse to this RigidBodyComponent.
 
AddAngularImpulse (Sansar.Vector, Sansar.Script.ScriptBase.OperationComplete) : ulong
Adds an angular impulse to this RigidBodyComponent.
 
AddAngularImpulse (Sansar.Vector, Action<Sansar.Script.OperationCompleteEvent>) : ulong
Adds an angular impulse to this RigidBodyComponent.
 
AddLinearImpulse (Sansar.Vector) : ulong
Adds a linear impulse the the center of mass of this RigidBodyComponent.
 
AddLinearImpulse (Sansar.Vector, Sansar.Script.ScriptBase.OperationComplete) : ulong
Adds a linear impulse the the center of mass of this RigidBodyComponent.
 
AddLinearImpulse (Sansar.Vector, Action<Sansar.Script.OperationCompleteEvent>) : ulong
Adds a linear impulse the the center of mass of this RigidBodyComponent.
 
GetAngularDamping () : float
Retrieves the amount of damping applied to this object's angular motion.
 
GetAngularVelocity () : Sansar.Vector
Retrieves the angular velocity for this RigidBodyComponent.
 
GetBounce () : float
Retrieves the bounce of this RigidBodyComponent.
 
GetCenterOfMass () : Sansar.Vector
Retrieves the center of mass of this object in local space.
 
GetColliderCenter () : Sansar.Vector
Retrieves the center of the collision shape for this object in local space.
 
GetColliderExtents () : Sansar.Vector
Retrieves the extents of the collision shape for this object in local space.
 
GetDynamicFriction () : float
Retrieves the dynamic friction of this RigidBodyComponent.
 
GetGravityFactor () : float
Retrieves what factor of the world's gravity is applied to this object.
 
GetLinearDamping () : float
Retrieves the amount of damping applied to this object's linear motion.
 
GetLinearVelocity () : Sansar.Vector
Retrieves the linear velocity for this RigidBodyComponent.
 
GetMass () : float
Retrieves the mass of this RigidBodyComponent.
 
GetMotionType () : RigidBodyMotionType
The motion type for this RigidBodyComponent.
 
GetOrientation () : Sansar.Quaternion
Retrieves the orientation of this RigidBodyComponent.
 
GetPosition () : Sansar.Vector
Retrieves the position of this RigidBodyComponent.
 
GetStaticFriction () : float
Retrieves the static friction of this RigidBodyComponent.
 
IsDynamic () : bool
Whether this rigidbody is dynamic.
 
IsTriggerVolume () : bool
Whether this RigidBodyComponent is a TriggerVolume.
 
SetAngularDamping (float) : ulong
Sets the amount of damping to apply to this object's angular motion.
 
SetAngularDamping (float, Sansar.Script.ScriptBase.OperationComplete) : ulong
Sets the amount of damping to apply to this object's angular motion.
 
SetAngularDamping (float, Action<Sansar.Script.OperationCompleteEvent>) : ulong
Sets the amount of damping to apply to this object's angular motion.
 
SetAngularVelocity (Sansar.Vector) : ulong
Sets the angular velocity for this RigidBodyComponent.
 
SetAngularVelocity (Sansar.Vector, Sansar.Script.ScriptBase.OperationComplete) : ulong
Sets the angular velocity for this RigidBodyComponent.
 
SetAngularVelocity (Sansar.Vector, Action<Sansar.Script.OperationCompleteEvent>) : ulong
Sets the angular velocity for this RigidBodyComponent.
 
SetBounce (float) : ulong
Sets the bounce of this RigidBodyComponent.
 
SetBounce (float, Sansar.Script.ScriptBase.OperationComplete) : ulong
Sets the bounce of this RigidBodyComponent.
 
SetBounce (float, Action<Sansar.Script.OperationCompleteEvent>) : ulong
Sets the bounce of this RigidBodyComponent.
 
SetCenterOfMass (Sansar.Vector) : ulong
Sets the center of mass of this object in local space.
 
SetCenterOfMass (Sansar.Vector, Sansar.Script.ScriptBase.OperationComplete) : ulong
Sets the center of mass of this object in local space.
 
SetCenterOfMass (Sansar.Vector, Action<Sansar.Script.OperationCompleteEvent>) : ulong
Sets the center of mass of this object in local space.
 
SetDynamicFriction (float) : ulong
Sets the dynamic friction of this RigidBodyComponent.
 
SetDynamicFriction (float, Sansar.Script.ScriptBase.OperationComplete) : ulong
Sets the dynamic friction of this RigidBodyComponent.
 
SetDynamicFriction (float, Action<Sansar.Script.OperationCompleteEvent>) : ulong
Sets the dynamic friction of this RigidBodyComponent.
 
SetGravityFactor (float) : ulong
Sets what factor of the world's gravity is applied to this object.
 
SetGravityFactor (float, Sansar.Script.ScriptBase.OperationComplete) : ulong
Sets what factor of the world's gravity is applied to this object.
 
SetGravityFactor (float, Action<Sansar.Script.OperationCompleteEvent>) : ulong
Sets what factor of the world's gravity is applied to this object.
 
SetLinearDamping (float) : ulong
Sets the amount of damping to apply to this object's linear motion.
 
SetLinearDamping (float, Sansar.Script.ScriptBase.OperationComplete) : ulong
Sets the amount of damping to apply to this object's linear motion.
 
SetLinearDamping (float, Action<Sansar.Script.OperationCompleteEvent>) : ulong
Sets the amount of damping to apply to this object's linear motion.
 
SetLinearVelocity (Sansar.Vector) : ulong
Sets the linear velocity for this RigidBodyComponent.
 
SetLinearVelocity (Sansar.Vector, Sansar.Script.ScriptBase.OperationComplete) : ulong
Sets the linear velocity for this RigidBodyComponent.
 
SetLinearVelocity (Sansar.Vector, Action<Sansar.Script.OperationCompleteEvent>) : ulong
Sets the linear velocity for this RigidBodyComponent.
 
SetMass (float) : ulong
Sets the mass of this RigidBodyComponent.
 
SetMass (float, Sansar.Script.ScriptBase.OperationComplete) : ulong
Sets the mass of this RigidBodyComponent.
 
SetMass (float, Action<Sansar.Script.OperationCompleteEvent>) : ulong
Sets the mass of this RigidBodyComponent.
 
SetMotionType (RigidBodyMotionType) : ulong
Sets the motion type for this rigidbody.
 
SetMotionType (RigidBodyMotionType, Sansar.Script.ScriptBase.OperationComplete) : ulong
Sets the motion type for this rigidbody.
 
SetMotionType (RigidBodyMotionType, Action<Sansar.Script.OperationCompleteEvent>) : ulong
Sets the motion type for this rigidbody.
 
SetOrientation (Sansar.Quaternion) : ulong
Sets the orientation of this RigidBodyComponent.
 
SetOrientation (Sansar.Vector) : ulong
Sets the orientation of this $className$.
 
SetOrientation (Sansar.Quaternion, Sansar.Script.ScriptBase.OperationComplete) : ulong
Sets the orientation of this RigidBodyComponent.
 
SetOrientation (Sansar.Quaternion, Action<Sansar.Script.OperationCompleteEvent>) : ulong
Sets the orientation of this RigidBodyComponent.
 
SetOrientation (Sansar.Vector, Sansar.Script.ScriptBase.OperationComplete) : ulong
Sets the orientation of this $className$.
 
SetOrientation (Sansar.Vector, Action<Sansar.Script.OperationCompleteEvent>) : ulong
Sets the orientation of this $className$.
 
SetPosition (Sansar.Vector) : ulong
Sets the position of this RigidBodyComponent.
 
SetPosition (Sansar.Vector, Sansar.Script.ScriptBase.OperationComplete) : ulong
Sets the position of this RigidBodyComponent.
 
SetPosition (Sansar.Vector, Action<Sansar.Script.OperationCompleteEvent>) : ulong
Sets the position of this RigidBodyComponent.
 
SetStaticFriction (float) : ulong
Sets the static friction of this RigidBodyComponent.
 
SetStaticFriction (float, Sansar.Script.ScriptBase.OperationComplete) : ulong
Sets the static friction of this RigidBodyComponent.
 
SetStaticFriction (float, Action<Sansar.Script.OperationCompleteEvent>) : ulong
Sets the static friction of this RigidBodyComponent.
 
Subscribe (CollisionEventType, RigidBodyComponent.SubscriptionHandler, bool)
Subscribes to Collision Events.
 
Subscribe (CollisionEventType, Action<CollisionData>, bool) : Sansar.Script.IEventSubscription
Subscribes to Collision Events.
 
Subscribe (CollisionEventType, Sansar.Script.ComponentId, RigidBodyComponent.SubscriptionHandler, bool)
Subscribes to Collision Events.
 
Subscribe (CollisionEventType, Sansar.Script.ComponentId, Action<CollisionData>, bool) : Sansar.Script.IEventSubscription
Subscribes to Collision Events.
override
ToString () : string
A string representation of this object.

Member Details

AddAngularImpulse Method

Adds an angular impulse to this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public ulong AddAngularImpulse (Sansar.Vector impulse)

Parameters

impulse
The impulse.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

AddAngularImpulse Method

Adds an angular impulse to this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public ulong AddAngularImpulse (Sansar.Vector impulse, Sansar.Script.ScriptBase.OperationComplete handler)

Parameters

impulse
The impulse.
handler
Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

AddAngularImpulse Method

Adds an angular impulse to this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public ulong AddAngularImpulse (Sansar.Vector impulse, Action<Sansar.Script.OperationCompleteEvent> handler)

Parameters

impulse
The impulse.
handler
Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

AddLinearImpulse Method

Adds a linear impulse the the center of mass of this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public ulong AddLinearImpulse (Sansar.Vector impulse)

Parameters

impulse
The impulse.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

AddLinearImpulse Method

Adds a linear impulse the the center of mass of this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public ulong AddLinearImpulse (Sansar.Vector impulse, Sansar.Script.ScriptBase.OperationComplete handler)

Parameters

impulse
The impulse.
handler
Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

AddLinearImpulse Method

Adds a linear impulse the the center of mass of this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public ulong AddLinearImpulse (Sansar.Vector impulse, Action<Sansar.Script.OperationCompleteEvent> handler)

Parameters

impulse
The impulse.
handler
Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

ComponentId Property

Retrieves the component id for this RigidBodyComponent.

Syntax

[get: Sansar.Script.Interface]
public Sansar.Script.ComponentId ComponentId { get; }

Value

The id.

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

ComponentType Field

The RigidBodyComponent.ComponentType of this component

Syntax

public static readonly ComponentType ComponentType

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

GetAngularDamping Method

Retrieves the amount of damping applied to this object's angular motion.

Syntax

[Sansar.Script.Interface]
public float GetAngularDamping ()

Returns

The angular damping factor.

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

GetAngularVelocity Method

Retrieves the angular velocity for this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public Sansar.Vector GetAngularVelocity ()

Returns

The velocity.

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

GetBounce Method

Retrieves the bounce of this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public float GetBounce ()

Returns

The bounce factor.

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

GetCenterOfMass Method

Retrieves the center of mass of this object in local space.

Syntax

[Sansar.Script.Interface]
public Sansar.Vector GetCenterOfMass ()

Returns

A Vector to the center of mass of this object, in the objects local space.

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

GetColliderCenter Method

Retrieves the center of the collision shape for this object in local space.

Syntax

[Sansar.Script.Interface]
public Sansar.Vector GetColliderCenter ()

Returns

The center of the collision shape.

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

GetColliderExtents Method

Retrieves the extents of the collision shape for this object in local space.

Syntax

[Sansar.Script.Interface]
public Sansar.Vector GetColliderExtents ()

Returns

The extents of the collision shape.

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

GetDynamicFriction Method

Retrieves the dynamic friction of this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public float GetDynamicFriction ()

Returns

The dynamic friction.

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

GetGravityFactor Method

Retrieves what factor of the world's gravity is applied to this object.

Syntax

[Sansar.Script.Interface]
public float GetGravityFactor ()

Returns

The gravity factor.

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

GetLinearDamping Method

Retrieves the amount of damping applied to this object's linear motion.

Syntax

[Sansar.Script.Interface]
public float GetLinearDamping ()

Returns

The linear damping factor.

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

GetLinearVelocity Method

Retrieves the linear velocity for this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public Sansar.Vector GetLinearVelocity ()

Returns

The velocity.

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

GetMass Method

Retrieves the mass of this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public float GetMass ()

Returns

The mass.

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

GetMotionType Method

The motion type for this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public RigidBodyMotionType GetMotionType ()

Returns

A RigidBodyMotionType enum for the motion type.

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

GetOrientation Method

Retrieves the orientation of this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public Sansar.Quaternion GetOrientation ()

Returns

The orientation.

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

GetPosition Method

Retrieves the position of this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public Sansar.Vector GetPosition ()

Returns

The position.

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

GetStaticFriction Method

Retrieves the static friction of this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public float GetStaticFriction ()

Returns

The static friction.

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

IsDynamic Method

Whether this rigidbody is dynamic.

Syntax

[Sansar.Script.Interface]
[System.Obsolete("Use GetMotionType()", false)]
public bool IsDynamic ()

Returns

True if this is a dynamic object.

Remarks

Deprecated. Use GetMotionType() instead.

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

IsTriggerVolume Method

Whether this RigidBodyComponent is a TriggerVolume.

Syntax

[Sansar.Script.Interface]
public bool IsTriggerVolume ()

Returns

True if this RigidBodyComponent is a TriggerVolume.

Remarks

TriggerVolumes can be moved through and generate CollisionEventType.cTrigger collision events instead of normal collision events.

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

SetAngularDamping Method

Sets the amount of damping to apply to this object's angular motion.

Syntax

[Sansar.Script.Interface]
public ulong SetAngularDamping (float angularDamping)

Parameters

angularDamping
The angular damping factor. Default value is 0.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

SetAngularDamping Method

Sets the amount of damping to apply to this object's angular motion.

Syntax

[Sansar.Script.Interface]
public ulong SetAngularDamping (float angularDamping, Sansar.Script.ScriptBase.OperationComplete handler)

Parameters

angularDamping
The angular damping factor. Default value is 0.
handler
Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

SetAngularDamping Method

Sets the amount of damping to apply to this object's angular motion.

Syntax

[Sansar.Script.Interface]
public ulong SetAngularDamping (float angularDamping, Action<Sansar.Script.OperationCompleteEvent> handler)

Parameters

angularDamping
The angular damping factor. Default value is 0.
handler
Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

SetAngularVelocity Method

Sets the angular velocity for this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public ulong SetAngularVelocity (Sansar.Vector velocity)

Parameters

velocity
The velocity.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. Subsequent calls to RigidBodyComponent.GetAngularVelocity will return the previous velocity until the write occurs. To block until the write has occurred, 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

SetAngularVelocity Method

Sets the angular velocity for this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public ulong SetAngularVelocity (Sansar.Vector velocity, Sansar.Script.ScriptBase.OperationComplete handler)

Parameters

velocity
The velocity.
handler
Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. Subsequent calls to RigidBodyComponent.GetAngularVelocity will return the previous velocity until the write occurs. To block until the write has occurred, 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

SetAngularVelocity Method

Sets the angular velocity for this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public ulong SetAngularVelocity (Sansar.Vector velocity, Action<Sansar.Script.OperationCompleteEvent> handler)

Parameters

velocity
The velocity.
handler
Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. Subsequent calls to RigidBodyComponent.GetAngularVelocity will return the previous velocity until the write occurs. To block until the write has occurred, 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

SetBounce Method

Sets the bounce of this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public ulong SetBounce (float bounce)

Parameters

bounce
The bounce factor. Value should be between 0 and 1 (inclusive)

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

SetBounce Method

Sets the bounce of this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public ulong SetBounce (float bounce, Sansar.Script.ScriptBase.OperationComplete handler)

Parameters

bounce
The bounce factor. Value should be between 0 and 1 (inclusive)
handler
Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

SetBounce Method

Sets the bounce of this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public ulong SetBounce (float bounce, Action<Sansar.Script.OperationCompleteEvent> handler)

Parameters

bounce
The bounce factor. Value should be between 0 and 1 (inclusive)
handler
Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

SetCenterOfMass Method

Sets the center of mass of this object in local space.

Syntax

[Sansar.Script.Interface]
public ulong SetCenterOfMass (Sansar.Vector centerOfMass)

Parameters

centerOfMass
A Vector to the center of mass of this object, in the objects local space.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

SetCenterOfMass Method

Sets the center of mass of this object in local space.

Syntax

[Sansar.Script.Interface]
public ulong SetCenterOfMass (Sansar.Vector centerOfMass, Sansar.Script.ScriptBase.OperationComplete handler)

Parameters

centerOfMass
A Vector to the center of mass of this object, in the objects local space.
handler
Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

SetCenterOfMass Method

Sets the center of mass of this object in local space.

Syntax

[Sansar.Script.Interface]
public ulong SetCenterOfMass (Sansar.Vector centerOfMass, Action<Sansar.Script.OperationCompleteEvent> handler)

Parameters

centerOfMass
A Vector to the center of mass of this object, in the objects local space.
handler
Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

SetDynamicFriction Method

Sets the dynamic friction of this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public ulong SetDynamicFriction (float dynamicFriction)

Parameters

dynamicFriction
The dynamic friction. Value should be between 0 and 1 (inclusive)

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

SetDynamicFriction Method

Sets the dynamic friction of this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public ulong SetDynamicFriction (float dynamicFriction, Sansar.Script.ScriptBase.OperationComplete handler)

Parameters

dynamicFriction
The dynamic friction. Value should be between 0 and 1 (inclusive)
handler
Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

SetDynamicFriction Method

Sets the dynamic friction of this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public ulong SetDynamicFriction (float dynamicFriction, Action<Sansar.Script.OperationCompleteEvent> handler)

Parameters

dynamicFriction
The dynamic friction. Value should be between 0 and 1 (inclusive)
handler
Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

SetGravityFactor Method

Sets what factor of the world's gravity is applied to this object.

Syntax

[Sansar.Script.Interface]
public ulong SetGravityFactor (float gravityFactor)

Parameters

gravityFactor
The gravityFactor. Default value is 1, range is -2 to 2

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

SetGravityFactor Method

Sets what factor of the world's gravity is applied to this object.

Syntax

[Sansar.Script.Interface]
public ulong SetGravityFactor (float gravityFactor, Sansar.Script.ScriptBase.OperationComplete handler)

Parameters

gravityFactor
The gravityFactor. Default value is 1, range is -2 to 2
handler
Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

SetGravityFactor Method

Sets what factor of the world's gravity is applied to this object.

Syntax

[Sansar.Script.Interface]
public ulong SetGravityFactor (float gravityFactor, Action<Sansar.Script.OperationCompleteEvent> handler)

Parameters

gravityFactor
The gravityFactor. Default value is 1, range is -2 to 2
handler
Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

SetLinearDamping Method

Sets the amount of damping to apply to this object's linear motion.

Syntax

[Sansar.Script.Interface]
public ulong SetLinearDamping (float linearDamping)

Parameters

linearDamping
The linear damping factor. Default value is 0.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

SetLinearDamping Method

Sets the amount of damping to apply to this object's linear motion.

Syntax

[Sansar.Script.Interface]
public ulong SetLinearDamping (float linearDamping, Sansar.Script.ScriptBase.OperationComplete handler)

Parameters

linearDamping
The linear damping factor. Default value is 0.
handler
Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

SetLinearDamping Method

Sets the amount of damping to apply to this object's linear motion.

Syntax

[Sansar.Script.Interface]
public ulong SetLinearDamping (float linearDamping, Action<Sansar.Script.OperationCompleteEvent> handler)

Parameters

linearDamping
The linear damping factor. Default value is 0.
handler
Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

SetLinearVelocity Method

Sets the linear velocity for this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public ulong SetLinearVelocity (Sansar.Vector velocity)

Parameters

velocity
The velocity.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. Subsequent calls to RigidBodyComponent.GetLinearVelocity will return the previous velocity until the write occurs. To block until the write has occurred, 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

SetLinearVelocity Method

Sets the linear velocity for this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public ulong SetLinearVelocity (Sansar.Vector velocity, Sansar.Script.ScriptBase.OperationComplete handler)

Parameters

velocity
The velocity.
handler
Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. Subsequent calls to RigidBodyComponent.GetLinearVelocity will return the previous velocity until the write occurs. To block until the write has occurred, 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

SetLinearVelocity Method

Sets the linear velocity for this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public ulong SetLinearVelocity (Sansar.Vector velocity, Action<Sansar.Script.OperationCompleteEvent> handler)

Parameters

velocity
The velocity.
handler
Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. Subsequent calls to RigidBodyComponent.GetLinearVelocity will return the previous velocity until the write occurs. To block until the write has occurred, 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

SetMass Method

Sets the mass of this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public ulong SetMass (float mass)

Parameters

mass
The mass.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

SetMass Method

Sets the mass of this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public ulong SetMass (float mass, Sansar.Script.ScriptBase.OperationComplete handler)

Parameters

mass
The mass.
handler
Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

SetMass Method

Sets the mass of this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public ulong SetMass (float mass, Action<Sansar.Script.OperationCompleteEvent> handler)

Parameters

mass
The mass.
handler
Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

SetMotionType Method

Sets the motion type for this rigidbody.

Syntax

[Sansar.Script.Interface]
public ulong SetMotionType (RigidBodyMotionType motionType)

Parameters

motionType
The motion type.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

SetMotionType Method

Sets the motion type for this rigidbody.

Syntax

[Sansar.Script.Interface]
public ulong SetMotionType (RigidBodyMotionType motionType, Sansar.Script.ScriptBase.OperationComplete handler)

Parameters

motionType
The motion type.
handler
Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

SetMotionType Method

Sets the motion type for this rigidbody.

Syntax

[Sansar.Script.Interface]
public ulong SetMotionType (RigidBodyMotionType motionType, Action<Sansar.Script.OperationCompleteEvent> handler)

Parameters

motionType
The motion type.
handler
Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

SetOrientation Method

Sets the orientation of this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public ulong SetOrientation (Sansar.Quaternion orientation)

Parameters

orientation
The orientation.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

SetOrientation Method

Sets the orientation of this $className$.

Syntax

[Sansar.Script.Interface]
[System.Obsolete("Use SetOrientation(Quaternion)", false)]
public ulong SetOrientation (Sansar.Vector orientation)

Parameters

orientation
The orientation.

Returns

The return value is an internal event id.

Remarks

Deprecated. Use SetOrientation(Quaternion) instead.

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

SetOrientation Method

Sets the orientation of this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public ulong SetOrientation (Sansar.Quaternion orientation, Sansar.Script.ScriptBase.OperationComplete handler)

Parameters

orientation
The orientation.
handler
Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

SetOrientation Method

Sets the orientation of this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public ulong SetOrientation (Sansar.Quaternion orientation, Action<Sansar.Script.OperationCompleteEvent> handler)

Parameters

orientation
The orientation.
handler
Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

SetOrientation Method

Sets the orientation of this $className$.

Syntax

[Sansar.Script.Interface]
[System.Obsolete("Use SetOrientation(Quaternion)", false)]
public ulong SetOrientation (Sansar.Vector orientation, Sansar.Script.ScriptBase.OperationComplete handler)

Parameters

orientation
The orientation.
handler
Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

Deprecated. Use SetOrientation(Quaternion) instead.

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

SetOrientation Method

Sets the orientation of this $className$.

Syntax

[Sansar.Script.Interface]
[System.Obsolete("Use SetOrientation(Quaternion)", false)]
public ulong SetOrientation (Sansar.Vector orientation, Action<Sansar.Script.OperationCompleteEvent> handler)

Parameters

orientation
The orientation.
handler
Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

Deprecated. Use SetOrientation(Quaternion) instead.

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

SetPosition Method

Sets the position of this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public ulong SetPosition (Sansar.Vector position)

Parameters

position
The position.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

SetPosition Method

Sets the position of this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public ulong SetPosition (Sansar.Vector position, Sansar.Script.ScriptBase.OperationComplete handler)

Parameters

position
The position.
handler
Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

SetPosition Method

Sets the position of this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public ulong SetPosition (Sansar.Vector position, Action<Sansar.Script.OperationCompleteEvent> handler)

Parameters

position
The position.
handler
Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

SetStaticFriction Method

Sets the static friction of this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public ulong SetStaticFriction (float staticFriction)

Parameters

staticFriction
The static friction. Value should be between 0 and 1 (inclusive)

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

SetStaticFriction Method

Sets the static friction of this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public ulong SetStaticFriction (float staticFriction, Sansar.Script.ScriptBase.OperationComplete handler)

Parameters

staticFriction
The static friction. Value should be between 0 and 1 (inclusive)
handler
Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

SetStaticFriction Method

Sets the static friction of this RigidBodyComponent.

Syntax

[Sansar.Script.Interface]
public ulong SetStaticFriction (float staticFriction, Action<Sansar.Script.OperationCompleteEvent> handler)

Parameters

staticFriction
The static friction. Value should be between 0 and 1 (inclusive)
handler
Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

This asynchronous method queues the write then returns. To block until the write has occurred, 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

Subscribe Method

Subscribes to Collision Events.

Syntax

[Sansar.Script.Interface]
[System.Obsolete("Use subscription callbacks of type Action<Sansar.Simulation.CollisionData>", false)]
public void Subscribe (CollisionEventType EventType, RigidBodyComponent.SubscriptionHandler callback, bool persistent)

Parameters

EventType
The type of collision which occurred.
callback
Callback which is executed when the event completes.
persistent
Optional, set to false to unsubscribe after one event.

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

Subscribe Method

Subscribes to Collision Events.

Syntax

[Sansar.Script.Interface]
public Sansar.Script.IEventSubscription Subscribe (CollisionEventType EventType, Action<CollisionData> callback, bool persistent)

See Also

Parameters

EventType
The type of collision which occurred.
callback
Callback which is executed when the event completes.
persistent
Optional, set to false to unsubscribe after one event.

Returns

An Sansar.Script.IEventSubscription that can be used to cancel the subscription.

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

Subscribe Method

Subscribes to Collision Events.

Syntax

[Sansar.Script.Interface]
[System.Obsolete("Use subscription callbacks of type Action<Sansar.Simulation.CollisionData>", false)]
public void Subscribe (CollisionEventType EventType, Sansar.Script.ComponentId HitComponentId, RigidBodyComponent.SubscriptionHandler callback, bool persistent)

Parameters

EventType
The type of collision which occurred.
HitComponentId
The id of the rigid body component or character that was hit.
callback
Callback which is executed when the event completes.
persistent
Optional, set to false to unsubscribe after one event.

Remarks

 

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0

Subscribe Method

Subscribes to Collision Events.

Syntax

[Sansar.Script.Interface]
public Sansar.Script.IEventSubscription Subscribe (CollisionEventType EventType, Sansar.Script.ComponentId HitComponentId, Action<CollisionData> callback, bool persistent)

See Also

Parameters

EventType
The type of collision which occurred.
HitComponentId
The id of the rigid body component or character that was hit.
callback
Callback which is executed when the event completes.
persistent
Optional, set to false to unsubscribe after one event.

Returns

An Sansar.Script.IEventSubscription that can be used to cancel the subscription.

Remarks

 

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


Was this article helpful?
1 out of 1 found this helpful
Have more questions? Submit a request

0 Comments

Article is closed for comments.