Collapse All Expand All

C#

Clarion Library 6.1.1
World..::..GetDimensionValuePair Method
World Class See Also Send Feedback

[This is preliminary documentation and is subject to change.]

Gets the dimension-value pair with the specified world ID. If the dimension-value pair cannot be found, this method returns null.

Namespace: Clarion
Assembly: ClarionLibrary (in ClarionLibrary.dll) Version: 6.1.1.0 (6.1.1.0)

# Syntax

C#
    public static DimensionValuePair GetDimensionValuePair(
    	Guid worldID
    )

#### Parameters

worldID
  Type: System..::..Guid
  The ID (in the World) of the dimension-value pair to get

#### Return Value

The dimension-value pair with the specified world ID or null if the dimension-value pair cannot be found

# Remarks

Note
If the specified world ID is the world ID of a chunk or agent, this method will return the dimension-value pair representation of that chunk or agent.

TODO: Add note about Non-Generic dimension-value pairs

# Exceptions

Exception | Condition
--- | ---
System..::..InvalidOperationException | If the singleton world instance has not been initialized

# See Also

World Class
Clarion Namespace