A quest that auto-completes when its Objective is or becomes Complete, and grants its Rewards once over the quest's live memberships on a succeeding completion.
Represents the "Do X, Get Y" paradigm for goal setting: for example, pick up 5 apples, where each apple picked up adds progress, and on completion a reward is distributed to the participants set to receive.
Verse using statement |
using { /UnrealEngine.com/Progression } |
Inheritance Hierarchy
This class is derived from the following hierarchy, starting with objective:
| Name | Description |
|---|---|
objective |
A unit of trackable work with an
|
quest |
A completable goal with dynamic participation and terminal completion state. Participants join and abandon over time, each with its own
|
Exposed Interfaces
This class exposes the following interfaces:
| Name | Description |
|---|---|
has_objective |
Implemented by types that hold an |
has_quest_rewards |
Implemented by quests that carry a reward list. |
Members
This class has both data members and functions.
Data
| Data Member Name | Type | Description |
|---|---|---|
AbandonEvent |
unknown |
Signaled when a participant abandons this quest; sends the removed |
ActivateEvent |
unknown |
Signaled when this objective is activated. |
Collection |
?quest_collection |
The collection this quest belongs to; an archetype must name one.
Write it with |
CompleteEvent |
unknown |
Signaled when this objective completes. |
DeactivateEvent |
unknown |
Signaled when this objective is deactivated. |
JoinEvent |
unknown |
Signaled when a participant joins this quest; sends the new |
ProgressEvent |
unknown |
Signaled when this objective's progress changes. |
State |
?objective_state |
This objective's lifecycle state. |
Functions
| Function Name | Description |
|---|---|
Abandon |
Removes |
Activate |
Starts this objective; returns an error when it is already running or its type refuses to start it, otherwise the errors |
CanAbandon |
Succeeds if |
CanActivate |
Succeeds if this objective may be activated; the default succeeds. Veto by returning errors. |
CanComplete |
Succeeds if this objective may be completed for |
CanDeactivate |
Succeeds if this objective may be deactivated; the default succeeds. Veto by returning errors. |
CanJoin |
Succeeds if |
Complete |
Reports this objective as complete for |
Deactivate |
Stops this objective; returns an error when it is not running, otherwise the errors |
GetProgress |
Returns a |
Join |
Adds |
OnAbandon |
Called when a participant abandons this quest; withdraws an |
OnAbandon |
Called when a participant abandons this quest. |
OnActivate |
Called when this quest activates; propagates the activation to the |
OnActivate |
Called when this objective starts. |
OnComplete |
Called when this quest completes; grants |
OnComplete |
Called when this quest completes. |
OnComplete |
Called after this objective is complete, possibly more than once. |
OnDeactivate |
Called when this quest deactivates; propagates to the |
OnDeactivate |
Called when this objective stops. |
OnJoin |
Called when a participant joins this quest; enrolls |
OnJoin |
Called when a participant joins this quest. |
SetCollection |
Moves this quest and its memberships into |
SetObjective |
Writes |
SetRewards |
Writes |
SignalProgressEvent |
Signals |