en-quests

en-quests gives your settlements survivors with stories. Quest givers stand around the map. When one has something for you, they show a map blip and a marker. Talk to them to open a dialogue with the camera on the speaker. They offer three kinds of quest:

• Story quests: done once, often chained together.
• Side jobs: done once.
• Daily tasks: repeatable after a cooldown.

A quest is a list of steps: talk to someone, deliver items, carry items, reach a place, kill zombies (optionally a specific type), search bodies, or craft something. A tracker shows the current step and its progress. The journal (F5) lists active and completed quests, and lets you set a map waypoint or abandon a quest.

The server works out all progress from real game events, so a client can never simply claim a step is done. The one exception is "reach", which the server checks again. Kills and searches can also count for nearby party members on the same step. Rewards can be cash, character XP, items and skill XP.

#At a glance

#How it works

#Offers

A survivor offers a quest when all of these are true:

• the quest isn't already active
• a story quest or side job hasn't been completed before
• a task's cooldown since its last completion has passed
• you meet the character level, skill level and prerequisite quests in requires
• you have fewer than Config.maxActive quests active

When several quests are on offer, the survivor says Config.offersLine and you pick one. Offers are ordered by Config.types.

#Objectives

#Abandoning and rewards

Abandoning a repeatable task you've completed before sets it back to completed, so the cooldown still applies. Otherwise it becomes abandoned. Reward items that don't fit in your inventory aren't given, and you get a "No room for ..." message.

#Changing quest definitions

Editing a quest keeps player progress, clamped to the new number of steps. Deleting a quest leaves progress rows alone, and they resume if a quest with that id comes back.

#Configuration

#config/shared.lua

#data/npcs.lua

A table keyed by survivor id. Defaults: rhodes, hale, vance.

#data/quests.lua

A table keyed by quest id (up to 60 characters). Quest definitions stay on the server; clients never see them. Defaults: first_steps, clean_water (needs first_steps), thin_the_herd, runner_hunt (level 5) and scrap_run (task, 20 h cooldown).

Every step has a type and label, and can have a hint (journal line) and coords (waypoint). Extra fields by type:

#Adding a survivor and a daily task

-- data/npcs.lua
marla = {
    name = 'Marla', title = 'Grapeseed Farm',
    model = 'a_f_m_farmer_01', coords = vec4(2440.0, 4975.0, 46.8, 90.0),
    scenario = 'WORLD_HUMAN_GARDENER_PLANT',
    greeting = { 'Fields don\'t tend themselves.' },
},

-- data/quests.lua
cloth_for_marla = {
    label = 'Rags to Riches', type = 'task', giver = 'marla', cooldownHours = 12,
    description = 'Marla patches tarps for the farm and always needs cloth.',
    offer = { 'Bring me cloth and clear the walkers off the east field.' },
    requires = { level = 2 },
    steps = {
        { type = 'kill', count = 8, label = 'Clear the east field', coords = vec3(2470.0, 4990.0, 45.0) },
        { type = 'collect', item = 'cloth', count = 15, label = 'Gather cloth' },
        { type = 'deliver', npc = 'marla', item = 'cloth', count = 15, label = 'Bring Marla the cloth',
          dialog = { 'That\'ll hold the rain off. Here.' } },
    },
    rewards = { cash = 120, xp = 100, items = { { item = 'canned_beans', count = 2 } }, skills = { scavenging = 10 } },
},

#Exports

All exports are server-side. There are no client exports.

#Commands

#Events

Emitted, server-local:

Listened to, as objective sources:

#Database

encore_quest_progress: primary key (citizenid, quest_id), plus status (active, completed or abandoned), step, count, completions, completed_at and started_at (unix times).

#Examples

Use AdvanceQuest for an objective en-quests doesn't track itself. Here the current step of a signal_boost quest is finished when a player repairs a radio tower in your own script:

-- server
AddEventHandler('myradio:server:towerRepaired', function(source)
    if exports['en-quests']:IsQuestActive(source, 'signal_boost') then
        exports['en-quests']:AdvanceQuest(source, 'signal_boost')
    end
end)

Gate content behind a finished story quest:

if not exports['en-quests']:HasCompletedQuest(source, 'clean_water') then
    return false, 'Rhodes hasn\'t vouched for you yet.'
end

Announce completed quests:

AddEventHandler('en-quests:server:completed', function(source, questId)
    print(('%s completed %s'):format(GetPlayerName(source), questId))
end)

#Related

• Create a quest
• en-party
• en-zombies
• en-crafting
• XP and levels