QuestDefinition Class
The QuestDefinition stores the data that is used to create quest instances for users.
Syntax
[Sansar.Script.Interface]
public class QuestDefinition : Sansar.Script.InstanceInterface
public class QuestDefinition : Sansar.Script.InstanceInterface
Remarks
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
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] | Description | string . The description of this quest. |
| [read-only] | IsValid | bool . Whether or not this interface is valid. (Inherited from Sansar.Script.InstanceInterface.) |
| [read-only] | ObjectiveDefinitions | ObjectiveDefinition[]. All the ObjectiveDefinitions for this QuestDefinition. |
| [read-only] | Ready | bool . If the QuestDefinition data is ready. |
| [read-only] | Title | string . The title of this quest. |
Public Methods
GetQuest (Sansar.Script.SessionId)
Get the state of this quest for a particular user. |
||
GetQuest (AgentPrivate)
Get the state of this quest for a particular user. |
||
GetQuest (Sansar.Script.SessionId, Action<QuestDefinition.GetQuestData>)
Get the state of this quest for a particular user. |
||
GetQuest (AgentPrivate, Action<QuestDefinition.GetQuestData>)
Get the state of this quest for a particular user. |
||
|
override
|
ToString () : string
A string representation of this object. |
|
Update ()
Update the QuestDefinition data. |
||
Update (Action<Sansar.Script.OperationCompleteEvent>)
Update the QuestDefinition data. |
||
Member Details
Description Property
The description of this quest.Syntax
[get: Sansar.Script.Interface]
public string Description { get; }Value
Documentation for this section has not yet been entered.Remarks
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
GetQuest Method
Get the state of this quest for a particular user.Syntax
Parameters
- agent
- The Sansar.Script.SessionId of the user.
Remarks
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
GetQuest Method
Get the state of this quest for a particular user.Syntax
Parameters
- agent
- Obtain the quest state for this user.
Remarks
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
GetQuest Method
Get the state of this quest for a particular user.Syntax
[Sansar.Script.Interface]
public void GetQuest (Sansar.Script.SessionId agent, Action<QuestDefinition.GetQuestData> handler)Parameters
- agent
- The Sansar.Script.SessionId of the user.
- handler
- Handler to be called when the event completes.
Remarks
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
GetQuest Method
Get the state of this quest for a particular user.Syntax
[Sansar.Script.Interface]
public void GetQuest (AgentPrivate agent, Action<QuestDefinition.GetQuestData> handler)Parameters
- agent
- Obtain the quest state for this user.
- handler
- Handler to be called when the event completes.
Remarks
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
ObjectiveDefinitions Property
All the ObjectiveDefinitions for this QuestDefinition.Syntax
[get: Sansar.Script.Interface]
public ObjectiveDefinition[] ObjectiveDefinitions { get; }Value
Documentation for this section has not yet been entered.Remarks
The ObjectiveDefinitions for this QuestDefinitionRequirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
Ready Property
If the QuestDefinition data is ready.Syntax
[get: Sansar.Script.Interface]
public bool Ready { get; }See Also
Value
Documentation for this section has not yet been entered.Remarks
Returns false until the data has been fetched from the quest service. Once it returns true it will always return true.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
Title Property
The title of this quest.Syntax
[get: Sansar.Script.Interface]
public string Title { get; }Value
Documentation for this section has not yet been entered.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
The format of this string may change between releases.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
Update Method
Update the QuestDefinition data.Syntax
[Sansar.Script.Interface]
public void Update ()Remarks
Use in a WaitFor to wait for the data for the QuestDefinition to be ready. Once data is retrieved and Ready is true it will never again be false.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
Update Method
Update the QuestDefinition data.Syntax
Parameters
- handler
- Handler to be called when the event completes.
Remarks
Use in a WaitFor to wait for the data for the QuestDefinition to be ready. Once data is retrieved and Ready is true it will never again be false.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
0 Comments