Cluster Class
The Cluster class handles interactions with in game objects.
Syntax
[Sansar.Script.Interface]
public class Cluster : Sansar.Script.InstanceInterface
public class Cluster : Sansar.Script.InstanceInterface
Remarks
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]
|
ClusterId | ClusterId . Returns the Id of this cluster. |
| [read-only]
|
IsValid | bool . Whether or not this interface is valid. (Inherited from Sansar.Script.InstanceInterface.) |
| [read-only]
|
ObjectPrivateCount | uint . The current number of objects in this cluster. |
Public Methods
|
|
Destroy ()
Destroys this cluster. |
|
|
|
Destroy (Sansar.Script.ScriptBase.OperationComplete) : ulong
Destroys this cluster. |
|
|
|
Destroy (Action<Sansar.Script.OperationCompleteEvent>)
Destroys this cluster. |
|
|
|
GetObjectPrivate (uint) : ObjectPrivate
Retrieves a Sansar.Simulation.ObjectPrivate by index. |
|
|
|
GetObjectPrivates () : IEnumerable<ObjectPrivate>
Enumerable for GetObjectPrivate |
|
|
override
|
ToString () : string
A string representation of this object. |
|
Member Details
ClusterId Property
Returns the Id of this cluster.Syntax
[get: Sansar.Script.Interface]
public ClusterId ClusterId { get; }Value
Remarks
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
Destroy Method
Destroys this cluster.Syntax
[Sansar.Script.Interface]
public void Destroy ()Returns
The internal event id for the completion event.Remarks
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
Destroy Method
Destroys this cluster.Syntax
[Sansar.Script.Interface]
[System.Obsolete("Deprecated. Use the Action<> overload", false)]
public ulong Destroy (Sansar.Script.ScriptBase.OperationComplete handler)Parameters
- handler
- Handler to be called when the event completes.
Returns
The internal event id for the completion event.Remarks
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
Destroy Method
Destroys this cluster.Syntax
Parameters
- handler
- Handler to be called when the event completes.
Returns
The internal event id for the completion event.Remarks
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
GetObjectPrivate Method
Retrieves a Sansar.Simulation.ObjectPrivate by index.Syntax
Parameters
- index
- Index of the Sansar.Simulation.ObjectPrivate to retrieve.
Returns
The Sansar.Simulation.ObjectPrivate at that index or null.Remarks
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
GetObjectPrivates Method
Enumerable for GetObjectPrivateSyntax
[Sansar.Script.Interface]
public IEnumerable<ObjectPrivate> GetObjectPrivates ()Returns
Enumerable for GetObjectPrivateRemarks
The resulting enumerable may be invalidated if the underlying collection changes.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
ObjectPrivateCount Property
The current number of objects in this cluster.Syntax
[get: Sansar.Script.Interface]
public uint ObjectPrivateCount { 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
0 Comments