[This is preliminary documentation and is subject to change.]
Gets a goal chunk with the specified label. If a goal chunk cannot be found,
this method returns null.
Namespace: ClarionAssembly: ClarionLibrary (in ClarionLibrary.dll) Version: 6.1.1.0 (6.1.1.0)
Syntax
C# |
---|
public static GoalChunk GetGoalChunk( IComparable label ) |
Parameters
- label
- Type: System..::..IComparable
The label of a goal chunk to get
Return Value
A goal chunk with the specified label or null if a goal chunk cannot be found
Remarks
![]() |
---|
This method CANNOT guarantee correct retrieval unless ALL goal chunks are initialized using a unique label. Since a label is optional for a goal chunk and since multiple goal chunks can have the same label, calling this method will only returns the FIRST instance of a goal chunk with the specified label (if one is found). Keep this in mind if you plan to use this method to retrieve goal chunks from the world. |
Exceptions
Exception | Condition |
---|---|
System..::..InvalidOperationException | If the singleton world instance has not been initialized |