HeldObjectData

HeldObjectData Class

Handler for agent grab events.

Syntax

[Sansar.Script.Interface]
public class HeldObjectData : Sansar.Script.EventData

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.EventData.

Public Properties

[read-only]
 
ComponentId Sansar.Script.ComponentId . The ComponentId of the held object's Sansar.Simulation.RigidBodyComponent.
[read-only]
 
HeldObjectEvent HeldObjectEventType . The type of held object event which occurred.
[read-only]
 
HeldObjectInfo HeldObjectInfo . information about the held object
[read-only]
 
ObjectId Sansar.Script.ObjectId . The ObjectId of the held object.

Public Methods

override
ToString () : string
A string representation of this object.
override
ToString () : string
Generates a string representation of the EventData. (Inherited from Sansar.Script.EventData.)

Member Details

ComponentId Property

The ComponentId of the held object's Sansar.Simulation.RigidBodyComponent.

Syntax

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

Value

Remarks

 

Requirements

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

HeldObjectEvent Property

The type of held object event which occurred.

Syntax

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

Value

Remarks

 

Requirements

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

HeldObjectInfo Property

information about the held object

Syntax

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

Value

Remarks

 

Requirements

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

ObjectId Property

The ObjectId of the held object.

Syntax

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

Value

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?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Article is closed for comments.