A unit of trackable work with an Inactive, Active and Complete lifecycle. Use it for anything from an objective that simply tracks a number to a complex nested objective made of other objectives.
- Eliminate 10 enemies: one counter that completes at its target.
- Hold the point for 60 seconds: time accumulated while a condition holds.
- Clear the dungeon: nested objectives that complete in sequence or together.
Verse using statement |
using { /Verse.org/Progression } |
Members
This class has both data members and functions.
Data
| Data Member Name | Type | Description |
|---|---|---|
State |
?objective_state |
This objective's lifecycle state. |
CompleteEvent |
unknown |
Signaled when this objective completes. |
ProgressEvent |
unknown |
Signaled when this objective's progress changes. |
ActivateEvent |
unknown |
Signaled when this objective is activated. |
DeactivateEvent |
unknown |
Signaled when this objective is deactivated. |
Functions
| Function Name | Description |
|---|---|
GetProgress |
Returns a |
SignalProgressEvent |
Signals |
Activate |
Starts this objective; returns an error when it is already running or its type refuses to start it, otherwise the errors |
CanActivate |
Succeeds if this objective may be activated; the default succeeds. Veto by returning errors. |
OnActivate |
Called when this objective starts. |
Deactivate |
Stops this objective; returns an error when it is not running, otherwise the errors |
CanDeactivate |
Succeeds if this objective may be deactivated; the default succeeds. Veto by returning errors. |
OnDeactivate |
Called when this objective stops. |
Complete |
Reports this objective as complete for |
CanComplete |
Succeeds if this objective may be completed for |
OnComplete |
Called after this objective is complete, possibly more than once. |