Class engine.Quest

Handle quests

Methods

engine.Quest:isCompleted (sub)

Checks if the quest (or sub-objective) is complete

engine.Quest:isEnded ()

Checks if the quest is ended (DONE or FAILED)

engine.Quest:check (prop)

Check for an quest property If not a function it returns it directly, otherwise it calls the function with the extra parameters

engine.Quest:setStatus (status[, sub], who)

Sets the quests status or sub-objective status

engine.Quest:isStatus (status[, sub])

Checks the quests status or sub-objective status



Methods

engine.Quest:isCompleted (sub)
Checks if the quest (or sub-objective) is complete

Parameters:

  • sub a subobjective id or nil for the whole quest

Returns:

    false if objective still incomplete

Or

    true if objective completed
engine.Quest:isEnded ()
Checks if the quest is ended (DONE or FAILED)

Returns:

    false if quest didn't end

Or

    true if quest ended
engine.Quest:check (prop)
Check for an quest property If not a function it returns it directly, otherwise it calls the function with the extra parameters

Parameters:

  • prop the property name to check
engine.Quest:setStatus (status[, sub], who)
Sets the quests status or sub-objective status

Parameters:

  • status one of the possible quest status (PENDING, COMPLETED, DONE, FAILED)
  • sub sub-objective (optional)
  • who who did this??
engine.Quest:isStatus (status[, sub])
Checks the quests status or sub-objective status

Parameters:

  • status one of the possible quest status (PENDING, COMPLETED, DONE, FAILED)
  • sub sub-objective (optional)
generated by LDoc 1.4.3