Last updated
Last updated
The Cluster class handles interactions with in game objects.
Returns the Id of this cluster.
Syntax[get: Sansar.Script.Interface] public ClusterId { get; }
Value
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
Destroys this cluster.
SyntaxReturns
The internal event id for the completion event.
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
Destroys this cluster.
SyntaxParameters
handler
Handler to be called when the event completes.
Returns
The internal event id for the completion event.
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
Destroys this cluster.
SyntaxParameters
handler
Handler to be called when the event completes.
Returns
The internal event id for the completion event.
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
Retrieves a Sansar.Simulation.ObjectPrivate by index.
SyntaxParameters
index
Index of the Sansar.Simulation.ObjectPrivate to retrieve.
Returns
The Sansar.Simulation.ObjectPrivate at that index or null.
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
Enumerable for GetObjectPrivate
SyntaxReturns
Enumerable for GetObjectPrivate
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
The current number of objects in this cluster.
SyntaxValue
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
A string representation of this object.
SyntaxReturns
A string representation of this object.
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
Encapsulates an Cluster Id.
[Sansar.Script.Interface] public struct ClusterId
Value comparison for ClusterId.
SyntaxParameters
obj
The object to compare.
Returns
true if the argument is an ClusterId and has the same value.
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
Retrieves the hash code for this instance.
SyntaxReturns
The hash code for this instance.
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
The invalid id object.
Syntax
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
ClusterId equality operator.
SyntaxParameters
a
First ClusterId to compare.
b
Second ClusterId to compare.
Returns
true if the ClusterIds have the same value.
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
Internal explicit conversion from a uint.
SyntaxParameters
id
A uint representation of an ClusterId
Returns
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
ClusterId inequality operator.
SyntaxParameters
a
First ClusterId to compare.
b
Second ClusterId to compare.
Returns
true if the ClusterIds have a different value.
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
Converts the id to a hexadecimal string representation.
SyntaxReturns
The hexadecimal string representation.
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
Returns the resource Id of this ClusterResource.
SyntaxValue
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
A string representation of this object.
SyntaxReturns
A string representation of this object.
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
[Sansar.Script.Interface] public Destroy ()
[Sansar.Script.Interface] public GetObjectPrivate ( index)
[get: Sansar.Script.Interface] public ObjectPrivateCount { get; }
[Sansar.Script.Interface] public override ToString ()
[Sansar.Script.Interface] public override Equals ( obj)
[Sansar.Script.Interface] public override GetHashCode ()
[Sansar.Script.Interface] public static readonly Invalid
[Sansar.Script.Interface] public override ToString ()
The ClusterResource class represents a cluster that could be added to the scene. See .
[get: Sansar.Script.Interface] public ResourceId { get; }
[Sansar.Script.Interface] public override ToString ()
Cluster, resource, data, event phase, and event type docs.