Sansar Docs
Ask or search…
K

ScriptID

ScriptId Struct

Encapsulates an Script Id.

Syntax

Member Details

AllScripts Field

The invalid id script.

Syntax

public static readonly ScriptId AllScripts

Remarks

Requirements

Namespace: Sansar.Script Assembly: Sansar.Script (in Sansar.Script.dll) Assembly Versions: 1.0.0.0

CompareTo Method

Compares another instance to this scriptId.

Syntax

Parameters
other
The scriptId to compare with this instance.
Returns
Returns -1 if this scriptId comes before the specified instance, 1 if this script id comes after the specified instance, 0 otherwise.

Remarks

Requirements

Namespace: Sansar.Script Assembly: Sansar.Script (in Sansar.Script.dll) Assembly Versions: 1.0.0.0

CompareTo Method

Compares another instance to this scriptId.

Syntax

Parameters
other
The scriptId to compare with this instance.
Returns
Returns -1 if this scriptId comes before the specified instance, 1 if this script id comes after the specified instance, 0 otherwise. Returns 2 if the object is not a scriptId.

Remarks

Requirements

Namespace: Sansar.Script Assembly: Sansar.Script (in Sansar.Script.dll) Assembly Versions: 1.0.0.0

Equals Method

Value comparison for ScriptId.

Syntax

Parameters
obj
The script to compare.
Returns
true if the argument is an ScriptId and has the same value.

Remarks

Requirements

Namespace: Sansar.Script Assembly: Sansar.Script (in Sansar.Script.dll) Assembly Versions: 1.0.0.0

GetHashCode Method

Retrieves the hash code for this instance.

Syntax

public override int GetHashCode ()
Returns
The hash code for this instance.

Remarks

Requirements

Namespace: Sansar.Script Assembly: Sansar.Script (in Sansar.Script.dll) Assembly Versions: 1.0.0.0

Invalid Field

The invalid id script.

Syntax

public static readonly ScriptId Invalid

Remarks

Requirements

Namespace: Sansar.Script Assembly: Sansar.Script (in Sansar.Script.dll) Assembly Versions: 1.0.0.0

IsValid Property

Gets the valid state for this ScriptId.

Syntax

public bool IsValid { get; }
Value
True if this id is a valid ScriptId.

Remarks

Requirements

Namespace: Sansar.Script Assembly: Sansar.Script (in Sansar.Script.dll) Assembly Versions: 1.0.0.0

op_Equality Method

ScriptId equality operator.

Syntax

Parameters
a
First ScriptId to compare.
b
Second ScriptId to compare.
Returns
true if the ScriptIds have the same value.

Remarks

Requirements

Namespace: Sansar.Script Assembly: Sansar.Script (in Sansar.Script.dll) Assembly Versions: 1.0.0.0

Conversion Method

Convert a ScriptId to a uint.

Syntax

public static implicit operator uint (ScriptId id)
Parameters
id
The Script id to convert.
Returns

Remarks

Requirements

Namespace: Sansar.Script Assembly: Sansar.Script (in Sansar.Script.dll) Assembly Versions: 1.0.0.0

op_Inequality Method

ScriptId inequality operator.

Syntax

Parameters
a
First ScriptId to compare.
b
Second ScriptId to compare.
Returns
true if the ScriptIds have a different value.

Remarks

Requirements

Namespace: Sansar.Script Assembly: Sansar.Script (in Sansar.Script.dll) Assembly Versions: 1.0.0.0

ToString Method

Converts the id to a hexadecimal string representation.

Syntax

public override string ToString ()
Returns
The hexadecimal string representation.

Remarks

Requirements

Namespace: Sansar.Script Assembly: Sansar.Script (in Sansar.Script.dll) Assembly Versions: 1.0.0.0