Cluster

Cluster Class

The Cluster class handles interactions with in game objects.

Syntax

[Sansar.Script.Interface]
public class Cluster : 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 Properties

[read-only]
 
ClusterId ClusterId . Returns the Id of this cluster.
[read-only]
 
ObjectPrivateCount uint . The current number of objects in this cluster.

Public Methods

  Destroy (Sansar.Script.ScriptBase.OperationComplete) : ulong
Destroys this cluster.
  Destroy (Action<Sansar.Script.OperationCompleteEvent>) : ulong
Destroys this cluster.
  GetObjectPrivate (uint) : ObjectPrivate
Retrieves a Sansar.Simulation.ObjectPrivate by index.
  GetObjectPrivates () : IEnumerable<ObjectPrivate>
Enumerable for GetObjectPrivate

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 ulong Destroy (Sansar.Script.ScriptBase.OperationComplete handler)

Parameters

handler
The optional Action`1 to be called when the cluster has been destroyed.

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]
public ulong Destroy (Action<Sansar.Script.OperationCompleteEvent> handler)

Parameters

handler
The optional Action`1 to be called when the cluster has been destroyed.

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

[Sansar.Script.Interface]
public ObjectPrivate GetObjectPrivate (uint index)

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 GetObjectPrivate

Syntax

[Sansar.Script.Interface]
public IEnumerable<ObjectPrivate> GetObjectPrivates ()

Returns

Enumerable for GetObjectPrivate

Remarks

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


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

0 Comments

Article is closed for comments.