Sansar Docs
Ask or search…
K

Cluster

Cluster, resource, data, event phase, and event type docs.

Cluster Class

The Cluster class handles interactions with in game objects.

Syntax

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

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

[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

Returns
Enumerable for GetObjectPrivate

Remarks

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

Requirements

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


ClusterId Struct

Encapsulates an Cluster Id.

Syntax

[Sansar.Script.Interface] public struct ClusterId

Member Details

Equals Method

Value comparison for ClusterId.

Syntax

[Sansar.Script.Interface] public override bool Equals (object obj)
Parameters
obj
The object to compare.
Returns
true if the argument is an ClusterId and has the same value.

Remarks

Requirements

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

GetHashCode Method

Retrieves the hash code for this instance.

Syntax

[Sansar.Script.Interface] public override int GetHashCode ()
Returns
The hash code for this instance.

Remarks

Requirements

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

Invalid Field

The invalid id object.

Syntax

[Sansar.Script.Interface] public static readonly ClusterId Invalid

Remarks

Requirements

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

op_Equality Method

ClusterId equality operator.

Syntax

Parameters
a
First ClusterId to compare.
b
Second ClusterId to compare.
Returns
true if the ClusterIds have the same value.

Remarks

Requirements

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

Conversion Method

Internal explicit conversion from a uint.

Syntax

Parameters
id
A uint representation of an ClusterId
Returns

Remarks

Requirements

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

op_Inequality Method

ClusterId inequality operator.

Syntax

Parameters
a
First ClusterId to compare.
b
Second ClusterId to compare.
Returns
true if the ClusterIds have a different value.

Remarks

Requirements

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

ToString Method

Converts the id to a hexadecimal string representation.

Syntax

[Sansar.Script.Interface] public override string ToString ()
Returns
The hexadecimal string representation.

Remarks

Requirements

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


ClusterResource Class

Syntax

Member Details

ResourceId Property

Returns the resource Id of this ClusterResource.

Syntax

[get: Sansar.Script.Interface] public string ResourceId { 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

Requirements

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