CharacterTracker Class
The CharacterTracker keeps track of the quests associated with a QuestCharacter for a user.
Syntax
[Sansar.Script.Interface]
public class CharacterTracker : Sansar.Script.InstanceInterface
public class CharacterTracker : Sansar.Script.InstanceInterface
Remarks
There is as yet no way to create Quest Characters, but this functionality is coming soon.
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] | ActiveQuestCount | int . Number of this character's quests currently active for this user. |
| [read-only] | ActiveQuestDefinitions | QuestDefinition[]. Currently active quests. |
| [read-only] | AvailableQuestCount | int . umber of this character's quests currently available for this user. |
| [read-only] | AvailableQuestDefinitions | QuestDefinition[]. Quests that are available to be offered. |
| [read-only] | CanTurnInQuestCount | int . umber of this character's quests ready to be turned in for this user. |
| [read-only] | CanTurnInQuestDefinitions | QuestDefinition[]. Quests that are ready to be turned in to this character. |
| [read-only] | IsValid | bool . Whether or not this interface is valid. (Inherited from Sansar.Script.InstanceInterface.) |
| [read-only] | SessionId | Sansar.Script.SessionId . The session Id for the user being tracked. |
Public Methods
Subscribe (Action<CharacterTrackerData>, bool) : Sansar.Script.IEventSubscription
Subscribes to CharacterTracker Events. |
||
|
override
|
ToString () : string
A string representation of this object. |
|
Update ()
Update the CharacterTracker data. |
||
Update (Action<Sansar.Script.OperationCompleteEvent>)
Update the CharacterTracker data. |
||
Member Details
ActiveQuestCount Property
Number of this character's quests currently active for this user.Syntax
[get: Sansar.Script.Interface]
public int ActiveQuestCount { 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
ActiveQuestDefinitions Property
Currently active quests.Syntax
[get: Sansar.Script.Interface]
public QuestDefinition[] ActiveQuestDefinitions { 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
AvailableQuestCount Property
umber of this character's quests currently available for this user.Syntax
[get: Sansar.Script.Interface]
public int AvailableQuestCount { 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
AvailableQuestDefinitions Property
Quests that are available to be offered.Syntax
[get: Sansar.Script.Interface]
public QuestDefinition[] AvailableQuestDefinitions { 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
CanTurnInQuestCount Property
umber of this character's quests ready to be turned in for this user.Syntax
[get: Sansar.Script.Interface]
public int CanTurnInQuestCount { 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
CanTurnInQuestDefinitions Property
Quests that are ready to be turned in to this character.Syntax
[get: Sansar.Script.Interface]
public QuestDefinition[] CanTurnInQuestDefinitions { 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
SessionId Property
The session Id for the user being tracked.Syntax
[get: Sansar.Script.Interface]
public Sansar.Script.SessionId SessionId { 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
Subscribe Method
Subscribes to CharacterTracker Events.Syntax
[Sansar.Script.Interface]
public Sansar.Script.IEventSubscription Subscribe (Action<CharacterTrackerData> callback, bool persistent)See Also
Parameters
- callback
- Callback which is executed when the event completes.
- persistent
- Optional, set to false to unsubscribe after one event.
Returns
An Sansar.Script.IEventSubscription that can be used to cancel the subscription.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 CharacterTracker data.Syntax
[Sansar.Script.Interface]
public void Update ()Remarks
Use in a WaitFor to wait for the data for the CharacterTracker 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 CharacterTracker data.Syntax
Parameters
- handler
- Handler to be called when the event completes.
Remarks
Use in a WaitFor to wait for the data for the CharacterTracker 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