QuestObjective
classSingle trackable goal of a quest
Fields
| Name | Type | Description |
|---|---|---|
| id | string | Identifier unique within the quest |
| label | Loc | Localized objective text |
| completed | boolean | Whether the objective is done |
| show_progress | boolean | Whether the progress counter is shown |
| current | integer | Current progress counter |
| required | integer | Progress counter needed to complete |
Functions
QuestObjective:set_progress(current, required, show_progress)
Set the progress counters, completing the objective when they meet
| current | integer | Current amount |
| required | integer | Required amount |
| show_progress | boolean | Whether the counter is shown |
QuestObjective:set_completed(completed)
Set the completion flag directly
| completed | boolean | New completion state |
Standard members (4)
Generated for every class of this kind by the game's codegen, not written for QuestObjective.
| QuestObjective.cast(object) | Trying to cast Object into QuestObjective |
| QuestObjective.get_class() | Return QuestObjective class object |
| QuestObjective.new(parent, name) | Creates a new QuestObjective instance |
| QuestObjective.new_simple() | Creates a new QuestObjective instance |
Inherited from Instance (1)
- Instance:is_valid() Returns false once the underlying engine object has been destroyed
Inherited from Object (3)
- name Object name
- Object.find(name) Find an already loaded object by name
- Object:get_class() Class of this object
Used by
- StaticQuest.objectives field
- StaticQuest.create_objective return
- StaticQuest.add_objective param
- StaticQuest.find_objective_by_id return