PMDOWiki - User contributions [en]

Mod:Nebula's Mission Board/Basic setup

2026-02-19T08:22:51Z

MistressNebula: /* Importing the files */ Added instruction talking about mission items

Despite it being created to be as easy to add inside mods as possible, it still takes a bit of work to get the Mission Generation Library up and running. This page will run through all the necessary steps, from file placement to function hooks and <code>require</code> calls.

===== Importing the files =====

# Download [https://github.com/435THz/NebulaMissionBoard/releases Nebula's Mission Board] from github and extract the zip's content wherever you like.
# Go to the mod's <code>Data/Script</code> folder and copy the <code>missiongen_lib</code> folder.
# Paste the <code>missiongen_lib</code> folder inside your own mod's <code>Data/Script</code> folder.

Note that the library files expect to be placed exactly inside <code>Data/Script/missiongen_lib</code>. If you place them anywhere else, you will need to adjust all of the files' <code>include</code> calls accordingly, as well as all of the <code>include</code> calls present in this guide.
Don't forget to also copy all of the strings inside the <code>strings.resx</code> and <code>stringsEx.resx</code> files over to your mod, as well as the mission items inside the <code>Data/Item</code> folder!

===== Initializing the library =====

With the files imported in your mod, it's time to load it:
* Add <code>MissionGen = require("missiongen_lib.missiongen_lib")</code> inside your mod's <code>common.lua</code> file. You can rename this variable however you want, but it must be a global variable.
* If your global variable is not named "MissionGen", open missiongen_service.lua and change the <code>library_name</code> string into your global variable's name. Doing this will ensure that the service will be able to find the library when it needs to interact with it.
* Add <code>require 'missiongen_lib.missiongen_service'</code> inside your mod's <code>main.lua</code> file.

These steps will take care of most of the initialization process all by themselves. All of the library files will be loaded, and the <code>SV</code> structure will be automatically have the library's save data added to it. This, however, does nothing in terms of gameplay, and more steps are needed for the library to actually function.

===== Hooking up functions =====
This is the lengthiest part of the guide. There are a lot of functions that need to be set up in order for the library to work correctly, as highlighted by the many files inside Nebula's Mission Board mod. Luckily, they're pretty easy to port: All you need to do is copy-paste all functions in their respective files in your mod. For example, all functions inside Nebula's Mission Board's <code>common.lua</code> will need to go inside ''your mod's'' <code>common.lua</code>. Remember to also change any reference to the <code>nebula_mission_board</code> namespace into a reference to your mod's namespace.
These are the files containing code that needs to be copied over:
* <code>common.lua</code>
* <code>common_vars.lua</code>
* <code>event.lua</code> (the <code>require</code> statements)
* <code>event.battle.lua</code>
* <code>event_mapgen.lua</code>
* <code>event.single.lua</code>

You now need to hook up the dungeon generation code to the game. Open your mod in [[Dev Mode]], go to the Constants tab and open the Universal menu. Here, in Zone Steps, add a new Script Zone Step. Set its Script parameter to <code>GenerateJobInFloor</code>.
Now save your changes, and that's it! This function will be responsible for dynamically adding the necessary steps and events whenever a destination floor is reached.

Everything we did up until now takes care of everything when it comes to generating and handling jobs inside dungeons, but there is still nothing that allows players to take new jobs, or to hand in completed ones. Not to worry: all you need to do is to add a call to <code>MissionGen:BoardInteract(board_id)</code>, and your players will be able to access your job board of choice and take its contents. <code>board_id</code>s will be discussed in the page about [[Mod:Nebula's Mission Board/ Editing settings|Settings]].
As for how handing in missions works, you will need to write a cutscene for it. Nebula's Mission Board mod already has one inside <code>Data/Script/nebula_mission_board/ground/base_camp_2</code> if you want to copy it, but here's a basic rundown of how the job completion cutscene is handled:

<ol>
<li>If any mission has been completed in the last dungeon run, the library will send the player to the location set inside the <code>end_dungeon_day_destination</code> setting. This location will need to call the <code>MissionGen:PlayJobsCompletedCutscene(callback)</code> function. If you have multiple maps with job boards, this function will also handle switching between maps as needed. You will have to provide the callback. (see step 3 for more details)</li>
<li><code>PlayJobsCompletedCutscene</code> will generate a list of characters, that will be passed to the callback along with the job struct itself.</li>
<li>the callback is ran. This is a modder-defined function with the following arguments:
<ul>
<li>a job table</li>
<li>a list of <code>GroundChar</code>s. The first one is always the client, while the second, if present, is always the target. Third and fourth are only generated for law enforcement jobs, and represent the background officers that would normally keep the outlaw restrained during the cutscene.</li>
</ul>
The callback is supposed to handle the cutscene itself, moving the characters where they need to be and displaying dialogue. It also needs to call <code>MissionGen:RewardPlayer(job, speaker, line1, line2)</code>, otherwise the player will not actually receive any rewards for the job they completed.
</li>
<li>Once the cutscene is finished, control goes back to <code>PlayJobsCompletedCutscene</code>, which will get rid of the current job and keep scanning for other completed ones until the end of the list, repeating steps 2 and 3 for each of them.</li>
<li>Finally, the function stored in the <>after_rewards_function<> settings is called, the boards are refreshed, and control is returned to the player.</li>
</ol>

That said, what you need to do is:
* call <code>MissionGen:PlayJobsCompletedCutscene(callback)</code> in any and all maps that have a board assigned to it.
* write the callback for the function above; it needs to use the current job's data and the given list of characters to actually implement the cutscene itself, and call <code>MissionGen:RewardPlayer(job, speaker, line1, line2)</code> so that players will receive their reward.
When that is done, the library will finally be fully set up and ready to use, though you will still need to edit its Settings to make sure that it generates jobs for your mod's dungeons.

Mod:Nebula's Mission Board/Basic setup

2026-02-18T19:07:55Z

MistressNebula: Add namespace change instruction

Despite it being created to be as easy to add inside mods as possible, it still takes a bit of work to get the Mission Generation Library up and running. This page will run through all the necessary steps, from file placement to function hooks and <code>require</code> calls.

===== Importing the files =====

# Download [https://github.com/435THz/NebulaMissionBoard/releases Nebula's Mission Board] from github and extract the zip's content wherever you like.
# Go to the mod's <code>Data/Script</code> folder and copy the <code>missiongen_lib</code> folder.
# Paste the <code>missiongen_lib</code> folder inside your own mod's <code>Data/Script</code> folder.

Note that the library files expect to be placed exactly inside <code>Data/Script/missiongen_lib</code>. If you place them anywhere else, you will need to adjust all of the files' <code>include</code> calls accordingly, as well as all of the <code>include</code> calls present in this guide.
Don't forget to also copy all of the strings inside the <code>strings.resx</code> and <code>stringsEx.resx</code> files over to your mod!

===== Initializing the library =====

With the files imported in your mod, it's time to load it:
* Add <code>MissionGen = require("missiongen_lib.missiongen_lib")</code> inside your mod's <code>common.lua</code> file. You can rename this variable however you want, but it must be a global variable.
* If your global variable is not named "MissionGen", open missiongen_service.lua and change the <code>library_name</code> string into your global variable's name. Doing this will ensure that the service will be able to find the library when it needs to interact with it.
* Add <code>require 'missiongen_lib.missiongen_service'</code> inside your mod's <code>main.lua</code> file.

These steps will take care of most of the initialization process all by themselves. All of the library files will be loaded, and the <code>SV</code> structure will be automatically have the library's save data added to it. This, however, does nothing in terms of gameplay, and more steps are needed for the library to actually function.

===== Hooking up functions =====
This is the lengthiest part of the guide. There are a lot of functions that need to be set up in order for the library to work correctly, as highlighted by the many files inside Nebula's Mission Board mod. Luckily, they're pretty easy to port: All you need to do is copy-paste all functions in their respective files in your mod. For example, all functions inside Nebula's Mission Board's <code>common.lua</code> will need to go inside ''your mod's'' <code>common.lua</code>. Remember to also change any reference to the <code>nebula_mission_board</code> namespace into a reference to your mod's namespace.
These are the files containing code that needs to be copied over:
* <code>common.lua</code>
* <code>common_vars.lua</code>
* <code>event.lua</code> (the <code>require</code> statements)
* <code>event.battle.lua</code>
* <code>event_mapgen.lua</code>
* <code>event.single.lua</code>

You now need to hook up the dungeon generation code to the game. Open your mod in [[Dev Mode]], go to the Constants tab and open the Universal menu. Here, in Zone Steps, add a new Script Zone Step. Set its Script parameter to <code>GenerateJobInFloor</code>.
Now save your changes, and that's it! This function will be responsible for dynamically adding the necessary steps and events whenever a destination floor is reached.

Everything we did up until now takes care of everything when it comes to generating and handling jobs inside dungeons, but there is still nothing that allows players to take new jobs, or to hand in completed ones. Not to worry: all you need to do is to add a call to <code>MissionGen:BoardInteract(board_id)</code>, and your players will be able to access your job board of choice and take its contents. <code>board_id</code>s will be discussed in the page about [[Mod:Nebula's Mission Board/ Editing settings|Settings]].
As for how handing in missions works, you will need to write a cutscene for it. Nebula's Mission Board mod already has one inside <code>Data/Script/nebula_mission_board/ground/base_camp_2</code> if you want to copy it, but here's a basic rundown of how the job completion cutscene is handled:

<ol>
<li>If any mission has been completed in the last dungeon run, the library will send the player to the location set inside the <code>end_dungeon_day_destination</code> setting. This location will need to call the <code>MissionGen:PlayJobsCompletedCutscene(callback)</code> function. If you have multiple maps with job boards, this function will also handle switching between maps as needed. You will have to provide the callback. (see step 3 for more details)</li>
<li><code>PlayJobsCompletedCutscene</code> will generate a list of characters, that will be passed to the callback along with the job struct itself.</li>
<li>the callback is ran. This is a modder-defined function with the following arguments:
<ul>
<li>a job table</li>
<li>a list of <code>GroundChar</code>s. The first one is always the client, while the second, if present, is always the target. Third and fourth are only generated for law enforcement jobs, and represent the background officers that would normally keep the outlaw restrained during the cutscene.</li>
</ul>
The callback is supposed to handle the cutscene itself, moving the characters where they need to be and displaying dialogue. It also needs to call <code>MissionGen:RewardPlayer(job, speaker, line1, line2)</code>, otherwise the player will not actually receive any rewards for the job they completed.
</li>
<li>Once the cutscene is finished, control goes back to <code>PlayJobsCompletedCutscene</code>, which will get rid of the current job and keep scanning for other completed ones until the end of the list, repeating steps 2 and 3 for each of them.</li>
<li>Finally, the function stored in the <>after_rewards_function<> settings is called, the boards are refreshed, and control is returned to the player.</li>
</ol>

That said, what you need to do is:
* call <code>MissionGen:PlayJobsCompletedCutscene(callback)</code> in any and all maps that have a board assigned to it.
* write the callback for the function above; it needs to use the current job's data and the given list of characters to actually implement the cutscene itself, and call <code>MissionGen:RewardPlayer(job, speaker, line1, line2)</code> so that players will receive their reward.
When that is done, the library will finally be fully set up and ready to use, though you will still need to edit its Settings to make sure that it generates jobs for your mod's dungeons.

Mod:Nebula's Mission Board/ Editing settings

2026-01-03T15:27:41Z

MistressNebula: Update documentation

The Mission Generation Library is designed to be highly customizable. This choice is reflected in its <code>missiongen_settings.lua</code> file. This file is what modders are supposed to edit, changing the values inside the giant table it defines.

Here's a list of all settings in the library, with documentation:

== sv_root_name ==

Name of the SV table that will contain all stored data. Use a table to specify a deeper path. If not present in the SV structure, the defined path will be generated automatically. An empty list would just use SV as root.
Examples:
* <code>"jobs"</code> would use <code>SV.jobs</code> as its root.
* <code>{"adventure", "jobs"}</code> would use <code>SV.adventure.jobs</code> as its root.

=== Example ===
<pre>"jobs"</pre>

== boards ==

A list of board ids and the data necessary to define their behavior.
Format for each board:
<pre><nowiki>
<board_id>: {
display_key: string,
size: integer,
location: {
zone: string,
map: integer
},
condition: function(library),
dungeons: string[],
job_types: {id = string, weight = integer}[]
}</nowiki></pre>
* <board_id>: The id of the board. It will be used to identify and reference this specific board inside scripts
* display_key: the string key used when displaying the job menu for this board. The localized strings are fetched from the Menu Text list (strings.resx)
* size: the amount of quests this board can hold at a time
* location: a zone id and a map index. This data is where the player will be brought for the job completion cutscene. All of these maps must call library:PlayJobsCompletedCutscene before fade-in for the reward sequence to work correctly.
* condition: Optional. A function called to determine if library:PopulateBoards() should fill out this board. It receives the library object as an argument and returns a boolean. If it returns true, the board is filled out. If it returns false, it is left empty. If this property is missing, this board will always be active.
* dungeons: Optional. A list of zone ids to generate dungeons for. This board will never generate jobs for dungeons that do not appear in this list. If this property is missing, this board can generate jobs for any registered dungeon.
* job_types: a list of job types and their probability weight. Higher weight means more common.

=== Example ===
<pre>{
quest_board = {
display_key = "BOARD_QUEST_TITLE",
size = 8,
location = {zone = "guildmaster_island", map = 2},
condition = function (library)
local root = library.root
local completed = 0
for _, segments in pairs(root.dungeon_progress) do
for _, state in pairs(segments) do
if state then
completed = completed + 1
if completed>=3 then return true end
break
end
end
end
return false
end,
job_types = {
{id = "RESCUE_SELF", weight = 5},
{id = "RESCUE_FRIEND", weight = 5},
{id = "ESCORT", weight = 2},
{id = "EXPLORATION", weight = 2},
{id = "DELIVERY", weight = 2},
{id = "LOST_ITEM", weight = 4},
{id = "OUTLAW", weight = 5},
{id = "OUTLAW_ITEM", weight = 2},
{id = "OUTLAW_ITEM_UNK", weight = 1},
{id = "OUTLAW_MONSTER_HOUSE", weight = 1},
{id = "OUTLAW_FLEE", weight = 1}
}
}
}</pre>

== end_dungeon_day_destination ==

Zone and map id of the ground map where players will be sent to when a day ends and there is at least one mission to hand in. This map must contain a call to library:PlayJobsCompletedCutscene
Format: <code>{zone: string, map: integer}</code>

=== Example ===
<pre>{ zone = "guildmaster_island", map = 2 },</pre>

== after_rewards_function ==

Function ran after the game is done with the job completion cutscene. It takes no arguments, and is not expected to return anything.
You can use it to fix up the game state however you like before returning control to the player.

=== Example ===
<pre>
after_rewards_function = function()
GAME:MoveCamera(0, 0, 1, true)
SOUND:PlayBGM(SV.base_town.Song, true)
end</pre>

== taken_limit ==

The maximum number of jobs that can be taken from job boards at a time.

=== Example ===
<pre>8</pre>

== taken_jobs_start_active ==

If true, taken jobs will be activated automatically. Players can always deactivate them manually if they so choose.

=== Example ===
<pre>true</pre>

== max_guests ==

The maximum amount of guest-based jobs that can be generated in the same dungeon.
Guest-based jobs are: ESCORT, EXPLORATION

=== Example ===
<pre>1</pre>

== guests_take_up_space ==

The maximum amount of guest-based jobs that can be generated in the same dungeon.
Guest-based jobs are: ESCORT, EXPLORATION

=== Example ===
<pre>1</pre>

== min_party_limit ==

Minimum number for the party limit when it is reduced because of guests.
This value cannot be lower than 1, for obvious reasons.
Any excess guests will simply add to the party count, without reducing the limit.

=== Example ===
<pre>1</pre>

== losing_guests_means_defeat ==

If true, losing any guest will count as a loss for the entire exploration.
If false, it will simply mark that specific job as failed.

=== Example ===
<pre>false</pre>

== dungeon_boss_steps_piority ==

The priority of the SpawnOutlaw handler event. It can be either an integer or a list of integers.
This value should always be lower than dungeon_gen_steps_piority.

=== Example ===
<pre>-11</pre>

== dungeon_gen_steps_piority ==

The priority that most of the job handlers will have when being added to the event list. It can be either an integer or a list of integers.
This value should always be equal to or higher than the priority set for the event that calls library:GenerateJobInFloor.

=== Example ===
<pre>-6</pre>

== dungeon_npc_steps_piority ==

The priority that job npc spawners will have when being added to the event list. It can be either an integer or a list of integers.
This value should always be equal to or higher than dungeon_gen_steps_piority.

=== Example ===
<pre>{ 5, 2, 1 }</pre>

== difficulty_list ==

A list of all difficulty rank id strings you want to use.
The order of these strings will define the difficulty scale used by the library.

=== Example ===
<pre>{ "F", "E", "D", "C", "B", "A", "S", "STAR_1", "STAR_2", "STAR_3", "STAR_4", "STAR_5", "STAR_6", "STAR_7", "STAR_8", "STAR_9" }</pre>

== difficulty_data ==

All the data required to define difficulty rank behavior. There must be an entry for every rank defined in difficulty_list:
Format: <code><diff_id>: {display_key: string, money_reward: integer, extra_reward: integer, outlaw_level: integer, escort_level: integer}</code>
* <diff_id>: one of the difficulties defined in "difficulty_list"
* display_key: string key used when displaying the name of the rank. The localized strings are fetched from the Menu Text list (strings.resx)
* money_reward: the amount of money awarded at the end of the job. If set to 0, money rewards will simply not award anything
* extra_reward: the points of extra reward awarded at the end of the job. What these points are depends on extra_reward_type. If set to 0, extra_reward_type will be considered to be "none"
* outlaw_level: Optional. The base level of all outlaws spawned by jobs with this difficulty. If omitted, it will be equal to the dungeon's expected level.
* escort_level: Optional. The level of all guests spawned by jobs with this difficulty. If omitted, it will be equal to the dungeon's expected level.

=== Example ===
<pre>
{
F = {display_key = "RANK_STRING_F", money_reward = 100, extra_reward = 0},
E = {display_key = "RANK_STRING_E", money_reward = 200, extra_reward = 100},
D = {display_key = "RANK_STRING_D", money_reward = 400, extra_reward = 200},
C = {display_key = "RANK_STRING_C", money_reward = 600, extra_reward = 400},
B = {display_key = "RANK_STRING_B", money_reward = 700, extra_reward = 1250},
A = {display_key = "RANK_STRING_A", money_reward = 1500, extra_reward = 2500},
S = {display_key = "RANK_STRING_S", money_reward = 3000, extra_reward = 5000},
STAR_1 = {display_key = "RANK_STRING_STAR_1", money_reward = 6000, extra_reward = 10000},
STAR_2 = {display_key = "RANK_STRING_STAR_2", money_reward = 10000, extra_reward = 20000},
STAR_3 = {display_key = "RANK_STRING_STAR_3", money_reward = 15000, extra_reward = 30000},
STAR_4 = {display_key = "RANK_STRING_STAR_4", money_reward = 20000, extra_reward = 40000},
STAR_5 = {display_key = "RANK_STRING_STAR_5", money_reward = 25000, extra_reward = 50000},
STAR_6 = {display_key = "RANK_STRING_STAR_6", money_reward = 30000, extra_reward = 60000},
STAR_7 = {display_key = "RANK_STRING_STAR_7", money_reward = 35000, extra_reward = 70000},
STAR_8 = {display_key = "RANK_STRING_STAR_8", money_reward = 40000, extra_reward = 80000},
STAR_9 = {display_key = "RANK_STRING_STAR_9", money_reward = 45000, extra_reward = 90000}
}</pre>

== guest_level_scaling ==

Function that changes the level of guests based on the player's level. It must return the new level for the guest, or it will have no effect.
Arguments:
* lvl: base level of the guest.
* dungeon: if true, the level is the dungeon's recommended level. If false, it's taken from the difficulty data.
* avg_team_lvl: average level of the player team. It may or may not be an integer.
* hst_team_lvl: highest level in the player team.
* settings: the settings data structure itself

=== Example ===
<pre>
function(lvl, dungeon, avg_team_lvl, hst_team_lvl, settings)
local add = 0
if dungeon then lvl = lvl*4//5 end
if avg_team_lvl > lvl then add = (avg_team_lvl - lvl) // 10 end
return lvl + add
end
</pre>

== outlaw_level_scaling ==

Function that changes the level of guests based on the player's level. It must return the new level for the guest, or it will have no effect.
Arguments:
* lvl: base level of the guest.
* dungeon: if true, the level is the dungeon's recommended level. If false, it's taken from the difficulty data.
* avg_team_lvl: average level of the player team. It may or may not be an integer.
* hst_team_lvl: highest level in the player team.
* settings: the settings data structure itself

=== Example ===
<pre>
function(lvl, dungeon, avg_team_lvl, hst_team_lvl, settings)
local add = 0
if dungeon then lvl = lvl*23//20 end
if avg_team_lvl > lvl then add = (avg_team_lvl - lvl) // 8 end
add = add + (hst_team_lvl - avg_team_lvl) // 4
return lvl + add
end
</pre>

== apply_outlaw_changes ==

Function that allows you to edit an outlaw's data just before they are spawned.
You can change just about anything except its position and recruitability state. Its HP will also
always be automatically set to full after this function is called.
You will also be unable to change the EquippedItem of an "OUTLAW_ITEM" or "OUTLAW_ITEM_UNK" outlaw.
Arguments:
* outlaw: the outlaw Character itself
* job: the current job data table

=== Example ===
<pre>
function(outlaw, job)
local max_boost = PMDC.Data.MonsterFormData.MAX_STAT_BOOST
outlaw.MaxHPBonus = math.min(outlaw.Level * max_boost // 64, max_boost);
if job.Type == "OUTLAW_FLEE" then
local speedMin = math.floor(outlaw.Level * 4 // 3)
local speedMax = math.floor(outlaw.Level * 6 // 2)
outlaw.SpeedBonus = math.min(_DATA.Save.Rand:Next(speedMin, speedMax), 100)
end
end
</pre>

== fleeing_outlaw_restrictions ==

A list of ids for types that are banned from ever being picked as fleeing outlaws.

=== Example ===
<pre>{ "ghost" }</pre>

== outlaw_music_name ==

The name of the outlaw music file. This file will be sourced from the Content/Music folder.

=== Example ===
<pre>"Outlaw.ogg"</pre>

== dungeons ==

This is where dungeon difficulty is set. Quests can only generate for dungeons inside this list.
Given the complexity of this structure, it is best generated using the [[Mod:Nebula's Mission Board/ Editing settings#settings.AddDungeonSection(zone, segment, start, difficulty, finish, must_end)||AddDungeonSection]] function at the bottom of this page.

== dungeon_order ==

Jobs are sorted by dungeon, following the order defined in this table. Missing dungeons are shoved at the bottom and sorted alphabetically.
This list is automatically populated in call order when using the "AddDungeonSection" function near the bottom of this file.

== external_events ==

A list of events unrelated to this library that can cause job generation to ignore a specific dungeon.
They can also be displayed in the objectives log if you so choose.
Format: <code>{condition: function(zone), message_key: string, message_args: function(zone), icon: string}</code>
* condition: a function that takes a zone and returns a boolean. If it returns true, jobs will not be generated for this dungeon, and all already taken jobs will be automatically suspended.
* message_key: Optional. It will be used in the objectives log instead of the default message if the condition is true.
* message_args: Optional. If the message's localization string contains placeholders, this function is in charge of taking a zone and returning a list of values that will be used for those placeholders in the form of a table array (Up to 5).
* icon: Optional. The icon that will be displayed beside the corresponding dungeon in the dungeon selection menu if the condition is true for any of its segments. Defaults to ""

=== Example ===
<pre>
{
{condition = function(zone) return COMMON.HasSidequestInZone(zone) end, icon = "\\uE111", message_key = "MENU_JOB_OBJECTIVE_DEFAULT"}
}
</pre>

== external_events_icon_mode ==

How to display external event icons in the dungeon list. This value can only be either "FIRST" or ALL".
* If set to "ALL", they will always be displayed in the order defined by external_events. Only one copy of the same icon will be shown, no matter how many conditions require it.
* If set to "FIRST", only the first event in the list's order will be displayed, no matter how many events are actually there. This setting does not prevent multiple messages from appearing in the objectives list.

=== Example ===
<pre>"FIRST"</pre>

== dungeon_list_pattern ==

The pattern that will define how to display entries in the dungeon list.
{0} is the placeholder for the dungeon name, {1} for pending job icon and {2} for external condition icons.

=== Example ===
<pre>"FIRST"</pre>

== job_types ==

Table used to determine various properties regarding job types.
Remove a job type entirely to disable its generation altogether.
Format: <code><job_type_id>: {rank_modifier: integer, min_rank: string}</code>
* <job_type_id>: one of RESCUE_SELF, RESCUE_FRIEND, ESCORT, EXPLORATION, DELIVERY, LOST_ITEM, OUTLAW, OUTLAW_ITEM, OUTLAW_ITEM_UNK, OUTLAW_MONSTER_HOUSE, OUTLAW_FLEE
* rank_modifier (optional): these jobs will always have this modifier applied to their rank.
* min_rank (optional): this type of jobs can never be of a rank lower than this.
: This influences possible dungeon spawn: a rank_modifier 1 job with min_rank "C" can also spawn in "D" rank dungeons.

=== Example ===
<pre>{
RESCUE_SELF = {rank_modifier = 0, min_rank = "F"},
RESCUE_FRIEND = {rank_modifier = 0, min_rank = "E"},
ESCORT = {rank_modifier = 1, min_rank = "C"},
EXPLORATION = {rank_modifier = 1, min_rank = "C"},
DELIVERY = {rank_modifier = 0, min_rank = "D"},
LOST_ITEM = {rank_modifier = 0, min_rank = "D"},
OUTLAW = {rank_modifier = 1, min_rank = "C"},
OUTLAW_ITEM = {rank_modifier = 1, min_rank = "C"},
OUTLAW_ITEM_UNK = {rank_modifier = 1, min_rank = "C"},
OUTLAW_MONSTER_HOUSE = {rank_modifier = 2, min_rank = "S"},
OUTLAW_FLEE = {rank_modifier = 1, min_rank = "B"}
}
</pre>

== dungeon_job_modifiers ==

Special table that allows modders to specify chance multipliers for job types depending on the dungeon.
Format: <code><dungeon_id>: {<job_type_id>: <multiplier>}</code>
* <dungeon_id>: the string id of a dungeon
* <job_type_id>: one of RESCUE_SELF, RESCUE_FRIEND, ESCORT, EXPLORATION, DELIVERY, LOST_ITEM, OUTLAW, OUTLAW_ITEM, OUTLAW_ITEM_UNK, OUTLAW_MONSTER_HOUSE, OUTLAW_FLEE
* <multiplier>: a multiplier number. It doesn't need to be an integer. It will be multiplied with the board's base chances, rounding up, when choosing the type of a job. Set it to 0 or less to disable the job type altogether.

=== Example ===
<pre>{
ambush_forest = {
OUTLAW = 3,
OUTLAW_ITEM = 3,
OUTLAW_ITEM_UNK = 3,
OUTLAW_MONSTER_HOUSE = 3,
OUTLAW_FLEE = 3
},
treacherous_mountain = {
OUTLAW = 3,
OUTLAW_ITEM = 3,
OUTLAW_ITEM_UNK = 3,
OUTLAW_MONSTER_HOUSE = 3,
OUTLAW_FLEE = 3
}
}
</pre>

== special_chance ==

Chance of special missions to be generated. Special missions are just handcrafted scenarios with specific client and target pairs and custom flavor texts. Set to 0 to disable altogether.

=== Example ===
<pre>0.2</pre>

== special_jobs ==

This is where you can define special cases for specific types of jobs.
Format: <code><job_type_id>: <special_id>[]</code>
* <job_type_id>: one of RESCUE_SELF, RESCUE_FRIEND, ESCORT, EXPLORATION, DELIVERY, LOST_ITEM, OUTLAW, OUTLAW_ITEM, OUTLAW_ITEM_UNK, OUTLAW_MONSTER_HOUSE, OUTLAW_FLEE
* <special_id>: any id of your choosing except RESCUE_SELF, RESCUE_FRIEND, ESCORT, EXPLORATION, DELIVERY, LOST_ITEM, OUTLAW, OUTLAW_ITEM, OUTLAW_ITEM_UNK, OUTLAW_MONSTER_HOUSE, OUTLAW_FLEE

=== Example ===
<pre>{
RESCUE_FRIEND = {"CHILD", "LOVER", "RIVAL", "FRIEND"}
}</pre>

== hidden_floor_chance ==

Chance for supported quest types to have their destination floor hidden. Set to 0 to disable altogether.
Players will still be notified when reaching the floor. It just won't show in the quest description.
Job types that can have their floor hidden are: RESCUE_FRIEND, EXPLORATION, OUTLAW, OUTLAW_ITEM, OUTLAW_ITEM_UNK, OUTLAW_FLEE.

=== Example ===
<pre>0.15</pre>

== reward_types ==

A list of all types of rewards to be offered to players.
Format: <code>{id: string, weight: integer, min_rank: string}</code>
* id: one of the supported reward types. You can use duplicate values to alter odds depending on job rank.
: Supported reward types are: item, money, item_item, money_item, client, exclusive
* weight: Chance of appearing. Set to 0 or delete altogether to stop a type of reward from being offered.
* min_rank: optional. If set, this type of reward will only be offered if the job is this rank or higher.

=== Example ===
<pre>{
{id = "item", weight = 6},
{id = "money", weight = 2},
{id = "item_item", weight = 3},
{id = "money_item", weight = 1},
{id = "client", weight = 1, min_rank = "STAR_1"},
{id = "exclusive", weight = 1, min_rank = "STAR_4"}
}</pre>

== extra_reward_type ==

The type of extra reward for all quests. It can be "none", "rank" or "exp". Any other value will result in "none".

=== Example ===
<pre>"exp"</pre>

== rewards_per_difficulty ==

This table assigns different weights to reward pools depending on the difficulty rank of the mission.
Format: <code><diff_id>: {id: string, weight: integer}[]</code>
* <diff_id>: one of the difficulties defined in difficulty_list"
* id: the id of one of the reward pools defined in "reward_pools"
* weight: Chance of appearing. Set to 0 or delete altogether to stop a reward pool from being picked.

=== Example ===
<pre>{
F = {
{id = "NECESSITIES", weight = 10}
},
E = {
{id = "NECESSITIES", weight = 10},
{id = "APRICORN_GENERIC", weight = 10},
{id = "FOOD_LOW", weight = 10},
{id = "SEED_LOW", weight = 10},
{id = "HELD_LOW", weight = 3},
{id = "LOOT_LOW", weight = 3},
{id = "EVO_ITEMS", weight = 1},
{id = "WANDS_LOW", weight = 10}
},
D = {
{id = "NECESSITIES", weight = 5},
{id = "AMMO_LOW", weight = 10},
{id = "APRICORN_GENERIC", weight = 10},
{id = "APRICORN_TYPED", weight = 2},
{id = "FOOD_LOW", weight = 4},
{id = "SEED_LOW", weight = 4},
{id = "SEED_MID", weight = 10},
{id = "HELD_LOW", weight = 10},
{id = "HELD_TYPE", weight = 3},
{id = "LOOT_LOW", weight = 10},
{id = "EVO_ITEMS", weight = 2},
{id = "ORBS_LOW", weight = 2},
{id = "WANDS_LOW", weight = 4},
{id = "WANDS_MID", weight = 10},
},
[...]
}</pre>

== reward_pools ==

List of all reward pools and the items they contain. You must at least include all pools referenced in the rewards_per_difficulty table, but you can add more.
Entry ids may be either items or other pools. A pool doesn't have to only contain one of the two.
Format: <code><pool id>: {id: string, count: integer, hidden: string, weight: integer}[]</code>
* <pool_id>: the id of the pool. It should be used somewhere else either in this table or in rewards_per_difficulty.
* id: item_id or pool_id. If it matches a pool, count and hidden will be ignored.
* count: Optional. The amount of items awarded. It cannot be higher than the item's max stack. Defaults to the item's max stack.
* hidden: Optional. Hidden value that can be used for various purposes depending on the item. Defaults to "".
* weight: Chance of appearing. Set to 0 or delete altogether to stop an entry from being picked.

=== Example ===
<pre>{
NECESSITIES = {
{id = "seed_reviver", weight = 10},
{id = "berry_leppa", weight = 5},
{id = "berry_oran", weight = 5},
{id = "berry_lum", weight = 5},
{id = "food_apple", weight = 5},
{id = "orb_escape", weight = 5},
{id = "apricorn_plain", weight = 5},
{id = "key",count = 3, weight = 2}
},
AMMO_LOW = {
{id = "ammo_iron_thorn", count = 3, weight = 5},
{id = "ammo_geo_pebble", count = 3, weight = 1},
{id = "ammo_stick", count = 3, weight = 1},
},
[...]
}</pre>

== target_items ==

Ids of items that can be used as targets, divided depending on the job type.
Make sure they're either easy enough to obtain or impossible to lose, depending on the job.
Using stackable items is highly discouraged for all job types, as it may result in odd behaviors.
''Please keep in mind that if you want to use the "mission_" items shown in the example you must either recreate them or copy them over from the example mod.''
Format: <code><job_type_id>: <item_id>[]</code>
* <job_type_id>: the id of a job type defined inside "job_types"
* <item_id>: the id of the item to use

=== Example ===
<pre>{
LOST_ITEM = {
"mission_lost_scarf",
"mission_lost_specs",
"mission_lost_band"
},
OUTLAW_ITEM = {
"mission_stolen_scarf",
"mission_stolen_band",
"mission_stolen_specs"
},
DELIVERY = {
"berry_oran",
"berry_leppa",
"food_apple",
"berry_lum",
"apricorn_plain"
},
[...]
}</pre>

== difficulty_to_tier ==

Weighted table that associates mission difficulty to a specific tier of characters and outlaws.
Format: <code><diff_id>: {id: string, weight: integer}[]</code>
* <diff_id>: one of the difficulties defined in "difficulty_list"
* id: A string that defines a pokémon tier id.
* weight: Chance of being picked. Set to 0 or delete altogether to stop an entry from being picked.

=== Example ===
<pre>{
F = {
{id = "TIER_LOW", weight = 10}
},
E = {
{id = "TIER_LOW", weight = 9},
{id = "TIER_MID", weight = 1}
},
D = {
{id = "TIER_LOW", weight = 7},
{id = "TIER_MID", weight = 3}
},
[...]
}</pre>

== pokemon ==

A list of Pokémon that will be used for job generation, sorted by arbitrary quest tiers.
Any of these entries may be picked when choosing client and target.
If the client picked is not in the seen dex, the reward type can never be "client" nor "exclusive".
Format: <code><tier>: <monster_id>[]</code>
* <tier>: one of the tier ids used in difficulty_to_tier
* <monster_id>: either the species id of a pokémon or a MonsterIDTable
Format of MonsterIDTable: see the "monsterIdTemplate" function in missiongen_lib.lua

=== Example ===
<pre>{
TIER_LOW = {
"abra","amaura","anorith","applin","archen","aron","arrokuda","axew","azurill", [...]
},
[...]
}</pre>

== job_titles ==

A list of all possible job display titles, divided by job type.
You must also include lists for any special job types you intend to use.
Format: <code><job_type_id>: <string_key>[]</code>
* <job_type_id>: either the id of a job type defined inside "job_types", or the id of a special job type
* <string_key>: the localization key used for the title. The localized strings are fetched from the Menu Text list (strings.resx)

Localization placeholders:
* {0}: target
* {1}: dungeon
* {2}: item
* {3}: client

=== Example ===
<pre>
{
RESCUE_SELF = {
"MISSION_TITLE_RESCUE_SELF_001",
"MISSION_TITLE_RESCUE_SELF_002",
"MISSION_TITLE_RESCUE_SELF_003",
"MISSION_TITLE_RESCUE_SELF_004",
[...]
},
[...]
}</pre>

== job_flavor ==

A list of all possible job flavor text entries, divided by job type and by line.
Format: <code><job_type_id>: {<string_key>[], <string_key>[]}</code>
* <job_type_id>: either the id of a job type defined inside "job_types", or the id of a special job type
* <string_key>: the localization key used for the flavor text. Every job has 2 lists assigned: one for the top string and one for the bottom one.
If only the first list is specified, the second one will be left empty.
The localized strings are fetched from the Menu Text list (strings.resx)

Localization placeholders:
* {0}: target
* {1}: dungeon
* {2}: item
* {3}: client

=== Example ===
<pre>
{
RESCUE_SELF = {
{
"MISSION_BODY_TOP_RESCUE_SELF_001",
"MISSION_BODY_TOP_RESCUE_SELF_002",
"MISSION_BODY_TOP_RESCUE_SELF_003",
"MISSION_BODY_TOP_RESCUE_SELF_004",
[...]
},
{
"MISSION_BODY_BOTTOM_RESCUE_SELF_001",
"MISSION_BODY_BOTTOM_RESCUE_SELF_002",
"MISSION_BODY_BOTTOM_RESCUE_SELF_003",
[...]
}
},
[...]
}</pre>

== law_enforcement ==

Law enforcement characters in your setting. All OUTLAW jobs except OUTLAW_ITEM and OUTLAW_ITEM_UNK use these characters as job clients.
You may specify only 1 officer, and then a list containing any number of agents. Two of the latter will be randomly picked every time the job completion cutscene is played.
You may add a weight property to agents to specify a custom chance of being picked. Any without will
have a weight of 1.
Add "unique = true" to the MonsterIDTable to stop an agent from being picked twice. You must
have at least either 1 non-unique agent or 2 unique ones for this list table to be valid.
Format of MonsterIDTable: see the "monsterIdTemplate" function in missiongen_lib.lua

=== Example ===
<pre>
{
OFFICER = {Species = "magnezone", Gender = 0},
AGENT = {
{Species = "magnemite", Gender = 0, Weight = 31},
{Species = "magnemite", Gender = 0, Skin = "shiny", Weight = 1, Unique = true}
}
}</pre>

== enforcer_chance ==

Defines the chance of either the officer or an agent being the client of a mission depending on the character tier of the mission, as defined in difficulty_to_tier.
Format: <code><tier>: {id: string, weight: integer}[]</code>
* <tier>: one of the tier ids used in difficulty_to_tier
* id: One of: OFFICER, AGENT
* index: Optional. Ignored if id is OFFICER. You can set it to specify a specific agent instead of rolling using their chance in "law_enforcement".
* weight: Chance of being picked. Set to 0 or delete altogether to stop an entry from being picked.

=== Example ===
<pre>
{
TIER_LOW = {
{id = "OFFICER", weight = 2},
{id = "AGENT", weight = 8}
},
TIER_MID = {
{id = "OFFICER", weight = 5},
{id = "AGENT", weight = 5}
},
TIER_HIGH = {
{id = "OFFICER", weight = 8},
{id = "AGENT", weight = 2}
}
}</pre>

== special_data ==

Data of characters and flavor key used for special jobs, divided by tier.
In outlaw related quests, you may use ENFORCER as a keyword for a random law enforcement character.
You may also use OFFICER or AGENT to specify a more specific selection.
These keywords can only be used in place of MonsterIDTables.
Format: <code><special_type>: {<tier>: {client: MonsterIDTable, target: MonsterIDTable, item: string, flavor: string}[]}</code>
* <special_type>: an id of your choosing. It must be different from any basic job id
* <tier>: one of the tier ids used in difficulty_to_tier
* client: the data used to generate this Pokémon.
* target: the data used to generate this Pokémon. Only used in job types that require a target.
* item: the id of the item that will be used for this job. Only used in job types that require an item.
* flavor: flavor string key used for the job, sourced from the Menu Text list (strings.resx)
Format of MonsterIDTable: see the "monsterIdTemplate" function in missiongen_lib.lua

Localization placeholders:
* {0}: target
* {1}: dungeon
* {2}: item
* {3}: client

=== Example ===
<pre>{
LOVER = {
TIER_LOW = {
{client = {Species = "volbeat", Gender = 1}, target = {Species = "illumise", Gender = 2}, flavor = "MISSION_BODY_SPECIAL_LOVER_001"},
{client = {Species = "minun", Gender = 1}, target = {Species = "plusle", Gender = 2}, flavor = "MISSION_BODY_SPECIAL_LOVER_002"},
{client = {Species = "mareep", Gender = 2}, target = {Species = "wooloo", Gender = 1}, flavor = "MISSION_BODY_SPECIAL_LOVER_003"},
[...]
},
TIER_MID = {
{client = {Species = "miltank", Gender = 2}, target = {Species = "tauros", Gender = 1}, flavor = "MISSION_BODY_SPECIAL_LOVER_005"},
{client = {Species = "venomoth", Gender = 1}, target = {Species = "butterfree", Gender = 2}, flavor = "MISSION_BODY_SPECIAL_LOVER_006"},
[...]
},
[...]
},
[...]
}</pre>

== escort_talks ==

String keys to be used whenever the player interacts with an escort mission client, depending on the job type.
You can also include tables for special escort jobs. If no such table exists for a specific case, the generic table for the job type will be used.
Format: <code><job_type_id>: <string_key>[]</code>
* <job_type_id>: "ESCORT", "EXPLORATION", or the id of a special job type that corresponds to one of these job types
* <string_key>: the localization key of possible messages. The localized strings are fetched from the Gameplay Text list (stringsEx.resx)

Localization placeholders:
* {0}: target
* {1}: dungeon
* {2}: item

=== Example ===
<pre>
{
ESCORT = {
"MISSION_ESCORT_INTERACT"
},
EXPLORATION = {
"MISSION_EXPLORATION_INTERACT"
}
}</pre>

== rescue_responses ==

Strings keys to be used whenever the player interacts with a pokémon that needs rescue, depending on the job type and the response given.
You must include a "_DEFAULT" table, but you can also include tables for special job types. _DEFAULT will still be used for any special
case that doesn't have a table associated with it.
Format: <code>{rescue_yes: {<case_id>: {key: string, emotion: string}[]}, rescue_no: {<case_id>: {key: string, emotion: string}[]}}</code>
* <case_id>: "_DEFAULT", or the id of a special job type that corresponds to either "RESCUE_SELF" or "RESCUE_FRIEND"
* key: the localization key of possible messages. The localized strings are fetched from the Gameplay Text list (stringsEx.resx)
* emotion: Optional. An emotion id to use with this specific message. Defaults to "Normal"

Localization placeholders:
* {0}: client
* {1}: target
* {2}: dungeon

=== Example ===
<pre>
{
rescue_yes = {
_DEFAULT = { {key = "MISSION_RESCUE_CONFIRM_DEFAULT"} },
CHILD = { {key = "MISSION_RESCUE_CONFIRM_CHILD", emotion = "Joyous"} },
FRIEND = { {key = "MISSION_RESCUE_CONFIRM_FRIEND"} },
RIVAL = { {key = "MISSION_RESCUE_CONFIRM_RIVAL"} },
LOVER = { {key = "MISSION_RESCUE_CONFIRM_LOVER", emotion = "Joyous"} }
},
rescue_no = {
_DEFAULT = { {key = "MISSION_RESCUE_DENY_DEFAULT", emotion = "Surprised"} },
CHILD = { {key = "MISSION_RESCUE_DENY_CHILD", emotion = "Crying"} },
FRIEND = { {key = "MISSION_RESCUE_DENY_FRIEND", emotion = "Surprised"} },
RIVAL = { {key = "MISSION_RESCUE_DENY_RIVAL", emotion = "Stunned"} },
LOVER = { {key = "MISSION_RESCUE_DENY_LOVER", emotion = "Stunned"} }
}
}</pre>

== mission_callback_root ==

The object that contains job callback functions. It is recommended to define this object somewhere else.
Job callbacks are stored inside jobs as strings. These strings are then used as an index in the callback root object to retrieve the actual function.

The callback system is a pretty involved one, that gives a modder the ability to handcraft entirely new types of jobs if they so choose, but is also pretty difficult to handle, so it will be discussed in [[Mod:Nebula's Mission Board/ Job callbacks|its own guide]].

=== Example ===
<pre>COMMON</pre>

== settings.AddDungeonSection(zone, segment, start, difficulty, finish, must_end, weight) ==

Adds a new dungeon section to the list of possible job destinations.
Section start values must always be added in ascending order. Failing to do so may cause inconsistent behaviors.

=== Arguments ===

* <code>zone</code> - <code>string</code>: the string id of the dungeon zone.
* <code>segment</code> - <code>integer</code>: the numeric id of the dungeon segment.
* <code>start</code> - <code>integer</code>: the starting floor of this dungeon section (start counting from 1 for this).
* <code>difficulty</code> - <code>string</code>: the string id of the difficulty assigned to this section.
* <code>finish</code> - <code>integer</code>: Only considered when first adding a segment to the list. Can be omitted otherwise. This will be the last floor of the segment where jobs can spawn (start counting from 1 for this). If higher than the dungeon floors, it will default to the full dungeon length.
* <code>must_end</code> - <code>boolean</code> Only considered when first adding a segment to the list. Can be omitted otherwise. If true, this segment must be completed before jobs can spawn in it. If false, the segment must be accessed at least once, unless it's segment 0, which just needs to be unlocked. Defaults to true.
* <code>weight</code> - <code>integer|function(table, string):integer</code> Only considered when first adding a zone to the list. Can be omitted otherwise. This is the weight that the dungeon will have when rolling for job destinations. If set to a function, it takes the library and current board id as arguments and must return an integer. If not set, defaults to 1.

=== Example ===

<pre>
settings.AddDungeonSection("faultline_ridge", 0, 6, "D", 10)
settings.AddDungeonSection("sickly_hollow", 0, 9, "S", 16, false, 8)
settings.AddDungeonSection("sickly_hollow", 0, 13, "STAR_1")

</pre>

__NOTOC__

Mod:Nebula's Mission Board/ Handcrafted jobs

2026-01-01T10:47:31Z

MistressNebula: Fixes

The Mission Generation Library contains a method that allows the creation of basic jobs with arbitrarily chosen parameters. These jobs do not have to abide by any of the rules that the normal job generation uses, so do keep in mind that you might have to run a few checks to make sure you're not going off script, or to simply give the job to the player only when the rules are all respected. You can also choose not to care, of course, but that might have some consequences depending on what isn't being respected.
Here's a quick rundown of the rules followed by the library, and how to check if your desired job data would break them:
* '''No two jobs should be on the same floor''' - If this is not respected, the player will only be able to keep one of the jobs active at the same time.
: Check with: <code>MissionGen:IsDestinationOccupied(zone, segment, floor)</code>
* '''The number of guest jobs in the same dungeon should not be higher than "max_guests"''' - This might make the adventure more difficult if "guests_take_up_space" is true, because the game might remove more party members than expected.
: Check with: <code>MissionGen:GetDungeonsGuestCount()[zone]</code>

After handling all the rules you care about respecting, you can move on to actually creating the job. This is done with the following function:
<pre>MissionGen:MakeNewJob(zone, segment, floor, job_type, client, target, target_item, reward_type, rewards, title, flavor, hide_floor)</pre>
As you can see, there are a lot of parameters, though the great majority of them is optional. Those that are will have a <code>?</code> beside their type. Any missing parameter that is required for the given job type to function will be generated randomly:
* <code>zone</code> - <code>string</code>: The id of the zone this job takes place in.

* <code>segment</code> - <code>integer</code>: The specific segment this job takes place in.

* <code>floor</code> - <code>integer</code>: The destination floor of this job.

* <code>job_type</code> - <code>string</code>: The id of the type of this job. It must always be equal to one of the following values: "RESCUE_SELF", "RESCUE_FRIEND", "ESCORT", "EXPLORATION", "DELIVERY", "LOST_ITEM", "OUTLAW", "OUTLAW_ITEM", "OUTLAW_ITEM_UNK", "OUTLAW_MONSTER_HOUSE", "OUTLAW_FLEE".

* <code>client</code> - <code>string|monsterIDTable?</code>: Data that will be used for the client of this job. If it's not a mosterIdTable (see below), it must be either "ENFORCER", "OFFICER" or "AGENT". A law enforcement character will be selected using different rules depending on the string.

* <code>target</code> - <code>string|monsterIDTable?</code>: Data that will be used for the target of this job. If it's not a mosterIdTable (see below), it must be either "ENFORCER", "OFFICER" or "AGENT". A law enforcement character will be selected using different rules depending on the string. This value will be used only if the job type requires a target.

* <code>target_item</code> - <code>string?</code>: The id of the item that will be used as target. This value will be used only if the job type requires an item.

* <code>reward_type</code> - <code>string?</code>: The combination of rewards that will be awarded for this job. It must always be equal to one of the following values: "item", "money", "item_item", "money_item", "client", "exclusive". If <code>rewards</code> is set, this value will be inferred from the items used, even if a value was already provided.

* <code>rewards</code> - <code>{string|itemTable?, string|itemTable?}</code>: The item rewards that will be awarded for this job. If not set but <code>reward_type</code> is, they will be generated automatically. You can either write only the id of the item, or use a full itemTable (see below). If the first item is nil, it will award money in its place.

* <code>title</code> - <code>string?</code>: The string key to use for this job's title. If not set, it will be chosen randomly.

* <code>flavor</code> - <code>{string, string?}?</code>: The string key, or keys, to use for this job's flavor text. If not set, they will be chosen randomly.

* <code>hide_floor</code> - <code>boolean?</code>: If true, the job's floor will be hidden when viewing the job inside menus.

'''monsterIDTable'''
<pre>{
Species:string,
Form:integer?,
Skin:string?,
Gender:integer?,
Nickname:string?
}</pre>

'''itemTable'''
<pre>{id:string, count:integer?, hidden:string?}</pre>

<code>MakeNewJob</code> will return a fully-formed [[Mod:Nebula's Mission Board/ Job Table|JobTable]], which can then be edited further either indirectly or with other functions. Once you're done, however, you will need to add a BackReference to it, otherwise the game won't know where to send the player for the reward cutscene. This can be done in two ways, depending on what you want to accomplish; if you want to give the job directly to the player, you can do this:
<pre>
MissionGen:SetBackReference(<job>, <board_id>)
MissionGen:AddJobToTaken(<job>, <startActive>)
</pre>
where:
* <code>job</code> is the JobTable.
* <code>board_id</code> is the board the job should bring the player to after completing it.
* <code>startActive</code> is an optional boolean that tells the game whether or not to set the job as active as it gets added to the taken list. Defaults to <code>false</code>.
If, instead of giving it directly to the player, you want to add the job to a board, you can do this:
<pre>
MissionGen:AddJobToBoard(<board_id>, <job>)
</pre>
where:
* <code>board_id</code> is the board the job will be added to, and that will be set as BackReference.
* <code>job</code> is the JobTable.
With this done, the job is now fully set up and can be safely presented to the player.

===== Custom text =====
You can further customize the jobs you create by editing the text displayed in the various fields of the job menu. There are a few functions that allow you to set overrides for some of the job's sensitive information:
<pre>
MissionGen:SetClientOverride(<job>, <string_key>)
MissionGen:SetObjectiveOverride(<job>, <string_key>)
MissionGen:SetDungeonOverride(<job>, <string_key>)
MissionGen:SetDifficultyOverride(<job>, <string_key>)
MissionGen:SetRewardOverride(<job>, <string_key>)
</pre>
where:

* <code>job</code> is the JobTable you want to edit.
* <code>string_key</code> is the localization key of the string you want to set.

Tutorial:Adding New Settings

2025-08-31T09:26:45Z

MistressNebula: Fix links that were still broken

Version 0.8.4 contained a heavy rework of the Settings menu. The new menu supports multiple pages of settings, and allows modders to add new pages at will thanks to the [[Service Events#EngineServiceEvents.AddMenu|AddMenu]] service callback. Please refer to the [[Editing Menus#Prerequisites]] section to know how to interact with menus using this callback.

The label we need is literally just <code>"SETTINGS_MENU"</code>. Keep in mind that this is the label of the settings menu TITLE window. The actual settings pages are supposed to be populated indirectly by using the functions described in this page.

Despite the menu being technically an InteractableMenu, using any function described in the Editing Menus page is highly discouraged, with the ILabeled functions being the only exception.

Feel free to visit the [[Settings Menu Reference]] page for a more in-depth explanation of all of the functions and values provided by the settings engine specifically.

== Making a new settings page ==
With all that said, adding new settings is very simple. Call <code>SettingsTitleMenu:NewPage</code>, and then register new settings with <code>SettingsPage:AddSetting</code>, like this:

<pre>
if menu:HasLabel() and menu.Label == labels.SETTINGS_MENU and menu.InGame then
local page = menu:AddPage("my_namespace", "My Mod")

local options = {"Off", 1, 2, 3, 4, 5}
local saveFunction = function(setting) SV.MySetting = setting.CurrentChoice end
local choiceChangedFunction = function(setting) PrintInfo("MySetting preview: "..setting.CurrentChoice) end
page:AddSetting("My Setting", options, SV.MySetting or 0, saveFunction, choiceChangedFunction)

page.GlobalSaveAction = function() PrintInfo("SV.MySetting has been set to "..SV.MySetting) end
end
</pre>

Of course, the code has something more going on, so let's check it out in more detail:
The first thing we need to do is, as usual, to make sure that we're editing the right menu. Then we check if we're in game or not. Making a setting work from the Top Menu requires a bit more work than what is shown here, so we're going avoid that entirely for now.

The first step now is to create a [[Settings Menu Reference#SettingsPage|SettingsPage]] and store it in a variable. Then we prepare the structures we need for our setting: a list of options and a function that saves our settings when the player presses the confirm button. Since this is a demonstration, we will also include a function that runs every time the setting's value change, even though it is both optional and not necessary here.

It is now time to create our setting, giving it also a display name and using its previous value (or a default value if there wasn't one yet) as the starting choice for the setting. This default value is a 0-based index into the list of options, so, for this setting, valid values go from 0 to 5.

Finally, the last line registers a special function that is ran at the end of every other save actions in the page when the player confirms their changes. This is also optional, and it's included here simply for demonstration.

Notice how the saveFunction and the choiceChangedFunction both accept an argument. This is because the engine always passes the [https://github.com/RogueCollab/RogueEssence/tree/master/RogueEssence/Menu/MenuElements/MenuSetting.cs MenuSetting] in question to our function. In almost all cases, all we are interested in doing is store its <code> CurrentChoice</code> value somewhere in our code, but it IS technically possible to tamper with any of the object's <code>public</code> properties and fields.

== Top Menu settings ==
As stated previously, making a setting work from the Top Menu requires a bit more work. The SV structure is already loaded when a player reaches the Top Menu, but it is also loaded again as soon as the Continue button is pressed, so any changes made to it in this state will be completely lost.

Fortunately for us, we don't HAVE to save our changes on the SV structure immediately, and we can use a buffer instead:

<pre>
if menu:HasLabel() and menu.Label == labels.SETTINGS_MENU then
local page = menu:AddPage("my_namespace", "My Mod")
if not MY_SETTINGS then
MY_SETTINGS = {
Setting = SV.MySetting or 0
}
end
local options = {"Off", 1, 2, 3, 4, 5}
local saveFunction = function(setting)
if menu.InGame then
SV.MySetting = setting.CurrentChoice
else
MY_SETTINGS.Setting = setting.CurrentChoice
end
end
page:AddSetting("My Setting", options, MY_SETTINGS.Setting, saveFunction, choiceChangedFunction)
end
</pre>

The first noticeable difference is that the initial check does not care about us being in game or not anymore. We are then creating a new global table called MY_SETTINGS and loading the current state of the setting inside of it (or a default value if it doesn't exist yet). Of course, we also check if MY_SETTINGS already exists, because we don't want to reset the player's choices if they already opened the menu once.
The save function has also changed to account for the two cases of being inside the game or in the top menu. We save our data directly in the SV structure if we're in game, and save in the MY_SETTINGS table if we're not.

And that's it!
Except, it's not. We need to load our temporary table in the SV structure if we want to ACTUALLY save our setting. For that, we will need another service callback: [[Service Events#EngineServiceEvents.LoadSavedData|LoadSavedData]].

This is all we need to finish the job. Once subscribed to the callback, the function below will be called as soon as the Continue button is pressed on the Top Menu, finally storing our setting inside the SV structure.

<pre>
function MenuTools.OnSaveLoad()
if MY_SETTINGS then
SV.MySetting = MY_SETTINGS.Setting
end
end
</pre>
[[Category:Modding]]

Mod:Nebula's Mission Board/ Editing settings

2025-08-24T09:02:50Z

MistressNebula: /* boards */ 1.0.3 changes

The Mission Generation Library is designed to be highly customizable. This choice is reflected in its <code>missiongen_settings.lua</code> file. This file is what modders are supposed to edit, changing the values inside the giant table it defines.

Here's a list of all settings in the library, with documentation:

== sv_root_name ==

Name of the SV table that will contain all stored data. Use a table to specify a deeper path. If not present in the SV structure, the defined path will be generated automatically. An empty list would just use SV as root.
Examples:
* <code>"jobs"</code> would use <code>SV.jobs</code> as its root.
* <code>{"adventure", "jobs"}</code> would use <code>SV.adventure.jobs</code> as its root.

=== Example ===
<pre>"jobs"</pre>

== boards ==

A list of board ids and the data necessary to define their behavior.
Format for each board:
<pre><nowiki>
<board_id>: {
display_key: string,
size: integer,
location: {
zone: string,
map: integer
},
condition: function(library),
dungeons: string[],
job_types: {id = string, weight = integer}[]
}</nowiki></pre>
* <board_id>: The id of the board. It will be used to identify and reference this specific board inside scripts
* display_key: the string key used when displaying the job menu for this board. The localized strings are fetched from the Menu Text list (strings.resx)
* size: the amount of quests this board can hold at a time
* location: a zone id and a map index. This data is where the player will be brought for the job completion cutscene. All of these maps must call library:PlayJobsCompletedCutscene before fade-in for the reward sequence to work correctly.
* condition: Optional. A function called to determine if library:PopulateBoards() should fill out this board. It receives the library object as an argument and returns a boolean. If it returns true, the board is filled out. If it returns false, it is left empty. If this property is missing, this board will always be active.
* dungeons: Optional. A list of zone ids to generate dungeons for. This board will never generate jobs for dungeons that do not appear in this list. If this property is missing, this board can generate jobs for any registered dungeon.
* job_types: a list of job types and their probability weight. Higher weight means more common.

=== Example ===
<pre>{
quest_board = {
display_key = "BOARD_QUEST_TITLE",
size = 8,
location = {zone = "guildmaster_island", map = 2},
condition = function (library)
local root = library.root
local completed = 0
for _, segments in pairs(root.dungeon_progress) do
for _, state in pairs(segments) do
if state then
completed = completed + 1
if completed>=3 then return true end
break
end
end
end
return false
end,
job_types = {
{id = "RESCUE_SELF", weight = 5},
{id = "RESCUE_FRIEND", weight = 5},
{id = "ESCORT", weight = 2},
{id = "EXPLORATION", weight = 2},
{id = "DELIVERY", weight = 2},
{id = "LOST_ITEM", weight = 4},
{id = "OUTLAW", weight = 5},
{id = "OUTLAW_ITEM", weight = 2},
{id = "OUTLAW_ITEM_UNK", weight = 1},
{id = "OUTLAW_MONSTER_HOUSE", weight = 1},
{id = "OUTLAW_FLEE", weight = 1}
}
}
}</pre>

== end_dungeon_day_destination ==

Zone and map id of the ground map where players will be sent to when a day ends and there is at least one mission to hand in. This map must contain a call to library:PlayJobsCompletedCutscene
Format: <code>{zone: string, map: integer}</code>

=== Example ===
<pre>{ zone = "guildmaster_island", map = 2 },</pre>

== after_rewards_function ==

Function ran after the game is done with the job completion cutscene. It takes no arguments, and is not expected to return anything.
You can use it to fix up the game state however you like before returning control to the player.

=== Example ===
<pre>
after_rewards_function = function()
GAME:MoveCamera(0, 0, 1, true)
SOUND:PlayBGM(SV.base_town.Song, true)
end</pre>

== taken_limit ==

The maximum number of jobs that can be taken from job boards at a time.

=== Example ===
<pre>8</pre>

== taken_jobs_start_active ==

If true, taken jobs will be activated automatically. Players can always deactivate them manually if they so choose.

=== Example ===
<pre>true</pre>

== max_guests ==

The maximum amount of guest-based jobs that can be generated in the same dungeon.
Guest-based jobs are: ESCORT, EXPLORATION

=== Example ===
<pre>1</pre>

== guests_take_up_space ==

The maximum amount of guest-based jobs that can be generated in the same dungeon.
Guest-based jobs are: ESCORT, EXPLORATION

=== Example ===
<pre>1</pre>

== min_party_limit ==

Minimum number for the party limit when it is reduced because of guests.
This value cannot be lower than 1, for obvious reasons.
Any excess guests will simply add to the party count, without reducing the limit.

=== Example ===
<pre>1</pre>

== losing_guests_means_defeat ==

If true, losing any guest will count as a loss for the entire exploration.
If false, it will simply mark that specific job as failed.

=== Example ===
<pre>false</pre>

== dungeon_boss_steps_piority ==

The priority of the SpawnOutlaw handler event. It can be either an integer or a list of integers.
This value should always be lower than dungeon_gen_steps_piority.

=== Example ===
<pre>-11</pre>

== dungeon_gen_steps_piority ==

The priority that most of the job handlers will have when being added to the event list. It can be either an integer or a list of integers.
This value should always be equal to or higher than the priority set for the event that calls library:GenerateJobInFloor.

=== Example ===
<pre>-6</pre>

== dungeon_npc_steps_piority ==

The priority that job npc spawners will have when being added to the event list. It can be either an integer or a list of integers.
This value should always be equal to or higher than dungeon_gen_steps_piority.

=== Example ===
<pre>{ 5, 2, 1 }</pre>

== difficulty_list ==

A list of all difficulty rank id strings you want to use.
The order of these strings will define the difficulty scale used by the library.

=== Example ===
<pre>{ "F", "E", "D", "C", "B", "A", "S", "STAR_1", "STAR_2", "STAR_3", "STAR_4", "STAR_5", "STAR_6", "STAR_7", "STAR_8", "STAR_9" }</pre>

== difficulty_data ==

All the data required to define difficulty rank behavior. There must be an entry for every rank defined in difficulty_list:
Format: <code><diff_id>: {display_key: string, money_reward: integer, extra_reward: integer, outlaw_level: integer, escort_level: integer}</code>
* <diff_id>: one of the difficulties defined in "difficulty_list"
* display_key: string key used when displaying the name of the rank. The localized strings are fetched from the Menu Text list (strings.resx)
* money_reward: the amount of money awarded at the end of the job. If set to 0, money rewards will simply not award anything
* extra_reward: the points of extra reward awarded at the end of the job. What these points are depends on extra_reward_type. If set to 0, extra_reward_type will be considered to be "none"
* outlaw_level: Optional. The base level of all outlaws spawned by jobs with this difficulty. If omitted, it will be equal to the dungeon's expected level.
* escort_level: Optional. The level of all guests spawned by jobs with this difficulty. If omitted, it will be equal to the dungeon's expected level.

=== Example ===
<pre>
{
F = {display_key = "RANK_STRING_F", money_reward = 100, extra_reward = 0},
E = {display_key = "RANK_STRING_E", money_reward = 200, extra_reward = 100},
D = {display_key = "RANK_STRING_D", money_reward = 400, extra_reward = 200},
C = {display_key = "RANK_STRING_C", money_reward = 600, extra_reward = 400},
B = {display_key = "RANK_STRING_B", money_reward = 700, extra_reward = 1250},
A = {display_key = "RANK_STRING_A", money_reward = 1500, extra_reward = 2500},
S = {display_key = "RANK_STRING_S", money_reward = 3000, extra_reward = 5000},
STAR_1 = {display_key = "RANK_STRING_STAR_1", money_reward = 6000, extra_reward = 10000},
STAR_2 = {display_key = "RANK_STRING_STAR_2", money_reward = 10000, extra_reward = 20000},
STAR_3 = {display_key = "RANK_STRING_STAR_3", money_reward = 15000, extra_reward = 30000},
STAR_4 = {display_key = "RANK_STRING_STAR_4", money_reward = 20000, extra_reward = 40000},
STAR_5 = {display_key = "RANK_STRING_STAR_5", money_reward = 25000, extra_reward = 50000},
STAR_6 = {display_key = "RANK_STRING_STAR_6", money_reward = 30000, extra_reward = 60000},
STAR_7 = {display_key = "RANK_STRING_STAR_7", money_reward = 35000, extra_reward = 70000},
STAR_8 = {display_key = "RANK_STRING_STAR_8", money_reward = 40000, extra_reward = 80000},
STAR_9 = {display_key = "RANK_STRING_STAR_9", money_reward = 45000, extra_reward = 90000}
}</pre>

== guest_level_scaling ==

Function that changes the level of guests based on the player's level. It must return the new level for the guest, or it will have no effect.
Arguments:
* lvl: base level of the guest.
* dungeon: if true, the level is the dungeon's recommended level. If false, it's taken from the difficulty data.
* avg_team_lvl: average level of the player team. It may or may not be an integer.
* hst_team_lvl: highest level in the player team.
* settings: the settings data structure itself

=== Example ===
<pre>
function(lvl, dungeon, avg_team_lvl, hst_team_lvl, settings)
local add = 0
if dungeon then lvl = lvl*4//5 end
if avg_team_lvl > lvl then add = (avg_team_lvl - lvl) // 10 end
return lvl + add
end
</pre>

== outlaw_level_scaling ==

Function that changes the level of guests based on the player's level. It must return the new level for the guest, or it will have no effect.
Arguments:
* lvl: base level of the guest.
* dungeon: if true, the level is the dungeon's recommended level. If false, it's taken from the difficulty data.
* avg_team_lvl: average level of the player team. It may or may not be an integer.
* hst_team_lvl: highest level in the player team.
* settings: the settings data structure itself

=== Example ===
<pre>
function(lvl, dungeon, avg_team_lvl, hst_team_lvl, settings)
local add = 0
if dungeon then lvl = lvl*23//20 end
if avg_team_lvl > lvl then add = (avg_team_lvl - lvl) // 8 end
add = add + (hst_team_lvl - avg_team_lvl) // 4
return lvl + add
end
</pre>

== apply_outlaw_changes ==

Function that allows you to edit an outlaw's data just before they are spawned.
You can change just about anything except its position and recruitability state. Its HP will also
always be automatically set to full after this function is called.
You will also be unable to change the EquippedItem of an "OUTLAW_ITEM" or "OUTLAW_ITEM_UNK" outlaw.
Arguments:
* outlaw: the outlaw Character itself
* job: the current job data table

=== Example ===
<pre>
function(outlaw, job)
local max_boost = PMDC.Data.MonsterFormData.MAX_STAT_BOOST
outlaw.MaxHPBonus = math.min(outlaw.Level * max_boost // 64, max_boost);
if job.Type == "OUTLAW_FLEE" then
local speedMin = math.floor(outlaw.Level * 4 // 3)
local speedMax = math.floor(outlaw.Level * 6 // 2)
outlaw.SpeedBonus = math.min(_DATA.Save.Rand:Next(speedMin, speedMax), 100)
end
end
</pre>

== fleeing_outlaw_restrictions ==

A list of ids for types that are banned from ever being picked as fleeing outlaws.

=== Example ===
<pre>{ "ghost" }</pre>

== outlaw_music_name ==

The name of the outlaw music file. This file will be sourced from the Content/Music folder.

=== Example ===
<pre>"Outlaw.ogg"</pre>

== dungeons ==

This is where dungeon difficulty is set. Quests can only generate for dungeons inside this list.
Given the complexity of this structure, it is best generated using the [[Mod:Nebula's Mission Board/ Editing settings#settings.AddDungeonSection(zone, segment, start, difficulty, finish, must_end)||AddDungeonSection]] function at the bottom of this page.

== dungeon_order ==

Jobs are sorted by dungeon, following the order defined in this table. Missing dungeons are shoved at the bottom and sorted alphabetically.
This list is automatically populated in call order when using the "AddDungeonSection" function near the bottom of this file.

== external_events ==

A list of events unrelated to this library that can cause job generation to ignore a specific dungeon.
They can also be displayed in the objectives log if you so choose.
Format: <code>{condition: function(zone), message_key: string, message_args: function(zone), icon: string}</code>
* condition: a function that takes a zone and returns a boolean. If it returns true, jobs will not be generated for this dungeon, and all already taken jobs will be automatically suspended.
* message_key: Optional. It will be used in the objectives log instead of the default message if the condition is true.
* message_args: Optional. If the message's localization string contains placeholders, this function is in charge of taking a zone and returning a list of values that will be used for those placeholders in the form of a table array (Up to 5).
* icon: Optional. The icon that will be displayed beside the corresponding dungeon in the dungeon selection menu if the condition is true for any of its segments. Defaults to ""

=== Example ===
<pre>
{
{condition = function(zone) return COMMON.HasSidequestInZone(zone) end, icon = "\\uE111", message_key = "MENU_JOB_OBJECTIVE_DEFAULT"}
}
</pre>

== external_events_icon_mode ==

How to display external event icons in the dungeon list. This value can only be either "FIRST" or ALL".
* If set to "ALL", they will always be displayed in the order defined by external_events. Only one copy of the same icon will be shown, no matter how many conditions require it.
* If set to "FIRST", only the first event in the list's order will be displayed, no matter how many events are actually there. This setting does not prevent multiple messages from appearing in the objectives list.

=== Example ===
<pre>"FIRST"</pre>

== dungeon_list_pattern ==

The pattern that will define how to display entries in the dungeon list.
{0} is the placeholder for the dungeon name, {1} for pending job icon and {2} for external condition icons.

=== Example ===
<pre>"FIRST"</pre>

== job_types ==

Table used to determine various properties regarding job types.
Remove a job type entirely to disable its generation altogether.
Format: <code><job_type_id>: {rank_modifier: integer, min_rank: string}</code>
* <job_type_id>: one of RESCUE_SELF, RESCUE_FRIEND, ESCORT, EXPLORATION, DELIVERY, LOST_ITEM, OUTLAW, OUTLAW_ITEM, OUTLAW_ITEM_UNK, OUTLAW_MONSTER_HOUSE, OUTLAW_FLEE
* rank_modifier (optional): these jobs will always have this modifier applied to their rank.
* min_rank (optional): this type of jobs can never be of a rank lower than this.
: This influences possible dungeon spawn: a rank_modifier 1 job with min_rank "C" can also spawn in "D" rank dungeons.

=== Example ===
<pre>{
RESCUE_SELF = {rank_modifier = 0, min_rank = "F"},
RESCUE_FRIEND = {rank_modifier = 0, min_rank = "E"},
ESCORT = {rank_modifier = 1, min_rank = "C"},
EXPLORATION = {rank_modifier = 1, min_rank = "C"},
DELIVERY = {rank_modifier = 0, min_rank = "D"},
LOST_ITEM = {rank_modifier = 0, min_rank = "D"},
OUTLAW = {rank_modifier = 1, min_rank = "C"},
OUTLAW_ITEM = {rank_modifier = 1, min_rank = "C"},
OUTLAW_ITEM_UNK = {rank_modifier = 1, min_rank = "C"},
OUTLAW_MONSTER_HOUSE = {rank_modifier = 2, min_rank = "S"},
OUTLAW_FLEE = {rank_modifier = 1, min_rank = "B"}
}
</pre>

== dungeon_job_modifiers ==

Special table that allows modders to specify chance multipliers for job types depending on the dungeon.
Format: <code><dungeon_id>: {<job_type_id>: <multiplier>}</code>
* <dungeon_id>: the string id of a dungeon
* <job_type_id>: one of RESCUE_SELF, RESCUE_FRIEND, ESCORT, EXPLORATION, DELIVERY, LOST_ITEM, OUTLAW, OUTLAW_ITEM, OUTLAW_ITEM_UNK, OUTLAW_MONSTER_HOUSE, OUTLAW_FLEE
* <multiplier>: a multiplier number. It doesn't need to be an integer. It will be multiplied with the board's base chances, rounding up, when choosing the type of a job. Set it to 0 or less to disable the job type altogether.

=== Example ===
<pre>{
ambush_forest = {
OUTLAW = 3,
OUTLAW_ITEM = 3,
OUTLAW_ITEM_UNK = 3,
OUTLAW_MONSTER_HOUSE = 3,
OUTLAW_FLEE = 3
},
treacherous_mountain = {
OUTLAW = 3,
OUTLAW_ITEM = 3,
OUTLAW_ITEM_UNK = 3,
OUTLAW_MONSTER_HOUSE = 3,
OUTLAW_FLEE = 3
}
}
</pre>

== special_chance ==

Chance of special missions to be generated. Special missions are just handcrafted scenarios with specific client and target pairs and custom flavor texts. Set to 0 to disable altogether.

=== Example ===
<pre>0.2</pre>

== special_jobs ==

This is where you can define special cases for specific types of jobs.
Format: <code><job_type_id>: <special_id>[]</code>
* <job_type_id>: one of RESCUE_SELF, RESCUE_FRIEND, ESCORT, EXPLORATION, DELIVERY, LOST_ITEM, OUTLAW, OUTLAW_ITEM, OUTLAW_ITEM_UNK, OUTLAW_MONSTER_HOUSE, OUTLAW_FLEE
* <special_id>: any id of your choosing except RESCUE_SELF, RESCUE_FRIEND, ESCORT, EXPLORATION, DELIVERY, LOST_ITEM, OUTLAW, OUTLAW_ITEM, OUTLAW_ITEM_UNK, OUTLAW_MONSTER_HOUSE, OUTLAW_FLEE

=== Example ===
<pre>{
RESCUE_FRIEND = {"CHILD", "LOVER", "RIVAL", "FRIEND"}
}</pre>

== hidden_floor_chance ==

Chance for supported quest types to have their destination floor hidden. Set to 0 to disable altogether.
Players will still be notified when reaching the floor. It just won't show in the quest description.
Job types that can have their floor hidden are: RESCUE_FRIEND, EXPLORATION, OUTLAW, OUTLAW_ITEM, OUTLAW_ITEM_UNK, OUTLAW_FLEE.

=== Example ===
<pre>0.15</pre>

== reward_types ==

A list of all types of rewards to be offered to players.
Format: <code>{id: string, weight: integer, min_rank: string}</code>
* id: one of the supported reward types. You can use duplicate values to alter odds depending on job rank.
: Supported reward types are: item, money, item_item, money_item, client, exclusive
* weight: Chance of appearing. Set to 0 or delete altogether to stop a type of reward from being offered.
* min_rank: optional. If set, this type of reward will only be offered if the job is this rank or higher.

=== Example ===
<pre>{
{id = "item", weight = 6},
{id = "money", weight = 2},
{id = "item_item", weight = 3},
{id = "money_item", weight = 1},
{id = "client", weight = 1, min_rank = "STAR_1"},
{id = "exclusive", weight = 1, min_rank = "STAR_4"}
}</pre>

== extra_reward_type ==

The type of extra reward for all quests. It can be "none", "rank" or "exp". Any other value will result in "none".

=== Example ===
<pre>"exp"</pre>

== rewards_per_difficulty ==

This table assigns different weights to reward pools depending on the difficulty rank of the mission.
Format: <code><diff_id>: {id: string, weight: integer}[]</code>
* <diff_id>: one of the difficulties defined in difficulty_list"
* id: the id of one of the reward pools defined in "reward_pools"
* weight: Chance of appearing. Set to 0 or delete altogether to stop a reward pool from being picked.

=== Example ===
<pre>{
F = {
{id = "NECESSITIES", weight = 10}
},
E = {
{id = "NECESSITIES", weight = 10},
{id = "APRICORN_GENERIC", weight = 10},
{id = "FOOD_LOW", weight = 10},
{id = "SEED_LOW", weight = 10},
{id = "HELD_LOW", weight = 3},
{id = "LOOT_LOW", weight = 3},
{id = "EVO_ITEMS", weight = 1},
{id = "WANDS_LOW", weight = 10}
},
D = {
{id = "NECESSITIES", weight = 5},
{id = "AMMO_LOW", weight = 10},
{id = "APRICORN_GENERIC", weight = 10},
{id = "APRICORN_TYPED", weight = 2},
{id = "FOOD_LOW", weight = 4},
{id = "SEED_LOW", weight = 4},
{id = "SEED_MID", weight = 10},
{id = "HELD_LOW", weight = 10},
{id = "HELD_TYPE", weight = 3},
{id = "LOOT_LOW", weight = 10},
{id = "EVO_ITEMS", weight = 2},
{id = "ORBS_LOW", weight = 2},
{id = "WANDS_LOW", weight = 4},
{id = "WANDS_MID", weight = 10},
},
[...]
}</pre>

== reward_pools ==

List of all reward pools and the items they contain. You must at least include all pools referenced in the rewards_per_difficulty table, but you can add more.
Entry ids may be either items or other pools. A pool doesn't have to only contain one of the two.
Format: <code><pool id>: {id: string, count: integer, hidden: string, weight: integer}[]</code>
* <pool_id>: the id of the pool. It should be used somewhere else either in this table or in rewards_per_difficulty.
* id: item_id or pool_id. If it matches a pool, count and hidden will be ignored.
* count: Optional. The amount of items awarded. It cannot be higher than the item's max stack. Defaults to the item's max stack.
* hidden: Optional. Hidden value that can be used for various purposes depending on the item. Defaults to "".
* weight: Chance of appearing. Set to 0 or delete altogether to stop an entry from being picked.

=== Example ===
<pre>{
NECESSITIES = {
{id = "seed_reviver", weight = 10},
{id = "berry_leppa", weight = 5},
{id = "berry_oran", weight = 5},
{id = "berry_lum", weight = 5},
{id = "food_apple", weight = 5},
{id = "orb_escape", weight = 5},
{id = "apricorn_plain", weight = 5},
{id = "key",count = 3, weight = 2}
},
AMMO_LOW = {
{id = "ammo_iron_thorn", count = 3, weight = 5},
{id = "ammo_geo_pebble", count = 3, weight = 1},
{id = "ammo_stick", count = 3, weight = 1},
},
[...]
}</pre>

== target_items ==

Ids of items that can be used as targets, divided depending on the job type.
Make sure they're either easy enough to obtain or impossible to lose, depending on the job.
Using stackable items is highly discouraged for all job types, as it may result in odd behaviors.
''Please keep in mind that if you want to use the "mission_" items shown in the example you must either recreate them or copy them over from the example mod.''
Format: <code><job_type_id>: <item_id>[]</code>
* <job_type_id>: the id of a job type defined inside "job_types"
* <item_id>: the id of the item to use

=== Example ===
<pre>{
LOST_ITEM = {
"mission_lost_scarf",
"mission_lost_specs",
"mission_lost_band"
},
OUTLAW_ITEM = {
"mission_stolen_scarf",
"mission_stolen_band",
"mission_stolen_specs"
},
DELIVERY = {
"berry_oran",
"berry_leppa",
"food_apple",
"berry_lum",
"apricorn_plain"
},
[...]
}</pre>

== difficulty_to_tier ==

Weighted table that associates mission difficulty to a specific tier of characters and outlaws.
Format: <code><diff_id>: {id: string, weight: integer}[]</code>
* <diff_id>: one of the difficulties defined in "difficulty_list"
* id: A string that defines a pokémon tier id.
* weight: Chance of being picked. Set to 0 or delete altogether to stop an entry from being picked.

=== Example ===
<pre>{
F = {
{id = "TIER_LOW", weight = 10}
},
E = {
{id = "TIER_LOW", weight = 9},
{id = "TIER_MID", weight = 1}
},
D = {
{id = "TIER_LOW", weight = 7},
{id = "TIER_MID", weight = 3}
},
[...]
}</pre>

== pokemon ==

A list of Pokémon that will be used for job generation, sorted by arbitrary quest tiers.
Any of these entries may be picked when choosing client and target.
If the client picked is not in the seen dex, the reward type can never be "client" nor "exclusive".
Format: <code><tier>: <monster_id>[]</code>
* <tier>: one of the tier ids used in difficulty_to_tier
* <monster_id>: either the species id of a pokémon or a MonsterIDTable
Format of MonsterIDTable: see the "monsterIdTemplate" function in missiongen_lib.lua

=== Example ===
<pre>{
TIER_LOW = {
"abra","amaura","anorith","applin","archen","aron","arrokuda","axew","azurill", [...]
},
[...]
}</pre>

== job_titles ==

A list of all possible job display titles, divided by job type.
You must also include lists for any special job types you intend to use.
Format: <code><job_type_id>: <string_key>[]</code>
* <job_type_id>: either the id of a job type defined inside "job_types", or the id of a special job type
* <string_key>: the localization key used for the title. The localized strings are fetched from the Menu Text list (strings.resx)

Localization placeholders:
* {0}: target
* {1}: dungeon
* {2}: item
* {3}: client

=== Example ===
<pre>
{
RESCUE_SELF = {
"MISSION_TITLE_RESCUE_SELF_001",
"MISSION_TITLE_RESCUE_SELF_002",
"MISSION_TITLE_RESCUE_SELF_003",
"MISSION_TITLE_RESCUE_SELF_004",
[...]
},
[...]
}</pre>

== job_flavor ==

A list of all possible job flavor text entries, divided by job type and by line.
Format: <code><job_type_id>: {<string_key>[], <string_key>[]}</code>
* <job_type_id>: either the id of a job type defined inside "job_types", or the id of a special job type
* <string_key>: the localization key used for the flavor text. Every job has 2 lists assigned: one for the top string and one for the bottom one.
If only the first list is specified, the second one will be left empty.
The localized strings are fetched from the Menu Text list (strings.resx)

Localization placeholders:
* {0}: target
* {1}: dungeon
* {2}: item
* {3}: client

=== Example ===
<pre>
{
RESCUE_SELF = {
{
"MISSION_BODY_TOP_RESCUE_SELF_001",
"MISSION_BODY_TOP_RESCUE_SELF_002",
"MISSION_BODY_TOP_RESCUE_SELF_003",
"MISSION_BODY_TOP_RESCUE_SELF_004",
[...]
},
{
"MISSION_BODY_BOTTOM_RESCUE_SELF_001",
"MISSION_BODY_BOTTOM_RESCUE_SELF_002",
"MISSION_BODY_BOTTOM_RESCUE_SELF_003",
[...]
}
},
[...]
}</pre>

== law_enforcement ==

Law enforcement characters in your setting. All OUTLAW jobs except OUTLAW_ITEM and OUTLAW_ITEM_UNK use these characters as job clients.
You may specify only 1 officer, and then a list containing any number of agents. Two of the latter will be randomly picked every time the job completion cutscene is played.
You may add a weight property to agents to specify a custom chance of being picked. Any without will
have a weight of 1.
Add "unique = true" to the MonsterIDTable to stop an agent from being picked twice. You must
have at least either 1 non-unique agent or 2 unique ones for this list table to be valid.
Format of MonsterIDTable: see the "monsterIdTemplate" function in missiongen_lib.lua

=== Example ===
<pre>
{
OFFICER = {Species = "magnezone", Gender = 0},
AGENT = {
{Species = "magnemite", Gender = 0, Weight = 31},
{Species = "magnemite", Gender = 0, Skin = "shiny", Weight = 1, Unique = true}
}
}</pre>

== enforcer_chance ==

Defines the chance of either the officer or an agent being the client of a mission depending on the character tier of the mission, as defined in difficulty_to_tier.
Format: <code><tier>: {id: string, weight: integer}[]</code>
* <tier>: one of the tier ids used in difficulty_to_tier
* id: One of: OFFICER, AGENT
* index: Optional. Ignored if id is OFFICER. You can set it to specify a specific agent instead of rolling using their chance in "law_enforcement".
* weight: Chance of being picked. Set to 0 or delete altogether to stop an entry from being picked.

=== Example ===
<pre>
{
TIER_LOW = {
{id = "OFFICER", weight = 2},
{id = "AGENT", weight = 8}
},
TIER_MID = {
{id = "OFFICER", weight = 5},
{id = "AGENT", weight = 5}
},
TIER_HIGH = {
{id = "OFFICER", weight = 8},
{id = "AGENT", weight = 2}
}
}</pre>

== special_data ==

Data of characters and flavor key used for special jobs, divided by tier.
In outlaw related quests, you may use ENFORCER as a keyword for a random law enforcement character.
You may also use OFFICER or AGENT to specify a more specific selection.
These keywords can only be used in place of MonsterIDTables.
Format: <code><special_type>: {<tier>: {client: MonsterIDTable, target: MonsterIDTable, item: string, flavor: string}[]}</code>
* <special_type>: an id of your choosing. It must be different from any basic job id
* <tier>: one of the tier ids used in difficulty_to_tier
* client: the data used to generate this Pokémon.
* target: the data used to generate this Pokémon. Only used in job types that require a target.
* item: the id of the item that will be used for this job. Only used in job types that require an item.
* flavor: flavor string key used for the job, sourced from the Menu Text list (strings.resx)
Format of MonsterIDTable: see the "monsterIdTemplate" function in missiongen_lib.lua

Localization placeholders:
* {0}: target
* {1}: dungeon
* {2}: item
* {3}: client

=== Example ===
<pre>{
LOVER = {
TIER_LOW = {
{client = {Species = "volbeat", Gender = 1}, target = {Species = "illumise", Gender = 2}, flavor = "MISSION_BODY_SPECIAL_LOVER_001"},
{client = {Species = "minun", Gender = 1}, target = {Species = "plusle", Gender = 2}, flavor = "MISSION_BODY_SPECIAL_LOVER_002"},
{client = {Species = "mareep", Gender = 2}, target = {Species = "wooloo", Gender = 1}, flavor = "MISSION_BODY_SPECIAL_LOVER_003"},
[...]
},
TIER_MID = {
{client = {Species = "miltank", Gender = 2}, target = {Species = "tauros", Gender = 1}, flavor = "MISSION_BODY_SPECIAL_LOVER_005"},
{client = {Species = "venomoth", Gender = 1}, target = {Species = "butterfree", Gender = 2}, flavor = "MISSION_BODY_SPECIAL_LOVER_006"},
[...]
},
[...]
},
[...]
}</pre>

== escort_talks ==

String keys to be used whenever the player interacts with an escort mission client, depending on the job type.
You can also include tables for special escort jobs. If no such table exists for a specific case, the generic table for the job type will be used.
Format: <code><job_type_id>: <string_key>[]</code>
* <job_type_id>: "ESCORT", "EXPLORATION", or the id of a special job type that corresponds to one of these job types
* <string_key>: the localization key of possible messages. The localized strings are fetched from the Gameplay Text list (stringsEx.resx)

Localization placeholders:
* {0}: target
* {1}: dungeon
* {2}: item

=== Example ===
<pre>
{
ESCORT = {
"MISSION_ESCORT_INTERACT"
},
EXPLORATION = {
"MISSION_EXPLORATION_INTERACT"
}
}</pre>

== rescue_responses ==

Strings keys to be used whenever the player interacts with a pokémon that needs rescue, depending on the job type and the response given.
You must include a "_DEFAULT" table, but you can also include tables for special job types. _DEFAULT will still be used for any special
case that doesn't have a table associated with it.
Format: <code>{rescue_yes: {<case_id>: {key: string, emotion: string}[]}, rescue_no: {<case_id>: {key: string, emotion: string}[]}}</code>
* <case_id>: "_DEFAULT", or the id of a special job type that corresponds to either "RESCUE_SELF" or "RESCUE_FRIEND"
* key: the localization key of possible messages. The localized strings are fetched from the Gameplay Text list (stringsEx.resx)
* emotion: Optional. An emotion id to use with this specific message. Defaults to "Normal"

Localization placeholders:
* {0}: client
* {1}: target
* {2}: dungeon

=== Example ===
<pre>
{
rescue_yes = {
_DEFAULT = { {key = "MISSION_RESCUE_CONFIRM_DEFAULT"} },
CHILD = { {key = "MISSION_RESCUE_CONFIRM_CHILD", emotion = "Joyous"} },
FRIEND = { {key = "MISSION_RESCUE_CONFIRM_FRIEND"} },
RIVAL = { {key = "MISSION_RESCUE_CONFIRM_RIVAL"} },
LOVER = { {key = "MISSION_RESCUE_CONFIRM_LOVER", emotion = "Joyous"} }
},
rescue_no = {
_DEFAULT = { {key = "MISSION_RESCUE_DENY_DEFAULT", emotion = "Surprised"} },
CHILD = { {key = "MISSION_RESCUE_DENY_CHILD", emotion = "Crying"} },
FRIEND = { {key = "MISSION_RESCUE_DENY_FRIEND", emotion = "Surprised"} },
RIVAL = { {key = "MISSION_RESCUE_DENY_RIVAL", emotion = "Stunned"} },
LOVER = { {key = "MISSION_RESCUE_DENY_LOVER", emotion = "Stunned"} }
}
}</pre>

== mission_callback_root ==

The object that contains job callback functions. It is recommended to define this object somewhere else.
Job callbacks are stored inside jobs as strings. These strings are then used as an index in the callback root object to retrieve the actual function.

The callback system is a pretty involved one, that gives a modder the ability to handcraft entirely new types of jobs if they so choose, but is also pretty difficult to handle, so it will be discussed in [[Mod:Nebula's Mission Board/ Job callbacks|its own guide]].

=== Example ===
<pre>COMMON</pre>

== settings.AddDungeonSection(zone, segment, start, difficulty, finish, must_end) ==

Adds a new dungeon section to the list of possible job destinations.
Section start values must always be added in ascending order. Failing to do so may cause inconsistent behaviors.

=== Arguments ===

* <code>zone</code> - <code>string</code>: the string id of the dungeon zone.
* <code>segment</code> - <code>integer</code>: the numeric id of the dungeon segment.
* <code>start</code> - <code>integer</code>: the starting floor of this dungeon section (start counting from 1 for this).
* <code>difficulty</code> - <code>string</code>: the string id of the difficulty assigned to this section.
* <code>finish</code> - <code>integer</code>: Only considered when first adding a segment to the list. Can be omitted otherwise. This will be the last floor of the segment where jobs can spawn (start counting from 1 for this). If higher than the dungeon floors, it will default to the full dungeon length.
* <code>must_end</code> - <code>boolean</code> Only considered when first adding a segment to the list. Can be omitted otherwise. If true, this segment must be completed before jobs can spawn in it. If false, the segment must be accessed at least once, unless it's segment 0, which just needs to be unlocked. Defaults to true.

=== Example ===

<pre>
settings.AddDungeonSection("faultline_ridge", 0, 6, "D", 10)
settings.AddDungeonSection("sickly_hollow", 0, 9, "S", 16, false)
settings.AddDungeonSection("sickly_hollow", 0, 13, "STAR_1")

</pre>

__NOTOC__

Mod:Nebula's Mission Board/ Job callbacks

2025-08-01T17:44:16Z

MistressNebula: Account for 1.0.1 changes

The library contains a callback system that allows modders to attach code to specific jobs to customize their behavior. It functions very similarly to how the base game handles scripted events: you attach a function name and a series of arguments to an id, and the system will fetch a function from somewhere, passing those arguments to it. Let's see exactly how this works.

== Events ==
There are a few places in which the library checks a job's <code>Callback</code> field. These are called "events", and there are ten in total. Most events can also be interrupted; we will discuss how to do that next.
* <code>"JobTake"</code>: Happens when a job is taken using the board menu, or when <code>MissionGen:TakeJob(<board_id>, <index>)</code> is called directly. Interrupting this event will cause it to not add the job to the taken list or mark it as taken.
* <code>"JobActivate"</code>: Called when a job is activated from the taken menu, or when <code>MissionGen:ToggleTakenJob(<index>)</code> is called directly on a currently inactive job. Interrupting this event will cause the job to not be activated.
* <code>"JobDeactivate"</code>: Called when a job is deactivated from the taken menu, or when <code>MissionGen:ToggleTakenJob(<index>)</code> is called directly on a currently active job. Interrupting this event will cause the job to not be deactivated.
* <code>"DungeonStart"</code>: Called right before checking if the job is supposed to have a guest. This event cannot be interrupted.
* <code>"DungeonEnd"</code>: Called right before checking for job completion. This event cannot be interrupted.
* <code>"FloorStart"</code>: Called at the start of the destination floor of a job, right after applying the segment's generation steps but before applying the floor's specific generation steps. Interrupting this event will prevent any battle event and floor generation step normally required by the job's type from being added to the queue.
* <code>"JobComplete"</code>: Called when a job is marked as completed, or when <code>MissionGen:MarkJobCompleted(<job>)</code> is called directly. Interrupting this event will prevent the job from being marked as completed.
* <code>"JobFail"</code>: Called when a job is marked as failed, or when <code>MissionGen:MarkJobFailed(<job>)</code> is called directly. Interrupting this event will prevent the job from being marked as failed.
* <code>"BeforeReward"</code>: Called right before the reward cutscene is about to start for a specific job. Interrupting this event will skip the cutscene altogether.
* <code>"AfterReward"</code>: Called right after the reward cutscene ends for a specific job. Interrupting this event will prevent the job from being removed from the taken list.

By attaching code to these events, one can change how the library handles a job; jobs that unlock their target dungeons when activated become possible, for example. Expert modders might even be able to create completely new types of jobs, given enough effort.

=== The Event Table ===
When an event is called, a small table of data is generated and then passed to whatever callback is assigned to it. This table contains the following data:
* <code>cancel</code> - <code>boolean</code>: Begins equal to false. If true, it will interrupt the event if possible.
* <code>job</code> - <code>[[Mod:Nebula's Mission Board/ Job Table|JobTable]]</code>: The job that this instance of the event applies to.
* <code>data</code> - <code>table</code>: Some extra parameters that may be useful to the callback.

This gives you full access to all data stored inside the job table, making it easy to write general purpose functions. Plus, as you can see, interrupting an event is as easy as setting <code>cancel</code> to <code>true</code>. This is not all, though; the <code>data</code> table might contain different properties depending on the event. If an event is not on this list, its data table will be empty:
* <code>"JobTake"</code>:
** <code>board</code> - <code>string</code>: the id of the board this job is being taken from.
* <code>"JobActivate"</code>: Nothing.
* <code>"JobDeactivate"</code>: Nothing.
* <code>"DungeonStart"</code>: Nothing.
* <code>"DungeonEnd"</code>:
** <code>result</code> - <code>[https://github.com/RogueCollab/RogueEssence/blob/master/RogueEssence/Data/GameProgress.cs#L72 ResultType]</code>: The final result of this exploration.
* <code>"FloorStart"</code>:
** <code>zoneContext</code> - <code>[https://github.com/RogueCollab/RogueEssence/blob/master/RogueEssence/LevelGen/Zones/ZoneSegment.cs#L288 ZoneGenContext]</code> the collection of zone gen data associated to the current task
** <code>context</code> - any <code>[https://github.com/RogueCollab/RogueEssence/blob/master/RogueEssence/LevelGen/MapGenContext.cs BaseMapGenContext]</code> implementation: an object that describes the map in its during-generation state
** <code>queue</code> - <code>[https://github.com/audinowho/RogueElements/blob/master/RogueElements/StablePriorityQueue.cs StablePriorityQueue]<[https://github.com/audinowho/RogueElements/blob/master/RogueElements/Priority/Priority.cs Priority],any [https://github.com/audinowho/RogueElements/blob/master/RogueElements/MapGen/IGenStep.cs IGenStep] implementation></code>: the list of floor generation steps to apply after this callback returns.
** <code>seed</code> - <code>integer</code>: the numeric seed supplied to the ZoneStep that is handling this code.
* <code>"BeforeReward"</code>:
** <code>zone</code> - <code>string</code> the id of the zone the player is currently in.
** <code>map</code> - <code>integer</code> the index of the map the player is currently in.
* <code>"AfterReward"</code>:
** <code>zone</code> - <code>string</code> the id of the zone the player is currently in.
** <code>map</code> - <code>integer</code> the index of the map the player is currently in.
After the callback returns, the table will be returned to the event-calling code, which will check for the field's state and react accordingly.

== Callbacks ==
To use the callback system, you first need to set the [[Mod:Nebula's Mission Board/ Editing settings#mission_callback_root|mission_callback_root]] setting to a global table of your choice. All callbacks will then need to be stored inside that table. Furthermore, this is what their signature should look like:
<pre>
function(<evt>, <args>)
</pre>
where:
* <code>evt</code> is the event table discussed above
* <code>args</code> is the list of arguments set when registering the callback.

Any changes to the job table will be kept after the callback ends, so you can even use this to change the job's properties if you want.

=== Registering a callback ===
Once you have your callback ready, you need to register it to a job. This is done by using this function:
<pre>
MissionGen:RegisterCallback(<job>, <event>, <func>, <args>)
</pre>
where:
* <code>job</code> is the job table to add the callback to.
* <code>event</code> is the id of the event to subscribe to, as discussed at the top.
* <code>func</code> is the name of the callback function.
* <code>event</code> is optional, and is the table of arguments to pass to this instance of the callback. If not set, it defaults to an empty table. You should not save C# objects or functions in here, because they wouldn't be saved correctly.

This will make it so that the given function is called when the given event is triggered. Do keep in mind that only one callback per event can be registered inside a job. Trying to register a second function will remove the previous one.

Once your callback is registered, just give the job to the player in some way, and you're good to go.

Mod:Nebula's Mission Board/ Handcrafted jobs

2025-08-01T15:27:11Z

MistressNebula: Add override info

The Mission Generation Library contains a method that allows the creation of basic jobs with arbitrarily chosen parameters. These jobs do not have to abide by any of the rules that the normal job generation uses, so do keep in mind that you might have to run a few checks to make sure you're not going off script, or to simply give the job to the player only when the rules are all respected. You can also choose not to care, of course, but that might have some consequences depending on what isn't being respected.
Here's a quick rundown of the rules followed by the library, and how to check if your desired job data would break them:
* '''No two jobs should be on the same floor''' - If this is not respected, the player will only be able to keep one of the jobs active at the same time.
: Check with: <code>MissionGen:IsDestinationOccupied(zone, segment, floor)</code>
* '''The number of guest jobs in the same dungeon should not be higher than "max_guests"''' - This might make the adventure more difficult if "guests_take_up_space" is true, because the game might remove more party members than expected.
: Check with: <code>MissionGen:GetDungeonsGuestCount()[zone]</code>

After handling all the rules you care about respecting, you can move on to actually creating the job. This is done with the following function:
<pre>MissionGen:MakeNewJob(zone, segment, floor, job_type, client, target, target_item, reward_type, rewards, title, flavor, hide_floor)</pre>
As you can see, there are a lot of parameters, though the great majority of them is optional. Those that are will have a <code>?</code> beside its type. Any missing parameter that is required for the given job type to function will be generated randomly:
* <code>zone</code> - <code>string</code>: The id of the zone this job takes place in.

* <code>segment</code> - <code>integer</code>: The specific segment this job takes place in.

* <code>floor</code> - <code>integer</code>: The destination floor of this job.

* <code>job_type</code> - <code>string</code>: The id of the type of this job. It must always be equal to one of the following values: "RESCUE_SELF", "RESCUE_FRIEND", "ESCORT", "EXPLORATION", "DELIVERY", "LOST_ITEM", "OUTLAW", "OUTLAW_ITEM", "OUTLAW_ITEM_UNK", "OUTLAW_MONSTER_HOUSE", "OUTLAW_FLEE".

* <code>client</code> - <code>string|monsterIDTable</code>: Data that will be used for the client of this job. If it's not a mosterIdTable (see below), it must be either "ENFORCER", "OFFICER" or "AGENT". A law enforcement character will be selected using different rules depending on the string.

* <code>target</code> - <code>string|monsterIDTable</code>: Data that will be used for the target of this job. If it's not a mosterIdTable (see below), it must be either "ENFORCER", "OFFICER" or "AGENT". A law enforcement character will be selected using different rules depending on the string. This value will be used only if the job type requires a target.

* <code>target_item</code> - <code>string?</code>: The id of the item that will be used as target. This value will be used only if the job type requires an item.

* <code>reward_type</code> - <code>string?</code>: The combination of rewards that will be awarded for this job. It must always be equal to one of the following values: "item", "money", "item_item", "money_item", "client", "exclusive". If <code>rewards</code> is set, this value will be inferred from the items used, even if a value was already provided.

* <code>rewards</code> - <code>{string|itemTable?, string|itemTable?}</code>: The item rewards that will be awarded for this job. If not set but <code>reward_type</code> is, they will be generated automatically. You can either write only the id of the item, or use a full itemTable (see below). If the first item is nil, it will award money in its place.

* <code>title</code> - <code>string?</code>: The string key to use for this job's title. If not set, it will be chosen randomly.

* <code>flavor</code> - <code>{string, string?}?</code>: The string key, or keys, to use for this job's flavor text. If not set, they will be chosen randomly.

* <code>hide_floor</code> - <code>boolean?</code>: If true, the job's floor will be hidden when viewing the job inside menus.

'''monsterIDTable'''
<pre>{
Species:string,
Form:integer,
Skin:string,
Gender:integer,
Nickname:string?
}</pre>

'''itemTable'''
<pre>{id:string, count:integer?, hidden:string?}</pre>

<code>MakeNewJob</code> will return a fully-formed [[Mod:Nebula's Mission Board/ Job Table|JobTable]], which can then be edited further either indirectly or with other functions. Once you're done, however, you will need to add a BackReference to it, otherwise the game won't know where to send the player for the reward cutscene. This can be done in two ways, depending on what you want to accomplish; if you want to give the job directly to the player, you can do this:
<pre>
MissionGen:SetBackReference(<job>, <board_id>)
MissionGen:AddJobToTaken(<job>, <startActive>)
</pre>
where:
* <code>job</code> is the JobTable.
* <code>board_id</code> is the board the job should bring the player to after completing it.
* <code>startActive</code> is an optional boolean that tells the game whether or not to set the job as active as it gets added to the taken list. Defaults to <code>false</code>.
If, instead of giving it directly to the player, you want to add the job to a board, you can do this:
<pre>
MissionGen:AddJobToBoard(<board_id>, <job>)
</pre>
where:
* <code>board_id</code> is the board the job will be added to, and that will be set as BackReference.
* <code>job</code> is the JobTable.
With this done, the job is now fully set up and can be safely presented to the player.

===== Custom text =====
You can further customize the jobs you create by editing the text displayed in the various fields of the job menu. There are a few functions that allow you to set overrides for some of the job's sensitive information:
<pre>
MissionGen:SetClientOverride(<job>, <string_key>)
MissionGen:SetObjectiveOverride(<job>, <string_key>)
MissionGen:SetDungeonOverride(<job>, <string_key>)
MissionGen:SetDifficultyOverride(<job>, <string_key>)
MissionGen:SetRewardOverride(<job>, <string_key>)
</pre>
where:

* <code>job</code> is the JobTable you want to edit.
* <code>string_key</code> is the localization key of the string you want to set.

Mod:Nebula's Mission Board/ Handcrafted jobs

2025-08-01T15:06:17Z

MistressNebula: Account for 1.0.1 changes

The Mission Generation Library contains a method that allows the creation of basic jobs with arbitrarily chosen parameters. These jobs do not have to abide by any of the rules that the normal job generation uses, so do keep in mind that you might have to run a few checks to make sure you're not going off script, or to simply give the job to the player only when the rules are all respected. You can also choose not to care, of course, but that might have some consequences depending on what isn't being respected.
Here's a quick rundown of the rules followed by the library, and how to check if your desired job data would break them:
* '''No two jobs should be on the same floor''' - If this is not respected, the player will only be able to keep one of the jobs active at the same time.
: Check with: <code>MissionGen:IsDestinationOccupied(zone, segment, floor)</code>
* '''The number of guest jobs in the same dungeon should not be higher than "max_guests"''' - This might make the adventure more difficult if "guests_take_up_space" is true, because the game might remove more party members than expected.
: Check with: <code>MissionGen:GetDungeonsGuestCount()[zone]</code>

After handling all the rules you care about respecting, you can move on to actually creating the job. This is done with the following function:
<pre>MissionGen:MakeNewJob(zone, segment, floor, job_type, client, target, target_item, reward_type, rewards, title, flavor, hide_floor)</pre>
As you can see, there are a lot of parameters, though the great majority of them is optional. Those that are will have a <code>?</code> beside its type. Any missing parameter that is required for the given job type to function will be generated randomly:
* <code>zone</code> - <code>string</code>: The id of the zone this job takes place in.

* <code>segment</code> - <code>integer</code>: The specific segment this job takes place in.

* <code>floor</code> - <code>integer</code>: The destination floor of this job.

* <code>job_type</code> - <code>string</code>: The id of the type of this job. It must always be equal to one of the following values: "RESCUE_SELF", "RESCUE_FRIEND", "ESCORT", "EXPLORATION", "DELIVERY", "LOST_ITEM", "OUTLAW", "OUTLAW_ITEM", "OUTLAW_ITEM_UNK", "OUTLAW_MONSTER_HOUSE", "OUTLAW_FLEE".

* <code>client</code> - <code>string|monsterIDTable</code>: Data that will be used for the client of this job. If it's not a mosterIdTable (see below), it must be either "ENFORCER", "OFFICER" or "AGENT". A law enforcement character will be selected using different rules depending on the string.

* <code>target</code> - <code>string|monsterIDTable</code>: Data that will be used for the target of this job. If it's not a mosterIdTable (see below), it must be either "ENFORCER", "OFFICER" or "AGENT". A law enforcement character will be selected using different rules depending on the string. This value will be used only if the job type requires a target.

* <code>target_item</code> - <code>string?</code>: The id of the item that will be used as target. This value will be used only if the job type requires an item.

* <code>reward_type</code> - <code>string?</code>: The combination of rewards that will be awarded for this job. It must always be equal to one of the following values: "item", "money", "item_item", "money_item", "client", "exclusive". If <code>rewards</code> is set, this value will be inferred from the items used, even if a value was already provided.

* <code>rewards</code> - <code>{string|itemTable?, string|itemTable?}</code>: The item rewards that will be awarded for this job. If not set but <code>reward_type</code> is, they will be generated automatically. You can either write only the id of the item, or use a full itemTable (see below). If the first item is nil, it will award money in its place.

* <code>title</code> - <code>string?</code>: The string key to use for this job's title. If not set, it will be chosen randomly.

* <code>flavor</code> - <code>{string, string?}?</code>: The string key, or keys, to use for this job's flavor text. If not set, they will be chosen randomly.

* <code>hide_floor</code> - <code>boolean?</code>: If true, the job's floor will be hidden when viewing the job inside menus.

'''monsterIDTable'''
<pre>{
Species:string,
Form:integer,
Skin:string,
Gender:integer,
Nickname:string?
}</pre>

'''itemTable'''
<pre>{id:string, count:integer?, hidden:string?}</pre>

<code>MakeNewJob</code> will return a fully-formed [[Mod:Nebula's Mission Board/ Job Table|JobTable]], which can then be edited further either indirectly or with other functions. Once you're done, however, you will need to add a BackReference to it, otherwise the game won't know where to send the player for the reward cutscene. This can be done in two ways, depending on what you want to accomplish; if you want to give the job directly to the player, you can do this:
<pre>
MissionGen:SetBackReference(<job>, <board_id>)
MissionGen:AddJobToTaken(<job>, <startActive>)
</pre>
where:
* <code>job</code> is the JobTable.
* <code>board_id</code> is the board the job should bring the player to after completing it.
* <code>startActive</code> is an optional boolean that tells the game whether or not to set the job as active as it gets added to the taken list. Defaults to <code>false</code>.
If, instead of giving it directly to the player, you want to add the job to a board, you can do this:
<pre>
MissionGen:AddJobToBoard(<board_id>, <job>)
</pre>
where:
* <code>board_id</code> is the board the job will be added to, and that will be set as BackReference.
* <code>job</code> is the JobTable.
With this done, the job is now fully set up and can be safely presented to the player.

Mod:Nebula's Mission Board/ Job Table

2025-08-01T15:03:46Z

MistressNebula: /* ObjectiveOverride */ Account for 1.0.1 changes

This page contains a list of all fields contained inside a Job Table.
Fields with a ? to their side can be safely set to <code>nil</code> depending on the circumstances.

==== Client ====
A MonsterID-style table describing the client of the job.
====== Type ======
<pre>{
Species:string,
Form:integer?,
Skin:string?,
Gender:integer?,
Nickname:string?
}</pre>

==== Target ====
MonsterID style table describing the target. Must be set if the job type expects a target.
====== Type ======
<pre>{
Species:string,
Form:integer?,
Skin:string?,
Gender:integer?,
Nickname:string?
}?</pre>

==== Flavor ====
Pair of string keys displayed when the job details are displayed. The second key is optional.
====== Type ======
<pre>{string, string?}</pre>

==== Title ====
String key displayed when browsing quest boards.
====== Type ======
<pre>string</pre>

==== Zone ====
The id of the zone this job takes place in.
====== Type ======
<pre>string</pre>

==== Segment ====
The specific segment this job takes place in.
====== Type ======
<pre>integer</pre>

==== Floor ====
The destination floor of this job.
====== Type ======
<pre>integer</pre>

==== RewardType ====
The id of the combination of rewards that will be awarded by this job. It must always be equal to one of the following values:
<code>"money"</code>, <code>"item"</code>, <code>"money_item"</code>, <code>"item_item"</code>, <code>"client"</code>, <code>"exclusive"</code>
====== Type ======
<pre>string</pre>

==== Reward1 ====
Data of the first item awarded by the job. Must be set if RewardType expects a visible item reward.
====== Type ======
<pre>{id:string, count:integer?, hidden:string?}?</pre>

==== Reward2 ====
Data of the second item awarded by the job. Must be set if RewardType expects a hidden item reward.
====== Type ======
<pre>{id:string, count:integer?, hidden:string?}?</pre>

==== Type ====
The id of the type of this job. It must always be equal to one of the following values:
<code>"RESCUE_SELF"</code>, <code>"RESCUE_FRIEND"</code>, <code>"ESCORT"</code>, <code>"EXPLORATION"</code>, <code>"DELIVERY"</code>, <code>"LOST_ITEM"</code>, <code>"OUTLAW"</code>, <code>"OUTLAW_ITEM"</code>, <code>"OUTLAW_ITEM_UNK"</code>, <code>"OUTLAW_MONSTER_HOUSE"</code>, <code>"OUTLAW_FLEE"</code>
====== Type ======
<pre>string</pre>

==== Completion ====
The state of the job. -1 means failed. 0 means not completed. 1 means completed. This is always reset to 0 on day end if the job rewards are not claimed (like when an adventure is failed).
====== Type ======
<pre>integer</pre>

==== Taken ====
This variable means different things depending on what list this job is in:
* Taken list: if true, the job is active.
* Boards: if true, the job is considered to be inside the taken list.
====== Type ======
<pre>boolean</pre>

==== BackReference ====
Contains the id of the board it was in. It is used only in the taken list for discarding jobs and for routing the player during the reward process.
====== Type ======
<pre>string?</pre>

==== Difficulty ====
The difficulty index of this job. It is stored as a number instead of a string for ease of calculations.
====== Type ======
<pre>integer</pre>

==== Item ====
The id of the item this job requires. It must be set if the job type requires a target item.
====== Type ======
<pre>string?</pre>

==== Special ====
Special jobs can be triggered sometimes. If so, this will contain the special job category id.
====== Type ======
<pre>string?</pre>

==== HideFloor ====
If this is true, the target floor of this job will be hidden when inside menus.
====== Type ======
<pre>boolean</pre>

==== Callbacks ====
Table of callbacks with their respective parameters. Empty by default. You can add callbacks using the <code>RegisterCallback</code> library function. Every job can only have one callback per event.
====== Type ======
<pre>table<string, {name:string, args:table}></pre>

==== MenuOverrides ====
String keys to be used instead of the normal ones in various places in the Job Menu. They only affect menus. Please refer to the normal usage of the string you're replacing for more info on its placeholders.
====== Type ======
<pre>table<string, string>?</pre>
__NOTOC__

Mod:Nebula's Mission Board/ Editing settings

2025-08-01T14:17:59Z

MistressNebula: Account for 1.0.1 changes

The Mission Generation Library is designed to be highly customizable. This choice is reflected in its <code>missiongen_settings.lua</code> file. This file is what modders are supposed to edit, changing the values inside the giant table it defines.

Here's a list of all settings in the library, with documentation:

== sv_root_name ==

Name of the SV table that will contain all stored data. Use a table to specify a deeper path. If not present in the SV structure, the defined path will be generated automatically. An empty list would just use SV as root.
Examples:
* <code>"jobs"</code> would use <code>SV.jobs</code> as its root.
* <code>{"adventure", "jobs"}</code> would use <code>SV.adventure.jobs</code> as its root.

=== Example ===
<pre>"jobs"</pre>

== boards ==

A list of board ids and the data necessary to define their behavior.
Format for each board:
<pre><nowiki>
<board_id>: {
display_key: string,
size: integer,
location: {
zone: string,
map: integer
},
condition: function(library),
job_types: {id = string, weight = integer}[]
}</nowiki></pre>
* <board_id>: The id of the board. It will be used to identify and reference this specific board inside scripts
* display_key: the string key used when displaying the job menu for this board. The localized strings are fetched from the Menu Text list (strings.resx)
* size: the amount of quests this board can hold at a time
* location: a zone id and a map index. This data is where the player will be brought for the job completion cutscene. All of these maps must call library:PlayJobsCompletedCutscene before fade-in for the reward sequence to work correctly.
* condition: Optional. A function called to determine if library:PopulateBoards() should fill out this board. It receives the library object as an argument and returns a boolean. If it returns true, the board is filled out. If it returns false, it is left empty. If this property is missing, this board will always be active.
* job_types: a list of job types and their probability weight. Higher weight means more common.

=== Example ===
<pre>{
quest_board = {
display_key = "BOARD_QUEST_TITLE",
size = 8,
location = {zone = "guildmaster_island", map = 2},
condition = function (library)
local root = library.root
local completed = 0
for _, segments in pairs(root.dungeon_progress) do
for _, state in pairs(segments) do
if state then
completed = completed + 1
if completed>=3 then return true end
break
end
end
end
return false
end,
job_types = {
{id = "RESCUE_SELF", weight = 5},
{id = "RESCUE_FRIEND", weight = 5},
{id = "ESCORT", weight = 2},
{id = "EXPLORATION", weight = 2},
{id = "DELIVERY", weight = 2},
{id = "LOST_ITEM", weight = 4},
{id = "OUTLAW", weight = 5},
{id = "OUTLAW_ITEM", weight = 2},
{id = "OUTLAW_ITEM_UNK", weight = 1},
{id = "OUTLAW_MONSTER_HOUSE", weight = 1},
{id = "OUTLAW_FLEE", weight = 1}
}
}
}</pre>

== end_dungeon_day_destination ==

Zone and map id of the ground map where players will be sent to when a day ends and there is at least one mission to hand in. This map must contain a call to library:PlayJobsCompletedCutscene
Format: <code>{zone: string, map: integer}</code>

=== Example ===
<pre>{ zone = "guildmaster_island", map = 2 },</pre>

== after_rewards_function ==

Function ran after the game is done with the job completion cutscene. It takes no arguments, and is not expected to return anything.
You can use it to fix up the game state however you like before returning control to the player.

=== Example ===
<pre>
after_rewards_function = function()
GAME:MoveCamera(0, 0, 1, true)
SOUND:PlayBGM(SV.base_town.Song, true)
end</pre>

== taken_limit ==

The maximum number of jobs that can be taken from job boards at a time.

=== Example ===
<pre>8</pre>

== taken_jobs_start_active ==

If true, taken jobs will be activated automatically. Players can always deactivate them manually if they so choose.

=== Example ===
<pre>true</pre>

== max_guests ==

The maximum amount of guest-based jobs that can be generated in the same dungeon.
Guest-based jobs are: ESCORT, EXPLORATION

=== Example ===
<pre>1</pre>

== guests_take_up_space ==

The maximum amount of guest-based jobs that can be generated in the same dungeon.
Guest-based jobs are: ESCORT, EXPLORATION

=== Example ===
<pre>1</pre>

== min_party_limit ==

Minimum number for the party limit when it is reduced because of guests.
This value cannot be lower than 1, for obvious reasons.
Any excess guests will simply add to the party count, without reducing the limit.

=== Example ===
<pre>1</pre>

== losing_guests_means_defeat ==

If true, losing any guest will count as a loss for the entire exploration.
If false, it will simply mark that specific job as failed.

=== Example ===
<pre>false</pre>

== dungeon_boss_steps_piority ==

The priority of the SpawnOutlaw handler event. It can be either an integer or a list of integers.
This value should always be lower than dungeon_gen_steps_piority.

=== Example ===
<pre>-11</pre>

== dungeon_gen_steps_piority ==

The priority that most of the job handlers will have when being added to the event list. It can be either an integer or a list of integers.
This value should always be equal to or higher than the priority set for the event that calls library:GenerateJobInFloor.

=== Example ===
<pre>-6</pre>

== dungeon_npc_steps_piority ==

The priority that job npc spawners will have when being added to the event list. It can be either an integer or a list of integers.
This value should always be equal to or higher than dungeon_gen_steps_piority.

=== Example ===
<pre>{ 5, 2, 1 }</pre>

== difficulty_list ==

A list of all difficulty rank id strings you want to use.
The order of these strings will define the difficulty scale used by the library.

=== Example ===
<pre>{ "F", "E", "D", "C", "B", "A", "S", "STAR_1", "STAR_2", "STAR_3", "STAR_4", "STAR_5", "STAR_6", "STAR_7", "STAR_8", "STAR_9" }</pre>

== difficulty_data ==

All the data required to define difficulty rank behavior. There must be an entry for every rank defined in difficulty_list:
Format: <code><diff_id>: {display_key: string, money_reward: integer, extra_reward: integer, outlaw_level: integer, escort_level: integer}</code>
* <diff_id>: one of the difficulties defined in "difficulty_list"
* display_key: string key used when displaying the name of the rank. The localized strings are fetched from the Menu Text list (strings.resx)
* money_reward: the amount of money awarded at the end of the job. If set to 0, money rewards will simply not award anything
* extra_reward: the points of extra reward awarded at the end of the job. What these points are depends on extra_reward_type. If set to 0, extra_reward_type will be considered to be "none"
* outlaw_level: Optional. The base level of all outlaws spawned by jobs with this difficulty. If omitted, it will be equal to the dungeon's expected level.
* escort_level: Optional. The level of all guests spawned by jobs with this difficulty. If omitted, it will be equal to the dungeon's expected level.

=== Example ===
<pre>
{
F = {display_key = "RANK_STRING_F", money_reward = 100, extra_reward = 0},
E = {display_key = "RANK_STRING_E", money_reward = 200, extra_reward = 100},
D = {display_key = "RANK_STRING_D", money_reward = 400, extra_reward = 200},
C = {display_key = "RANK_STRING_C", money_reward = 600, extra_reward = 400},
B = {display_key = "RANK_STRING_B", money_reward = 700, extra_reward = 1250},
A = {display_key = "RANK_STRING_A", money_reward = 1500, extra_reward = 2500},
S = {display_key = "RANK_STRING_S", money_reward = 3000, extra_reward = 5000},
STAR_1 = {display_key = "RANK_STRING_STAR_1", money_reward = 6000, extra_reward = 10000},
STAR_2 = {display_key = "RANK_STRING_STAR_2", money_reward = 10000, extra_reward = 20000},
STAR_3 = {display_key = "RANK_STRING_STAR_3", money_reward = 15000, extra_reward = 30000},
STAR_4 = {display_key = "RANK_STRING_STAR_4", money_reward = 20000, extra_reward = 40000},
STAR_5 = {display_key = "RANK_STRING_STAR_5", money_reward = 25000, extra_reward = 50000},
STAR_6 = {display_key = "RANK_STRING_STAR_6", money_reward = 30000, extra_reward = 60000},
STAR_7 = {display_key = "RANK_STRING_STAR_7", money_reward = 35000, extra_reward = 70000},
STAR_8 = {display_key = "RANK_STRING_STAR_8", money_reward = 40000, extra_reward = 80000},
STAR_9 = {display_key = "RANK_STRING_STAR_9", money_reward = 45000, extra_reward = 90000}
}</pre>

== guest_level_scaling ==

Function that changes the level of guests based on the player's level. It must return the new level for the guest, or it will have no effect.
Arguments:
* lvl: base level of the guest.
* dungeon: if true, the level is the dungeon's recommended level. If false, it's taken from the difficulty data.
* avg_team_lvl: average level of the player team. It may or may not be an integer.
* hst_team_lvl: highest level in the player team.
* settings: the settings data structure itself

=== Example ===
<pre>
function(lvl, dungeon, avg_team_lvl, hst_team_lvl, settings)
local add = 0
if dungeon then lvl = lvl*4//5 end
if avg_team_lvl > lvl then add = (avg_team_lvl - lvl) // 10 end
return lvl + add
end
</pre>

== outlaw_level_scaling ==

Function that changes the level of guests based on the player's level. It must return the new level for the guest, or it will have no effect.
Arguments:
* lvl: base level of the guest.
* dungeon: if true, the level is the dungeon's recommended level. If false, it's taken from the difficulty data.
* avg_team_lvl: average level of the player team. It may or may not be an integer.
* hst_team_lvl: highest level in the player team.
* settings: the settings data structure itself

=== Example ===
<pre>
function(lvl, dungeon, avg_team_lvl, hst_team_lvl, settings)
local add = 0
if dungeon then lvl = lvl*23//20 end
if avg_team_lvl > lvl then add = (avg_team_lvl - lvl) // 8 end
add = add + (hst_team_lvl - avg_team_lvl) // 4
return lvl + add
end
</pre>

== apply_outlaw_changes ==

Function that allows you to edit an outlaw's data just before they are spawned.
You can change just about anything except its position and recruitability state. Its HP will also
always be automatically set to full after this function is called.
You will also be unable to change the EquippedItem of an "OUTLAW_ITEM" or "OUTLAW_ITEM_UNK" outlaw.
Arguments:
* outlaw: the outlaw Character itself
* job: the current job data table

=== Example ===
<pre>
function(outlaw, job)
local max_boost = PMDC.Data.MonsterFormData.MAX_STAT_BOOST
outlaw.MaxHPBonus = math.min(outlaw.Level * max_boost // 64, max_boost);
if job.Type == "OUTLAW_FLEE" then
local speedMin = math.floor(outlaw.Level * 4 // 3)
local speedMax = math.floor(outlaw.Level * 6 // 2)
outlaw.SpeedBonus = math.min(_DATA.Save.Rand:Next(speedMin, speedMax), 100)
end
end
</pre>

== fleeing_outlaw_restrictions ==

A list of ids for types that are banned from ever being picked as fleeing outlaws.

=== Example ===
<pre>{ "ghost" }</pre>

== outlaw_music_name ==

The name of the outlaw music file. This file will be sourced from the Content/Music folder.

=== Example ===
<pre>"Outlaw.ogg"</pre>

== dungeons ==

This is where dungeon difficulty is set. Quests can only generate for dungeons inside this list.
Given the complexity of this structure, it is best generated using the [[Mod:Nebula's Mission Board/ Editing settings#settings.AddDungeonSection(zone, segment, start, difficulty, finish, must_end)||AddDungeonSection]] function at the bottom of this page.

== dungeon_order ==

Jobs are sorted by dungeon, following the order defined in this table. Missing dungeons are shoved at the bottom and sorted alphabetically.
This list is automatically populated in call order when using the "AddDungeonSection" function near the bottom of this file.

== external_events ==

A list of events unrelated to this library that can cause job generation to ignore a specific dungeon.
They can also be displayed in the objectives log if you so choose.
Format: <code>{condition: function(zone), message_key: string, message_args: function(zone), icon: string}</code>
* condition: a function that takes a zone and returns a boolean. If it returns true, jobs will not be generated for this dungeon, and all already taken jobs will be automatically suspended.
* message_key: Optional. It will be used in the objectives log instead of the default message if the condition is true.
* message_args: Optional. If the message's localization string contains placeholders, this function is in charge of taking a zone and returning a list of values that will be used for those placeholders in the form of a table array (Up to 5).
* icon: Optional. The icon that will be displayed beside the corresponding dungeon in the dungeon selection menu if the condition is true for any of its segments. Defaults to ""

=== Example ===
<pre>
{
{condition = function(zone) return COMMON.HasSidequestInZone(zone) end, icon = "\\uE111", message_key = "MENU_JOB_OBJECTIVE_DEFAULT"}
}
</pre>

== external_events_icon_mode ==

How to display external event icons in the dungeon list. This value can only be either "FIRST" or ALL".
* If set to "ALL", they will always be displayed in the order defined by external_events. Only one copy of the same icon will be shown, no matter how many conditions require it.
* If set to "FIRST", only the first event in the list's order will be displayed, no matter how many events are actually there. This setting does not prevent multiple messages from appearing in the objectives list.

=== Example ===
<pre>"FIRST"</pre>

== dungeon_list_pattern ==

The pattern that will define how to display entries in the dungeon list.
{0} is the placeholder for the dungeon name, {1} for pending job icon and {2} for external condition icons.

=== Example ===
<pre>"FIRST"</pre>

== job_types ==

Table used to determine various properties regarding job types.
Remove a job type entirely to disable its generation altogether.
Format: <code><job_type_id>: {rank_modifier: integer, min_rank: string}</code>
* <job_type_id>: one of RESCUE_SELF, RESCUE_FRIEND, ESCORT, EXPLORATION, DELIVERY, LOST_ITEM, OUTLAW, OUTLAW_ITEM, OUTLAW_ITEM_UNK, OUTLAW_MONSTER_HOUSE, OUTLAW_FLEE
* rank_modifier (optional): these jobs will always have this modifier applied to their rank.
* min_rank (optional): this type of jobs can never be of a rank lower than this.
: This influences possible dungeon spawn: a rank_modifier 1 job with min_rank "C" can also spawn in "D" rank dungeons.

=== Example ===
<pre>{
RESCUE_SELF = {rank_modifier = 0, min_rank = "F"},
RESCUE_FRIEND = {rank_modifier = 0, min_rank = "E"},
ESCORT = {rank_modifier = 1, min_rank = "C"},
EXPLORATION = {rank_modifier = 1, min_rank = "C"},
DELIVERY = {rank_modifier = 0, min_rank = "D"},
LOST_ITEM = {rank_modifier = 0, min_rank = "D"},
OUTLAW = {rank_modifier = 1, min_rank = "C"},
OUTLAW_ITEM = {rank_modifier = 1, min_rank = "C"},
OUTLAW_ITEM_UNK = {rank_modifier = 1, min_rank = "C"},
OUTLAW_MONSTER_HOUSE = {rank_modifier = 2, min_rank = "S"},
OUTLAW_FLEE = {rank_modifier = 1, min_rank = "B"}
}
</pre>

== dungeon_job_modifiers ==

Special table that allows modders to specify chance multipliers for job types depending on the dungeon.
Format: <code><dungeon_id>: {<job_type_id>: <multiplier>}</code>
* <dungeon_id>: the string id of a dungeon
* <job_type_id>: one of RESCUE_SELF, RESCUE_FRIEND, ESCORT, EXPLORATION, DELIVERY, LOST_ITEM, OUTLAW, OUTLAW_ITEM, OUTLAW_ITEM_UNK, OUTLAW_MONSTER_HOUSE, OUTLAW_FLEE
* <multiplier>: a multiplier number. It doesn't need to be an integer. It will be multiplied with the board's base chances, rounding up, when choosing the type of a job. Set it to 0 or less to disable the job type altogether.

=== Example ===
<pre>{
ambush_forest = {
OUTLAW = 3,
OUTLAW_ITEM = 3,
OUTLAW_ITEM_UNK = 3,
OUTLAW_MONSTER_HOUSE = 3,
OUTLAW_FLEE = 3
},
treacherous_mountain = {
OUTLAW = 3,
OUTLAW_ITEM = 3,
OUTLAW_ITEM_UNK = 3,
OUTLAW_MONSTER_HOUSE = 3,
OUTLAW_FLEE = 3
}
}
</pre>

== special_chance ==

Chance of special missions to be generated. Special missions are just handcrafted scenarios with specific client and target pairs and custom flavor texts. Set to 0 to disable altogether.

=== Example ===
<pre>0.2</pre>

== special_jobs ==

This is where you can define special cases for specific types of jobs.
Format: <code><job_type_id>: <special_id>[]</code>
* <job_type_id>: one of RESCUE_SELF, RESCUE_FRIEND, ESCORT, EXPLORATION, DELIVERY, LOST_ITEM, OUTLAW, OUTLAW_ITEM, OUTLAW_ITEM_UNK, OUTLAW_MONSTER_HOUSE, OUTLAW_FLEE
* <special_id>: any id of your choosing except RESCUE_SELF, RESCUE_FRIEND, ESCORT, EXPLORATION, DELIVERY, LOST_ITEM, OUTLAW, OUTLAW_ITEM, OUTLAW_ITEM_UNK, OUTLAW_MONSTER_HOUSE, OUTLAW_FLEE

=== Example ===
<pre>{
RESCUE_FRIEND = {"CHILD", "LOVER", "RIVAL", "FRIEND"}
}</pre>

== hidden_floor_chance ==

Chance for supported quest types to have their destination floor hidden. Set to 0 to disable altogether.
Players will still be notified when reaching the floor. It just won't show in the quest description.
Job types that can have their floor hidden are: RESCUE_FRIEND, EXPLORATION, OUTLAW, OUTLAW_ITEM, OUTLAW_ITEM_UNK, OUTLAW_FLEE.

=== Example ===
<pre>0.15</pre>

== reward_types ==

A list of all types of rewards to be offered to players.
Format: <code>{id: string, weight: integer, min_rank: string}</code>
* id: one of the supported reward types. You can use duplicate values to alter odds depending on job rank.
: Supported reward types are: item, money, item_item, money_item, client, exclusive
* weight: Chance of appearing. Set to 0 or delete altogether to stop a type of reward from being offered.
* min_rank: optional. If set, this type of reward will only be offered if the job is this rank or higher.

=== Example ===
<pre>{
{id = "item", weight = 6},
{id = "money", weight = 2},
{id = "item_item", weight = 3},
{id = "money_item", weight = 1},
{id = "client", weight = 1, min_rank = "STAR_1"},
{id = "exclusive", weight = 1, min_rank = "STAR_4"}
}</pre>

== extra_reward_type ==

The type of extra reward for all quests. It can be "none", "rank" or "exp". Any other value will result in "none".

=== Example ===
<pre>"exp"</pre>

== rewards_per_difficulty ==

This table assigns different weights to reward pools depending on the difficulty rank of the mission.
Format: <code><diff_id>: {id: string, weight: integer}[]</code>
* <diff_id>: one of the difficulties defined in difficulty_list"
* id: the id of one of the reward pools defined in "reward_pools"
* weight: Chance of appearing. Set to 0 or delete altogether to stop a reward pool from being picked.

=== Example ===
<pre>{
F = {
{id = "NECESSITIES", weight = 10}
},
E = {
{id = "NECESSITIES", weight = 10},
{id = "APRICORN_GENERIC", weight = 10},
{id = "FOOD_LOW", weight = 10},
{id = "SEED_LOW", weight = 10},
{id = "HELD_LOW", weight = 3},
{id = "LOOT_LOW", weight = 3},
{id = "EVO_ITEMS", weight = 1},
{id = "WANDS_LOW", weight = 10}
},
D = {
{id = "NECESSITIES", weight = 5},
{id = "AMMO_LOW", weight = 10},
{id = "APRICORN_GENERIC", weight = 10},
{id = "APRICORN_TYPED", weight = 2},
{id = "FOOD_LOW", weight = 4},
{id = "SEED_LOW", weight = 4},
{id = "SEED_MID", weight = 10},
{id = "HELD_LOW", weight = 10},
{id = "HELD_TYPE", weight = 3},
{id = "LOOT_LOW", weight = 10},
{id = "EVO_ITEMS", weight = 2},
{id = "ORBS_LOW", weight = 2},
{id = "WANDS_LOW", weight = 4},
{id = "WANDS_MID", weight = 10},
},
[...]
}</pre>

== reward_pools ==

List of all reward pools and the items they contain. You must at least include all pools referenced in the rewards_per_difficulty table, but you can add more.
Entry ids may be either items or other pools. A pool doesn't have to only contain one of the two.
Format: <code><pool id>: {id: string, count: integer, hidden: string, weight: integer}[]</code>
* <pool_id>: the id of the pool. It should be used somewhere else either in this table or in rewards_per_difficulty.
* id: item_id or pool_id. If it matches a pool, count and hidden will be ignored.
* count: Optional. The amount of items awarded. It cannot be higher than the item's max stack. Defaults to the item's max stack.
* hidden: Optional. Hidden value that can be used for various purposes depending on the item. Defaults to "".
* weight: Chance of appearing. Set to 0 or delete altogether to stop an entry from being picked.

=== Example ===
<pre>{
NECESSITIES = {
{id = "seed_reviver", weight = 10},
{id = "berry_leppa", weight = 5},
{id = "berry_oran", weight = 5},
{id = "berry_lum", weight = 5},
{id = "food_apple", weight = 5},
{id = "orb_escape", weight = 5},
{id = "apricorn_plain", weight = 5},
{id = "key",count = 3, weight = 2}
},
AMMO_LOW = {
{id = "ammo_iron_thorn", count = 3, weight = 5},
{id = "ammo_geo_pebble", count = 3, weight = 1},
{id = "ammo_stick", count = 3, weight = 1},
},
[...]
}</pre>

== target_items ==

Ids of items that can be used as targets, divided depending on the job type.
Make sure they're either easy enough to obtain or impossible to lose, depending on the job.
Using stackable items is highly discouraged for all job types, as it may result in odd behaviors.
''Please keep in mind that if you want to use the "mission_" items shown in the example you must either recreate them or copy them over from the example mod.''
Format: <code><job_type_id>: <item_id>[]</code>
* <job_type_id>: the id of a job type defined inside "job_types"
* <item_id>: the id of the item to use

=== Example ===
<pre>{
LOST_ITEM = {
"mission_lost_scarf",
"mission_lost_specs",
"mission_lost_band"
},
OUTLAW_ITEM = {
"mission_stolen_scarf",
"mission_stolen_band",
"mission_stolen_specs"
},
DELIVERY = {
"berry_oran",
"berry_leppa",
"food_apple",
"berry_lum",
"apricorn_plain"
},
[...]
}</pre>

== difficulty_to_tier ==

Weighted table that associates mission difficulty to a specific tier of characters and outlaws.
Format: <code><diff_id>: {id: string, weight: integer}[]</code>
* <diff_id>: one of the difficulties defined in "difficulty_list"
* id: A string that defines a pokémon tier id.
* weight: Chance of being picked. Set to 0 or delete altogether to stop an entry from being picked.

=== Example ===
<pre>{
F = {
{id = "TIER_LOW", weight = 10}
},
E = {
{id = "TIER_LOW", weight = 9},
{id = "TIER_MID", weight = 1}
},
D = {
{id = "TIER_LOW", weight = 7},
{id = "TIER_MID", weight = 3}
},
[...]
}</pre>

== pokemon ==

A list of Pokémon that will be used for job generation, sorted by arbitrary quest tiers.
Any of these entries may be picked when choosing client and target.
If the client picked is not in the seen dex, the reward type can never be "client" nor "exclusive".
Format: <code><tier>: <monster_id>[]</code>
* <tier>: one of the tier ids used in difficulty_to_tier
* <monster_id>: either the species id of a pokémon or a MonsterIDTable
Format of MonsterIDTable: see the "monsterIdTemplate" function in missiongen_lib.lua

=== Example ===
<pre>{
TIER_LOW = {
"abra","amaura","anorith","applin","archen","aron","arrokuda","axew","azurill", [...]
},
[...]
}</pre>

== job_titles ==

A list of all possible job display titles, divided by job type.
You must also include lists for any special job types you intend to use.
Format: <code><job_type_id>: <string_key>[]</code>
* <job_type_id>: either the id of a job type defined inside "job_types", or the id of a special job type
* <string_key>: the localization key used for the title. The localized strings are fetched from the Menu Text list (strings.resx)

Localization placeholders:
* {0}: target
* {1}: dungeon
* {2}: item
* {3}: client

=== Example ===
<pre>
{
RESCUE_SELF = {
"MISSION_TITLE_RESCUE_SELF_001",
"MISSION_TITLE_RESCUE_SELF_002",
"MISSION_TITLE_RESCUE_SELF_003",
"MISSION_TITLE_RESCUE_SELF_004",
[...]
},
[...]
}</pre>

== job_flavor ==

A list of all possible job flavor text entries, divided by job type and by line.
Format: <code><job_type_id>: {<string_key>[], <string_key>[]}</code>
* <job_type_id>: either the id of a job type defined inside "job_types", or the id of a special job type
* <string_key>: the localization key used for the flavor text. Every job has 2 lists assigned: one for the top string and one for the bottom one.
If only the first list is specified, the second one will be left empty.
The localized strings are fetched from the Menu Text list (strings.resx)

Localization placeholders:
* {0}: target
* {1}: dungeon
* {2}: item
* {3}: client

=== Example ===
<pre>
{
RESCUE_SELF = {
{
"MISSION_BODY_TOP_RESCUE_SELF_001",
"MISSION_BODY_TOP_RESCUE_SELF_002",
"MISSION_BODY_TOP_RESCUE_SELF_003",
"MISSION_BODY_TOP_RESCUE_SELF_004",
[...]
},
{
"MISSION_BODY_BOTTOM_RESCUE_SELF_001",
"MISSION_BODY_BOTTOM_RESCUE_SELF_002",
"MISSION_BODY_BOTTOM_RESCUE_SELF_003",
[...]
}
},
[...]
}</pre>

== law_enforcement ==

Law enforcement characters in your setting. All OUTLAW jobs except OUTLAW_ITEM and OUTLAW_ITEM_UNK use these characters as job clients.
You may specify only 1 officer, and then a list containing any number of agents. Two of the latter will be randomly picked every time the job completion cutscene is played.
You may add a weight property to agents to specify a custom chance of being picked. Any without will
have a weight of 1.
Add "unique = true" to the MonsterIDTable to stop an agent from being picked twice. You must
have at least either 1 non-unique agent or 2 unique ones for this list table to be valid.
Format of MonsterIDTable: see the "monsterIdTemplate" function in missiongen_lib.lua

=== Example ===
<pre>
{
OFFICER = {Species = "magnezone", Gender = 0},
AGENT = {
{Species = "magnemite", Gender = 0, Weight = 31},
{Species = "magnemite", Gender = 0, Skin = "shiny", Weight = 1, Unique = true}
}
}</pre>

== enforcer_chance ==

Defines the chance of either the officer or an agent being the client of a mission depending on the character tier of the mission, as defined in difficulty_to_tier.
Format: <code><tier>: {id: string, weight: integer}[]</code>
* <tier>: one of the tier ids used in difficulty_to_tier
* id: One of: OFFICER, AGENT
* index: Optional. Ignored if id is OFFICER. You can set it to specify a specific agent instead of rolling using their chance in "law_enforcement".
* weight: Chance of being picked. Set to 0 or delete altogether to stop an entry from being picked.

=== Example ===
<pre>
{
TIER_LOW = {
{id = "OFFICER", weight = 2},
{id = "AGENT", weight = 8}
},
TIER_MID = {
{id = "OFFICER", weight = 5},
{id = "AGENT", weight = 5}
},
TIER_HIGH = {
{id = "OFFICER", weight = 8},
{id = "AGENT", weight = 2}
}
}</pre>

== special_data ==

Data of characters and flavor key used for special jobs, divided by tier.
In outlaw related quests, you may use ENFORCER as a keyword for a random law enforcement character.
You may also use OFFICER or AGENT to specify a more specific selection.
These keywords can only be used in place of MonsterIDTables.
Format: <code><special_type>: {<tier>: {client: MonsterIDTable, target: MonsterIDTable, item: string, flavor: string}[]}</code>
* <special_type>: an id of your choosing. It must be different from any basic job id
* <tier>: one of the tier ids used in difficulty_to_tier
* client: the data used to generate this Pokémon.
* target: the data used to generate this Pokémon. Only used in job types that require a target.
* item: the id of the item that will be used for this job. Only used in job types that require an item.
* flavor: flavor string key used for the job, sourced from the Menu Text list (strings.resx)
Format of MonsterIDTable: see the "monsterIdTemplate" function in missiongen_lib.lua

Localization placeholders:
* {0}: target
* {1}: dungeon
* {2}: item
* {3}: client

=== Example ===
<pre>{
LOVER = {
TIER_LOW = {
{client = {Species = "volbeat", Gender = 1}, target = {Species = "illumise", Gender = 2}, flavor = "MISSION_BODY_SPECIAL_LOVER_001"},
{client = {Species = "minun", Gender = 1}, target = {Species = "plusle", Gender = 2}, flavor = "MISSION_BODY_SPECIAL_LOVER_002"},
{client = {Species = "mareep", Gender = 2}, target = {Species = "wooloo", Gender = 1}, flavor = "MISSION_BODY_SPECIAL_LOVER_003"},
[...]
},
TIER_MID = {
{client = {Species = "miltank", Gender = 2}, target = {Species = "tauros", Gender = 1}, flavor = "MISSION_BODY_SPECIAL_LOVER_005"},
{client = {Species = "venomoth", Gender = 1}, target = {Species = "butterfree", Gender = 2}, flavor = "MISSION_BODY_SPECIAL_LOVER_006"},
[...]
},
[...]
},
[...]
}</pre>

== escort_talks ==

String keys to be used whenever the player interacts with an escort mission client, depending on the job type.
You can also include tables for special escort jobs. If no such table exists for a specific case, the generic table for the job type will be used.
Format: <code><job_type_id>: <string_key>[]</code>
* <job_type_id>: "ESCORT", "EXPLORATION", or the id of a special job type that corresponds to one of these job types
* <string_key>: the localization key of possible messages. The localized strings are fetched from the Gameplay Text list (stringsEx.resx)

Localization placeholders:
* {0}: target
* {1}: dungeon
* {2}: item

=== Example ===
<pre>
{
ESCORT = {
"MISSION_ESCORT_INTERACT"
},
EXPLORATION = {
"MISSION_EXPLORATION_INTERACT"
}
}</pre>

== rescue_responses ==

Strings keys to be used whenever the player interacts with a pokémon that needs rescue, depending on the job type and the response given.
You must include a "_DEFAULT" table, but you can also include tables for special job types. _DEFAULT will still be used for any special
case that doesn't have a table associated with it.
Format: <code>{rescue_yes: {<case_id>: {key: string, emotion: string}[]}, rescue_no: {<case_id>: {key: string, emotion: string}[]}}</code>
* <case_id>: "_DEFAULT", or the id of a special job type that corresponds to either "RESCUE_SELF" or "RESCUE_FRIEND"
* key: the localization key of possible messages. The localized strings are fetched from the Gameplay Text list (stringsEx.resx)
* emotion: Optional. An emotion id to use with this specific message. Defaults to "Normal"

Localization placeholders:
* {0}: client
* {1}: target
* {2}: dungeon

=== Example ===
<pre>
{
rescue_yes = {
_DEFAULT = { {key = "MISSION_RESCUE_CONFIRM_DEFAULT"} },
CHILD = { {key = "MISSION_RESCUE_CONFIRM_CHILD", emotion = "Joyous"} },
FRIEND = { {key = "MISSION_RESCUE_CONFIRM_FRIEND"} },
RIVAL = { {key = "MISSION_RESCUE_CONFIRM_RIVAL"} },
LOVER = { {key = "MISSION_RESCUE_CONFIRM_LOVER", emotion = "Joyous"} }
},
rescue_no = {
_DEFAULT = { {key = "MISSION_RESCUE_DENY_DEFAULT", emotion = "Surprised"} },
CHILD = { {key = "MISSION_RESCUE_DENY_CHILD", emotion = "Crying"} },
FRIEND = { {key = "MISSION_RESCUE_DENY_FRIEND", emotion = "Surprised"} },
RIVAL = { {key = "MISSION_RESCUE_DENY_RIVAL", emotion = "Stunned"} },
LOVER = { {key = "MISSION_RESCUE_DENY_LOVER", emotion = "Stunned"} }
}
}</pre>

== mission_callback_root ==

The object that contains job callback functions. It is recommended to define this object somewhere else.
Job callbacks are stored inside jobs as strings. These strings are then used as an index in the callback root object to retrieve the actual function.

The callback system is a pretty involved one, that gives a modder the ability to handcraft entirely new types of jobs if they so choose, but is also pretty difficult to handle, so it will be discussed in [[Mod:Nebula's Mission Board/ Job callbacks|its own guide]].

=== Example ===
<pre>COMMON</pre>

== settings.AddDungeonSection(zone, segment, start, difficulty, finish, must_end) ==

Adds a new dungeon section to the list of possible job destinations.
Section start values must always be added in ascending order. Failing to do so may cause inconsistent behaviors.

=== Arguments ===

* <code>zone</code> - <code>string</code>: the string id of the dungeon zone.
* <code>segment</code> - <code>integer</code>: the numeric id of the dungeon segment.
* <code>start</code> - <code>integer</code>: the starting floor of this dungeon section (start counting from 1 for this).
* <code>difficulty</code> - <code>string</code>: the string id of the difficulty assigned to this section.
* <code>finish</code> - <code>integer</code>: Only considered when first adding a segment to the list. Can be omitted otherwise. This will be the last floor of the segment where jobs can spawn (start counting from 1 for this). If higher than the dungeon floors, it will default to the full dungeon length.
* <code>must_end</code> - <code>boolean</code> Only considered when first adding a segment to the list. Can be omitted otherwise. If true, this segment must be completed before jobs can spawn in it. If false, the segment must be accessed at least once, unless it's segment 0, which just needs to be unlocked. Defaults to true.

=== Example ===

<pre>
settings.AddDungeonSection("faultline_ridge", 0, 6, "D", 10)
settings.AddDungeonSection("sickly_hollow", 0, 9, "S", 16, false)
settings.AddDungeonSection("sickly_hollow", 0, 13, "STAR_1")

</pre>

__NOTOC__

Mod:Nebula's Mission Board/ Job callbacks

2025-07-30T15:43:09Z

MistressNebula: Make page

Mod:Nebula's Mission Board/ Editing settings

2025-07-30T13:55:49Z

MistressNebula: /* mission_callback_root */ Redirect

The Mission Generation Library is designed to be highly customizable. This choice is reflected in its <code>missiongen_settings.lua</code> file. This file is what modders are supposed to edit, changing the values inside the giant table it defines.

Here's a list of all settings in the library, with documentation:

== sv_root_name ==

Name of the SV table that will contain all stored data. Use a table to specify a deeper path. If not present in the SV structure, the defined path will be generated automatically. An empty list would just use SV as root.
Examples:
* <code>"jobs"</code> would use <code>SV.jobs</code> as its root.
* <code>{"adventure", "jobs"}</code> would use <code>SV.adventure.jobs</code> as its root.

=== Example ===
<pre>"jobs"</pre>

== boards ==

A list of board ids and the data necessary to define their behavior.
Format for each board:
<pre><nowiki>
<board_id>: {
display_key: string,
size: integer,
location: {
zone: string,
map: integer
},
condition: function(library),
job_types: {id = string, weight = integer}[]
}</nowiki></pre>
* <board_id>: The id of the board. It will be used to identify and reference this specific board inside scripts
* display_key: the string key used when displaying the job menu for this board. The localized strings are fetched from the Menu Text list (strings.resx)
* size: the amount of quests this board can hold at a time
* location: a zone id and a map index. This data is where the player will be brought for the job completion cutscene. All of these maps must call library:PlayJobsCompletedCutscene before fade-in for the reward sequence to work correctly.
* condition: Optional. A function called to determine if library:PopulateBoards() should fill out this board. It receives the library object as an argument and returns a boolean. If it returns true, the board is filled out. If it returns false, it is left empty. If this property is missing, this board will always be active.
* job_types: a list of job types and their probability weight. Higher weight means more common.

=== Example ===
<pre>{
quest_board = {
display_key = "BOARD_QUEST_TITLE",
size = 8,
location = {zone = "guildmaster_island", map = 2},
condition = function (library)
local root = library.root
local completed = 0
for _, segments in pairs(root.dungeon_progress) do
for _, state in pairs(segments) do
if state then
completed = completed + 1
if completed>=3 then return true end
break
end
end
end
return false
end,
job_types = {
{id = "RESCUE_SELF", weight = 5},
{id = "RESCUE_FRIEND", weight = 5},
{id = "ESCORT", weight = 2},
{id = "EXPLORATION", weight = 2},
{id = "DELIVERY", weight = 2},
{id = "LOST_ITEM", weight = 4},
{id = "OUTLAW", weight = 5},
{id = "OUTLAW_ITEM", weight = 2},
{id = "OUTLAW_ITEM_UNK", weight = 1},
{id = "OUTLAW_MONSTER_HOUSE", weight = 1},
{id = "OUTLAW_FLEE", weight = 1}
}
}
}</pre>

== end_dungeon_day_destination ==

Zone and map id of the ground map where players will be sent to when a day ends and there is at least one mission to hand in. This map must contain a call to library:PlayJobsCompletedCutscene
Format: <code>{zone: string, map: integer}</code>

=== Example ===
<pre>{ zone = "guildmaster_island", map = 2 },</pre>

== after_rewards_function ==

Function ran after the game is done with the job completion cutscene. It takes no arguments, and is not expected to return anything.
You can use it to fix up the game state however you like before returning control to the player.

=== Example ===
<pre>
after_rewards_function = function()
GAME:MoveCamera(0, 0, 1, true)
SOUND:PlayBGM(SV.base_town.Song, true)
end</pre>

== taken_limit ==

The maximum number of jobs that can be taken from job boards at a time.

=== Example ===
<pre>8</pre>

== taken_jobs_start_active ==

If true, taken jobs will be activated automatically. Players can always deactivate them manually if they so choose.

=== Example ===
<pre>true</pre>

== max_guests ==

The maximum amount of guest-based jobs that can be generated in the same dungeon.
Guest-based jobs are: ESCORT, EXPLORATION

=== Example ===
<pre>1</pre>

== guests_take_up_space ==

The maximum amount of guest-based jobs that can be generated in the same dungeon.
Guest-based jobs are: ESCORT, EXPLORATION

=== Example ===
<pre>1</pre>

== min_party_limit ==

Minimum number for the party limit when it is reduced because of guests.
This value cannot be lower than 1, for obvious reasons.
Any excess guests will simply add to the party count, without reducing the limit.

=== Example ===
<pre>1</pre>

== losing_guests_means_defeat ==

If true, losing any guest will count as a loss for the entire exploration.
If false, it will simply mark that specific job as failed.

=== Example ===
<pre>false</pre>

== dungeon_boss_steps_piority ==

The priority of the SpawnOutlaw handler event. It can be either an integer or a list of integers.
This value should always be lower than dungeon_gen_steps_piority.

=== Example ===
<pre>-11</pre>

== dungeon_gen_steps_piority ==

The priority that most of the job handlers will have when being added to the event list. It can be either an integer or a list of integers.
This value should always be equal to or higher than the priority set for the event that calls library:GenerateJobInFloor.

=== Example ===
<pre>-6</pre>

== dungeon_npc_steps_piority ==

The priority that job npc spawners will have when being added to the event list. It can be either an integer or a list of integers.
This value should always be equal to or higher than dungeon_gen_steps_piority.

=== Example ===
<pre>{ 5, 2, 1 }</pre>

== difficulty_list ==

A list of all difficulty rank id strings you want to use.
The order of these strings will define the difficulty scale used by the library.

=== Example ===
<pre>{ "F", "E", "D", "C", "B", "A", "S", "STAR_1", "STAR_2", "STAR_3", "STAR_4", "STAR_5", "STAR_6", "STAR_7", "STAR_8", "STAR_9" }</pre>

== difficulty_data ==

All the data required to define difficulty rank behavior. There must be an entry for every rank defined in difficulty_list:
Format: <code><diff_id>: {display_key: string, money_reward: integer, extra_reward: integer, outlaw_level: integer, escort_level: integer}</code>
* <diff_id>: one of the difficulties defined in "difficulty_list"
* display_key: string key used when displaying the name of the rank. The localized strings are fetched from the Menu Text list (strings.resx)
* money_reward: the amount of money awarded at the end of the job. If set to 0, money rewards will simply not award anything
* extra_reward: the points of extra reward awarded at the end of the job. What these points are depends on extra_reward_type. If set to 0, extra_reward_type will be considered to be "none"
* outlaw_level: Optional. The base level of all outlaws spawned by jobs with this difficulty. If omitted, it will be equal to the dungeon's expected level.
* escort_level: Optional. The level of all guests spawned by jobs with this difficulty. If omitted, it will be equal to the dungeon's expected level.

=== Example ===
<pre>
{
F = {display_key = "RANK_STRING_F", money_reward = 100, extra_reward = 0},
E = {display_key = "RANK_STRING_E", money_reward = 200, extra_reward = 100},
D = {display_key = "RANK_STRING_D", money_reward = 400, extra_reward = 200},
C = {display_key = "RANK_STRING_C", money_reward = 600, extra_reward = 400},
B = {display_key = "RANK_STRING_B", money_reward = 700, extra_reward = 1250},
A = {display_key = "RANK_STRING_A", money_reward = 1500, extra_reward = 2500},
S = {display_key = "RANK_STRING_S", money_reward = 3000, extra_reward = 5000},
STAR_1 = {display_key = "RANK_STRING_STAR_1", money_reward = 6000, extra_reward = 10000},
STAR_2 = {display_key = "RANK_STRING_STAR_2", money_reward = 10000, extra_reward = 20000},
STAR_3 = {display_key = "RANK_STRING_STAR_3", money_reward = 15000, extra_reward = 30000},
STAR_4 = {display_key = "RANK_STRING_STAR_4", money_reward = 20000, extra_reward = 40000},
STAR_5 = {display_key = "RANK_STRING_STAR_5", money_reward = 25000, extra_reward = 50000},
STAR_6 = {display_key = "RANK_STRING_STAR_6", money_reward = 30000, extra_reward = 60000},
STAR_7 = {display_key = "RANK_STRING_STAR_7", money_reward = 35000, extra_reward = 70000},
STAR_8 = {display_key = "RANK_STRING_STAR_8", money_reward = 40000, extra_reward = 80000},
STAR_9 = {display_key = "RANK_STRING_STAR_9", money_reward = 45000, extra_reward = 90000}
}</pre>

== guest_level_scaling ==

Function that changes the level of guests based on the player's level. It must return the new level for the guest, or it will have no effect.
Arguments:
* lvl: base level of the guest.
* dungeon: if true, the level is the dungeon's recommended level. If false, it's taken from the difficulty data.
* avg_team_lvl: average level of the player team. It may or may not be an integer.
* hst_team_lvl: highest level in the player team.
* settings: the settings data structure itself

=== Example ===
<pre>
function(lvl, dungeon, avg_team_lvl, hst_team_lvl, settings)
local add = 0
if dungeon then lvl = lvl*4//5 end
if avg_team_lvl > lvl then add = (avg_team_lvl - lvl) // 10 end
return lvl + add
end
</pre>

== outlaw_level_scaling ==

Function that changes the level of guests based on the player's level. It must return the new level for the guest, or it will have no effect.
Arguments:
* lvl: base level of the guest.
* dungeon: if true, the level is the dungeon's recommended level. If false, it's taken from the difficulty data.
* avg_team_lvl: average level of the player team. It may or may not be an integer.
* hst_team_lvl: highest level in the player team.
* settings: the settings data structure itself

=== Example ===
<pre>
function(lvl, dungeon, avg_team_lvl, hst_team_lvl, settings)
local add = 0
if dungeon then lvl = lvl*23//20 end
if avg_team_lvl > lvl then add = (avg_team_lvl - lvl) // 8 end
add = add + (hst_team_lvl - avg_team_lvl) // 4
return lvl + add
end
</pre>

== apply_outlaw_changes ==

Function that allows you to edit an outlaw's data just before they are spawned.
You can change just about anything except its position and recruitability state. Its HP will also
always be automatically set to full after this function is called.
You will also be unable to change the EquippedItem of an "OUTLAW_ITEM" or "OUTLAW_ITEM_UNK" outlaw.
Arguments:
* outlaw: the outlaw Character itself
* job: the current job data table

=== Example ===
<pre>
function(outlaw, job)
local max_boost = PMDC.Data.MonsterFormData.MAX_STAT_BOOST
outlaw.MaxHPBonus = math.min(outlaw.Level * max_boost // 64, max_boost);
if job.Type == "OUTLAW_FLEE" then
local speedMin = math.floor(outlaw.Level * 4 // 3)
local speedMax = math.floor(outlaw.Level * 6 // 2)
outlaw.SpeedBonus = math.min(_DATA.Save.Rand:Next(speedMin, speedMax), 100)
end
end
</pre>

== fleeing_outlaw_restrictions ==

A list of ids for types that are banned from ever being picked as fleeing outlaws.

=== Example ===
<pre>{ "ghost" }</pre>

== outlaw_music_name ==

The name of the outlaw music file. This file will be sourced from the Content/Music folder.

=== Example ===
<pre>"Outlaw.ogg"</pre>

== dungeons ==

This is where dungeon difficulty is set. Quests can only generate for dungeons inside this list.
Given the complexity of this structure, it is best generated using the [[Mod:Nebula's Mission Board/ Editing settings#settings.AddDungeonSection(zone, segment, start, difficulty, finish, must_end)||AddDungeonSection]] function at the bottom of this page.

== dungeon_order ==

Jobs are sorted by dungeon, following the order defined in this table. Missing dungeons are shoved at the bottom and sorted alphabetically.
This list is automatically populated in call order when using the "AddDungeonSection" function near the bottom of this file.

== external_events ==

A list of events unrelated to this library that can cause job generation to ignore a specific dungeon.
They can also be displayed in the objectives log if you so choose.
Format: <code>{condition: function(zone), message_key: string, message_args: function(zone), icon: string}</code>
* condition: a function that takes a zone and returns a boolean. If it returns true, jobs will not be generated for this dungeon, and all already taken jobs will be automatically suspended.
* message_key: Optional. It will be used in the objectives log instead of the default message if the condition is true.
* message_args: Optional. If the message's localization string contains placeholders, this function is in charge of taking a zone and returning a list of values that will be used for those placeholders in the form of a table array (Up to 5).
* icon: Optional. The icon that will be displayed beside the corresponding dungeon in the dungeon selection menu if the condition is true for any of its segments. Defaults to ""

=== Example ===
<pre>
{
{condition = function(zone) return COMMON.HasSidequestInZone(zone) end, icon = "\\uE111", message_key = "MENU_JOB_OBJECTIVE_DEFAULT"}
}
</pre>

== external_events_icon_mode ==

How to display external event icons in the dungeon list. This value can only be either "FIRST" or ALL".
* If set to "ALL", they will always be displayed in the order defined by external_events. Only one copy of the same icon will be shown, no matter how many conditions require it.
* If set to "FIRST", only the first event in the list's order will be displayed, no matter how many events are actually there. This setting does not prevent multiple messages from appearing in the objectives list.

=== Example ===
<pre>"FIRST"</pre>

== dungeon_list_pattern ==

The pattern that will define how to display entries in the dungeon list.
{0} is the placeholder for the dungeon name, {1} for pending job icon and {2} for external condition icons.

=== Example ===
<pre>"FIRST"</pre>

== job_types ==

Table used to determine various properties regarding job types.
Remove a job type entirely to disable its generation altogether.
Format: <code><job_type_id>: {rank_modifier: integer, min_rank: string}</code>
* <job_type_id>: one of RESCUE_SELF, RESCUE_FRIEND, ESCORT, EXPLORATION, DELIVERY, LOST_ITEM, OUTLAW, OUTLAW_ITEM, OUTLAW_ITEM_UNK, OUTLAW_MONSTER_HOUSE, OUTLAW_FLEE
* rank_modifier (optional): these jobs will always have this modifier applied to their rank.
* min_rank (optional): this type of jobs can never be of a rank lower than this.
: This influences possible dungeon spawn: a rank_modifier 1 job with min_rank "C" can also spawn in "D" rank dungeons.

=== Example ===
<pre>{
RESCUE_SELF = {rank_modifier = 0, min_rank = "F"},
RESCUE_FRIEND = {rank_modifier = 0, min_rank = "E"},
ESCORT = {rank_modifier = 1, min_rank = "C"},
EXPLORATION = {rank_modifier = 1, min_rank = "C"},
DELIVERY = {rank_modifier = 0, min_rank = "D"},
LOST_ITEM = {rank_modifier = 0, min_rank = "D"},
OUTLAW = {rank_modifier = 1, min_rank = "C"},
OUTLAW_ITEM = {rank_modifier = 1, min_rank = "C"},
OUTLAW_ITEM_UNK = {rank_modifier = 1, min_rank = "C"},
OUTLAW_MONSTER_HOUSE = {rank_modifier = 2, min_rank = "S"},
OUTLAW_FLEE = {rank_modifier = 1, min_rank = "B"}
}
</pre>

== dungeon_job_modifiers ==

Special table that allows modders to specify chance multipliers for job types depending on the dungeon.
Format: <code><dungeon_id>: {<job_type_id>: <multiplier>}</code>
* <dungeon_id>: the string id of a dungeon
* <job_type_id>: one of RESCUE_SELF, RESCUE_FRIEND, ESCORT, EXPLORATION, DELIVERY, LOST_ITEM, OUTLAW, OUTLAW_ITEM, OUTLAW_ITEM_UNK, OUTLAW_MONSTER_HOUSE, OUTLAW_FLEE
* <multiplier>: a multiplier number. It doesn't need to be an integer. It will be multiplied with the board's base chances, rounding up, when choosing the type of a job. Set it to 0 or less to disable the job type altogether.

=== Example ===
<pre>{
ambush_forest = {
OUTLAW = 3,
OUTLAW_ITEM = 3,
OUTLAW_ITEM_UNK = 3,
OUTLAW_MONSTER_HOUSE = 3,
OUTLAW_FLEE = 3
},
treacherous_mountain = {
OUTLAW = 3,
OUTLAW_ITEM = 3,
OUTLAW_ITEM_UNK = 3,
OUTLAW_MONSTER_HOUSE = 3,
OUTLAW_FLEE = 3
}
}
</pre>

== special_chance ==

Chance of special missions to be generated. Special missions are just handcrafted scenarios with specific client and target pairs and custom flavor texts. Set to 0 to disable altogether.

=== Example ===
<pre>0.2</pre>

== special_jobs ==

This is where you can define special cases for specific types of jobs.
Format: <code><job_type_id>: <special_id>[]</code>
* <job_type_id>: one of RESCUE_SELF, RESCUE_FRIEND, ESCORT, EXPLORATION, DELIVERY, LOST_ITEM, OUTLAW, OUTLAW_ITEM, OUTLAW_ITEM_UNK, OUTLAW_MONSTER_HOUSE, OUTLAW_FLEE
* <special_id>: any id of your choosing except RESCUE_SELF, RESCUE_FRIEND, ESCORT, EXPLORATION, DELIVERY, LOST_ITEM, OUTLAW, OUTLAW_ITEM, OUTLAW_ITEM_UNK, OUTLAW_MONSTER_HOUSE, OUTLAW_FLEE

=== Example ===
<pre>{
RESCUE_FRIEND = {"CHILD", "LOVER", "RIVAL", "FRIEND"}
}</pre>

== hidden_floor_chance ==

Chance for supported quest types to have their destination floor hidden. Set to 0 to disable altogether.
Players will still be notified when reaching the floor. It just won't show in the quest description.
Job types that can have their floor hidden are: RESCUE_FRIEND, EXPLORATION, OUTLAW, OUTLAW_ITEM, OUTLAW_ITEM_UNK, OUTLAW_FLEE.

=== Example ===
<pre>0.15</pre>

== reward_types ==

A list of all types of rewards to be offered to players.
Format: <code>{id: string, weight: integer, min_rank: string}</code>
* id: one of the supported reward types. You can use duplicate values to alter odds depending on job rank.
: Supported reward types are: item, money, item_item, money_item, client, exclusive
* weight: Chance of appearing. Set to 0 or delete altogether to stop a type of reward from being offered.
* min_rank: optional. If set, this type of reward will only be offered if the job is this rank or higher.

=== Example ===
<pre>{
{id = "item", weight = 6},
{id = "money", weight = 2},
{id = "item_item", weight = 3},
{id = "money_item", weight = 1},
{id = "client", weight = 1, min_rank = "STAR_1"},
{id = "exclusive", weight = 1, min_rank = "STAR_4"}
}</pre>

== extra_reward_type ==

The type of extra reward for all quests. It can be "none", "rank" or "exp". Any other value will result in "none".

=== Example ===
<pre>"exp"</pre>

== rewards_per_difficulty ==

This table assigns different weights to reward pools depending on the difficulty rank of the mission.
Format: <code><diff_id>: {id: string, weight: integer}[]</code>
* <diff_id>: one of the difficulties defined in difficulty_list"
* id: the id of one of the reward pools defined in "reward_pools"
* weight: Chance of appearing. Set to 0 or delete altogether to stop a reward pool from being picked.

=== Example ===
<pre>{
F = {
{id = "NECESSITIES", weight = 10}
},
E = {
{id = "NECESSITIES", weight = 10},
{id = "APRICORN_GENERIC", weight = 10},
{id = "FOOD_LOW", weight = 10},
{id = "SEED_LOW", weight = 10},
{id = "HELD_LOW", weight = 3},
{id = "LOOT_LOW", weight = 3},
{id = "EVO_ITEMS", weight = 1},
{id = "WANDS_LOW", weight = 10}
},
D = {
{id = "NECESSITIES", weight = 5},
{id = "AMMO_LOW", weight = 10},
{id = "APRICORN_GENERIC", weight = 10},
{id = "APRICORN_TYPED", weight = 2},
{id = "FOOD_LOW", weight = 4},
{id = "SEED_LOW", weight = 4},
{id = "SEED_MID", weight = 10},
{id = "HELD_LOW", weight = 10},
{id = "HELD_TYPE", weight = 3},
{id = "LOOT_LOW", weight = 10},
{id = "EVO_ITEMS", weight = 2},
{id = "ORBS_LOW", weight = 2},
{id = "WANDS_LOW", weight = 4},
{id = "WANDS_MID", weight = 10},
},
[...]
}</pre>

== reward_pools ==

List of all reward pools and the items they contain. You must at least include all pools referenced in the rewards_per_difficulty table, but you can add more.
Entry ids may be either items or other pools. A pool doesn't have to only contain one of the two.
Format: <code><pool id>: {id: string, count: integer, hidden: string, weight: integer}[]</code>
* <pool_id>: the id of the pool. It should be used somewhere else either in this table or in rewards_per_difficulty.
* id: item_id or pool_id. If it matches a pool, count and hidden will be ignored.
* count: Optional. The amount of items awarded. It cannot be higher than the item's max stack. Defaults to the item's max stack.
* hidden: Optional. Hidden value that can be used for various purposes depending on the item. Defaults to "".
* weight: Chance of appearing. Set to 0 or delete altogether to stop an entry from being picked.

=== Example ===
<pre>{
NECESSITIES = {
{id = "seed_reviver", weight = 10},
{id = "berry_leppa", weight = 5},
{id = "berry_oran", weight = 5},
{id = "berry_lum", weight = 5},
{id = "food_apple", weight = 5},
{id = "orb_escape", weight = 5},
{id = "apricorn_plain", weight = 5},
{id = "key",count = 3, weight = 2}
},
AMMO_LOW = {
{id = "ammo_iron_thorn", count = 3, weight = 5},
{id = "ammo_geo_pebble", count = 3, weight = 1},
{id = "ammo_stick", count = 3, weight = 1},
},
[...]
}</pre>

== target_items ==

Ids of items that can be used as targets, divided depending on the job type.
Make sure they're either easy enough to obtain or impossible to lose, depending on the job.
Using stackable items is highly discouraged for all job types, as it may result in odd behaviors.
''Please keep in mind that if you want to use the "mission_" items shown in the example you must either recreate them or copy them over from the example mod.''
Format: <code><job_type_id>: <item_id>[]</code>
* <job_type_id>: the id of a job type defined inside "job_types"
* <item_id>: the id of the item to use

=== Example ===
<pre>{
LOST_ITEM = {
"mission_lost_scarf",
"mission_lost_specs",
"mission_lost_band"
},
OUTLAW_ITEM = {
"mission_stolen_scarf",
"mission_stolen_band",
"mission_stolen_specs"
},
DELIVERY = {
"berry_oran",
"berry_leppa",
"food_apple",
"berry_lum",
"apricorn_plain"
},
[...]
}</pre>

== difficulty_to_tier ==

Weighted table that associates mission difficulty to a specific tier of characters and outlaws.
Format: <code><diff_id>: {id: string, weight: integer}[]</code>
* <diff_id>: one of the difficulties defined in "difficulty_list"
* id: A string that defines a pokémon tier id.
* weight: Chance of being picked. Set to 0 or delete altogether to stop an entry from being picked.

=== Example ===
<pre>{
F = {
{id = "TIER_LOW", weight = 10}
},
E = {
{id = "TIER_LOW", weight = 9},
{id = "TIER_MID", weight = 1}
},
D = {
{id = "TIER_LOW", weight = 7},
{id = "TIER_MID", weight = 3}
},
[...]
}</pre>

== pokemon ==

A list of Pokémon that will be used for job generation, sorted by arbitrary quest tiers.
Any of these entries may be picked when choosing client and target.
If the client picked is not in the seen dex, the reward type can never be "client" nor "exclusive".
Format: <code><tier>: <monster_id>[]</code>
* <tier>: one of the tier ids used in difficulty_to_tier
* <monster_id>: either the species id of a pokémon or a MonsterIDTable
Format of MonsterIDTable: see the "monsterIdTemplate" function in missiongen_lib.lua

=== Example ===
<pre>{
TIER_LOW = {
"abra","amaura","anorith","applin","archen","aron","arrokuda","axew","azurill", [...]
},
[...]
}</pre>

== job_titles ==

A list of all possible job display titles, divided by job type.
You must also include lists for any special job types you intend to use.
Format: <code><job_type_id>: <string_key>[]</code>
* <job_type_id>: either the id of a job type defined inside "job_types", or the id of a special job type
* <string_key>: the localization key used for the title. The localized strings are fetched from the Menu Text list (strings.resx)

Localization placeholders:
* {0}: target (or client, if there is no target)
* {1}: dungeon
* {2}: item

=== Example ===
<pre>
{
RESCUE_SELF = {
"MISSION_TITLE_RESCUE_SELF_001",
"MISSION_TITLE_RESCUE_SELF_002",
"MISSION_TITLE_RESCUE_SELF_003",
"MISSION_TITLE_RESCUE_SELF_004",
[...]
},
[...]
}</pre>

== job_flavor ==

A list of all possible job flavor text entries, divided by job type and by line.
Format: <code><job_type_id>: {<string_key>[], <string_key>[]}</code>
* <job_type_id>: either the id of a job type defined inside "job_types", or the id of a special job type
* <string_key>: the localization key used for the flavor text. Every job has 2 lists assigned: one for the top string and one for the bottom one.
If only the first list is specified, the second one will be left empty.
The localized strings are fetched from the Menu Text list (strings.resx)

Localization placeholders:
* {0}: target (or client, if there is no target)
* {1}: dungeon
* {2}: item

=== Example ===
<pre>
{
RESCUE_SELF = {
{
"MISSION_BODY_TOP_RESCUE_SELF_001",
"MISSION_BODY_TOP_RESCUE_SELF_002",
"MISSION_BODY_TOP_RESCUE_SELF_003",
"MISSION_BODY_TOP_RESCUE_SELF_004",
[...]
},
{
"MISSION_BODY_BOTTOM_RESCUE_SELF_001",
"MISSION_BODY_BOTTOM_RESCUE_SELF_002",
"MISSION_BODY_BOTTOM_RESCUE_SELF_003",
[...]
}
},
[...]
}</pre>

== law_enforcement ==

Law enforcement characters in your setting. All OUTLAW jobs except OUTLAW_ITEM and OUTLAW_ITEM_UNK use these characters as job clients.
You may specify only 1 officer, and then a list containing any number of agents. Two of the latter will be randomly picked every time the job completion cutscene is played.
You may add a weight property to agents to specify a custom chance of being picked. Any without will
have a weight of 1.
Add "unique = true" to the MonsterIDTable to stop an agent from being picked twice. You must
have at least either 1 non-unique agent or 2 unique ones for this list table to be valid.
Format of MonsterIDTable: see the "monsterIdTemplate" function in missiongen_lib.lua

=== Example ===
<pre>
{
OFFICER = {Species = "magnezone", Gender = 0},
AGENT = {
{Species = "magnemite", Gender = 0, Weight = 31},
{Species = "magnemite", Gender = 0, Skin = "shiny", Weight = 1, Unique = true}
}
}</pre>

== enforcer_chance ==

Defines the chance of either the officer or an agent being the client of a mission depending on the character tier of the mission, as defined in difficulty_to_tier.
Format: <code><tier>: {id: string, weight: integer}[]</code>
* <tier>: one of the tier ids used in difficulty_to_tier
* id: One of: OFFICER, AGENT
* index: Optional. Ignored if id is OFFICER. You can set it to specify a specific agent instead of rolling using their chance in "law_enforcement".
* weight: Chance of being picked. Set to 0 or delete altogether to stop an entry from being picked.

=== Example ===
<pre>
{
TIER_LOW = {
{id = "OFFICER", weight = 2},
{id = "AGENT", weight = 8}
},
TIER_MID = {
{id = "OFFICER", weight = 5},
{id = "AGENT", weight = 5}
},
TIER_HIGH = {
{id = "OFFICER", weight = 8},
{id = "AGENT", weight = 2}
}
}</pre>

== special_data ==

Data of characters and flavor key used for special jobs, divided by tier.
In outlaw related quests, you may use ENFORCER as a keyword for a random law enforcement character.
You may also use OFFICER or AGENT to specify a more specific selection.
These keywords can only be used in place of MonsterIDTables.
Format: <code><special_type>: {<tier>: {client: MonsterIDTable, target: MonsterIDTable, item: string, flavor: string}[]}</code>
* <special_type>: an id of your choosing. It must be different from any basic job id
* <tier>: one of the tier ids used in difficulty_to_tier
* client: the data used to generate this Pokémon.
* target: the data used to generate this Pokémon. Only used in job types that require a target.
* item: the id of the item that will be used for this job. Only used in job types that require an item.
* flavor: flavor string key used for the job, sourced from the Menu Text list (strings.resx)
Format of MonsterIDTable: see the "monsterIdTemplate" function in missiongen_lib.lua

Localization placeholders:
* {0}: target (or client, if there is no target)
* {1}: dungeon
* {2}: item

=== Example ===
<pre>{
LOVER = {
TIER_LOW = {
{client = {Species = "volbeat", Gender = 1}, target = {Species = "illumise", Gender = 2}, flavor = "MISSION_BODY_SPECIAL_LOVER_001"},
{client = {Species = "minun", Gender = 1}, target = {Species = "plusle", Gender = 2}, flavor = "MISSION_BODY_SPECIAL_LOVER_002"},
{client = {Species = "mareep", Gender = 2}, target = {Species = "wooloo", Gender = 1}, flavor = "MISSION_BODY_SPECIAL_LOVER_003"},
[...]
},
TIER_MID = {
{client = {Species = "miltank", Gender = 2}, target = {Species = "tauros", Gender = 1}, flavor = "MISSION_BODY_SPECIAL_LOVER_005"},
{client = {Species = "venomoth", Gender = 1}, target = {Species = "butterfree", Gender = 2}, flavor = "MISSION_BODY_SPECIAL_LOVER_006"},
[...]
},
[...]
},
[...]
}</pre>

== escort_talks ==

String keys to be used whenever the player interacts with an escort mission client, depending on the job type.
You can also include tables for special escort jobs. If no such table exists for a specific case, the generic table for the job type will be used.
Format: <code><job_type_id>: <string_key>[]</code>
* <job_type_id>: "ESCORT", "EXPLORATION", or the id of a special job type that corresponds to one of these job types
* <string_key>: the localization key of possible messages. The localized strings are fetched from the Gameplay Text list (stringsEx.resx)

Localization placeholders:
* {0}: target
* {1}: dungeon
* {2}: item

=== Example ===
<pre>
{
ESCORT = {
"MISSION_ESCORT_INTERACT"
},
EXPLORATION = {
"MISSION_EXPLORATION_INTERACT"
}
}</pre>

== rescue_responses ==

Strings keys to be used whenever the player interacts with a pokémon that needs rescue, depending on the job type and the response given.
You must include a "_DEFAULT" table, but you can also include tables for special job types. _DEFAULT will still be used for any special
case that doesn't have a table associated with it.
Format: <code>{rescue_yes: {<case_id>: {key: string, emotion: string}[]}, rescue_no: {<case_id>: {key: string, emotion: string}[]}}</code>
* <case_id>: "_DEFAULT", or the id of a special job type that corresponds to either "RESCUE_SELF" or "RESCUE_FRIEND"
* key: the localization key of possible messages. The localized strings are fetched from the Gameplay Text list (stringsEx.resx)
* emotion: Optional. An emotion id to use with this specific message. Defaults to "Normal"

Localization placeholders:
* {0}: client
* {1}: target
* {2}: dungeon

=== Example ===
<pre>
{
rescue_yes = {
_DEFAULT = { {key = "MISSION_RESCUE_CONFIRM_DEFAULT"} },
CHILD = { {key = "MISSION_RESCUE_CONFIRM_CHILD", emotion = "Joyous"} },
FRIEND = { {key = "MISSION_RESCUE_CONFIRM_FRIEND"} },
RIVAL = { {key = "MISSION_RESCUE_CONFIRM_RIVAL"} },
LOVER = { {key = "MISSION_RESCUE_CONFIRM_LOVER", emotion = "Joyous"} }
},
rescue_no = {
_DEFAULT = { {key = "MISSION_RESCUE_DENY_DEFAULT", emotion = "Surprised"} },
CHILD = { {key = "MISSION_RESCUE_DENY_CHILD", emotion = "Crying"} },
FRIEND = { {key = "MISSION_RESCUE_DENY_FRIEND", emotion = "Surprised"} },
RIVAL = { {key = "MISSION_RESCUE_DENY_RIVAL", emotion = "Stunned"} },
LOVER = { {key = "MISSION_RESCUE_DENY_LOVER", emotion = "Stunned"} }
}
}</pre>

== mission_callback_root ==

The object that contains job callback functions. It is recommended to define this object somewhere else.
Job callbacks are stored inside jobs as strings. These strings are then used as an index in the callback root object to retrieve the actual function.

The callback system is a pretty involved one, that gives a modder the ability to handcraft entirely new types of jobs if they so choose, but is also pretty difficult to handle, so it will be discussed in [[Mod:Nebula's Mission Board/ Job callbacks|its own guide]].

=== Example ===
<pre>COMMON</pre>

== settings.AddDungeonSection(zone, segment, start, difficulty, finish, must_end) ==

Adds a new dungeon section to the list of possible job destinations.
Section start values must always be added in ascending order. Failing to do so may cause inconsistent behaviors.

=== Arguments ===

* <code>zone</code> - <code>string</code>: the string id of the dungeon zone.
* <code>segment</code> - <code>integer</code>: the numeric id of the dungeon segment.
* <code>start</code> - <code>integer</code>: the starting floor of this dungeon section (start counting from 1 for this).
* <code>difficulty</code> - <code>string</code>: the string id of the difficulty assigned to this section.
* <code>finish</code> - <code>integer</code>: Only considered when first adding a segment to the list. Can be omitted otherwise. This will be the last floor of the segment where jobs can spawn (start counting from 1 for this). If higher than the dungeon floors, it will default to the full dungeon length.
* <code>must_end</code> - <code>boolean</code> Only considered when first adding a segment to the list. Can be omitted otherwise. If true, this segment must be completed before jobs can spawn in it. If false, the segment must be accessed at least once, unless it's segment 0, which just needs to be unlocked. Defaults to true.

=== Example ===

<pre>
settings.AddDungeonSection("faultline_ridge", 0, 6, "D", 10)
settings.AddDungeonSection("sickly_hollow", 0, 9, "S", 16, false)
settings.AddDungeonSection("sickly_hollow", 0, 13, "STAR_1")

</pre>

__NOTOC__

Mod:Nebula's Mission Board

2025-07-29T20:21:14Z

MistressNebula: Link github

[[User:MistressNebula|Nebula]]'s Mission Board is a mod that adds a mission board to the base PMDO game, allowing players to embark in missions to gain special items and money and to gain experience.
It looks and plays essentially the same as the base game's Enable Mission Board mod, except that all job generation and job handling functions are dealt with by a highly customizable library bundled within the mod, built with the express purpose of being as easy to import and implement as possible while giving experienced modders the tools they need to make even more complex systems and behaviors.
You can download the mod [https://github.com/435THz/NebulaMissionBoard here].

== PMDO Mission Generation Library ==
The library itself is fully contained inside the Data/Script/missiongen_lib folder inside the mod. By taking this folder and moving it to your mod, you will have access to all of its functions. Remember to credit MistressNebula if you include this library in your project!

Do keep in mind that simply moving the files inside your mod is not enough to set up the library: you will also need to hook all of the necessary events to your mod. Please refer to the links at the bottom of this page for a more in-depth guide on how to do it.

===== How the library is structured =====
The library is broken up into 5 files:
* <code>missiongen_lib.lua</code> is the core file of the library. It's where the most important structures, functions and global variables are defined and handled, as well as the one containing all the hooks that mods are expected to use to interface with it.
* <code>missiongen_settings.lua</code> contains a table of parameters and properties used by the library to function. This is the file that modders are supposed to edit to alter the behavior of the library. Every setting is documented individually, describing its format, what it is used for and what kind of data it requires. The file is loaded directly by the main file, and is not supposed to be loaded directly.
* <code>missiongen_menus.lua</code> is a file whose sole purpose is to contain the menus used by the library. It is loaded automatically by the main file, and its functions are not supposed to be interacted with directly.
* <code>missiongen_service.lua</code> is the file that contains the service required by the library to handle loading, menu edits and dungeon completion tracking. It needs to be loaded separately from the main file. This file also contains the only value outside of the settings file that MIGHT require changing. More details in the setup guide below.
* <code>missiongen_devcheck.lua</code> contains a function, called by the main file when loading, whose purpose is to check, to the best of its abilities, if the values inside the settings file are valid, and print the results of its test to the console. If this file is deleted or misplaced, the check will simply be skipped. This file is only loaded when the game is in [[Dev Mode]]. If you hear the music restart when loading your save data, it's because of this file.

===== Setup guides =====
* [[Mod:Nebula's Mission Board/Basic setup|Basic setup]]
* [[Mod:Nebula's Mission Board/ Hook implementations|Hook implementations]]
* [[Mod:Nebula's Mission Board/ Editing settings|Editing settings]]
* [[Mod:Nebula's Mission Board/ String keys|String keys]]

===== Easy guides =====
* [[Mod:Nebula's Mission Board/ Job boards|Setting up job boards]]
* [[Mod:Nebula's Mission Board/ Reward cutscenes|Making reward cutscenes]]
** [[Mod:Nebula's Mission Board/ Job Table|Job Table Documentation]]

===== Intermediate guide =====
* [[Mod:Nebula's Mission Board/ Handcrafted jobs|Making handcrafted jobs]]

===== Advanced guide =====
* [[Mod:Nebula's Mission Board/ Job callbacks|Job callbacks]]

Modding Hub

2025-07-29T20:19:03Z

MistressNebula: /* Scripts */ Add User link

== Tutorials ==
If it's your first time making a mod, start here:
* [[Modding Intro]]
* [https://www.youtube.com/playlist?list=PLXlJTVdeyhO-rQnuRU7A0BIxutM8mL0Wg Audino's Video Tutorials]

Optional but ''highly'' recommended:
* [[Getting Started With Git]]

=== Graphics ===
* [[Modding Portraits and Sprites]]
* [[Modding Objects and VFX]]
* [[Modding Tilesets]]
* [[Modding Font]]

=== Audio ===
* [[Modding Music]]

=== Dungeon Generation ===
* [[Creating Dungeons]] by editing Tropical Path
* [[Creating Dungeons from Scratch]]
** [[Using Themes]]
** [[Using SpreadPlans]]
** [[Creating Dungeon Shops]]
** [[Creating Monster Houses]]
** [[Creating Vaults]]
** [[Creating Mid-Dungeon Boss Rooms]]
** [[Creating Branching Dungeons]]
* [[Creating Dungeon Maps]]
* [[Custom Floor Generation Steps]]

=== Game Mechanics ===
* [[Creating Items]]
** [[Creating TMs]]
* [[Creating Moves]]
* [[Creating Map Statuses]] (i.e. weather and field effects)
* [[Creating New Types]]
* [[Creating Terrain]]
* [[Creating New Pokémon]]

=== Ground Maps and Cutscenes ===
* [[Creating Ground Maps]]
* [[Creating Ground Map NPCs]]
* [[Custom Ground Item Actions]]

=== Scripting ===
* [[Services]]
* [[Making Custom Menus]]
** [[Editing the Top Menu]]
** [[Editing the Main Menu]]
* [[Lua Conversion Guide|Converting C# classes to Lua]]
* [[Avoiding Desyncs]] in replays and quicksaves
* [[Basic Zone Scripts]]

=== Miscellaneous ===
* [[Manual Install]]
* [[Contributing Code]] to the engine

== Documentation ==

* [[Dev Mode]]

=== Graphics ===
* [[PMD Sprite Format]]
* [[Sprite Tool|Sprite Tool Manual]]
* [[Mass Sprite Import]] (Advanced. Modders can skip this page.)

=== Audio ===
* [[Ogg Tags]]

=== Dungeon Generation ===
* [[Floor Generation Overview]]
* [[Zone Step Overview]]

=== Game Mechanics ===
* [[AI Overview]]
* Pokémon [[Spawn Features]]
* [[Move Ranges]]
* [[Map Statuses]] (weather, Electric Terrain, Trick Room, etc.)
* [[Terrain]]
** Floor [[Darkness]]
* [[Statistics]]
* [[Status Conditions]]
* [[Recruitment]]
* [[Traps]]
* [[:Category:Moves|Moves]]
* [[:Category:Items|Items]]
* [[:Category:Abilities|Abilities]]
* [[:Category:Game Mechanics|Misc. game mechanics]]

=== Ground Maps and Cutscenes ===
* [[Text Guide|Text Tag Guide]]

=== Scripting ===
* [[Script Reference]]
** [[Scripting Cheat Sheet]]
* [[Service Events]]
* [[Random Number Generators]]
* Data Structure Documentation
** [[BattleContext Reference| BattleContext]]
** [[BattleData Reference| BattleData]] (Effects of moves, items, etc.)
** [[DataManager Reference| DataManager]] (_DATA module)
** [[IntrinsicData Reference| IntrinsicData]] (Abilities)
** [[ItemData Reference| ItemData]] (Items)
** [[MapStatusData Reference| MapStatusData]] (Map Statuses/Weather)
** [[MonsterData Reference| MonsterData]] (Pokémon)
** [[SkillData Reference| SkillData]] (Moves)
** [[StatusData Reference| StatusData]] (Status conditions)
** [[TileData Reference| TileData]] (Traps et. al.)
* [[Modding Strings]]
* [[List of BattleEvents]]

=== Miscellaneous ===
* [[Controller Support]]
* C# [[Code Documentation]] links

== Free-to-use Resources ==

=== Scripts ===
* [[SingleEvent Scripts]] (custom dungeon events)
* [[BattleEvent Scripts]] (custom moves/abilities/items etc.)
* [[Mod:Nebula's Mission Board|Mission Generation Library]] by [[User:MistressNebula|MistressNebula]]

=== Graphics ===
* [https://drive.google.com/drive/u/0/folders/1OzUciIeuqk2GsQ7Q645vBi4yRjToKBWV PMD Cleaned Assets] by [[User:Imbion|Imbion]] for cleaned Explorers and Rescuers assets, including some tilesets. Credit should be either linked to the drive itself or to PMD Cleaned Assets.

==== Ground Map Props ====
* [https://drive.google.com/drive/folders/1Mp-8VpNXNdnfI-hZk7eEiuKGscZZ3lXJ "New Neighborhood November" town assets] by [https://bsky.app/profile/jaidonkin.bsky.social/ JaiFain]
* [https://www.dropbox.com/scl/fi/owxfyzqqegvrb96l5pq2m/House-sprites.png?rlkey=pwrkfnhq1kjs1aowvtk3csswt&st=7nizxe4v&dl=0 Rescue Team-style house sprites] by oulongtea

==== Pokémon Sprites ====
* [https://sprites.pmdcollab.org/ SpriteCollab]. Most of these are in PMDO already. If you use something that wasn't, you '''must''' credit the artist in your mod.
* [https://nsc.pmdcollab.org/ NotSpriteCollab]. Non-Pokémon sprites. You '''must''' credit the artist in your mod if you use these.

=== Music ===
* [https://drive.google.com/file/d/1oNXa9SO45sNwuTdYnbFsvsmMzctnlhOs/view?usp=sharing Rescue Team, Explorers, Gates to Infinity, and Zwei!! looped OGG files]

[[Category: Modding]]

Modding Hub

2025-07-29T20:17:55Z

MistressNebula: /* Scripts */ Add Mission Generation Library

== Tutorials ==
If it's your first time making a mod, start here:
* [[Modding Intro]]
* [https://www.youtube.com/playlist?list=PLXlJTVdeyhO-rQnuRU7A0BIxutM8mL0Wg Audino's Video Tutorials]

Optional but ''highly'' recommended:
* [[Getting Started With Git]]

=== Graphics ===
* [[Modding Portraits and Sprites]]
* [[Modding Objects and VFX]]
* [[Modding Tilesets]]
* [[Modding Font]]

=== Audio ===
* [[Modding Music]]

=== Dungeon Generation ===
* [[Creating Dungeons]] by editing Tropical Path
* [[Creating Dungeons from Scratch]]
** [[Using Themes]]
** [[Using SpreadPlans]]
** [[Creating Dungeon Shops]]
** [[Creating Monster Houses]]
** [[Creating Vaults]]
** [[Creating Mid-Dungeon Boss Rooms]]
** [[Creating Branching Dungeons]]
* [[Creating Dungeon Maps]]
* [[Custom Floor Generation Steps]]

=== Game Mechanics ===
* [[Creating Items]]
** [[Creating TMs]]
* [[Creating Moves]]
* [[Creating Map Statuses]] (i.e. weather and field effects)
* [[Creating New Types]]
* [[Creating Terrain]]
* [[Creating New Pokémon]]

=== Ground Maps and Cutscenes ===
* [[Creating Ground Maps]]
* [[Creating Ground Map NPCs]]
* [[Custom Ground Item Actions]]

=== Scripting ===
* [[Services]]
* [[Making Custom Menus]]
** [[Editing the Top Menu]]
** [[Editing the Main Menu]]
* [[Lua Conversion Guide|Converting C# classes to Lua]]
* [[Avoiding Desyncs]] in replays and quicksaves
* [[Basic Zone Scripts]]

=== Miscellaneous ===
* [[Manual Install]]
* [[Contributing Code]] to the engine

== Documentation ==

* [[Dev Mode]]

=== Graphics ===
* [[PMD Sprite Format]]
* [[Sprite Tool|Sprite Tool Manual]]
* [[Mass Sprite Import]] (Advanced. Modders can skip this page.)

=== Audio ===
* [[Ogg Tags]]

=== Dungeon Generation ===
* [[Floor Generation Overview]]
* [[Zone Step Overview]]

=== Game Mechanics ===
* [[AI Overview]]
* Pokémon [[Spawn Features]]
* [[Move Ranges]]
* [[Map Statuses]] (weather, Electric Terrain, Trick Room, etc.)
* [[Terrain]]
** Floor [[Darkness]]
* [[Statistics]]
* [[Status Conditions]]
* [[Recruitment]]
* [[Traps]]
* [[:Category:Moves|Moves]]
* [[:Category:Items|Items]]
* [[:Category:Abilities|Abilities]]
* [[:Category:Game Mechanics|Misc. game mechanics]]

=== Ground Maps and Cutscenes ===
* [[Text Guide|Text Tag Guide]]

=== Scripting ===
* [[Script Reference]]
** [[Scripting Cheat Sheet]]
* [[Service Events]]
* [[Random Number Generators]]
* Data Structure Documentation
** [[BattleContext Reference| BattleContext]]
** [[BattleData Reference| BattleData]] (Effects of moves, items, etc.)
** [[DataManager Reference| DataManager]] (_DATA module)
** [[IntrinsicData Reference| IntrinsicData]] (Abilities)
** [[ItemData Reference| ItemData]] (Items)
** [[MapStatusData Reference| MapStatusData]] (Map Statuses/Weather)
** [[MonsterData Reference| MonsterData]] (Pokémon)
** [[SkillData Reference| SkillData]] (Moves)
** [[StatusData Reference| StatusData]] (Status conditions)
** [[TileData Reference| TileData]] (Traps et. al.)
* [[Modding Strings]]
* [[List of BattleEvents]]

=== Miscellaneous ===
* [[Controller Support]]
* C# [[Code Documentation]] links

== Free-to-use Resources ==

=== Scripts ===
* [[SingleEvent Scripts]] (custom dungeon events)
* [[BattleEvent Scripts]] (custom moves/abilities/items etc.)
* [[Mod:Nebula's Mission Board|Mission Generation Library]] by MistressNebula

=== Graphics ===
* [https://drive.google.com/drive/u/0/folders/1OzUciIeuqk2GsQ7Q645vBi4yRjToKBWV PMD Cleaned Assets] by [[User:Imbion|Imbion]] for cleaned Explorers and Rescuers assets, including some tilesets. Credit should be either linked to the drive itself or to PMD Cleaned Assets.

==== Ground Map Props ====
* [https://drive.google.com/drive/folders/1Mp-8VpNXNdnfI-hZk7eEiuKGscZZ3lXJ "New Neighborhood November" town assets] by [https://bsky.app/profile/jaidonkin.bsky.social/ JaiFain]
* [https://www.dropbox.com/scl/fi/owxfyzqqegvrb96l5pq2m/House-sprites.png?rlkey=pwrkfnhq1kjs1aowvtk3csswt&st=7nizxe4v&dl=0 Rescue Team-style house sprites] by oulongtea

==== Pokémon Sprites ====
* [https://sprites.pmdcollab.org/ SpriteCollab]. Most of these are in PMDO already. If you use something that wasn't, you '''must''' credit the artist in your mod.
* [https://nsc.pmdcollab.org/ NotSpriteCollab]. Non-Pokémon sprites. You '''must''' credit the artist in your mod if you use these.

=== Music ===
* [https://drive.google.com/file/d/1oNXa9SO45sNwuTdYnbFsvsmMzctnlhOs/view?usp=sharing Rescue Team, Explorers, Gates to Infinity, and Zwei!! looped OGG files]

[[Category: Modding]]

Mod:Nebula's Mission Board

2025-07-29T18:54:12Z

MistressNebula: /* Advanced guide */ Redirect

[[User:MistressNebula|Nebula]]'s Mission Board is a mod that adds a mission board to the base PMDO game, allowing players to embark in missions to gain special items and money and to gain experience.
It looks and plays essentially the same as the base game's Enable Mission Board mod, except that all job generation and job handling functions are dealt with by a highly customizable library bundled within the mod, built with the express purpose of being as easy to import and implement as possible while giving experienced modders the tools they need to make even more complex systems and behaviors.

== PMDO Mission Generation Library ==
The library itself is fully contained inside the Data/Script/missiongen_lib folder inside the mod. By taking this folder and moving it to your mod, you will have access to all of its functions. Remember to credit MistressNebula if you include this library in your project!

Do keep in mind that simply moving the files inside your mod is not enough to set up the library: you will also need to hook all of the necessary events to your mod. Please refer to the links at the bottom of this page for a more in-depth guide on how to do it.

===== How the library is structured =====
The library is broken up into 5 files:
* <code>missiongen_lib.lua</code> is the core file of the library. It's where the most important structures, functions and global variables are defined and handled, as well as the one containing all the hooks that mods are expected to use to interface with it.
* <code>missiongen_settings.lua</code> contains a table of parameters and properties used by the library to function. This is the file that modders are supposed to edit to alter the behavior of the library. Every setting is documented individually, describing its format, what it is used for and what kind of data it requires. The file is loaded directly by the main file, and is not supposed to be loaded directly.
* <code>missiongen_menus.lua</code> is a file whose sole purpose is to contain the menus used by the library. It is loaded automatically by the main file, and its functions are not supposed to be interacted with directly.
* <code>missiongen_service.lua</code> is the file that contains the service required by the library to handle loading, menu edits and dungeon completion tracking. It needs to be loaded separately from the main file. This file also contains the only value outside of the settings file that MIGHT require changing. More details in the setup guide below.
* <code>missiongen_devcheck.lua</code> contains a function, called by the main file when loading, whose purpose is to check, to the best of its abilities, if the values inside the settings file are valid, and print the results of its test to the console. If this file is deleted or misplaced, the check will simply be skipped. This file is only loaded when the game is in [[Dev Mode]]. If you hear the music restart when loading your save data, it's because of this file.

===== Setup guides =====
* [[Mod:Nebula's Mission Board/Basic setup|Basic setup]]
* [[Mod:Nebula's Mission Board/ Hook implementations|Hook implementations]]
* [[Mod:Nebula's Mission Board/ Editing settings|Editing settings]]
* [[Mod:Nebula's Mission Board/ String keys|String keys]]

===== Easy guides =====
* [[Mod:Nebula's Mission Board/ Job boards|Setting up job boards]]
* [[Mod:Nebula's Mission Board/ Reward cutscenes|Making reward cutscenes]]
** [[Mod:Nebula's Mission Board/ Job Table|Job Table Documentation]]

===== Intermediate guide =====
* [[Mod:Nebula's Mission Board/ Handcrafted jobs|Making handcrafted jobs]]

===== Advanced guide =====
* [[Mod:Nebula's Mission Board/ Job callbacks|Job callbacks]]

Mod:Nebula's Mission Board/ Handcrafted jobs

2025-07-29T18:53:05Z

MistressNebula: Redirect

The Mission Generation Library contains a method that allows the creation of basic jobs with arbitrarily chosen parameters. These jobs do not have to abide by any of the rules that the normal job generation uses, so do keep in mind that you might have to run a few checks to make sure you're not going off script, or to simply give the job to the player only when the rules are all respected. You can also choose not to care, of course, but that might have some consequences depending on what isn't being respected.
Here's a quick rundown of the rules followed by the library, and how to check if your desired job data would break them:
* '''No two jobs should be on the same floor''' - If this is not respected, the player will only be able to keep one of the jobs active at the same time.
: Check with: <code>MissionGen:IsDestinationOccupied(zone, segment, floor)</code>
* '''The number of guest jobs in the same dungeon should not be higher than "max_guests"''' - This might make the adventure more difficult if "guests_take_up_space" is true, because the game might remove more party members than expected.
: Check with: <code>MissionGen:GetDungeonsGuestCount()[zone]</code>

After handling all the rules you care about respecting, you can move on to actually creating the job. This is done with the following function:
<pre>MissionGen:MakeNewJob(zone, segment, floor, job_type, client, target, target_item, reward_type, rewards, title, flavor, hide_floor, objective_key)</pre>
As you can see, there are a lot of parameters, though the great majority of them is optional. Those that are will have a <code>?</code> beside its type. Any missing parameter that is required for the given job type to function will be generated randomly:
* <code>zone</code> - <code>string</code>: The id of the zone this job takes place in.

* <code>segment</code> - <code>integer</code>: The specific segment this job takes place in.

* <code>floor</code> - <code>integer</code>: The destination floor of this job.

* <code>job_type</code> - <code>string</code>: The id of the type of this job. It must always be equal to one of the following values: "RESCUE_SELF", "RESCUE_FRIEND", "ESCORT", "EXPLORATION", "DELIVERY", "LOST_ITEM", "OUTLAW", "OUTLAW_ITEM", "OUTLAW_ITEM_UNK", "OUTLAW_MONSTER_HOUSE", "OUTLAW_FLEE".

* <code>client</code> - <code>string|monsterIDTable</code>: Data that will be used for the client of this job. If it's not a mosterIdTable (see below), it must be either "ENFORCER", "OFFICER" or "AGENT". A law enforcement character will be selected using different rules depending on the string.

* <code>target</code> - <code>string|monsterIDTable</code>: Data that will be used for the target of this job. If it's not a mosterIdTable (see below), it must be either "ENFORCER", "OFFICER" or "AGENT". A law enforcement character will be selected using different rules depending on the string. This value will be used only if the job type requires a target.

* <code>target_item</code> - <code>string?</code>: The id of the item that will be used as target. This value will be used only if the job type requires an item.

* <code>reward_type</code> - <code>string?</code>: The combination of rewards that will be awarded for this job. It must always be equal to one of the following values: "item", "money", "item_item", "money_item", "client", "exclusive". If <code>rewards</code> is set, this value will be inferred from the items used, even if a value was already provided.

* <code>rewards</code> - <code>{string|itemTable?, string|itemTable?}</code>: The item rewards that will be awarded for this job. If not set but <code>reward_type</code> is, they will be generated automatically. You can either write only the id of the item, or use a full itemTable (see below). If the first item is nil, it will award money in its place.

* <code>title</code> - <code>string?</code>: The string key to use for this job's title. If not set, it will be chosen randomly.

* <code>flavor</code> - <code>{string, string?}?</code>: The string key, or keys, to use for this job's flavor text. If not set, they will be chosen randomly.

* <code>hide_floor</code> - <code>boolean?</code>: If true, the job's floor will be hidden when viewing the job inside menus.

* <code>objective_key</code> - <code>string?</code> A string key that will be used instead of the job_type one to display this job's objective.

'''monsterIDTable'''
<pre>{
Species:string,
Form:integer,
Skin:string,
Gender:integer,
Nickname:string?
}</pre>

'''itemTable'''
<pre>{id:string, count:integer?, hidden:string?}</pre>

<code>MakeNewJob</code> will return a fully-formed [[Mod:Nebula's Mission Board/ Job Table|JobTable]], which can then be edited further either indirectly or with other functions. Once you're done, however, you will need to add a BackReference to it, otherwise the game won't know where to send the player for the reward cutscene. This can be done in two ways, depending on what you want to accomplish; if you want to give the job directly to the player, you can do this:
<pre>
MissionGen:SetBackReference(<job>, <board_id>)
MissionGen:AddJobToTaken(<job>, <startActive>)
</pre>
where:
* <code>job</code> is the JobTable.
* <code>board_id</code> is the board the job should bring the player to after completing it.
* <code>startActive</code> is an optional boolean that tells the game whether or not to set the job as active as it gets added to the taken list. Defaults to <code>false</code>.
If, instead of giving it directly to the player, you want to add the job to a board, you can do this:
<pre>
MissionGen:AddJobToBoard(<board_id>, <job>)
</pre>
where:
* <code>board_id</code> is the board the job will be added to, and that will be set as BackReference.
* <code>job</code> is the JobTable.
With this done, the job is now fully set up and can be safely presented to the player.

Mod:Nebula's Mission Board

2025-07-29T18:52:01Z

MistressNebula: /* Intermediate guide */ Redirect

[[User:MistressNebula|Nebula]]'s Mission Board is a mod that adds a mission board to the base PMDO game, allowing players to embark in missions to gain special items and money and to gain experience.
It looks and plays essentially the same as the base game's Enable Mission Board mod, except that all job generation and job handling functions are dealt with by a highly customizable library bundled within the mod, built with the express purpose of being as easy to import and implement as possible while giving experienced modders the tools they need to make even more complex systems and behaviors.

== PMDO Mission Generation Library ==
The library itself is fully contained inside the Data/Script/missiongen_lib folder inside the mod. By taking this folder and moving it to your mod, you will have access to all of its functions. Remember to credit MistressNebula if you include this library in your project!

Do keep in mind that simply moving the files inside your mod is not enough to set up the library: you will also need to hook all of the necessary events to your mod. Please refer to the links at the bottom of this page for a more in-depth guide on how to do it.

===== How the library is structured =====
The library is broken up into 5 files:
* <code>missiongen_lib.lua</code> is the core file of the library. It's where the most important structures, functions and global variables are defined and handled, as well as the one containing all the hooks that mods are expected to use to interface with it.
* <code>missiongen_settings.lua</code> contains a table of parameters and properties used by the library to function. This is the file that modders are supposed to edit to alter the behavior of the library. Every setting is documented individually, describing its format, what it is used for and what kind of data it requires. The file is loaded directly by the main file, and is not supposed to be loaded directly.
* <code>missiongen_menus.lua</code> is a file whose sole purpose is to contain the menus used by the library. It is loaded automatically by the main file, and its functions are not supposed to be interacted with directly.
* <code>missiongen_service.lua</code> is the file that contains the service required by the library to handle loading, menu edits and dungeon completion tracking. It needs to be loaded separately from the main file. This file also contains the only value outside of the settings file that MIGHT require changing. More details in the setup guide below.
* <code>missiongen_devcheck.lua</code> contains a function, called by the main file when loading, whose purpose is to check, to the best of its abilities, if the values inside the settings file are valid, and print the results of its test to the console. If this file is deleted or misplaced, the check will simply be skipped. This file is only loaded when the game is in [[Dev Mode]]. If you hear the music restart when loading your save data, it's because of this file.

===== Setup guides =====
* [[Mod:Nebula's Mission Board/Basic setup|Basic setup]]
* [[Mod:Nebula's Mission Board/ Hook implementations|Hook implementations]]
* [[Mod:Nebula's Mission Board/ Editing settings|Editing settings]]
* [[Mod:Nebula's Mission Board/ String keys|String keys]]

===== Easy guides =====
* [[Mod:Nebula's Mission Board/ Job boards|Setting up job boards]]
* [[Mod:Nebula's Mission Board/ Reward cutscenes|Making reward cutscenes]]
** [[Mod:Nebula's Mission Board/ Job Table|Job Table Documentation]]

===== Intermediate guide =====
* [[Mod:Nebula's Mission Board/ Handcrafted jobs|Making handcrafted jobs]]

===== Advanced guide =====
* [[MissionGen guide: Job callbacks|Job callbacks]]

User:MistressNebula/MissionGen: Handcrafted jobs

2025-07-29T18:51:06Z

MistressNebula: MistressNebula moved page User:MistressNebula/MissionGen: Handcrafted jobs to Mod:Nebula's Mission Board/ Handcrafted jobs: Move to Mod namespace

#REDIRECT [[Mod:Nebula's Mission Board/ Handcrafted jobs]]

Mod:Nebula's Mission Board/ Handcrafted jobs

2025-07-29T18:51:06Z

MistressNebula: MistressNebula moved page User:MistressNebula/MissionGen: Handcrafted jobs to Mod:Nebula's Mission Board/ Handcrafted jobs: Move to Mod namespace

The Mission Generation Library contains a method that allows the creation of basic jobs with arbitrarily chosen parameters. These jobs do not have to abide by any of the rules that the normal job generation uses, so do keep in mind that you might have to run a few checks to make sure you're not going off script, or to simply give the job to the player only when the rules are all respected. You can also choose not to care, of course, but that might have some consequences depending on what isn't being respected.
Here's a quick rundown of the rules followed by the library, and how to check if your desired job data would break them:
* '''No two jobs should be on the same floor''' - If this is not respected, the player will only be able to keep one of the jobs active at the same time.
: Check with: <code>MissionGen:IsDestinationOccupied(zone, segment, floor)</code>
* '''The number of guest jobs in the same dungeon should not be higher than "max_guests"''' - This might make the adventure more difficult if "guests_take_up_space" is true, because the game might remove more party members than expected.
: Check with: <code>MissionGen:GetDungeonsGuestCount()[zone]</code>

After handling all the rules you care about respecting, you can move on to actually creating the job. This is done with the following function:
<pre>MissionGen:MakeNewJob(zone, segment, floor, job_type, client, target, target_item, reward_type, rewards, title, flavor, hide_floor, objective_key)</pre>
As you can see, there are a lot of parameters, though the great majority of them is optional. Those that are will have a <code>?</code> beside its type. Any missing parameter that is required for the given job type to function will be generated randomly:
* <code>zone</code> - <code>string</code>: The id of the zone this job takes place in.

* <code>segment</code> - <code>integer</code>: The specific segment this job takes place in.

* <code>floor</code> - <code>integer</code>: The destination floor of this job.

* <code>job_type</code> - <code>string</code>: The id of the type of this job. It must always be equal to one of the following values: "RESCUE_SELF", "RESCUE_FRIEND", "ESCORT", "EXPLORATION", "DELIVERY", "LOST_ITEM", "OUTLAW", "OUTLAW_ITEM", "OUTLAW_ITEM_UNK", "OUTLAW_MONSTER_HOUSE", "OUTLAW_FLEE".

* <code>client</code> - <code>string|monsterIDTable</code>: Data that will be used for the client of this job. If it's not a mosterIdTable (see below), it must be either "ENFORCER", "OFFICER" or "AGENT". A law enforcement character will be selected using different rules depending on the string.

* <code>target</code> - <code>string|monsterIDTable</code>: Data that will be used for the target of this job. If it's not a mosterIdTable (see below), it must be either "ENFORCER", "OFFICER" or "AGENT". A law enforcement character will be selected using different rules depending on the string. This value will be used only if the job type requires a target.

* <code>target_item</code> - <code>string?</code>: The id of the item that will be used as target. This value will be used only if the job type requires an item.

* <code>reward_type</code> - <code>string?</code>: The combination of rewards that will be awarded for this job. It must always be equal to one of the following values: "item", "money", "item_item", "money_item", "client", "exclusive". If <code>rewards</code> is set, this value will be inferred from the items used, even if a value was already provided.

* <code>rewards</code> - <code>{string|itemTable?, string|itemTable?}</code>: The item rewards that will be awarded for this job. If not set but <code>reward_type</code> is, they will be generated automatically. You can either write only the id of the item, or use a full itemTable (see below). If the first item is nil, it will award money in its place.

* <code>title</code> - <code>string?</code>: The string key to use for this job's title. If not set, it will be chosen randomly.

* <code>flavor</code> - <code>{string, string?}?</code>: The string key, or keys, to use for this job's flavor text. If not set, they will be chosen randomly.

* <code>hide_floor</code> - <code>boolean?</code>: If true, the job's floor will be hidden when viewing the job inside menus.

* <code>objective_key</code> - <code>string?</code> A string key that will be used instead of the job_type one to display this job's objective.

'''monsterIDTable'''
<pre>{
Species:string,
Form:integer,
Skin:string,
Gender:integer,
Nickname:string?
}</pre>

'''itemTable'''
<pre>{id:string, count:integer?, hidden:string?}</pre>

<code>MakeNewJob</code> will return a fully-formed [[User:MistressNebula/MissionGen: Job Table|JobTable]], which can then be edited further either indirectly or with other functions. Once you're done, however, you will need to add a BackReference to it, otherwise the game won't know where to send the player for the reward cutscene. This can be done in two ways, depending on what you want to accomplish; if you want to give the job directly to the player, you can do this:
<pre>
MissionGen:SetBackReference(<job>, <board_id>)
MissionGen:AddJobToTaken(<job>, <startActive>)
</pre>
where:
* <code>job</code> is the JobTable.
* <code>board_id</code> is the board the job should bring the player to after completing it.
* <code>startActive</code> is an optional boolean that tells the game whether or not to set the job as active as it gets added to the taken list. Defaults to <code>false</code>.
If, instead of giving it directly to the player, you want to add the job to a board, you can do this:
<pre>
MissionGen:AddJobToBoard(<board_id>, <job>)
</pre>
where:
* <code>board_id</code> is the board the job will be added to, and that will be set as BackReference.
* <code>job</code> is the JobTable.
With this done, the job is now fully set up and can be safely presented to the player.

Mod:Nebula's Mission Board/ Reward cutscenes

2025-07-29T18:03:12Z

MistressNebula: Redirect

When players leave a dungeon successfully after completing at least one job, they will be brought to the map defined inside the <code>[[Mod:Nebula's Mission Board/ Editing settings#end_dungeon_day_destination|end_dungeon_day_destination]]</code> setting. The library will then expect your code to use the reward handler here.
Do note that the end_dungeon_day_destination can also be a place where you assigned one or more job boards. It doesn't need to be a completely separate place.

Go to your <code>end_dungeon_day_destination</code>'s <code>Enter</code> function and paste this code in it, before any kind of fade-in occurs:
<pre>if MissionGen:HasCompletedMissions() then
MissionGen:PlayJobsCompletedCutscene()
end</pre>
If the map has no job board assigned to it, this is already everything you need to do. <code>PlayJobsCompletedCutscene</code> will move the flow of execution to the maps where the completed jobs' board is set and then simply return, letting those maps handle the rest.
If that is not the case, however, you will also need to write the reward cutscene, and then pass it to the function like so:
<pre>
MissionGen:PlayJobsCompletedCutscene(<callback>)
</pre>
This should be done in any map where there's a job board.

=== Writing a Reward Cutscene ===
When <code>PlayJobsCompletedCutscene</code> is called, it looks for the first completed job in the taken list. If the board that job has been taken from is not assigned to the current map, the player is transported to the correct map, where another instance of the function is then expected to run. If the map is correct, however, a list of [https://github.com/RogueCollab/RogueEssence/blob/master/RogueEssence/Ground/GroundChar.cs GroundChars] is created and then passed to the callback you provided the function with, alongside the job table itself. In other words, the callback needs to be a function with the following signature:
<pre>
function(job, npcs)
</pre>
where:
* <code>job</code> is the Job Table. See the [[Mod:Nebula's Mission Board/ Job Table|Job Table Documentation]] page for more details
* <code>npcs</code> is the list of GroundChars, already added to the map at the coordinates 0, 0. It contains 4 characters for law enforcement jobs, 2 for jobs with a friendly target, and 1 for jobs with no targets

This function is what needs to implement the reward cutscene. You can use the job data and the number of npcs created to move the characters to the correct positions, differentiate between multiple boardss in the same map, if you have to, and then display a different introductory dialogue depending on the job type. Then, whenever you need to actually give the rewards to your players, call the following function
<pre>MissionGen:RewardPlayer(job, speaker, line1, line2)</pre>
where:
* <code>job</code> is the Job Table, needed to read what the rewards are
* <code>speaker</code> is the character that will say the lines given in the next parameters. If omitted, the lines will be displayed with no speaker.
* <code>line1</code> is the line that <code>speaker</code> will say before giving the first reward to the player, unless the client itself is the reward
* <code>line2</code> is the line that <code>speaker</code> will say before giving the second reward to the player, if it exists

This function will handle everything in regards to rewards, without moving the characters around. You will then be able to add more actions after it returns.

When the cutscene is done, simply add a fade-out, and you'll be good to go. <code>PlayJobsCompletedCutscene</code> will dispose of the characters and move to the next completed job, or return control to the player if there are no more completed jobs.

Mod:Nebula's Mission Board

2025-07-29T18:01:31Z

MistressNebula: /* Easy guides */ Redirect

[[User:MistressNebula|Nebula]]'s Mission Board is a mod that adds a mission board to the base PMDO game, allowing players to embark in missions to gain special items and money and to gain experience.
It looks and plays essentially the same as the base game's Enable Mission Board mod, except that all job generation and job handling functions are dealt with by a highly customizable library bundled within the mod, built with the express purpose of being as easy to import and implement as possible while giving experienced modders the tools they need to make even more complex systems and behaviors.

== PMDO Mission Generation Library ==
The library itself is fully contained inside the Data/Script/missiongen_lib folder inside the mod. By taking this folder and moving it to your mod, you will have access to all of its functions. Remember to credit MistressNebula if you include this library in your project!

Do keep in mind that simply moving the files inside your mod is not enough to set up the library: you will also need to hook all of the necessary events to your mod. Please refer to the links at the bottom of this page for a more in-depth guide on how to do it.

===== How the library is structured =====
The library is broken up into 5 files:
* <code>missiongen_lib.lua</code> is the core file of the library. It's where the most important structures, functions and global variables are defined and handled, as well as the one containing all the hooks that mods are expected to use to interface with it.
* <code>missiongen_settings.lua</code> contains a table of parameters and properties used by the library to function. This is the file that modders are supposed to edit to alter the behavior of the library. Every setting is documented individually, describing its format, what it is used for and what kind of data it requires. The file is loaded directly by the main file, and is not supposed to be loaded directly.
* <code>missiongen_menus.lua</code> is a file whose sole purpose is to contain the menus used by the library. It is loaded automatically by the main file, and its functions are not supposed to be interacted with directly.
* <code>missiongen_service.lua</code> is the file that contains the service required by the library to handle loading, menu edits and dungeon completion tracking. It needs to be loaded separately from the main file. This file also contains the only value outside of the settings file that MIGHT require changing. More details in the setup guide below.
* <code>missiongen_devcheck.lua</code> contains a function, called by the main file when loading, whose purpose is to check, to the best of its abilities, if the values inside the settings file are valid, and print the results of its test to the console. If this file is deleted or misplaced, the check will simply be skipped. This file is only loaded when the game is in [[Dev Mode]]. If you hear the music restart when loading your save data, it's because of this file.

===== Setup guides =====
* [[Mod:Nebula's Mission Board/Basic setup|Basic setup]]
* [[Mod:Nebula's Mission Board/ Hook implementations|Hook implementations]]
* [[Mod:Nebula's Mission Board/ Editing settings|Editing settings]]
* [[Mod:Nebula's Mission Board/ String keys|String keys]]

===== Easy guides =====
* [[Mod:Nebula's Mission Board/ Job boards|Setting up job boards]]
* [[Mod:Nebula's Mission Board/ Reward cutscenes|Making reward cutscenes]]
** [[Mod:Nebula's Mission Board/ Job Table|Job Table Documentation]]

===== Intermediate guide =====
* [[User:MistressNebula/MissionGen: Handcrafted jobs|Making handcrafted jobs]]

===== Advanced guide =====
* [[MissionGen guide: Job callbacks|Job callbacks]]

User:MistressNebula/MissionGen: Job Table

2025-07-29T18:00:42Z

MistressNebula: MistressNebula moved page User:MistressNebula/MissionGen: Job Table to Mod:Nebula's Mission Board/ Job Table: Move to Mod namespace

#REDIRECT [[Mod:Nebula's Mission Board/ Job Table]]

Mod:Nebula's Mission Board/ Job Table

2025-07-29T18:00:42Z

MistressNebula: MistressNebula moved page User:MistressNebula/MissionGen: Job Table to Mod:Nebula's Mission Board/ Job Table: Move to Mod namespace

This page contains a list of all fields contained inside a Job Table.
Fields with a ? to their side can be safely set to <code>nil</code> depending on the circumstances.

==== Client ====
A MonsterID-style table describing the client of the job.
====== Type ======
<pre>{
Species:string,
Form:integer?,
Skin:string?,
Gender:integer?,
Nickname:string?
}</pre>

==== Target ====
MonsterID style table describing the target. Must be set if the job type expects a target.
====== Type ======
<pre>{
Species:string,
Form:integer?,
Skin:string?,
Gender:integer?,
Nickname:string?
}?</pre>

==== Flavor ====
Pair of string keys displayed when the job details are displayed. The second key is optional.
====== Type ======
<pre>{string, string?}</pre>

==== Title ====
String key displayed when browsing quest boards.
====== Type ======
<pre>string</pre>

==== Zone ====
The id of the zone this job takes place in.
====== Type ======
<pre>string</pre>

==== Segment ====
The specific segment this job takes place in.
====== Type ======
<pre>integer</pre>

==== Floor ====
The destination floor of this job.
====== Type ======
<pre>integer</pre>

==== RewardType ====
The id of the combination of rewards that will be awarded by this job. It must always be equal to one of the following values:
<code>"money"</code>, <code>"item"</code>, <code>"money_item"</code>, <code>"item_item"</code>, <code>"client"</code>, <code>"exclusive"</code>
====== Type ======
<pre>string</pre>

==== Reward1 ====
Data of the first item awarded by the job. Must be set if RewardType expects a visible item reward.
====== Type ======
<pre>{id:string, count:integer?, hidden:string?}?</pre>

==== Reward2 ====
Data of the second item awarded by the job. Must be set if RewardType expects a hidden item reward.
====== Type ======
<pre>{id:string, count:integer?, hidden:string?}?</pre>

==== Type ====
The id of the type of this job. It must always be equal to one of the following values:
<code>"RESCUE_SELF"</code>, <code>"RESCUE_FRIEND"</code>, <code>"ESCORT"</code>, <code>"EXPLORATION"</code>, <code>"DELIVERY"</code>, <code>"LOST_ITEM"</code>, <code>"OUTLAW"</code>, <code>"OUTLAW_ITEM"</code>, <code>"OUTLAW_ITEM_UNK"</code>, <code>"OUTLAW_MONSTER_HOUSE"</code>, <code>"OUTLAW_FLEE"</code>
====== Type ======
<pre>string</pre>

==== Completion ====
The state of the job. -1 means failed. 0 means not completed. 1 means completed. This is always reset to 0 on day end if the job rewards are not claimed (like when an adventure is failed).
====== Type ======
<pre>integer</pre>

==== Taken ====
This variable means different things depending on what list this job is in:
* Taken list: if true, the job is active.
* Boards: if true, the job is considered to be inside the taken list.
====== Type ======
<pre>boolean</pre>

==== BackReference ====
Contains the id of the board it was in. It is used only in the taken list for discarding jobs and for routing the player during the reward process.
====== Type ======
<pre>string?</pre>

==== Difficulty ====
The difficulty index of this job. It is stored as a number instead of a string for ease of calculations.
====== Type ======
<pre>integer</pre>

==== Item ====
The id of the item this job requires. It must be set if the job type requires a target item.
====== Type ======
<pre>string?</pre>

==== Special ====
Special jobs can be triggered sometimes. If so, this will contain the special job category id.
====== Type ======
<pre>string?</pre>

==== HideFloor ====
If this is true, the target floor of this job will be hidden when inside menus.
====== Type ======
<pre>boolean</pre>

==== Callbacks ====
Table of callbacks with their respective parameters. Empty by default. You can add callbacks using the <code>RegisterCallback</code> library function. Every job can only have one callback per event.
====== Type ======
<pre>table<string, {name:string, args:table}></pre>

==== ObjectiveOverride ====
A string key that, if set, is used instead of the job type's objective key. It only affects menus.

Localization placeholders:
* {0}: client
* {1}: target
* {2}: item
====== Type ======
<pre>string?</pre>
__NOTOC__

User:MistressNebula/MissionGen: Job boards

2025-07-29T17:59:51Z

MistressNebula: MistressNebula moved page User:MistressNebula/MissionGen: Job boards to Mod:Nebula's Mission Board/ Job boards: Move to Mod namespace

#REDIRECT [[Mod:Nebula's Mission Board/ Job boards]]

Mod:Nebula's Mission Board/ Job boards

2025-07-29T17:59:50Z

MistressNebula: MistressNebula moved page User:MistressNebula/MissionGen: Job boards to Mod:Nebula's Mission Board/ Job boards: Move to Mod namespace

This guide expects you to have completed the setup guides.

The Mission Generation Library is equipped with functions to make interacting with jobs as easy as possible, both for modders and for players. This includes a full set of menus that allow the player to interact with jobs and job boards, and a group of functions made to effortlessly and safely open those menus.

The first thing you need to do is to add an object to the ground map. It might be a mailbox, an actual mission board or even an NPC, it makes no difference. You will then have to add this code somewhere in the interact function:
<pre>
MissionGen:BoardInteract(<board_id>)
</pre>
This will call a menu that allows the player to interact the board whose id corresponds to the given string, or to check their taken jobs. If you want them to skip directly to the board without displaying this first menu, call the following function instead:
<pre>
MissionGen:OpenBoardMenu(<board_id>)
</pre>
There is also the option of displaying a single job, like the NPCs in the Spinda Cafe do. All you have to do is call this function:
<pre>
MissionGen:ShowSingularJob(<board_id>, [index])
</pre>
This is best used in conjunction with boards with a size of 1, which would then allow you to omit the index altogether.

As a bonus, here's how to display the taken list by itself. If default is omitted, slot 1 will be selected:
<pre>
MissionGen:OpenTakenMenu([default])
</pre>

And that's it! When it comes to it, displaying job boards is really simple! Just remember that if a board is empty, its menu will not be shown at all, so remember to make sure the board has something in it by using these functions:

<pre>
MissionGen:IsBoardEmpty(<board_id>)

MissionGen:IsTakenListEmpty()
</pre>

Mod:Nebula's Mission Board

2025-07-29T17:53:56Z

MistressNebula: /* Setup guides */ Redirect

[[User:MistressNebula|Nebula]]'s Mission Board is a mod that adds a mission board to the base PMDO game, allowing players to embark in missions to gain special items and money and to gain experience.
It looks and plays essentially the same as the base game's Enable Mission Board mod, except that all job generation and job handling functions are dealt with by a highly customizable library bundled within the mod, built with the express purpose of being as easy to import and implement as possible while giving experienced modders the tools they need to make even more complex systems and behaviors.

== PMDO Mission Generation Library ==
The library itself is fully contained inside the Data/Script/missiongen_lib folder inside the mod. By taking this folder and moving it to your mod, you will have access to all of its functions. Remember to credit MistressNebula if you include this library in your project!

Do keep in mind that simply moving the files inside your mod is not enough to set up the library: you will also need to hook all of the necessary events to your mod. Please refer to the links at the bottom of this page for a more in-depth guide on how to do it.

===== How the library is structured =====
The library is broken up into 5 files:
* <code>missiongen_lib.lua</code> is the core file of the library. It's where the most important structures, functions and global variables are defined and handled, as well as the one containing all the hooks that mods are expected to use to interface with it.
* <code>missiongen_settings.lua</code> contains a table of parameters and properties used by the library to function. This is the file that modders are supposed to edit to alter the behavior of the library. Every setting is documented individually, describing its format, what it is used for and what kind of data it requires. The file is loaded directly by the main file, and is not supposed to be loaded directly.
* <code>missiongen_menus.lua</code> is a file whose sole purpose is to contain the menus used by the library. It is loaded automatically by the main file, and its functions are not supposed to be interacted with directly.
* <code>missiongen_service.lua</code> is the file that contains the service required by the library to handle loading, menu edits and dungeon completion tracking. It needs to be loaded separately from the main file. This file also contains the only value outside of the settings file that MIGHT require changing. More details in the setup guide below.
* <code>missiongen_devcheck.lua</code> contains a function, called by the main file when loading, whose purpose is to check, to the best of its abilities, if the values inside the settings file are valid, and print the results of its test to the console. If this file is deleted or misplaced, the check will simply be skipped. This file is only loaded when the game is in [[Dev Mode]]. If you hear the music restart when loading your save data, it's because of this file.

===== Setup guides =====
* [[Mod:Nebula's Mission Board/Basic setup|Basic setup]]
* [[Mod:Nebula's Mission Board/ Hook implementations|Hook implementations]]
* [[Mod:Nebula's Mission Board/ Editing settings|Editing settings]]
* [[Mod:Nebula's Mission Board/ String keys|String keys]]

===== Easy guides =====
* [[User:MistressNebula/MissionGen: Job boards|Setting up job boards]]
* [[User:MistressNebula/MissionGen: Reward cutscenes|Making reward cutscenes]]
** [[User:MistressNebula/MissionGen: Job Table|Job Table Documentation]]

===== Intermediate guide =====
* [[User:MistressNebula/MissionGen: Handcrafted jobs|Making handcrafted jobs]]

===== Advanced guide =====
* [[MissionGen guide: Job callbacks|Job callbacks]]

User:MistressNebula/MissionGen: Hook implementations

2025-07-29T17:51:00Z

MistressNebula: MistressNebula moved page User:MistressNebula/MissionGen: Hook implementations to Mod:Nebula's Mission Board/ Hook implementations: Move to Mod namespace

#REDIRECT [[Mod:Nebula's Mission Board/ Hook implementations]]

Mod:Nebula's Mission Board/ Hook implementations

2025-07-29T17:51:00Z

MistressNebula: MistressNebula moved page User:MistressNebula/MissionGen: Hook implementations to Mod:Nebula's Mission Board/ Hook implementations: Move to Mod namespace

This page contains the standard implementation of all of the library's most essential hooks, sorted by the file the are supposed to be in. You are free to copy-paste them from here, instead of the example mod's files, and edit them afterwards if you need to do so. 
Most event calls just consist of calling the corresponding library function and passing all parameters down to it, but the common functions can be a bit more involved.

=== common.lua ===
<pre>
MissionGen = require("missiongen_lib.missiongen_lib")

function COMMON.ShowDestinationMenu(dungeon_entrances, ground_entrances, force_list, speaker, confirm_msg)
local job_dests = MissionGen:LoadJobDestinations()

local open_dests = {}
-- check for unlock of grounds
for ii = 1, #ground_entrances, 1 do
if ground_entrances[ii].Flag then
local ground_id = ground_entrances[ii].Zone
local zone_summary = _DATA.DataIndices[RogueEssence.Data.DataManager.DataType.Zone]:Get(ground_id)
local ground = _DATA:GetGround(zone_summary.Grounds[ground_entrances[ii].ID])
local ground_name = ground:GetColoredName()
table.insert(open_dests, {
Name = ground_name,
Dest = RogueEssence.Dungeon.ZoneLoc(ground_id, -1, ground_entrances[ii].ID, ground_entrances[ii].Entry)
})
end
end

-- check for unlock of dungeons
for ii = 1, #dungeon_entrances, 1 do
if GAME:DungeonUnlocked(dungeon_entrances[ii]) then
local zone_summary = _DATA.DataIndices[RogueEssence.Data.DataManager.DataType.Zone]:Get(dungeon_entrances[ii])
if zone_summary.Released then
local zone_name = ""
if _DATA.Save:GetDungeonUnlock(dungeon_entrances[ii]) ==
RogueEssence.Data.GameProgress.UnlockState.Completed then
zone_name = zone_summary:GetColoredName()
else
zone_name = "[color=#00FFFF]" .. zone_summary.Name:ToLocal() .. "[color]"
end
zone_name = MissionGen:FormatDestinationMenuZoneName(job_dests, dungeon_entrances[ii], zone_name) -- missiongen_lib.lua

table.insert(open_dests, {
Name = zone_name,
Dest = RogueEssence.Dungeon.ZoneLoc(dungeon_entrances[ii], 0, 0, 0)
})
end
end
end

local dest = RogueEssence.Dungeon.ZoneLoc.Invalid
if #open_dests > 1 or force_list then
if before_list ~= nil then
before_list(dest)
end

SOUND:PlaySE("Menu/Skip")
local default_choice = 1
while true do
UI:ResetSpeaker()
UI:DestinationMenu(open_dests, default_choice)
UI:WaitForChoice()
default_choice = UI:ChoiceResult()

if default_choice == nil then
break
end
local ask_dest = open_dests[default_choice].Dest
if ask_dest.StructID.Segment >= 0 then
-- chosen dungeon entry
if speaker ~= nil then
UI:SetSpeaker(speaker)
else
UI:ResetSpeaker(false)
end
UI:DungeonChoice(open_dests[default_choice].Name, ask_dest)
UI:WaitForChoice()
if UI:ChoiceResult() then
dest = ask_dest
break
end
else
dest = ask_dest
break
end
end
elseif #open_dests == 1 then
if open_dests[1].Dest.StructID.Segment < 0 then
-- single ground entry
if speaker ~= nil then
UI:SetSpeaker(speaker)
else
UI:ResetSpeaker(false)
SOUND:PlaySE("Menu/Skip")
end
UI:ChoiceMenuYesNo(STRINGS:FormatKey("DLG_ASK_ENTER_GROUND", open_dests[1].Name))
UI:WaitForChoice()
if UI:ChoiceResult() then
dest = open_dests[1].Dest
end
else
-- single dungeon entry
if speaker ~= nil then
UI:SetSpeaker(speaker)
else
UI:ResetSpeaker(false)
SOUND:PlaySE("Menu/Skip")
end
UI:DungeonChoice(open_dests[1].Name, open_dests[1].Dest)
UI:WaitForChoice()
if UI:ChoiceResult() then
dest = open_dests[1].Dest
end
end
else
PrintInfo("No valid destinations found!")
end

if dest:IsValid() then
if confirm_msg ~= nil then
UI:WaitShowDialogue(confirm_msg)
end
if dest.StructID.Segment > -1 then
-- pre-loads the zone on a separate thread while we fade out, just for a little optimization
_DATA:PreLoadZone(dest.ID)
SOUND:PlayBGM("", true)
GAME:FadeOut(false, 20)
GAME:EnterDungeon(dest.ID, dest.StructID.Segment, dest.StructID.ID, dest.EntryPoint,
RogueEssence.Data.GameProgress.DungeonStakes.Risk, true, false)
else
SOUND:PlayBGM("", true)
GAME:FadeOut(false, 20)
GAME:EnterZone(dest.ID, dest.StructID.Segment, dest.StructID.ID, dest.EntryPoint)
end
end
end

function COMMON.EnterDungeonMissionCheck(zoneId, segmentID)
local escort_jobs, removed_names = MissionGen:EnterDungeonPrepareParty(zoneId)
MissionGen:PrintSentHome(removed_names)

local added_names = MissionGen:EnterDungeonAddJobEscorts(zoneId, escort_jobs)
for _, name in ipairs(COMMON.GetSortedKeys(SV.missions.Missions)) do
local mission = SV.missions.Missions[name]
if mission.Complete == COMMON.MISSION_INCOMPLETE and zoneId == mission.DestZone and segmentID ==
mission.DestSegment then
if mission.Type == 1 then -- escort
-- add escort to team
local mon_id = mission.EscortSpecies
local new_mob = _DATA.Save.ActiveTeam:CreatePlayer(_DATA.Save.Rand, mon_id, 50, "", -1)
_DATA.Save.ActiveTeam.Guests:Add(new_mob)

local talk_evt = RogueEssence.Dungeon.BattleScriptEvent("EscortInteract")
new_mob.ActionEvents:Add(talk_evt)

local tbl = LTBL(new_mob)
tbl.Escort = name

table.insert(added_names, new_mob.Name)
end
end
end
MissionGen:PrintEscortAdd(added_names)
end
</pre>

=== common_vars.lua ===
<pre>
---Check used in missiongen_settings to see if there is an active sidequest in the current zone
function COMMON.HasSidequestInZone(zone)
for _, mission in pairs(SV.missions.Missions) do
if mission.DestZone == zone then
return true
end
end
return false
end

---Overrides origin function.
function COMMON.ExitDungeonMissionCheckEx(result, rescue, zoneId, segmentID)
--remove all guests from the dungeon
return MissionGen:ExitDungeonMissionCheckEx(result, rescue, zoneId, segmentID)
end
</pre>

=== event_battle.lua ===
<pre>
--- Reuse origin code
local base_game_escort_interact = BATTLE_SCRIPT.EscortInteract
function BATTLE_SCRIPT.EscortInteract(owner, ownerChar, context, args)
if (context.Target.LuaData.JobReference) then
MissionGen:EscortInteract(owner, ownerChar, context, args)
else
base_game_escort_interact(owner, ownerChar, context, args)
end
end

function BATTLE_SCRIPT.EscortReached(owner, ownerChar, context, args)
MissionGen:EscortReached(owner, ownerChar, context, args)
end

function BATTLE_SCRIPT.RescueReached(owner, ownerChar, context, args)
MissionGen:RescueReached(owner, ownerChar, context, args)
end
</pre>

=== event_mapgen.lua ===
<pre>
function ZONE_GEN_SCRIPT.GenerateJobInFloor(zoneContext, context, queue, seed, args)
MissionGen:GenerateJobInFloor(zoneContext, context, queue, seed, args)
end
</pre>

=== event_single.lua ===
<pre>function SINGLE_CHAR_SCRIPT.SpawnOutlaw(owner, ownerChar, context, args)
MissionGen:SpawnOutlaw(owner, ownerChar, context, args)
end

function SINGLE_CHAR_SCRIPT.OutlawFloor(owner, ownerChar, context, args)
MissionGen:OutlawFloor(owner, ownerChar, context, args)
end

function SINGLE_CHAR_SCRIPT.OutlawDeathCheck(owner, ownerChar, context, args)
MissionGen:OutlawDeathCheck(owner, ownerChar, context, args)
end

function SINGLE_CHAR_SCRIPT.OutlawCheck(owner, ownerChar, context, args)
MissionGen:OutlawCheck(owner, ownerChar, context, args)
end

function SINGLE_CHAR_SCRIPT.MonsterHouseOutlawCheck(owner, ownerChar, context, args)
MissionGen:MonsterHouseOutlawCheck(owner, ownerChar, context, args)
end

function SINGLE_CHAR_SCRIPT.OutlawItemCheckItem(owner, ownerChar, context, args)
MissionGen:OutlawItemCheckItem(owner, ownerChar, context, args)
end

function SINGLE_CHAR_SCRIPT.OutlawItemCheck(owner, ownerChar, context, args)
MissionGen:OutlawItemCheck(owner, ownerChar, context, args)
end

function SINGLE_CHAR_SCRIPT.OutlawFleeStairsCheck(owner, ownerChar, context, args)
MissionGen:OutlawFleeStairsCheck(owner, ownerChar, context, args)
end

function SINGLE_CHAR_SCRIPT.ExplorationReached(owner, ownerChar, context, args)
MissionGen:ExplorationReached(owner, ownerChar, context, args)
end

function SINGLE_CHAR_SCRIPT.MissionItemCheck(owner, ownerChar, context, args)
MissionGen:MissionItemCheck(owner, ownerChar, context, args)
end

function SINGLE_CHAR_SCRIPT.MissionGuestCheck(owner, ownerChar, context, args)
MissionGen:MissionGuestCheck(owner, ownerChar, context, args)
end

function SINGLE_CHAR_SCRIPT.MobilityEndTurn(owner, ownerChar, context, args)
MissionGen:MobilityEndTurn(owner, ownerChar, context, args)
end
</pre>

User:MistressNebula/MissionGen: String keys

2025-07-29T17:47:35Z

MistressNebula: MistressNebula moved page User:MistressNebula/MissionGen: String keys to Mod:Nebula's Mission Board/ String keys: Move to Mod namespace

#REDIRECT [[Mod:Nebula's Mission Board/ String keys]]

Mod:Nebula's Mission Board/ String keys

2025-07-29T17:47:35Z

MistressNebula: MistressNebula moved page User:MistressNebula/MissionGen: String keys to Mod:Nebula's Mission Board/ String keys: Move to Mod namespace

The Mission Generation Library requires a selection of strings to be set up in order to display things correctly. Most of them are defined by modders using the <code>missiongen_settings.lua</code> file, and every setting specifies in its documentation which string file needs to contain its entries. There are, however, a few string keys that are defined by the library itself, and are used by key components of the system, like for displaying objectives and rewards, or as event messages during jobs.
These strings are defined near the top of <code>missiongen_lib.lua</code>, but are also listed here for convenience. Every string has its own list of allowed text placeholders:
==strings.resx==
Static display keys that are fetched from <code>strings.resx</code>:

=== MENU_JOB_OBJECTIVE_RESCUE_SELF ===

Objective string for jobs where you rescue the client.

==== Placeholders ====
* <code>{0}</code>: Client

=== MENU_JOB_OBJECTIVE_RESCUE_FRIEND ===

Objective string for jobs where you rescue the target.

==== Placeholders ====
* <code>{0}</code>: Client
* <code>{1}</code>: Target

=== MENU_JOB_OBJECTIVE_ESCORT ===

Objective string for escort jobs.

==== Placeholders ====
* <code>{0}</code>: Client
* <code>{1}</code>: Target

=== MENU_JOB_OBJECTIVE_EXPLORATION ===

Objective string for exploration jobs.

==== Placeholders ====
* <code>{0}</code>: Client

=== MENU_JOB_OBJECTIVE_DELIVERY ===

Objective string for delivery jobs.

==== Placeholders ====
* <code>{0}</code>: Client
* <code>{2}</code>: Item

=== MENU_JOB_OBJECTIVE_LOST_ITEM ===

Objective string for lost item jobs.

==== Placeholders ====
* <code>{0}</code>: Client
* <code>{2}</code>: Item

=== MENU_JOB_OBJECTIVE_OUTLAW ===

Objective string for regular outlaw jobs.

==== Placeholders ====
* <code>{0}</code>: Client
* <code>{1}</code>: Target,

=== MENU_JOB_OBJECTIVE_OUTLAW_ITEM ===

Objective string for stolen item outlaw jobs.

==== Placeholders ====
* <code>{0}</code>: Client
* <code>{1}</code>: Target
* <code>{2}</code>: Item

=== MENU_JOB_OBJECTIVE_OUTLAW_ITEM_UNK ===

Objective string for stolen item outlaw jobs whose target is supposed to be hidden.

==== Placeholders ====
* <code>{0}</code>: Client
* <code>{1}</code>: Target
* <code>{2}</code>: Item

=== MENU_JOB_OBJECTIVE_OUTLAW_MONSTER_HOUSE ===

Objective string for outlaw monster house jobs.

==== Placeholders ====
* <code>{0}</code>: Client
* <code>{1}</code>: Target

=== MENU_JOB_OBJECTIVE_OUTLAW_FLEE ===

Objective string for fleeing outlaw jobs.

==== Placeholders ====
* <code>{0}</code>: Client
* <code>{1}</code>: Target

=== MENU_JOB_OBJECTIVE_DEFAULT ===

Objective string displayed when there are no jobs.

=== MENU_JOB_OBJECTIVE_REACH_SEGMENT ===

Objective string displayed when there are jobs in a different segment.

==== Placeholders ====
* <code>{0}</code>: Segment

=== MENU_OPTION_JOBLIST ===

Name of the main menu button that displays the taken list

=== MENU_OPTION_OBJECTIVES_LIST ===

Name of the main menu button that displays the current objectives

=== BOARD_TAKEN_TITLE ===

Name of the taken board in the board menu

=== MENU_JOB_OBJECTIVES_TITLE ===

Label for the button used to view mission objectives in dungeons

=== MENU_JOB_ACCEPTED ===

Displayed when viewing boards. It shows how full the taken list is.

==== Placeholders ====
* <code>{0}</code> Current Taken Count
* <code>{1}</code>: Taken Limit

=== MENU_JOB_SUMMARY ===

Displays the Job Summary label text

=== MENU_JOB_CLIENT ===

Displays the Client label text

=== MENU_JOB_OBJECTIVE ===

Displays the Objective label text

=== MENU_JOB_PLACE ===

Displays the Place label text

=== MENU_JOB_DIFFICULTY ===

Displays the Difficulty label text

=== MENU_JOB_REWARD ===

Displays the Reward label text

=== EXTRA_REWARD_AMOUNT ===

Displays the Extra Reward.

==== Placeholders ====
* <code>{0}</code>: Amount

=== MENU_JOB_REWARD_SINGLE ===

Reward string for a job with 1 reward.

==== Placeholders ====
* <code>{0}</code>: Reward1

=== MENU_JOB_REWARD_DOUBLE ===

Reward string for a job with 2 rewards.

==== Placeholders ====
* <code>{0}</code>: Reward1
* <code>{1}</code>: Reward2

=== MENU_JOB_REWARD_UNKNOWN ===

Reward string for special rewards. Meant to be hidden.

==== Placeholders ====
* <code>{0}</code>: Reward1

=== MENU_JOB_TAKE ===

Label for the button used to take jobs or to activate them

=== MENU_JOB_DELETE ===

Label for the button used to delete taken jobs

=== MENU_JOB_SUSPEND ===

Label for the button used to suspend jobs

==stringsEx.resx==
Static display keys that are fetched from <code>stringsEx.resx</code>:

=== DLG_MISSION_RESCUE_FOUND ===

Message for finding a rescue target and asking whether or not to warp it out.

==== Placeholders ====

* <code>{0}</code>: pokémon

=== DLG_MISSION_RESCUE_CONFIRM ===

Message for agreeing to warp out a rescue target.

==== Placeholders ====
* <code>{0}</code>: pokémon

=== DLG_MISSION_DELIVERY_FOUND ===

Message for finding a delivery target and asking whether or not to give it the requested item.

==== Placeholders ====
* <code>{0}</code>: pokémon
* <code>{1}</code>: item

=== DLG_MISSION_DELIVERY_CONFIRM ===

Dialogue from the target thanking the player for the item.

==== Placeholders ====
* <code>{0}</code>: item

=== DLG_MISSION_DELIVERY_DENY ===

Dialogue from the target being sad about the player refusing to give the item.

==== Placeholders ====
* <code>{0}</code>: item

=== DLG_MISSION_DELIVERY_NO_ITEM ===

Message for not having the requested item.

==== Placeholders ====
* <code>{0}</code>: pokémon
* <code>{1}</code>: item

=== DLG_MISSION_DELIVERY_NO_ITEM_CHAR ===

Dialogue from the target being sad about the player not having the item.

==== Placeholders ====
* <code>{0}</code>: item

=== DLG_MISSION_TARGET_LEFT ===

Message for the target warping out after completing its mission.

==== Placeholders ====
* <code>{0}</code>: pokémon

=== MISSION_ESCORT_ADD ===

Message for adding one escort guest to the party

==== Placeholders ====
* <code>{0}</code>: guest

=== MISSION_ESCORT_ADD_PLURAL ===

Message for adding multiple escort guests to the party.

==== Placeholders ====
* <code>{0}</code>: list of guests

=== MISSION_ESCORT_REACHED ===

Message for finding an escort target.

==== Placeholders ====
* <code>{0}</code>: client
* <code>{1}</code>: target

=== MISSION_ESCORT_THANKS ===

Dialogue from the guest thanking the player.

==== Placeholders ====
* <code>{0}</code>: target

=== MISSION_ESCORT_DEPART ===

Message for client and target leaving the dungeon.

==== Placeholders ====
* <code>{0}</code>: client
* <code>{1}</code>: target

=== MISSION_ESCORT_UNAVAILABLE ===

Message for the guest being fainted or not close enough to the target.

==== Placeholders ====
* <code>{0}</code>: client
* <code>{1}</code>: target

=== MISSION_ESCORT_FAINTED ===

Message for the escort getting knocked out

=== MISSION_EXPLORATION_REACHED ===

Message for reaching an exploration target floor.

==== Placeholders ====
* <code>{0}</code>: client
* <code>{1}</code>: dungeon

=== MISSION_EXPLORATION_THANKS ===

Dialogue from the guest thanking the player.

==== Placeholders ====
* <code>{1}</code>: dungeon

=== MISSION_EXPLORATION_DEPART ===

Message for the exploration client leaving the dungeon.

==== Placeholders ====
* <code>{0}</code>: client
* <code>{1}</code>: dungeon

=== DLG_MISSION_LOST_ITEM_RETRIEVED ===

Message for retrieving a lost item.

==== Placeholders ====
* <code>{0}</code>: client
* <code>{1}</code>: item

=== DLG_MISSION_OUTLAW_SPAWN_FAIL ===

Message for whenever an outlaw fails to spawn

=== DLG_MISSION_OUTLAW_REACHED ===

Message for reaching an outlaw floor.

==== Placeholders ====
* <code>{0}</code>: outlaw

=== DLG_MISSION_OUTLAW_FLEE ===

Intro dialogue for a fleeing outlaw.

=== DLG_MISSION_OUTLAW_FLED ===

Message for a fleeing outlaw managing to escape.

==== Placeholders ====
* <code>{0}</code>: outlaw

=== DLG_MISSION_OUTLAW_MONSTER_HOUSE ===

Intro dialogue for an outlaw with monster house.

=== DLG_MISSION_OUTLAW_DEFEATED ===

Message for an outlaw being defeated.

==== Placeholders ====
* <code>{0}</code>: outlaw

=== DLG_MISSION_OUTLAW_MINIONS_DEFEATED ===

Dialogue from an outlaw thanking the player

=== DLG_MISSION_OUTLAW_BOSS_DEFEATED ===

Message for an outlaw with monster house being defeated.

==== Placeholders ====
* <code>{0}</code>: outlaw

=== DLG_MISSION_OUTLAW_HOUSE_DEFEATED ===

Message for an outlaw monster house being fully defeated.

==== Placeholders ====
* <code>{0}</code>: outlaw

=== DLG_MISSION_OUTLAW_ITEM_RETRIEVED ===

Message for retrieving the stolen item from an outlaw.

==== Placeholders ====
* <code>{0}</code>: outlaw
* <code>{1}</code>: item

=== DLG_MISSION_OUTLAW_ITEM_UNK_RETRIEVED ===

Message for retrieving the stolen item from an outlaw before defeating the outlaw.

==== Placeholders ====
* <code>{0}</code>: outlaw
* <code>{1}</code>: item

=== DLG_MISSION_OUTLAW_ITEM_UNK_DEFEATED ===

Message for defeating an outlaw whose identity was unknown and seeing it drop the stolen item.

==== Placeholders ====
* <code>{0}</code>: outlaw
* <code>{1}</code>: item

=== DLG_MISSION_CONTINUE_ONGOING ===

Message that asks whether or not to stay in a dungeon when there are still more jobs.

=== DLG_MISSION_CONTINUE_CONFIRM ===

Message that asks for confirmation before leaving a dungeon when there are still more jobs.

=== DLG_MISSION_CONTINUE_NO_ONGOING ===

Message that asks whether or not to stay in a dungeon when there are no more jobs.

=== MISSION_COMPLETED_CUTSCENE_AWARD_ITEM ===

Message used to notify the player about the item they were awarded.
==== Placeholders ====

* <code>{0}</code>: team
* <code>{1}</code>: item

=== MISSION_COMPLETED_CUTSCENE_AWARD_ITEM_STORAGE ===

Message used to notify the player about fact that the item they were awarded was sent to storage.
==== Placeholders ====

* <code>{0}</code>: team
* <code>{1}</code>: item

=== MISSION_COMPLETED_CUTSCENE_AWARD_MONEY ===

Message used to notify the player about the sum of money they were awarded.

==== Placeholders ====
* <code>{0}</code>: team
* <code>{1}</code>: money

=== MISSION_COMPLETED_CUTSCENE_AWARD_CHAR ===

Dialogue from a client that wants to join the team as the reward.

==== Placeholders ====
* <code>{0}</code>: team

=== MISSION_COMPLETED_CUTSCENE_AWARD_CHAR_PROMPT ===

Message asking the player if they want the client as a team member.

==== Placeholders ====
* <code>{0}</code>: team
* <code>{1}</code>: client

=== MISSION_COMPLETED_CUTSCENE_AWARD_EXTRA ===

Message used to notify the player about the extra reward they were awarded.

==== Placeholders ====
* <code>{0}</code>: team
* <code>{1}</code>: amount

=== MISSION_COMPLETED_CUTSCENE_AWARD_RANK_UP ===

Message used to notify the player about a rank up.

==== Placeholders ====
* <code>{0}</code>: team
* <code>{1}</code>: original rank
* <code>{2}</code>: new rank

__NOTOC__

Mod:Nebula's Mission Board/ Reward cutscenes

2025-07-29T17:44:07Z

MistressNebula: Redirect

When players leave a dungeon successfully after completing at least one job, they will be brought to the map defined inside the <code>[[Mod:Nebula's Mission Board/ Editing settings#end_dungeon_day_destination|end_dungeon_day_destination]]</code> setting. The library will then expect your code to use the reward handler here.
Do note that the end_dungeon_day_destination can also be a place where you assigned one or more job boards. It doesn't need to be a completely separate place.

Go to your <code>end_dungeon_day_destination</code>'s <code>Enter</code> function and paste this code in it, before any kind of fade-in occurs:
<pre>if MissionGen:HasCompletedMissions() then
MissionGen:PlayJobsCompletedCutscene()
end</pre>
If the map has no job board assigned to it, this is already everything you need to do. <code>PlayJobsCompletedCutscene</code> will move the flow of execution to the maps where the completed jobs' board is set and then simply return, letting those maps handle the rest.
If that is not the case, however, you will also need to write the reward cutscene, and then pass it to the function like so:
<pre>
MissionGen:PlayJobsCompletedCutscene(<callback>)
</pre>
This should be done in any map where there's a job board.

=== Writing a Reward Cutscene ===
When <code>PlayJobsCompletedCutscene</code> is called, it looks for the first completed job in the taken list. If the board that job has been taken from is not assigned to the current map, the player is transported to the correct map, where another instance of the function is then expected to run. If the map is correct, however, a list of [https://github.com/RogueCollab/RogueEssence/blob/master/RogueEssence/Ground/GroundChar.cs GroundChars] is created and then passed to the callback you provided the function with, alongside the job table itself. In other words, the callback needs to be a function with the following signature:
<pre>
function(job, npcs)
</pre>
where:
* <code>job</code> is the Job Table. See the [[User:MistressNebula/MissionGen: Job Table|Job Table Documentation]] page for more details
* <code>npcs</code> is the list of GroundChars, already added to the map at the coordinates 0, 0. It contains 4 characters for law enforcement jobs, 2 for jobs with a friendly target, and 1 for jobs with no targets

This function is what needs to implement the reward cutscene. You can use the job data and the number of npcs created to move the characters to the correct positions, differentiate between multiple boardss in the same map, if you have to, and then display a different introductory dialogue depending on the job type. Then, whenever you need to actually give the rewards to your players, call the following function
<pre>MissionGen:RewardPlayer(job, speaker, line1, line2)</pre>
where:
* <code>job</code> is the Job Table, needed to read what the rewards are
* <code>speaker</code> is the character that will say the lines given in the next parameters. If omitted, the lines will be displayed with no speaker.
* <code>line1</code> is the line that <code>speaker</code> will say before giving the first reward to the player, unless the client itself is the reward
* <code>line2</code> is the line that <code>speaker</code> will say before giving the second reward to the player, if it exists

This function will handle everything in regards to rewards, without moving the characters around. You will then be able to add more actions after it returns.

When the cutscene is done, simply add a fade-out, and you'll be good to go. <code>PlayJobsCompletedCutscene</code> will dispose of the characters and move to the next completed job, or return control to the player if there are no more completed jobs.

User:MistressNebula/MissionGen: Reward cutscenes

2025-07-29T17:43:26Z

MistressNebula: MistressNebula moved page User:MistressNebula/MissionGen: Reward cutscenes to Mod:Nebula's Mission Board/ Reward cutscenes: Move to Mod namespace

#REDIRECT [[Mod:Nebula's Mission Board/ Reward cutscenes]]

Mod:Nebula's Mission Board/ Reward cutscenes

2025-07-29T17:43:26Z

MistressNebula: MistressNebula moved page User:MistressNebula/MissionGen: Reward cutscenes to Mod:Nebula's Mission Board/ Reward cutscenes: Move to Mod namespace

When players leave a dungeon successfully after completing at least one job, they will be brought to the map defined inside the <code>[[User:MistressNebula/MissionGen: Editing settings#end_dungeon_day_destination|end_dungeon_day_destination]]</code> setting. The library will then expect your code to use the reward handler here.
Do note that the end_dungeon_day_destination can also be a place where you assigned one or more job boards. It doesn't need to be a completely separate place.

Go to your <code>end_dungeon_day_destination</code>'s <code>Enter</code> function and paste this code in it, before any kind of fade-in occurs:
<pre>if MissionGen:HasCompletedMissions() then
MissionGen:PlayJobsCompletedCutscene()
end</pre>
If the map has no job board assigned to it, this is already everything you need to do. <code>PlayJobsCompletedCutscene</code> will move the flow of execution to the maps where the completed jobs' board is set and then simply return, letting those maps handle the rest.
If that is not the case, however, you will also need to write the reward cutscene, and then pass it to the function like so:
<pre>
MissionGen:PlayJobsCompletedCutscene(<callback>)
</pre>
This should be done in any map where there's a job board.

=== Writing a Reward Cutscene ===
When <code>PlayJobsCompletedCutscene</code> is called, it looks for the first completed job in the taken list. If the board that job has been taken from is not assigned to the current map, the player is transported to the correct map, where another instance of the function is then expected to run. If the map is correct, however, a list of [https://github.com/RogueCollab/RogueEssence/blob/master/RogueEssence/Ground/GroundChar.cs GroundChars] is created and then passed to the callback you provided the function with, alongside the job table itself. In other words, the callback needs to be a function with the following signature:
<pre>
function(job, npcs)
</pre>
where:
* <code>job</code> is the Job Table. See the [[User:MistressNebula/MissionGen: Job Table|Job Table Documentation]] page for more details
* <code>npcs</code> is the list of GroundChars, already added to the map at the coordinates 0, 0. It contains 4 characters for law enforcement jobs, 2 for jobs with a friendly target, and 1 for jobs with no targets

This function is what needs to implement the reward cutscene. You can use the job data and the number of npcs created to move the characters to the correct positions, differentiate between multiple boardss in the same map, if you have to, and then display a different introductory dialogue depending on the job type. Then, whenever you need to actually give the rewards to your players, call the following function
<pre>MissionGen:RewardPlayer(job, speaker, line1, line2)</pre>
where:
* <code>job</code> is the Job Table, needed to read what the rewards are
* <code>speaker</code> is the character that will say the lines given in the next parameters. If omitted, the lines will be displayed with no speaker.
* <code>line1</code> is the line that <code>speaker</code> will say before giving the first reward to the player, unless the client itself is the reward
* <code>line2</code> is the line that <code>speaker</code> will say before giving the second reward to the player, if it exists

This function will handle everything in regards to rewards, without moving the characters around. You will then be able to add more actions after it returns.

When the cutscene is done, simply add a fade-out, and you'll be good to go. <code>PlayJobsCompletedCutscene</code> will dispose of the characters and move to the next completed job, or return control to the player if there are no more completed jobs.

Mod:Nebula's Mission Board/Basic setup

2025-07-29T17:41:25Z

MistressNebula: Redirect

Despite it being created to be as easy to add inside mods as possible, it still takes a bit of work to get the Mission Generation Library up and running. This page will run through all the necessary steps, from file placement to function hooks and <code>require</code> calls.

===== Importing the files =====

# Download [https://github.com/435THz/NebulaMissionBoard/releases Nebula's Mission Board] from github and extract the zip's content wherever you like.
# Go to the mod's <code>Data/Script</code> folder and copy the <code>missiongen_lib</code> folder.
# Paste the <code>missiongen_lib</code> folder inside your own mod's <code>Data/Script</code> folder.

Note that the library files expect to be placed exactly inside <code>Data/Script/missiongen_lib</code>. If you place them anywhere else, you will need to adjust all of the files' <code>include</code> calls accordingly, as well as all of the <code>include</code> calls present in this guide.
Don't forget to also copy all of the strings inside the <code>strings.resx</code> and <code>stringsEx.resx</code> files over to your mod!

===== Initializing the library =====

With the files imported in your mod, it's time to load it:
* Add <code>MissionGen = require("missiongen_lib.missiongen_lib")</code> inside your mod's <code>common.lua</code> file. You can rename this variable however you want, but it must be a global variable.
* If your global variable is not named "MissionGen", open missiongen_service.lua and change the <code>library_name</code> string into your global variable's name. Doing this will ensure that the service will be able to find the library when it needs to interact with it.
* Add <code>require 'missiongen_lib.missiongen_service'</code> inside your mod's <code>main.lua</code> file.

These steps will take care of most of the initialization process all by themselves. All of the library files will be loaded, and the <code>SV</code> structure will be automatically have the library's save data added to it. This, however, does nothing in terms of gameplay, and more steps are needed for the library to actually function.

===== Hooking up functions =====
This is the lengthiest part of the guide. There are a lot of functions that need to be set up in order for the library to work correctly, as highlighted by the many files inside Nebula's Mission Board mod. Luckily, they're pretty easy to port: All you need to do is copy-paste all functions in their respective files in your mod. For example, all functions inside Nebula's Mission Board's <code>common.lua</code> will need to go inside ''your mod's'' <code>common.lua</code>.
These are the files containing code that needs to be copied over:
* <code>common.lua</code>
* <code>common_vars.lua</code>
* <code>event.lua</code> (the <code>require</code> statements)
* <code>event.battle.lua</code>
* <code>event_mapgen.lua</code>
* <code>event.single.lua</code>

You now need to hook up the dungeon generation code to the game. Open your mod in [[Dev Mode]], go to the Constants tab and open the Universal menu. Here, in Zone Steps, add a new Script Zone Step. Set its Script parameter to <code>GenerateJobInFloor</code>.
Now save your changes, and that's it! This function will be responsible for dynamically adding the necessary steps and events whenever a destination floor is reached.

Everything we did up until now takes care of everything when it comes to generating and handling jobs inside dungeons, but there is still nothing that allows players to take new jobs, or to hand in completed ones. Not to worry: all you need to do is to add a call to <code>MissionGen:BoardInteract(board_id)</code>, and your players will be able to access your job board of choice and take its contents. <code>board_id</code>s will be discussed in the page about [[Mod:Nebula's Mission Board/ Editing settings|Settings]].
As for how handing in missions works, you will need to write a cutscene for it. Nebula's Mission Board mod already has one inside <code>Data/Script/nebula_mission_board/ground/base_camp_2</code> if you want to copy it, but here's a basic rundown of how the job completion cutscene is handled:

<ol>
<li>If any mission has been completed in the last dungeon run, the library will send the player to the location set inside the <code>end_dungeon_day_destination</code> setting. This location will need to call the <code>MissionGen:PlayJobsCompletedCutscene(callback)</code> function. If you have multiple maps with job boards, this function will also handle switching between maps as needed. You will have to provide the callback. (see step 3 for more details)</li>
<li><code>PlayJobsCompletedCutscene</code> will generate a list of characters, that will be passed to the callback along with the job struct itself.</li>
<li>the callback is ran. This is a modder-defined function with the following arguments:
<ul>
<li>a job table</li>
<li>a list of <code>GroundChar</code>s. The first one is always the client, while the second, if present, is always the target. Third and fourth are only generated for law enforcement jobs, and represent the background officers that would normally keep the outlaw restrained during the cutscene.</li>
</ul>
The callback is supposed to handle the cutscene itself, moving the characters where they need to be and displaying dialogue. It also needs to call <code>MissionGen:RewardPlayer(job, speaker, line1, line2)</code>, otherwise the player will not actually receive any rewards for the job they completed.
</li>
<li>Once the cutscene is finished, control goes back to <code>PlayJobsCompletedCutscene</code>, which will get rid of the current job and keep scanning for other completed ones until the end of the list, repeating steps 2 and 3 for each of them.</li>
<li>Finally, the function stored in the <>after_rewards_function<> settings is called, the boards are refreshed, and control is returned to the player.</li>
</ol>

That said, what you need to do is:
* call <code>MissionGen:PlayJobsCompletedCutscene(callback)</code> in any and all maps that have a board assigned to it.
* write the callback for the function above; it needs to use the current job's data and the given list of characters to actually implement the cutscene itself, and call <code>MissionGen:RewardPlayer(job, speaker, line1, line2)</code> so that players will receive their reward.
When that is done, the library will finally be fully set up and ready to use, though you will still need to edit its Settings to make sure that it generates jobs for your mod's dungeons.

Mod:Nebula's Mission Board/ Editing settings

2025-07-29T17:41:02Z

MistressNebula: Redirect

The Mission Generation Library is designed to be highly customizable. This choice is reflected in its <code>missiongen_settings.lua</code> file. This file is what modders are supposed to edit, changing the values inside the giant table it defines.

Here's a list of all settings in the library, with documentation:

== sv_root_name ==

Name of the SV table that will contain all stored data. Use a table to specify a deeper path. If not present in the SV structure, the defined path will be generated automatically. An empty list would just use SV as root.
Examples:
* <code>"jobs"</code> would use <code>SV.jobs</code> as its root.
* <code>{"adventure", "jobs"}</code> would use <code>SV.adventure.jobs</code> as its root.

=== Example ===
<pre>"jobs"</pre>

== boards ==

A list of board ids and the data necessary to define their behavior.
Format for each board:
<pre><nowiki>
<board_id>: {
display_key: string,
size: integer,
location: {
zone: string,
map: integer
},
condition: function(library),
job_types: {id = string, weight = integer}[]
}</nowiki></pre>
* <board_id>: The id of the board. It will be used to identify and reference this specific board inside scripts
* display_key: the string key used when displaying the job menu for this board. The localized strings are fetched from the Menu Text list (strings.resx)
* size: the amount of quests this board can hold at a time
* location: a zone id and a map index. This data is where the player will be brought for the job completion cutscene. All of these maps must call library:PlayJobsCompletedCutscene before fade-in for the reward sequence to work correctly.
* condition: Optional. A function called to determine if library:PopulateBoards() should fill out this board. It receives the library object as an argument and returns a boolean. If it returns true, the board is filled out. If it returns false, it is left empty. If this property is missing, this board will always be active.
* job_types: a list of job types and their probability weight. Higher weight means more common.

=== Example ===
<pre>{
quest_board = {
display_key = "BOARD_QUEST_TITLE",
size = 8,
location = {zone = "guildmaster_island", map = 2},
condition = function (library)
local root = library.root
local completed = 0
for _, segments in pairs(root.dungeon_progress) do
for _, state in pairs(segments) do
if state then
completed = completed + 1
if completed>=3 then return true end
break
end
end
end
return false
end,
job_types = {
{id = "RESCUE_SELF", weight = 5},
{id = "RESCUE_FRIEND", weight = 5},
{id = "ESCORT", weight = 2},
{id = "EXPLORATION", weight = 2},
{id = "DELIVERY", weight = 2},
{id = "LOST_ITEM", weight = 4},
{id = "OUTLAW", weight = 5},
{id = "OUTLAW_ITEM", weight = 2},
{id = "OUTLAW_ITEM_UNK", weight = 1},
{id = "OUTLAW_MONSTER_HOUSE", weight = 1},
{id = "OUTLAW_FLEE", weight = 1}
}
}
}</pre>

== end_dungeon_day_destination ==

Zone and map id of the ground map where players will be sent to when a day ends and there is at least one mission to hand in. This map must contain a call to library:PlayJobsCompletedCutscene
Format: <code>{zone: string, map: integer}</code>

=== Example ===
<pre>{ zone = "guildmaster_island", map = 2 },</pre>

== after_rewards_function ==

Function ran after the game is done with the job completion cutscene. It takes no arguments, and is not expected to return anything.
You can use it to fix up the game state however you like before returning control to the player.

=== Example ===
<pre>
after_rewards_function = function()
GAME:MoveCamera(0, 0, 1, true)
SOUND:PlayBGM(SV.base_town.Song, true)
end</pre>

== taken_limit ==

The maximum number of jobs that can be taken from job boards at a time.

=== Example ===
<pre>8</pre>

== taken_jobs_start_active ==

If true, taken jobs will be activated automatically. Players can always deactivate them manually if they so choose.

=== Example ===
<pre>true</pre>

== max_guests ==

The maximum amount of guest-based jobs that can be generated in the same dungeon.
Guest-based jobs are: ESCORT, EXPLORATION

=== Example ===
<pre>1</pre>

== guests_take_up_space ==

The maximum amount of guest-based jobs that can be generated in the same dungeon.
Guest-based jobs are: ESCORT, EXPLORATION

=== Example ===
<pre>1</pre>

== min_party_limit ==

Minimum number for the party limit when it is reduced because of guests.
This value cannot be lower than 1, for obvious reasons.
Any excess guests will simply add to the party count, without reducing the limit.

=== Example ===
<pre>1</pre>

== losing_guests_means_defeat ==

If true, losing any guest will count as a loss for the entire exploration.
If false, it will simply mark that specific job as failed.

=== Example ===
<pre>false</pre>

== dungeon_boss_steps_piority ==

The priority of the SpawnOutlaw handler event. It can be either an integer or a list of integers.
This value should always be lower than dungeon_gen_steps_piority.

=== Example ===
<pre>-11</pre>

== dungeon_gen_steps_piority ==

The priority that most of the job handlers will have when being added to the event list. It can be either an integer or a list of integers.
This value should always be equal to or higher than the priority set for the event that calls library:GenerateJobInFloor.

=== Example ===
<pre>-6</pre>

== dungeon_npc_steps_piority ==

The priority that job npc spawners will have when being added to the event list. It can be either an integer or a list of integers.
This value should always be equal to or higher than dungeon_gen_steps_piority.

=== Example ===
<pre>{ 5, 2, 1 }</pre>

== difficulty_list ==

A list of all difficulty rank id strings you want to use.
The order of these strings will define the difficulty scale used by the library.

=== Example ===
<pre>{ "F", "E", "D", "C", "B", "A", "S", "STAR_1", "STAR_2", "STAR_3", "STAR_4", "STAR_5", "STAR_6", "STAR_7", "STAR_8", "STAR_9" }</pre>

== difficulty_data ==

All the data required to define difficulty rank behavior. There must be an entry for every rank defined in difficulty_list:
Format: <code><diff_id>: {display_key: string, money_reward: integer, extra_reward: integer, outlaw_level: integer, escort_level: integer}</code>
* <diff_id>: one of the difficulties defined in "difficulty_list"
* display_key: string key used when displaying the name of the rank. The localized strings are fetched from the Menu Text list (strings.resx)
* money_reward: the amount of money awarded at the end of the job. If set to 0, money rewards will simply not award anything
* extra_reward: the points of extra reward awarded at the end of the job. What these points are depends on extra_reward_type. If set to 0, extra_reward_type will be considered to be "none"
* outlaw_level: Optional. The base level of all outlaws spawned by jobs with this difficulty. If omitted, it will be equal to the dungeon's expected level.
* escort_level: Optional. The level of all guests spawned by jobs with this difficulty. If omitted, it will be equal to the dungeon's expected level.

=== Example ===
<pre>
{
F = {display_key = "RANK_STRING_F", money_reward = 100, extra_reward = 0},
E = {display_key = "RANK_STRING_E", money_reward = 200, extra_reward = 100},
D = {display_key = "RANK_STRING_D", money_reward = 400, extra_reward = 200},
C = {display_key = "RANK_STRING_C", money_reward = 600, extra_reward = 400},
B = {display_key = "RANK_STRING_B", money_reward = 700, extra_reward = 1250},
A = {display_key = "RANK_STRING_A", money_reward = 1500, extra_reward = 2500},
S = {display_key = "RANK_STRING_S", money_reward = 3000, extra_reward = 5000},
STAR_1 = {display_key = "RANK_STRING_STAR_1", money_reward = 6000, extra_reward = 10000},
STAR_2 = {display_key = "RANK_STRING_STAR_2", money_reward = 10000, extra_reward = 20000},
STAR_3 = {display_key = "RANK_STRING_STAR_3", money_reward = 15000, extra_reward = 30000},
STAR_4 = {display_key = "RANK_STRING_STAR_4", money_reward = 20000, extra_reward = 40000},
STAR_5 = {display_key = "RANK_STRING_STAR_5", money_reward = 25000, extra_reward = 50000},
STAR_6 = {display_key = "RANK_STRING_STAR_6", money_reward = 30000, extra_reward = 60000},
STAR_7 = {display_key = "RANK_STRING_STAR_7", money_reward = 35000, extra_reward = 70000},
STAR_8 = {display_key = "RANK_STRING_STAR_8", money_reward = 40000, extra_reward = 80000},
STAR_9 = {display_key = "RANK_STRING_STAR_9", money_reward = 45000, extra_reward = 90000}
}</pre>

== guest_level_scaling ==

Function that changes the level of guests based on the player's level. It must return the new level for the guest, or it will have no effect.
Arguments:
* lvl: base level of the guest.
* dungeon: if true, the level is the dungeon's recommended level. If false, it's taken from the difficulty data.
* avg_team_lvl: average level of the player team. It may or may not be an integer.
* hst_team_lvl: highest level in the player team.
* settings: the settings data structure itself

=== Example ===
<pre>
function(lvl, dungeon, avg_team_lvl, hst_team_lvl, settings)
local add = 0
if dungeon then lvl = lvl*4//5 end
if avg_team_lvl > lvl then add = (avg_team_lvl - lvl) // 10 end
return lvl + add
end
</pre>

== outlaw_level_scaling ==

Function that changes the level of guests based on the player's level. It must return the new level for the guest, or it will have no effect.
Arguments:
* lvl: base level of the guest.
* dungeon: if true, the level is the dungeon's recommended level. If false, it's taken from the difficulty data.
* avg_team_lvl: average level of the player team. It may or may not be an integer.
* hst_team_lvl: highest level in the player team.
* settings: the settings data structure itself

=== Example ===
<pre>
function(lvl, dungeon, avg_team_lvl, hst_team_lvl, settings)
local add = 0
if dungeon then lvl = lvl*23//20 end
if avg_team_lvl > lvl then add = (avg_team_lvl - lvl) // 8 end
add = add + (hst_team_lvl - avg_team_lvl) // 4
return lvl + add
end
</pre>

== apply_outlaw_changes ==

Function that allows you to edit an outlaw's data just before they are spawned.
You can change just about anything except its position and recruitability state. Its HP will also
always be automatically set to full after this function is called.
You will also be unable to change the EquippedItem of an "OUTLAW_ITEM" or "OUTLAW_ITEM_UNK" outlaw.
Arguments:
* outlaw: the outlaw Character itself
* job: the current job data table

=== Example ===
<pre>
function(outlaw, job)
local max_boost = PMDC.Data.MonsterFormData.MAX_STAT_BOOST
outlaw.MaxHPBonus = math.min(outlaw.Level * max_boost // 64, max_boost);
if job.Type == "OUTLAW_FLEE" then
local speedMin = math.floor(outlaw.Level * 4 // 3)
local speedMax = math.floor(outlaw.Level * 6 // 2)
outlaw.SpeedBonus = math.min(_DATA.Save.Rand:Next(speedMin, speedMax), 100)
end
end
</pre>

== fleeing_outlaw_restrictions ==

A list of ids for types that are banned from ever being picked as fleeing outlaws.

=== Example ===
<pre>{ "ghost" }</pre>

== outlaw_music_name ==

The name of the outlaw music file. This file will be sourced from the Content/Music folder.

=== Example ===
<pre>"Outlaw.ogg"</pre>

== dungeons ==

This is where dungeon difficulty is set. Quests can only generate for dungeons inside this list.
Given the complexity of this structure, it is best generated using the [[Mod:Nebula's Mission Board/ Editing settings#settings.AddDungeonSection(zone, segment, start, difficulty, finish, must_end)||AddDungeonSection]] function at the bottom of this page.

== dungeon_order ==

Jobs are sorted by dungeon, following the order defined in this table. Missing dungeons are shoved at the bottom and sorted alphabetically.
This list is automatically populated in call order when using the "AddDungeonSection" function near the bottom of this file.

== external_events ==

A list of events unrelated to this library that can cause job generation to ignore a specific dungeon.
They can also be displayed in the objectives log if you so choose.
Format: <code>{condition: function(zone), message_key: string, message_args: function(zone), icon: string}</code>
* condition: a function that takes a zone and returns a boolean. If it returns true, jobs will not be generated for this dungeon, and all already taken jobs will be automatically suspended.
* message_key: Optional. It will be used in the objectives log instead of the default message if the condition is true.
* message_args: Optional. If the message's localization string contains placeholders, this function is in charge of taking a zone and returning a list of values that will be used for those placeholders in the form of a table array (Up to 5).
* icon: Optional. The icon that will be displayed beside the corresponding dungeon in the dungeon selection menu if the condition is true for any of its segments. Defaults to ""

=== Example ===
<pre>
{
{condition = function(zone) return COMMON.HasSidequestInZone(zone) end, icon = "\\uE111", message_key = "MENU_JOB_OBJECTIVE_DEFAULT"}
}
</pre>

== external_events_icon_mode ==

How to display external event icons in the dungeon list. This value can only be either "FIRST" or ALL".
* If set to "ALL", they will always be displayed in the order defined by external_events. Only one copy of the same icon will be shown, no matter how many conditions require it.
* If set to "FIRST", only the first event in the list's order will be displayed, no matter how many events are actually there. This setting does not prevent multiple messages from appearing in the objectives list.

=== Example ===
<pre>"FIRST"</pre>

== dungeon_list_pattern ==

The pattern that will define how to display entries in the dungeon list.
{0} is the placeholder for the dungeon name, {1} for pending job icon and {2} for external condition icons.

=== Example ===
<pre>"FIRST"</pre>

== job_types ==

Table used to determine various properties regarding job types.
Remove a job type entirely to disable its generation altogether.
Format: <code><job_type_id>: {rank_modifier: integer, min_rank: string}</code>
* <job_type_id>: one of RESCUE_SELF, RESCUE_FRIEND, ESCORT, EXPLORATION, DELIVERY, LOST_ITEM, OUTLAW, OUTLAW_ITEM, OUTLAW_ITEM_UNK, OUTLAW_MONSTER_HOUSE, OUTLAW_FLEE
* rank_modifier (optional): these jobs will always have this modifier applied to their rank.
* min_rank (optional): this type of jobs can never be of a rank lower than this.
: This influences possible dungeon spawn: a rank_modifier 1 job with min_rank "C" can also spawn in "D" rank dungeons.

=== Example ===
<pre>{
RESCUE_SELF = {rank_modifier = 0, min_rank = "F"},
RESCUE_FRIEND = {rank_modifier = 0, min_rank = "E"},
ESCORT = {rank_modifier = 1, min_rank = "C"},
EXPLORATION = {rank_modifier = 1, min_rank = "C"},
DELIVERY = {rank_modifier = 0, min_rank = "D"},
LOST_ITEM = {rank_modifier = 0, min_rank = "D"},
OUTLAW = {rank_modifier = 1, min_rank = "C"},
OUTLAW_ITEM = {rank_modifier = 1, min_rank = "C"},
OUTLAW_ITEM_UNK = {rank_modifier = 1, min_rank = "C"},
OUTLAW_MONSTER_HOUSE = {rank_modifier = 2, min_rank = "S"},
OUTLAW_FLEE = {rank_modifier = 1, min_rank = "B"}
}
</pre>

== dungeon_job_modifiers ==

Special table that allows modders to specify chance multipliers for job types depending on the dungeon.
Format: <code><dungeon_id>: {<job_type_id>: <multiplier>}</code>
* <dungeon_id>: the string id of a dungeon
* <job_type_id>: one of RESCUE_SELF, RESCUE_FRIEND, ESCORT, EXPLORATION, DELIVERY, LOST_ITEM, OUTLAW, OUTLAW_ITEM, OUTLAW_ITEM_UNK, OUTLAW_MONSTER_HOUSE, OUTLAW_FLEE
* <multiplier>: a multiplier number. It doesn't need to be an integer. It will be multiplied with the board's base chances, rounding up, when choosing the type of a job. Set it to 0 or less to disable the job type altogether.

=== Example ===
<pre>{
ambush_forest = {
OUTLAW = 3,
OUTLAW_ITEM = 3,
OUTLAW_ITEM_UNK = 3,
OUTLAW_MONSTER_HOUSE = 3,
OUTLAW_FLEE = 3
},
treacherous_mountain = {
OUTLAW = 3,
OUTLAW_ITEM = 3,
OUTLAW_ITEM_UNK = 3,
OUTLAW_MONSTER_HOUSE = 3,
OUTLAW_FLEE = 3
}
}
</pre>

== special_chance ==

Chance of special missions to be generated. Special missions are just handcrafted scenarios with specific client and target pairs and custom flavor texts. Set to 0 to disable altogether.

=== Example ===
<pre>0.2</pre>

== special_jobs ==

This is where you can define special cases for specific types of jobs.
Format: <code><job_type_id>: <special_id>[]</code>
* <job_type_id>: one of RESCUE_SELF, RESCUE_FRIEND, ESCORT, EXPLORATION, DELIVERY, LOST_ITEM, OUTLAW, OUTLAW_ITEM, OUTLAW_ITEM_UNK, OUTLAW_MONSTER_HOUSE, OUTLAW_FLEE
* <special_id>: any id of your choosing except RESCUE_SELF, RESCUE_FRIEND, ESCORT, EXPLORATION, DELIVERY, LOST_ITEM, OUTLAW, OUTLAW_ITEM, OUTLAW_ITEM_UNK, OUTLAW_MONSTER_HOUSE, OUTLAW_FLEE

=== Example ===
<pre>{
RESCUE_FRIEND = {"CHILD", "LOVER", "RIVAL", "FRIEND"}
}</pre>

== hidden_floor_chance ==

Chance for supported quest types to have their destination floor hidden. Set to 0 to disable altogether.
Players will still be notified when reaching the floor. It just won't show in the quest description.
Job types that can have their floor hidden are: RESCUE_FRIEND, EXPLORATION, OUTLAW, OUTLAW_ITEM, OUTLAW_ITEM_UNK, OUTLAW_FLEE.

=== Example ===
<pre>0.15</pre>

== reward_types ==

A list of all types of rewards to be offered to players.
Format: <code>{id: string, weight: integer, min_rank: string}</code>
* id: one of the supported reward types. You can use duplicate values to alter odds depending on job rank.
: Supported reward types are: item, money, item_item, money_item, client, exclusive
* weight: Chance of appearing. Set to 0 or delete altogether to stop a type of reward from being offered.
* min_rank: optional. If set, this type of reward will only be offered if the job is this rank or higher.

=== Example ===
<pre>{
{id = "item", weight = 6},
{id = "money", weight = 2},
{id = "item_item", weight = 3},
{id = "money_item", weight = 1},
{id = "client", weight = 1, min_rank = "STAR_1"},
{id = "exclusive", weight = 1, min_rank = "STAR_4"}
}</pre>

== extra_reward_type ==

The type of extra reward for all quests. It can be "none", "rank" or "exp". Any other value will result in "none".

=== Example ===
<pre>"exp"</pre>

== rewards_per_difficulty ==

This table assigns different weights to reward pools depending on the difficulty rank of the mission.
Format: <code><diff_id>: {id: string, weight: integer}[]</code>
* <diff_id>: one of the difficulties defined in difficulty_list"
* id: the id of one of the reward pools defined in "reward_pools"
* weight: Chance of appearing. Set to 0 or delete altogether to stop a reward pool from being picked.

=== Example ===
<pre>{
F = {
{id = "NECESSITIES", weight = 10}
},
E = {
{id = "NECESSITIES", weight = 10},
{id = "APRICORN_GENERIC", weight = 10},
{id = "FOOD_LOW", weight = 10},
{id = "SEED_LOW", weight = 10},
{id = "HELD_LOW", weight = 3},
{id = "LOOT_LOW", weight = 3},
{id = "EVO_ITEMS", weight = 1},
{id = "WANDS_LOW", weight = 10}
},
D = {
{id = "NECESSITIES", weight = 5},
{id = "AMMO_LOW", weight = 10},
{id = "APRICORN_GENERIC", weight = 10},
{id = "APRICORN_TYPED", weight = 2},
{id = "FOOD_LOW", weight = 4},
{id = "SEED_LOW", weight = 4},
{id = "SEED_MID", weight = 10},
{id = "HELD_LOW", weight = 10},
{id = "HELD_TYPE", weight = 3},
{id = "LOOT_LOW", weight = 10},
{id = "EVO_ITEMS", weight = 2},
{id = "ORBS_LOW", weight = 2},
{id = "WANDS_LOW", weight = 4},
{id = "WANDS_MID", weight = 10},
},
[...]
}</pre>

== reward_pools ==

List of all reward pools and the items they contain. You must at least include all pools referenced in the rewards_per_difficulty table, but you can add more.
Entry ids may be either items or other pools. A pool doesn't have to only contain one of the two.
Format: <code><pool id>: {id: string, count: integer, hidden: string, weight: integer}[]</code>
* <pool_id>: the id of the pool. It should be used somewhere else either in this table or in rewards_per_difficulty.
* id: item_id or pool_id. If it matches a pool, count and hidden will be ignored.
* count: Optional. The amount of items awarded. It cannot be higher than the item's max stack. Defaults to the item's max stack.
* hidden: Optional. Hidden value that can be used for various purposes depending on the item. Defaults to "".
* weight: Chance of appearing. Set to 0 or delete altogether to stop an entry from being picked.

=== Example ===
<pre>{
NECESSITIES = {
{id = "seed_reviver", weight = 10},
{id = "berry_leppa", weight = 5},
{id = "berry_oran", weight = 5},
{id = "berry_lum", weight = 5},
{id = "food_apple", weight = 5},
{id = "orb_escape", weight = 5},
{id = "apricorn_plain", weight = 5},
{id = "key",count = 3, weight = 2}
},
AMMO_LOW = {
{id = "ammo_iron_thorn", count = 3, weight = 5},
{id = "ammo_geo_pebble", count = 3, weight = 1},
{id = "ammo_stick", count = 3, weight = 1},
},
[...]
}</pre>

== target_items ==

Ids of items that can be used as targets, divided depending on the job type.
Make sure they're either easy enough to obtain or impossible to lose, depending on the job.
Using stackable items is highly discouraged for all job types, as it may result in odd behaviors.
''Please keep in mind that if you want to use the "mission_" items shown in the example you must either recreate them or copy them over from the example mod.''
Format: <code><job_type_id>: <item_id>[]</code>
* <job_type_id>: the id of a job type defined inside "job_types"
* <item_id>: the id of the item to use

=== Example ===
<pre>{
LOST_ITEM = {
"mission_lost_scarf",
"mission_lost_specs",
"mission_lost_band"
},
OUTLAW_ITEM = {
"mission_stolen_scarf",
"mission_stolen_band",
"mission_stolen_specs"
},
DELIVERY = {
"berry_oran",
"berry_leppa",
"food_apple",
"berry_lum",
"apricorn_plain"
},
[...]
}</pre>

== difficulty_to_tier ==

Weighted table that associates mission difficulty to a specific tier of characters and outlaws.
Format: <code><diff_id>: {id: string, weight: integer}[]</code>
* <diff_id>: one of the difficulties defined in "difficulty_list"
* id: A string that defines a pokémon tier id.
* weight: Chance of being picked. Set to 0 or delete altogether to stop an entry from being picked.

=== Example ===
<pre>{
F = {
{id = "TIER_LOW", weight = 10}
},
E = {
{id = "TIER_LOW", weight = 9},
{id = "TIER_MID", weight = 1}
},
D = {
{id = "TIER_LOW", weight = 7},
{id = "TIER_MID", weight = 3}
},
[...]
}</pre>

== pokemon ==

A list of Pokémon that will be used for job generation, sorted by arbitrary quest tiers.
Any of these entries may be picked when choosing client and target.
If the client picked is not in the seen dex, the reward type can never be "client" nor "exclusive".
Format: <code><tier>: <monster_id>[]</code>
* <tier>: one of the tier ids used in difficulty_to_tier
* <monster_id>: either the species id of a pokémon or a MonsterIDTable
Format of MonsterIDTable: see the "monsterIdTemplate" function in missiongen_lib.lua

=== Example ===
<pre>{
TIER_LOW = {
"abra","amaura","anorith","applin","archen","aron","arrokuda","axew","azurill", [...]
},
[...]
}</pre>

== job_titles ==

A list of all possible job display titles, divided by job type.
You must also include lists for any special job types you intend to use.
Format: <code><job_type_id>: <string_key>[]</code>
* <job_type_id>: either the id of a job type defined inside "job_types", or the id of a special job type
* <string_key>: the localization key used for the title. The localized strings are fetched from the Menu Text list (strings.resx)

Localization placeholders:
* {0}: target (or client, if there is no target)
* {1}: dungeon
* {2}: item

=== Example ===
<pre>
{
RESCUE_SELF = {
"MISSION_TITLE_RESCUE_SELF_001",
"MISSION_TITLE_RESCUE_SELF_002",
"MISSION_TITLE_RESCUE_SELF_003",
"MISSION_TITLE_RESCUE_SELF_004",
[...]
},
[...]
}</pre>

== job_flavor ==

A list of all possible job flavor text entries, divided by job type and by line.
Format: <code><job_type_id>: {<string_key>[], <string_key>[]}</code>
* <job_type_id>: either the id of a job type defined inside "job_types", or the id of a special job type
* <string_key>: the localization key used for the flavor text. Every job has 2 lists assigned: one for the top string and one for the bottom one.
If only the first list is specified, the second one will be left empty.
The localized strings are fetched from the Menu Text list (strings.resx)

Localization placeholders:
* {0}: target (or client, if there is no target)
* {1}: dungeon
* {2}: item

=== Example ===
<pre>
{
RESCUE_SELF = {
{
"MISSION_BODY_TOP_RESCUE_SELF_001",
"MISSION_BODY_TOP_RESCUE_SELF_002",
"MISSION_BODY_TOP_RESCUE_SELF_003",
"MISSION_BODY_TOP_RESCUE_SELF_004",
[...]
},
{
"MISSION_BODY_BOTTOM_RESCUE_SELF_001",
"MISSION_BODY_BOTTOM_RESCUE_SELF_002",
"MISSION_BODY_BOTTOM_RESCUE_SELF_003",
[...]
}
},
[...]
}</pre>

== law_enforcement ==

Law enforcement characters in your setting. All OUTLAW jobs except OUTLAW_ITEM and OUTLAW_ITEM_UNK use these characters as job clients.
You may specify only 1 officer, and then a list containing any number of agents. Two of the latter will be randomly picked every time the job completion cutscene is played.
You may add a weight property to agents to specify a custom chance of being picked. Any without will
have a weight of 1.
Add "unique = true" to the MonsterIDTable to stop an agent from being picked twice. You must
have at least either 1 non-unique agent or 2 unique ones for this list table to be valid.
Format of MonsterIDTable: see the "monsterIdTemplate" function in missiongen_lib.lua

=== Example ===
<pre>
{
OFFICER = {Species = "magnezone", Gender = 0},
AGENT = {
{Species = "magnemite", Gender = 0, Weight = 31},
{Species = "magnemite", Gender = 0, Skin = "shiny", Weight = 1, Unique = true}
}
}</pre>

== enforcer_chance ==

Defines the chance of either the officer or an agent being the client of a mission depending on the character tier of the mission, as defined in difficulty_to_tier.
Format: <code><tier>: {id: string, weight: integer}[]</code>
* <tier>: one of the tier ids used in difficulty_to_tier
* id: One of: OFFICER, AGENT
* index: Optional. Ignored if id is OFFICER. You can set it to specify a specific agent instead of rolling using their chance in "law_enforcement".
* weight: Chance of being picked. Set to 0 or delete altogether to stop an entry from being picked.

=== Example ===
<pre>
{
TIER_LOW = {
{id = "OFFICER", weight = 2},
{id = "AGENT", weight = 8}
},
TIER_MID = {
{id = "OFFICER", weight = 5},
{id = "AGENT", weight = 5}
},
TIER_HIGH = {
{id = "OFFICER", weight = 8},
{id = "AGENT", weight = 2}
}
}</pre>

== special_data ==

Data of characters and flavor key used for special jobs, divided by tier.
In outlaw related quests, you may use ENFORCER as a keyword for a random law enforcement character.
You may also use OFFICER or AGENT to specify a more specific selection.
These keywords can only be used in place of MonsterIDTables.
Format: <code><special_type>: {<tier>: {client: MonsterIDTable, target: MonsterIDTable, item: string, flavor: string}[]}</code>
* <special_type>: an id of your choosing. It must be different from any basic job id
* <tier>: one of the tier ids used in difficulty_to_tier
* client: the data used to generate this Pokémon.
* target: the data used to generate this Pokémon. Only used in job types that require a target.
* item: the id of the item that will be used for this job. Only used in job types that require an item.
* flavor: flavor string key used for the job, sourced from the Menu Text list (strings.resx)
Format of MonsterIDTable: see the "monsterIdTemplate" function in missiongen_lib.lua

Localization placeholders:
* {0}: target (or client, if there is no target)
* {1}: dungeon
* {2}: item

=== Example ===
<pre>{
LOVER = {
TIER_LOW = {
{client = {Species = "volbeat", Gender = 1}, target = {Species = "illumise", Gender = 2}, flavor = "MISSION_BODY_SPECIAL_LOVER_001"},
{client = {Species = "minun", Gender = 1}, target = {Species = "plusle", Gender = 2}, flavor = "MISSION_BODY_SPECIAL_LOVER_002"},
{client = {Species = "mareep", Gender = 2}, target = {Species = "wooloo", Gender = 1}, flavor = "MISSION_BODY_SPECIAL_LOVER_003"},
[...]
},
TIER_MID = {
{client = {Species = "miltank", Gender = 2}, target = {Species = "tauros", Gender = 1}, flavor = "MISSION_BODY_SPECIAL_LOVER_005"},
{client = {Species = "venomoth", Gender = 1}, target = {Species = "butterfree", Gender = 2}, flavor = "MISSION_BODY_SPECIAL_LOVER_006"},
[...]
},
[...]
},
[...]
}</pre>

== escort_talks ==

String keys to be used whenever the player interacts with an escort mission client, depending on the job type.
You can also include tables for special escort jobs. If no such table exists for a specific case, the generic table for the job type will be used.
Format: <code><job_type_id>: <string_key>[]</code>
* <job_type_id>: "ESCORT", "EXPLORATION", or the id of a special job type that corresponds to one of these job types
* <string_key>: the localization key of possible messages. The localized strings are fetched from the Gameplay Text list (stringsEx.resx)

Localization placeholders:
* {0}: target
* {1}: dungeon
* {2}: item

=== Example ===
<pre>
{
ESCORT = {
"MISSION_ESCORT_INTERACT"
},
EXPLORATION = {
"MISSION_EXPLORATION_INTERACT"
}
}</pre>

== rescue_responses ==

Strings keys to be used whenever the player interacts with a pokémon that needs rescue, depending on the job type and the response given.
You must include a "_DEFAULT" table, but you can also include tables for special job types. _DEFAULT will still be used for any special
case that doesn't have a table associated with it.
Format: <code>{rescue_yes: {<case_id>: {key: string, emotion: string}[]}, rescue_no: {<case_id>: {key: string, emotion: string}[]}}</code>
* <case_id>: "_DEFAULT", or the id of a special job type that corresponds to either "RESCUE_SELF" or "RESCUE_FRIEND"
* key: the localization key of possible messages. The localized strings are fetched from the Gameplay Text list (stringsEx.resx)
* emotion: Optional. An emotion id to use with this specific message. Defaults to "Normal"

Localization placeholders:
* {0}: client
* {1}: target
* {2}: dungeon

=== Example ===
<pre>
{
rescue_yes = {
_DEFAULT = { {key = "MISSION_RESCUE_CONFIRM_DEFAULT"} },
CHILD = { {key = "MISSION_RESCUE_CONFIRM_CHILD", emotion = "Joyous"} },
FRIEND = { {key = "MISSION_RESCUE_CONFIRM_FRIEND"} },
RIVAL = { {key = "MISSION_RESCUE_CONFIRM_RIVAL"} },
LOVER = { {key = "MISSION_RESCUE_CONFIRM_LOVER", emotion = "Joyous"} }
},
rescue_no = {
_DEFAULT = { {key = "MISSION_RESCUE_DENY_DEFAULT", emotion = "Surprised"} },
CHILD = { {key = "MISSION_RESCUE_DENY_CHILD", emotion = "Crying"} },
FRIEND = { {key = "MISSION_RESCUE_DENY_FRIEND", emotion = "Surprised"} },
RIVAL = { {key = "MISSION_RESCUE_DENY_RIVAL", emotion = "Stunned"} },
LOVER = { {key = "MISSION_RESCUE_DENY_LOVER", emotion = "Stunned"} }
}
}</pre>

== mission_callback_root ==

The object that contains job callback functions. It is recommended to define this object somewhere else.
Job callbacks are stored inside jobs as strings. These strings are then used as an index in the callback root object to retrieve the actual function.

The callback system is a pretty involved one, that gives a modder the ability to handcraft entirely new types of jobs if they so choose, but is also pretty difficult to handle, so it will be discussed in [[User:MistressNebula/MissionGen: Job callbacks|its own guide]].

=== Example ===
<pre>COMMON</pre>

== settings.AddDungeonSection(zone, segment, start, difficulty, finish, must_end) ==

Adds a new dungeon section to the list of possible job destinations.
Section start values must always be added in ascending order. Failing to do so may cause inconsistent behaviors.

=== Arguments ===

* <code>zone</code> - <code>string</code>: the string id of the dungeon zone.
* <code>segment</code> - <code>integer</code>: the numeric id of the dungeon segment.
* <code>start</code> - <code>integer</code>: the starting floor of this dungeon section (start counting from 1 for this).
* <code>difficulty</code> - <code>string</code>: the string id of the difficulty assigned to this section.
* <code>finish</code> - <code>integer</code>: Only considered when first adding a segment to the list. Can be omitted otherwise. This will be the last floor of the segment where jobs can spawn (start counting from 1 for this). If higher than the dungeon floors, it will default to the full dungeon length.
* <code>must_end</code> - <code>boolean</code> Only considered when first adding a segment to the list. Can be omitted otherwise. If true, this segment must be completed before jobs can spawn in it. If false, the segment must be accessed at least once, unless it's segment 0, which just needs to be unlocked. Defaults to true.

=== Example ===

<pre>
settings.AddDungeonSection("faultline_ridge", 0, 6, "D", 10)
settings.AddDungeonSection("sickly_hollow", 0, 9, "S", 16, false)
settings.AddDungeonSection("sickly_hollow", 0, 13, "STAR_1")

</pre>

__NOTOC__

User:MistressNebula/MissionGen: Editing settings

2025-07-29T17:38:05Z

MistressNebula: MistressNebula moved page User:MistressNebula/MissionGen: Editing settings to Mod:Nebula's Mission Board/ Editing settings: Move to Mod namespace

#REDIRECT [[Mod:Nebula's Mission Board/ Editing settings]]

Mod:Nebula's Mission Board/ Editing settings

2025-07-29T17:38:05Z

MistressNebula: MistressNebula moved page User:MistressNebula/MissionGen: Editing settings to Mod:Nebula's Mission Board/ Editing settings: Move to Mod namespace

The Mission Generation Library is designed to be highly customizable. This choice is reflected in its <code>missiongen_settings.lua</code> file. This file is what modders are supposed to edit, changing the values inside the giant table it defines.

Here's a list of all settings in the library, with documentation:

== sv_root_name ==

Name of the SV table that will contain all stored data. Use a table to specify a deeper path. If not present in the SV structure, the defined path will be generated automatically. An empty list would just use SV as root.
Examples:
* <code>"jobs"</code> would use <code>SV.jobs</code> as its root.
* <code>{"adventure", "jobs"}</code> would use <code>SV.adventure.jobs</code> as its root.

=== Example ===
<pre>"jobs"</pre>

== boards ==

A list of board ids and the data necessary to define their behavior.
Format for each board:
<pre><nowiki>
<board_id>: {
display_key: string,
size: integer,
location: {
zone: string,
map: integer
},
condition: function(library),
job_types: {id = string, weight = integer}[]
}</nowiki></pre>
* <board_id>: The id of the board. It will be used to identify and reference this specific board inside scripts
* display_key: the string key used when displaying the job menu for this board. The localized strings are fetched from the Menu Text list (strings.resx)
* size: the amount of quests this board can hold at a time
* location: a zone id and a map index. This data is where the player will be brought for the job completion cutscene. All of these maps must call library:PlayJobsCompletedCutscene before fade-in for the reward sequence to work correctly.
* condition: Optional. A function called to determine if library:PopulateBoards() should fill out this board. It receives the library object as an argument and returns a boolean. If it returns true, the board is filled out. If it returns false, it is left empty. If this property is missing, this board will always be active.
* job_types: a list of job types and their probability weight. Higher weight means more common.

=== Example ===
<pre>{
quest_board = {
display_key = "BOARD_QUEST_TITLE",
size = 8,
location = {zone = "guildmaster_island", map = 2},
condition = function (library)
local root = library.root
local completed = 0
for _, segments in pairs(root.dungeon_progress) do
for _, state in pairs(segments) do
if state then
completed = completed + 1
if completed>=3 then return true end
break
end
end
end
return false
end,
job_types = {
{id = "RESCUE_SELF", weight = 5},
{id = "RESCUE_FRIEND", weight = 5},
{id = "ESCORT", weight = 2},
{id = "EXPLORATION", weight = 2},
{id = "DELIVERY", weight = 2},
{id = "LOST_ITEM", weight = 4},
{id = "OUTLAW", weight = 5},
{id = "OUTLAW_ITEM", weight = 2},
{id = "OUTLAW_ITEM_UNK", weight = 1},
{id = "OUTLAW_MONSTER_HOUSE", weight = 1},
{id = "OUTLAW_FLEE", weight = 1}
}
}
}</pre>

== end_dungeon_day_destination ==

Zone and map id of the ground map where players will be sent to when a day ends and there is at least one mission to hand in. This map must contain a call to library:PlayJobsCompletedCutscene
Format: <code>{zone: string, map: integer}</code>

=== Example ===
<pre>{ zone = "guildmaster_island", map = 2 },</pre>

== after_rewards_function ==

Function ran after the game is done with the job completion cutscene. It takes no arguments, and is not expected to return anything.
You can use it to fix up the game state however you like before returning control to the player.

=== Example ===
<pre>
after_rewards_function = function()
GAME:MoveCamera(0, 0, 1, true)
SOUND:PlayBGM(SV.base_town.Song, true)
end</pre>

== taken_limit ==

The maximum number of jobs that can be taken from job boards at a time.

=== Example ===
<pre>8</pre>

== taken_jobs_start_active ==

If true, taken jobs will be activated automatically. Players can always deactivate them manually if they so choose.

=== Example ===
<pre>true</pre>

== max_guests ==

The maximum amount of guest-based jobs that can be generated in the same dungeon.
Guest-based jobs are: ESCORT, EXPLORATION

=== Example ===
<pre>1</pre>

== guests_take_up_space ==

The maximum amount of guest-based jobs that can be generated in the same dungeon.
Guest-based jobs are: ESCORT, EXPLORATION

=== Example ===
<pre>1</pre>

== min_party_limit ==

Minimum number for the party limit when it is reduced because of guests.
This value cannot be lower than 1, for obvious reasons.
Any excess guests will simply add to the party count, without reducing the limit.

=== Example ===
<pre>1</pre>

== losing_guests_means_defeat ==

If true, losing any guest will count as a loss for the entire exploration.
If false, it will simply mark that specific job as failed.

=== Example ===
<pre>false</pre>

== dungeon_boss_steps_piority ==

The priority of the SpawnOutlaw handler event. It can be either an integer or a list of integers.
This value should always be lower than dungeon_gen_steps_piority.

=== Example ===
<pre>-11</pre>

== dungeon_gen_steps_piority ==

The priority that most of the job handlers will have when being added to the event list. It can be either an integer or a list of integers.
This value should always be equal to or higher than the priority set for the event that calls library:GenerateJobInFloor.

=== Example ===
<pre>-6</pre>

== dungeon_npc_steps_piority ==

The priority that job npc spawners will have when being added to the event list. It can be either an integer or a list of integers.
This value should always be equal to or higher than dungeon_gen_steps_piority.

=== Example ===
<pre>{ 5, 2, 1 }</pre>

== difficulty_list ==

A list of all difficulty rank id strings you want to use.
The order of these strings will define the difficulty scale used by the library.

=== Example ===
<pre>{ "F", "E", "D", "C", "B", "A", "S", "STAR_1", "STAR_2", "STAR_3", "STAR_4", "STAR_5", "STAR_6", "STAR_7", "STAR_8", "STAR_9" }</pre>

== difficulty_data ==

All the data required to define difficulty rank behavior. There must be an entry for every rank defined in difficulty_list:
Format: <code><diff_id>: {display_key: string, money_reward: integer, extra_reward: integer, outlaw_level: integer, escort_level: integer}</code>
* <diff_id>: one of the difficulties defined in "difficulty_list"
* display_key: string key used when displaying the name of the rank. The localized strings are fetched from the Menu Text list (strings.resx)
* money_reward: the amount of money awarded at the end of the job. If set to 0, money rewards will simply not award anything
* extra_reward: the points of extra reward awarded at the end of the job. What these points are depends on extra_reward_type. If set to 0, extra_reward_type will be considered to be "none"
* outlaw_level: Optional. The base level of all outlaws spawned by jobs with this difficulty. If omitted, it will be equal to the dungeon's expected level.
* escort_level: Optional. The level of all guests spawned by jobs with this difficulty. If omitted, it will be equal to the dungeon's expected level.

=== Example ===
<pre>
{
F = {display_key = "RANK_STRING_F", money_reward = 100, extra_reward = 0},
E = {display_key = "RANK_STRING_E", money_reward = 200, extra_reward = 100},
D = {display_key = "RANK_STRING_D", money_reward = 400, extra_reward = 200},
C = {display_key = "RANK_STRING_C", money_reward = 600, extra_reward = 400},
B = {display_key = "RANK_STRING_B", money_reward = 700, extra_reward = 1250},
A = {display_key = "RANK_STRING_A", money_reward = 1500, extra_reward = 2500},
S = {display_key = "RANK_STRING_S", money_reward = 3000, extra_reward = 5000},
STAR_1 = {display_key = "RANK_STRING_STAR_1", money_reward = 6000, extra_reward = 10000},
STAR_2 = {display_key = "RANK_STRING_STAR_2", money_reward = 10000, extra_reward = 20000},
STAR_3 = {display_key = "RANK_STRING_STAR_3", money_reward = 15000, extra_reward = 30000},
STAR_4 = {display_key = "RANK_STRING_STAR_4", money_reward = 20000, extra_reward = 40000},
STAR_5 = {display_key = "RANK_STRING_STAR_5", money_reward = 25000, extra_reward = 50000},
STAR_6 = {display_key = "RANK_STRING_STAR_6", money_reward = 30000, extra_reward = 60000},
STAR_7 = {display_key = "RANK_STRING_STAR_7", money_reward = 35000, extra_reward = 70000},
STAR_8 = {display_key = "RANK_STRING_STAR_8", money_reward = 40000, extra_reward = 80000},
STAR_9 = {display_key = "RANK_STRING_STAR_9", money_reward = 45000, extra_reward = 90000}
}</pre>

== guest_level_scaling ==

Function that changes the level of guests based on the player's level. It must return the new level for the guest, or it will have no effect.
Arguments:
* lvl: base level of the guest.
* dungeon: if true, the level is the dungeon's recommended level. If false, it's taken from the difficulty data.
* avg_team_lvl: average level of the player team. It may or may not be an integer.
* hst_team_lvl: highest level in the player team.
* settings: the settings data structure itself

=== Example ===
<pre>
function(lvl, dungeon, avg_team_lvl, hst_team_lvl, settings)
local add = 0
if dungeon then lvl = lvl*4//5 end
if avg_team_lvl > lvl then add = (avg_team_lvl - lvl) // 10 end
return lvl + add
end
</pre>

== outlaw_level_scaling ==

Function that changes the level of guests based on the player's level. It must return the new level for the guest, or it will have no effect.
Arguments:
* lvl: base level of the guest.
* dungeon: if true, the level is the dungeon's recommended level. If false, it's taken from the difficulty data.
* avg_team_lvl: average level of the player team. It may or may not be an integer.
* hst_team_lvl: highest level in the player team.
* settings: the settings data structure itself

=== Example ===
<pre>
function(lvl, dungeon, avg_team_lvl, hst_team_lvl, settings)
local add = 0
if dungeon then lvl = lvl*23//20 end
if avg_team_lvl > lvl then add = (avg_team_lvl - lvl) // 8 end
add = add + (hst_team_lvl - avg_team_lvl) // 4
return lvl + add
end
</pre>

== apply_outlaw_changes ==

Function that allows you to edit an outlaw's data just before they are spawned.
You can change just about anything except its position and recruitability state. Its HP will also
always be automatically set to full after this function is called.
You will also be unable to change the EquippedItem of an "OUTLAW_ITEM" or "OUTLAW_ITEM_UNK" outlaw.
Arguments:
* outlaw: the outlaw Character itself
* job: the current job data table

=== Example ===
<pre>
function(outlaw, job)
local max_boost = PMDC.Data.MonsterFormData.MAX_STAT_BOOST
outlaw.MaxHPBonus = math.min(outlaw.Level * max_boost // 64, max_boost);
if job.Type == "OUTLAW_FLEE" then
local speedMin = math.floor(outlaw.Level * 4 // 3)
local speedMax = math.floor(outlaw.Level * 6 // 2)
outlaw.SpeedBonus = math.min(_DATA.Save.Rand:Next(speedMin, speedMax), 100)
end
end
</pre>

== fleeing_outlaw_restrictions ==

A list of ids for types that are banned from ever being picked as fleeing outlaws.

=== Example ===
<pre>{ "ghost" }</pre>

== outlaw_music_name ==

The name of the outlaw music file. This file will be sourced from the Content/Music folder.

=== Example ===
<pre>"Outlaw.ogg"</pre>

== dungeons ==

This is where dungeon difficulty is set. Quests can only generate for dungeons inside this list.
Given the complexity of this structure, it is best generated using the [[User:MistressNebula/MissionGen: Editing settings#settings.AddDungeonSection(zone, segment, start, difficulty, finish, must_end)||AddDungeonSection]] function at the bottom of this page.

== dungeon_order ==

Jobs are sorted by dungeon, following the order defined in this table. Missing dungeons are shoved at the bottom and sorted alphabetically.
This list is automatically populated in call order when using the "AddDungeonSection" function near the bottom of this file.

== external_events ==

A list of events unrelated to this library that can cause job generation to ignore a specific dungeon.
They can also be displayed in the objectives log if you so choose.
Format: <code>{condition: function(zone), message_key: string, message_args: function(zone), icon: string}</code>
* condition: a function that takes a zone and returns a boolean. If it returns true, jobs will not be generated for this dungeon, and all already taken jobs will be automatically suspended.
* message_key: Optional. It will be used in the objectives log instead of the default message if the condition is true.
* message_args: Optional. If the message's localization string contains placeholders, this function is in charge of taking a zone and returning a list of values that will be used for those placeholders in the form of a table array (Up to 5).
* icon: Optional. The icon that will be displayed beside the corresponding dungeon in the dungeon selection menu if the condition is true for any of its segments. Defaults to ""

=== Example ===
<pre>
{
{condition = function(zone) return COMMON.HasSidequestInZone(zone) end, icon = "\\uE111", message_key = "MENU_JOB_OBJECTIVE_DEFAULT"}
}
</pre>

== external_events_icon_mode ==

How to display external event icons in the dungeon list. This value can only be either "FIRST" or ALL".
* If set to "ALL", they will always be displayed in the order defined by external_events. Only one copy of the same icon will be shown, no matter how many conditions require it.
* If set to "FIRST", only the first event in the list's order will be displayed, no matter how many events are actually there. This setting does not prevent multiple messages from appearing in the objectives list.

=== Example ===
<pre>"FIRST"</pre>

== dungeon_list_pattern ==

The pattern that will define how to display entries in the dungeon list.
{0} is the placeholder for the dungeon name, {1} for pending job icon and {2} for external condition icons.

=== Example ===
<pre>"FIRST"</pre>

== job_types ==

Table used to determine various properties regarding job types.
Remove a job type entirely to disable its generation altogether.
Format: <code><job_type_id>: {rank_modifier: integer, min_rank: string}</code>
* <job_type_id>: one of RESCUE_SELF, RESCUE_FRIEND, ESCORT, EXPLORATION, DELIVERY, LOST_ITEM, OUTLAW, OUTLAW_ITEM, OUTLAW_ITEM_UNK, OUTLAW_MONSTER_HOUSE, OUTLAW_FLEE
* rank_modifier (optional): these jobs will always have this modifier applied to their rank.
* min_rank (optional): this type of jobs can never be of a rank lower than this.
: This influences possible dungeon spawn: a rank_modifier 1 job with min_rank "C" can also spawn in "D" rank dungeons.

=== Example ===
<pre>{
RESCUE_SELF = {rank_modifier = 0, min_rank = "F"},
RESCUE_FRIEND = {rank_modifier = 0, min_rank = "E"},
ESCORT = {rank_modifier = 1, min_rank = "C"},
EXPLORATION = {rank_modifier = 1, min_rank = "C"},
DELIVERY = {rank_modifier = 0, min_rank = "D"},
LOST_ITEM = {rank_modifier = 0, min_rank = "D"},
OUTLAW = {rank_modifier = 1, min_rank = "C"},
OUTLAW_ITEM = {rank_modifier = 1, min_rank = "C"},
OUTLAW_ITEM_UNK = {rank_modifier = 1, min_rank = "C"},
OUTLAW_MONSTER_HOUSE = {rank_modifier = 2, min_rank = "S"},
OUTLAW_FLEE = {rank_modifier = 1, min_rank = "B"}
}
</pre>

== dungeon_job_modifiers ==

Special table that allows modders to specify chance multipliers for job types depending on the dungeon.
Format: <code><dungeon_id>: {<job_type_id>: <multiplier>}</code>
* <dungeon_id>: the string id of a dungeon
* <job_type_id>: one of RESCUE_SELF, RESCUE_FRIEND, ESCORT, EXPLORATION, DELIVERY, LOST_ITEM, OUTLAW, OUTLAW_ITEM, OUTLAW_ITEM_UNK, OUTLAW_MONSTER_HOUSE, OUTLAW_FLEE
* <multiplier>: a multiplier number. It doesn't need to be an integer. It will be multiplied with the board's base chances, rounding up, when choosing the type of a job. Set it to 0 or less to disable the job type altogether.

=== Example ===
<pre>{
ambush_forest = {
OUTLAW = 3,
OUTLAW_ITEM = 3,
OUTLAW_ITEM_UNK = 3,
OUTLAW_MONSTER_HOUSE = 3,
OUTLAW_FLEE = 3
},
treacherous_mountain = {
OUTLAW = 3,
OUTLAW_ITEM = 3,
OUTLAW_ITEM_UNK = 3,
OUTLAW_MONSTER_HOUSE = 3,
OUTLAW_FLEE = 3
}
}
</pre>

== special_chance ==

Chance of special missions to be generated. Special missions are just handcrafted scenarios with specific client and target pairs and custom flavor texts. Set to 0 to disable altogether.

=== Example ===
<pre>0.2</pre>

== special_jobs ==

This is where you can define special cases for specific types of jobs.
Format: <code><job_type_id>: <special_id>[]</code>
* <job_type_id>: one of RESCUE_SELF, RESCUE_FRIEND, ESCORT, EXPLORATION, DELIVERY, LOST_ITEM, OUTLAW, OUTLAW_ITEM, OUTLAW_ITEM_UNK, OUTLAW_MONSTER_HOUSE, OUTLAW_FLEE
* <special_id>: any id of your choosing except RESCUE_SELF, RESCUE_FRIEND, ESCORT, EXPLORATION, DELIVERY, LOST_ITEM, OUTLAW, OUTLAW_ITEM, OUTLAW_ITEM_UNK, OUTLAW_MONSTER_HOUSE, OUTLAW_FLEE

=== Example ===
<pre>{
RESCUE_FRIEND = {"CHILD", "LOVER", "RIVAL", "FRIEND"}
}</pre>

== hidden_floor_chance ==

Chance for supported quest types to have their destination floor hidden. Set to 0 to disable altogether.
Players will still be notified when reaching the floor. It just won't show in the quest description.
Job types that can have their floor hidden are: RESCUE_FRIEND, EXPLORATION, OUTLAW, OUTLAW_ITEM, OUTLAW_ITEM_UNK, OUTLAW_FLEE.

=== Example ===
<pre>0.15</pre>

== reward_types ==

A list of all types of rewards to be offered to players.
Format: <code>{id: string, weight: integer, min_rank: string}</code>
* id: one of the supported reward types. You can use duplicate values to alter odds depending on job rank.
: Supported reward types are: item, money, item_item, money_item, client, exclusive
* weight: Chance of appearing. Set to 0 or delete altogether to stop a type of reward from being offered.
* min_rank: optional. If set, this type of reward will only be offered if the job is this rank or higher.

=== Example ===
<pre>{
{id = "item", weight = 6},
{id = "money", weight = 2},
{id = "item_item", weight = 3},
{id = "money_item", weight = 1},
{id = "client", weight = 1, min_rank = "STAR_1"},
{id = "exclusive", weight = 1, min_rank = "STAR_4"}
}</pre>

== extra_reward_type ==

The type of extra reward for all quests. It can be "none", "rank" or "exp". Any other value will result in "none".

=== Example ===
<pre>"exp"</pre>

== rewards_per_difficulty ==

This table assigns different weights to reward pools depending on the difficulty rank of the mission.
Format: <code><diff_id>: {id: string, weight: integer}[]</code>
* <diff_id>: one of the difficulties defined in difficulty_list"
* id: the id of one of the reward pools defined in "reward_pools"
* weight: Chance of appearing. Set to 0 or delete altogether to stop a reward pool from being picked.

=== Example ===
<pre>{
F = {
{id = "NECESSITIES", weight = 10}
},
E = {
{id = "NECESSITIES", weight = 10},
{id = "APRICORN_GENERIC", weight = 10},
{id = "FOOD_LOW", weight = 10},
{id = "SEED_LOW", weight = 10},
{id = "HELD_LOW", weight = 3},
{id = "LOOT_LOW", weight = 3},
{id = "EVO_ITEMS", weight = 1},
{id = "WANDS_LOW", weight = 10}
},
D = {
{id = "NECESSITIES", weight = 5},
{id = "AMMO_LOW", weight = 10},
{id = "APRICORN_GENERIC", weight = 10},
{id = "APRICORN_TYPED", weight = 2},
{id = "FOOD_LOW", weight = 4},
{id = "SEED_LOW", weight = 4},
{id = "SEED_MID", weight = 10},
{id = "HELD_LOW", weight = 10},
{id = "HELD_TYPE", weight = 3},
{id = "LOOT_LOW", weight = 10},
{id = "EVO_ITEMS", weight = 2},
{id = "ORBS_LOW", weight = 2},
{id = "WANDS_LOW", weight = 4},
{id = "WANDS_MID", weight = 10},
},
[...]
}</pre>

== reward_pools ==

List of all reward pools and the items they contain. You must at least include all pools referenced in the rewards_per_difficulty table, but you can add more.
Entry ids may be either items or other pools. A pool doesn't have to only contain one of the two.
Format: <code><pool id>: {id: string, count: integer, hidden: string, weight: integer}[]</code>
* <pool_id>: the id of the pool. It should be used somewhere else either in this table or in rewards_per_difficulty.
* id: item_id or pool_id. If it matches a pool, count and hidden will be ignored.
* count: Optional. The amount of items awarded. It cannot be higher than the item's max stack. Defaults to the item's max stack.
* hidden: Optional. Hidden value that can be used for various purposes depending on the item. Defaults to "".
* weight: Chance of appearing. Set to 0 or delete altogether to stop an entry from being picked.

=== Example ===
<pre>{
NECESSITIES = {
{id = "seed_reviver", weight = 10},
{id = "berry_leppa", weight = 5},
{id = "berry_oran", weight = 5},
{id = "berry_lum", weight = 5},
{id = "food_apple", weight = 5},
{id = "orb_escape", weight = 5},
{id = "apricorn_plain", weight = 5},
{id = "key",count = 3, weight = 2}
},
AMMO_LOW = {
{id = "ammo_iron_thorn", count = 3, weight = 5},
{id = "ammo_geo_pebble", count = 3, weight = 1},
{id = "ammo_stick", count = 3, weight = 1},
},
[...]
}</pre>

== target_items ==

Ids of items that can be used as targets, divided depending on the job type.
Make sure they're either easy enough to obtain or impossible to lose, depending on the job.
Using stackable items is highly discouraged for all job types, as it may result in odd behaviors.
''Please keep in mind that if you want to use the "mission_" items shown in the example you must either recreate them or copy them over from the example mod.''
Format: <code><job_type_id>: <item_id>[]</code>
* <job_type_id>: the id of a job type defined inside "job_types"
* <item_id>: the id of the item to use

=== Example ===
<pre>{
LOST_ITEM = {
"mission_lost_scarf",
"mission_lost_specs",
"mission_lost_band"
},
OUTLAW_ITEM = {
"mission_stolen_scarf",
"mission_stolen_band",
"mission_stolen_specs"
},
DELIVERY = {
"berry_oran",
"berry_leppa",
"food_apple",
"berry_lum",
"apricorn_plain"
},
[...]
}</pre>

== difficulty_to_tier ==

Weighted table that associates mission difficulty to a specific tier of characters and outlaws.
Format: <code><diff_id>: {id: string, weight: integer}[]</code>
* <diff_id>: one of the difficulties defined in "difficulty_list"
* id: A string that defines a pokémon tier id.
* weight: Chance of being picked. Set to 0 or delete altogether to stop an entry from being picked.

=== Example ===
<pre>{
F = {
{id = "TIER_LOW", weight = 10}
},
E = {
{id = "TIER_LOW", weight = 9},
{id = "TIER_MID", weight = 1}
},
D = {
{id = "TIER_LOW", weight = 7},
{id = "TIER_MID", weight = 3}
},
[...]
}</pre>

== pokemon ==

A list of Pokémon that will be used for job generation, sorted by arbitrary quest tiers.
Any of these entries may be picked when choosing client and target.
If the client picked is not in the seen dex, the reward type can never be "client" nor "exclusive".
Format: <code><tier>: <monster_id>[]</code>
* <tier>: one of the tier ids used in difficulty_to_tier
* <monster_id>: either the species id of a pokémon or a MonsterIDTable
Format of MonsterIDTable: see the "monsterIdTemplate" function in missiongen_lib.lua

=== Example ===
<pre>{
TIER_LOW = {
"abra","amaura","anorith","applin","archen","aron","arrokuda","axew","azurill", [...]
},
[...]
}</pre>

== job_titles ==

A list of all possible job display titles, divided by job type.
You must also include lists for any special job types you intend to use.
Format: <code><job_type_id>: <string_key>[]</code>
* <job_type_id>: either the id of a job type defined inside "job_types", or the id of a special job type
* <string_key>: the localization key used for the title. The localized strings are fetched from the Menu Text list (strings.resx)

Localization placeholders:
* {0}: target (or client, if there is no target)
* {1}: dungeon
* {2}: item

=== Example ===
<pre>
{
RESCUE_SELF = {
"MISSION_TITLE_RESCUE_SELF_001",
"MISSION_TITLE_RESCUE_SELF_002",
"MISSION_TITLE_RESCUE_SELF_003",
"MISSION_TITLE_RESCUE_SELF_004",
[...]
},
[...]
}</pre>

== job_flavor ==

A list of all possible job flavor text entries, divided by job type and by line.
Format: <code><job_type_id>: {<string_key>[], <string_key>[]}</code>
* <job_type_id>: either the id of a job type defined inside "job_types", or the id of a special job type
* <string_key>: the localization key used for the flavor text. Every job has 2 lists assigned: one for the top string and one for the bottom one.
If only the first list is specified, the second one will be left empty.
The localized strings are fetched from the Menu Text list (strings.resx)

Localization placeholders:
* {0}: target (or client, if there is no target)
* {1}: dungeon
* {2}: item

=== Example ===
<pre>
{
RESCUE_SELF = {
{
"MISSION_BODY_TOP_RESCUE_SELF_001",
"MISSION_BODY_TOP_RESCUE_SELF_002",
"MISSION_BODY_TOP_RESCUE_SELF_003",
"MISSION_BODY_TOP_RESCUE_SELF_004",
[...]
},
{
"MISSION_BODY_BOTTOM_RESCUE_SELF_001",
"MISSION_BODY_BOTTOM_RESCUE_SELF_002",
"MISSION_BODY_BOTTOM_RESCUE_SELF_003",
[...]
}
},
[...]
}</pre>

== law_enforcement ==

Law enforcement characters in your setting. All OUTLAW jobs except OUTLAW_ITEM and OUTLAW_ITEM_UNK use these characters as job clients.
You may specify only 1 officer, and then a list containing any number of agents. Two of the latter will be randomly picked every time the job completion cutscene is played.
You may add a weight property to agents to specify a custom chance of being picked. Any without will
have a weight of 1.
Add "unique = true" to the MonsterIDTable to stop an agent from being picked twice. You must
have at least either 1 non-unique agent or 2 unique ones for this list table to be valid.
Format of MonsterIDTable: see the "monsterIdTemplate" function in missiongen_lib.lua

=== Example ===
<pre>
{
OFFICER = {Species = "magnezone", Gender = 0},
AGENT = {
{Species = "magnemite", Gender = 0, Weight = 31},
{Species = "magnemite", Gender = 0, Skin = "shiny", Weight = 1, Unique = true}
}
}</pre>

== enforcer_chance ==

Defines the chance of either the officer or an agent being the client of a mission depending on the character tier of the mission, as defined in difficulty_to_tier.
Format: <code><tier>: {id: string, weight: integer}[]</code>
* <tier>: one of the tier ids used in difficulty_to_tier
* id: One of: OFFICER, AGENT
* index: Optional. Ignored if id is OFFICER. You can set it to specify a specific agent instead of rolling using their chance in "law_enforcement".
* weight: Chance of being picked. Set to 0 or delete altogether to stop an entry from being picked.

=== Example ===
<pre>
{
TIER_LOW = {
{id = "OFFICER", weight = 2},
{id = "AGENT", weight = 8}
},
TIER_MID = {
{id = "OFFICER", weight = 5},
{id = "AGENT", weight = 5}
},
TIER_HIGH = {
{id = "OFFICER", weight = 8},
{id = "AGENT", weight = 2}
}
}</pre>

== special_data ==

Data of characters and flavor key used for special jobs, divided by tier.
In outlaw related quests, you may use ENFORCER as a keyword for a random law enforcement character.
You may also use OFFICER or AGENT to specify a more specific selection.
These keywords can only be used in place of MonsterIDTables.
Format: <code><special_type>: {<tier>: {client: MonsterIDTable, target: MonsterIDTable, item: string, flavor: string}[]}</code>
* <special_type>: an id of your choosing. It must be different from any basic job id
* <tier>: one of the tier ids used in difficulty_to_tier
* client: the data used to generate this Pokémon.
* target: the data used to generate this Pokémon. Only used in job types that require a target.
* item: the id of the item that will be used for this job. Only used in job types that require an item.
* flavor: flavor string key used for the job, sourced from the Menu Text list (strings.resx)
Format of MonsterIDTable: see the "monsterIdTemplate" function in missiongen_lib.lua

Localization placeholders:
* {0}: target (or client, if there is no target)
* {1}: dungeon
* {2}: item

=== Example ===
<pre>{
LOVER = {
TIER_LOW = {
{client = {Species = "volbeat", Gender = 1}, target = {Species = "illumise", Gender = 2}, flavor = "MISSION_BODY_SPECIAL_LOVER_001"},
{client = {Species = "minun", Gender = 1}, target = {Species = "plusle", Gender = 2}, flavor = "MISSION_BODY_SPECIAL_LOVER_002"},
{client = {Species = "mareep", Gender = 2}, target = {Species = "wooloo", Gender = 1}, flavor = "MISSION_BODY_SPECIAL_LOVER_003"},
[...]
},
TIER_MID = {
{client = {Species = "miltank", Gender = 2}, target = {Species = "tauros", Gender = 1}, flavor = "MISSION_BODY_SPECIAL_LOVER_005"},
{client = {Species = "venomoth", Gender = 1}, target = {Species = "butterfree", Gender = 2}, flavor = "MISSION_BODY_SPECIAL_LOVER_006"},
[...]
},
[...]
},
[...]
}</pre>

== escort_talks ==

String keys to be used whenever the player interacts with an escort mission client, depending on the job type.
You can also include tables for special escort jobs. If no such table exists for a specific case, the generic table for the job type will be used.
Format: <code><job_type_id>: <string_key>[]</code>
* <job_type_id>: "ESCORT", "EXPLORATION", or the id of a special job type that corresponds to one of these job types
* <string_key>: the localization key of possible messages. The localized strings are fetched from the Gameplay Text list (stringsEx.resx)

Localization placeholders:
* {0}: target
* {1}: dungeon
* {2}: item

=== Example ===
<pre>
{
ESCORT = {
"MISSION_ESCORT_INTERACT"
},
EXPLORATION = {
"MISSION_EXPLORATION_INTERACT"
}
}</pre>

== rescue_responses ==

Strings keys to be used whenever the player interacts with a pokémon that needs rescue, depending on the job type and the response given.
You must include a "_DEFAULT" table, but you can also include tables for special job types. _DEFAULT will still be used for any special
case that doesn't have a table associated with it.
Format: <code>{rescue_yes: {<case_id>: {key: string, emotion: string}[]}, rescue_no: {<case_id>: {key: string, emotion: string}[]}}</code>
* <case_id>: "_DEFAULT", or the id of a special job type that corresponds to either "RESCUE_SELF" or "RESCUE_FRIEND"
* key: the localization key of possible messages. The localized strings are fetched from the Gameplay Text list (stringsEx.resx)
* emotion: Optional. An emotion id to use with this specific message. Defaults to "Normal"

Localization placeholders:
* {0}: client
* {1}: target
* {2}: dungeon

=== Example ===
<pre>
{
rescue_yes = {
_DEFAULT = { {key = "MISSION_RESCUE_CONFIRM_DEFAULT"} },
CHILD = { {key = "MISSION_RESCUE_CONFIRM_CHILD", emotion = "Joyous"} },
FRIEND = { {key = "MISSION_RESCUE_CONFIRM_FRIEND"} },
RIVAL = { {key = "MISSION_RESCUE_CONFIRM_RIVAL"} },
LOVER = { {key = "MISSION_RESCUE_CONFIRM_LOVER", emotion = "Joyous"} }
},
rescue_no = {
_DEFAULT = { {key = "MISSION_RESCUE_DENY_DEFAULT", emotion = "Surprised"} },
CHILD = { {key = "MISSION_RESCUE_DENY_CHILD", emotion = "Crying"} },
FRIEND = { {key = "MISSION_RESCUE_DENY_FRIEND", emotion = "Surprised"} },
RIVAL = { {key = "MISSION_RESCUE_DENY_RIVAL", emotion = "Stunned"} },
LOVER = { {key = "MISSION_RESCUE_DENY_LOVER", emotion = "Stunned"} }
}
}</pre>

== mission_callback_root ==

The object that contains job callback functions. It is recommended to define this object somewhere else.
Job callbacks are stored inside jobs as strings. These strings are then used as an index in the callback root object to retrieve the actual function.

The callback system is a pretty involved one, that gives a modder the ability to handcraft entirely new types of jobs if they so choose, but is also pretty difficult to handle, so it will be discussed in [[User:MistressNebula/MissionGen: Job callbacks|its own guide]].

=== Example ===
<pre>COMMON</pre>

== settings.AddDungeonSection(zone, segment, start, difficulty, finish, must_end) ==

Adds a new dungeon section to the list of possible job destinations.
Section start values must always be added in ascending order. Failing to do so may cause inconsistent behaviors.

=== Arguments ===

* <code>zone</code> - <code>string</code>: the string id of the dungeon zone.
* <code>segment</code> - <code>integer</code>: the numeric id of the dungeon segment.
* <code>start</code> - <code>integer</code>: the starting floor of this dungeon section (start counting from 1 for this).
* <code>difficulty</code> - <code>string</code>: the string id of the difficulty assigned to this section.
* <code>finish</code> - <code>integer</code>: Only considered when first adding a segment to the list. Can be omitted otherwise. This will be the last floor of the segment where jobs can spawn (start counting from 1 for this). If higher than the dungeon floors, it will default to the full dungeon length.
* <code>must_end</code> - <code>boolean</code> Only considered when first adding a segment to the list. Can be omitted otherwise. If true, this segment must be completed before jobs can spawn in it. If false, the segment must be accessed at least once, unless it's segment 0, which just needs to be unlocked. Defaults to true.

=== Example ===

<pre>
settings.AddDungeonSection("faultline_ridge", 0, 6, "D", 10)
settings.AddDungeonSection("sickly_hollow", 0, 9, "S", 16, false)
settings.AddDungeonSection("sickly_hollow", 0, 13, "STAR_1")

</pre>

__NOTOC__

Mod:Nebula's Mission Board Mod/Basic setup

2025-07-29T17:33:13Z

MistressNebula: MistressNebula moved page Mod:Nebula's Mission Board Mod/Basic setup to Mod:Nebula's Mission Board/Basic setup: Misspelled title

#REDIRECT [[Mod:Nebula's Mission Board/Basic setup]]

Mod:Nebula's Mission Board/Basic setup

2025-07-29T17:33:13Z

MistressNebula: MistressNebula moved page Mod:Nebula's Mission Board Mod/Basic setup to Mod:Nebula's Mission Board/Basic setup: Misspelled title

Despite it being created to be as easy to add inside mods as possible, it still takes a bit of work to get the Mission Generation Library up and running. This page will run through all the necessary steps, from file placement to function hooks and <code>require</code> calls.

===== Importing the files =====

# Download [https://github.com/435THz/NebulaMissionBoard/releases Nebula's Mission Board] from github and extract the zip's content wherever you like.
# Go to the mod's <code>Data/Script</code> folder and copy the <code>missiongen_lib</code> folder.
# Paste the <code>missiongen_lib</code> folder inside your own mod's <code>Data/Script</code> folder.

Note that the library files expect to be placed exactly inside <code>Data/Script/missiongen_lib</code>. If you place them anywhere else, you will need to adjust all of the files' <code>include</code> calls accordingly, as well as all of the <code>include</code> calls present in this guide.
Don't forget to also copy all of the strings inside the <code>strings.resx</code> and <code>stringsEx.resx</code> files over to your mod!

===== Initializing the library =====

With the files imported in your mod, it's time to load it:
* Add <code>MissionGen = require("missiongen_lib.missiongen_lib")</code> inside your mod's <code>common.lua</code> file. You can rename this variable however you want, but it must be a global variable.
* If your global variable is not named "MissionGen", open missiongen_service.lua and change the <code>library_name</code> string into your global variable's name. Doing this will ensure that the service will be able to find the library when it needs to interact with it.
* Add <code>require 'missiongen_lib.missiongen_service'</code> inside your mod's <code>main.lua</code> file.

These steps will take care of most of the initialization process all by themselves. All of the library files will be loaded, and the <code>SV</code> structure will be automatically have the library's save data added to it. This, however, does nothing in terms of gameplay, and more steps are needed for the library to actually function.

===== Hooking up functions =====
This is the lengthiest part of the guide. There are a lot of functions that need to be set up in order for the library to work correctly, as highlighted by the many files inside Nebula's Mission Board mod. Luckily, they're pretty easy to port: All you need to do is copy-paste all functions in their respective files in your mod. For example, all functions inside Nebula's Mission Board's <code>common.lua</code> will need to go inside ''your mod's'' <code>common.lua</code>.
These are the files containing code that needs to be copied over:
* <code>common.lua</code>
* <code>common_vars.lua</code>
* <code>event.lua</code> (the <code>require</code> statements)
* <code>event.battle.lua</code>
* <code>event_mapgen.lua</code>
* <code>event.single.lua</code>

You now need to hook up the dungeon generation code to the game. Open your mod in [[Dev Mode]], go to the Constants tab and open the Universal menu. Here, in Zone Steps, add a new Script Zone Step. Set its Script parameter to <code>GenerateJobInFloor</code>.
Now save your changes, and that's it! This function will be responsible for dynamically adding the necessary steps and events whenever a destination floor is reached.

Everything we did up until now takes care of everything when it comes to generating and handling jobs inside dungeons, but there is still nothing that allows players to take new jobs, or to hand in completed ones. Not to worry: all you need to do is to add a call to <code>MissionGen:BoardInteract(board_id)</code>, and your players will be able to access your job board of choice and take its contents. <code>board_id</code>s will be discussed in the page about [[User:MistressNebula/MissionGen: Editing settings|Settings]].
As for how handing in missions works, you will need to write a cutscene for it. Nebula's Mission Board mod already has one inside <code>Data/Script/nebula_mission_board/ground/base_camp_2</code> if you want to copy it, but here's a basic rundown of how the job completion cutscene is handled:

<ol>
<li>If any mission has been completed in the last dungeon run, the library will send the player to the location set inside the <code>end_dungeon_day_destination</code> setting. This location will need to call the <code>MissionGen:PlayJobsCompletedCutscene(callback)</code> function. If you have multiple maps with job boards, this function will also handle switching between maps as needed. You will have to provide the callback. (see step 3 for more details)</li>
<li><code>PlayJobsCompletedCutscene</code> will generate a list of characters, that will be passed to the callback along with the job struct itself.</li>
<li>the callback is ran. This is a modder-defined function with the following arguments:
<ul>
<li>a job table</li>
<li>a list of <code>GroundChar</code>s. The first one is always the client, while the second, if present, is always the target. Third and fourth are only generated for law enforcement jobs, and represent the background officers that would normally keep the outlaw restrained during the cutscene.</li>
</ul>
The callback is supposed to handle the cutscene itself, moving the characters where they need to be and displaying dialogue. It also needs to call <code>MissionGen:RewardPlayer(job, speaker, line1, line2)</code>, otherwise the player will not actually receive any rewards for the job they completed.
</li>
<li>Once the cutscene is finished, control goes back to <code>PlayJobsCompletedCutscene</code>, which will get rid of the current job and keep scanning for other completed ones until the end of the list, repeating steps 2 and 3 for each of them.</li>
<li>Finally, the function stored in the <>after_rewards_function<> settings is called, the boards are refreshed, and control is returned to the player.</li>
</ol>

That said, what you need to do is:
* call <code>MissionGen:PlayJobsCompletedCutscene(callback)</code> in any and all maps that have a board assigned to it.
* write the callback for the function above; it needs to use the current job's data and the given list of characters to actually implement the cutscene itself, and call <code>MissionGen:RewardPlayer(job, speaker, line1, line2)</code> so that players will receive their reward.
When that is done, the library will finally be fully set up and ready to use, though you will still need to edit its Settings to make sure that it generates jobs for your mod's dungeons.

User:MistressNebula

2025-07-29T17:32:29Z

MistressNebula: Redirect

MistressNebula is a PMDO modder and source code contributor.

Notable modding works include:
* [[User:MistressNebula/Dungeon Recruitment List|Dungeon Recruitment List]] ([https://github.com/435THz/Dungeon_Recruitment_List github])
* [[Mod:Nebula's Mission Board|Mission Generation Library]] ([https://github.com/435THz/NebulaMissionBoard github])
* [[User:MistressNebula/PMD:New Leaf|PMD:NewLeaf]] (WIP, currently unreleased)

Mod:Nebula's Mission Board Mod

2025-07-29T17:31:44Z

MistressNebula: MistressNebula moved page Mod:Nebula's Mission Board Mod to Mod:Nebula's Mission Board: Misspelled title

#REDIRECT [[Mod:Nebula's Mission Board]]

Mod:Nebula's Mission Board

2025-07-29T17:31:44Z

MistressNebula: MistressNebula moved page Mod:Nebula's Mission Board Mod to Mod:Nebula's Mission Board: Misspelled title

[[User:MistressNebula|Nebula]]'s Mission Board is a mod that adds a mission board to the base PMDO game, allowing players to embark in missions to gain special items and money and to gain experience.
It looks and plays essentially the same as the base game's Enable Mission Board mod, except that all job generation and job handling functions are dealt with by a highly customizable library bundled within the mod, built with the express purpose of being as easy to import and implement as possible while giving experienced modders the tools they need to make even more complex systems and behaviors.

== PMDO Mission Generation Library ==
The library itself is fully contained inside the Data/Script/missiongen_lib folder inside the mod. By taking this folder and moving it to your mod, you will have access to all of its functions. Remember to credit MistressNebula if you include this library in your project!

Do keep in mind that simply moving the files inside your mod is not enough to set up the library: you will also need to hook all of the necessary events to your mod. Please refer to the links at the bottom of this page for a more in-depth guide on how to do it.

===== How the library is structured =====
The library is broken up into 5 files:
* <code>missiongen_lib.lua</code> is the core file of the library. It's where the most important structures, functions and global variables are defined and handled, as well as the one containing all the hooks that mods are expected to use to interface with it.
* <code>missiongen_settings.lua</code> contains a table of parameters and properties used by the library to function. This is the file that modders are supposed to edit to alter the behavior of the library. Every setting is documented individually, describing its format, what it is used for and what kind of data it requires. The file is loaded directly by the main file, and is not supposed to be loaded directly.
* <code>missiongen_menus.lua</code> is a file whose sole purpose is to contain the menus used by the library. It is loaded automatically by the main file, and its functions are not supposed to be interacted with directly.
* <code>missiongen_service.lua</code> is the file that contains the service required by the library to handle loading, menu edits and dungeon completion tracking. It needs to be loaded separately from the main file. This file also contains the only value outside of the settings file that MIGHT require changing. More details in the setup guide below.
* <code>missiongen_devcheck.lua</code> contains a function, called by the main file when loading, whose purpose is to check, to the best of its abilities, if the values inside the settings file are valid, and print the results of its test to the console. If this file is deleted or misplaced, the check will simply be skipped. This file is only loaded when the game is in [[Dev Mode]]. If you hear the music restart when loading your save data, it's because of this file.

===== Setup guides =====
* [[User:MistressNebula/MissionGen: Basic setup|Basic setup]]
* [[User:MistressNebula/MissionGen: Hook implementations|Hook implementations]]
* [[User:MistressNebula/MissionGen: Editing settings|Editing settings]]
* [[User:MistressNebula/MissionGen: String keys|String keys]]

===== Easy guides =====
* [[User:MistressNebula/MissionGen: Job boards|Setting up job boards]]
* [[User:MistressNebula/MissionGen: Reward cutscenes|Making reward cutscenes]]
** [[User:MistressNebula/MissionGen: Job Table|Job Table Documentation]]

===== Intermediate guide =====
* [[User:MistressNebula/MissionGen: Handcrafted jobs|Making handcrafted jobs]]

===== Advanced guide =====
* [[MissionGen guide: Job callbacks|Job callbacks]]

User:MistressNebula/MissionGen: Basic setup

2025-07-29T16:35:57Z

MistressNebula: MistressNebula moved page User:MistressNebula/MissionGen: Basic setup to Mod:Nebula's Mission Board Mod/Basic setup: Move to Mod namespace

#REDIRECT [[Mod:Nebula's Mission Board Mod/Basic setup]]

Mod:Nebula's Mission Board/Basic setup

2025-07-29T16:35:57Z

MistressNebula: MistressNebula moved page User:MistressNebula/MissionGen: Basic setup to Mod:Nebula's Mission Board Mod/Basic setup: Move to Mod namespace

Despite it being created to be as easy to add inside mods as possible, it still takes a bit of work to get the Mission Generation Library up and running. This page will run through all the necessary steps, from file placement to function hooks and <code>require</code> calls.

===== Importing the files =====

# Download [https://github.com/435THz/NebulaMissionBoard/releases Nebula's Mission Board] from github and extract the zip's content wherever you like.
# Go to the mod's <code>Data/Script</code> folder and copy the <code>missiongen_lib</code> folder.
# Paste the <code>missiongen_lib</code> folder inside your own mod's <code>Data/Script</code> folder.

Note that the library files expect to be placed exactly inside <code>Data/Script/missiongen_lib</code>. If you place them anywhere else, you will need to adjust all of the files' <code>include</code> calls accordingly, as well as all of the <code>include</code> calls present in this guide.
Don't forget to also copy all of the strings inside the <code>strings.resx</code> and <code>stringsEx.resx</code> files over to your mod!

===== Initializing the library =====

With the files imported in your mod, it's time to load it:
* Add <code>MissionGen = require("missiongen_lib.missiongen_lib")</code> inside your mod's <code>common.lua</code> file. You can rename this variable however you want, but it must be a global variable.
* If your global variable is not named "MissionGen", open missiongen_service.lua and change the <code>library_name</code> string into your global variable's name. Doing this will ensure that the service will be able to find the library when it needs to interact with it.
* Add <code>require 'missiongen_lib.missiongen_service'</code> inside your mod's <code>main.lua</code> file.

These steps will take care of most of the initialization process all by themselves. All of the library files will be loaded, and the <code>SV</code> structure will be automatically have the library's save data added to it. This, however, does nothing in terms of gameplay, and more steps are needed for the library to actually function.

===== Hooking up functions =====
This is the lengthiest part of the guide. There are a lot of functions that need to be set up in order for the library to work correctly, as highlighted by the many files inside Nebula's Mission Board mod. Luckily, they're pretty easy to port: All you need to do is copy-paste all functions in their respective files in your mod. For example, all functions inside Nebula's Mission Board's <code>common.lua</code> will need to go inside ''your mod's'' <code>common.lua</code>.
These are the files containing code that needs to be copied over:
* <code>common.lua</code>
* <code>common_vars.lua</code>
* <code>event.lua</code> (the <code>require</code> statements)
* <code>event.battle.lua</code>
* <code>event_mapgen.lua</code>
* <code>event.single.lua</code>

You now need to hook up the dungeon generation code to the game. Open your mod in [[Dev Mode]], go to the Constants tab and open the Universal menu. Here, in Zone Steps, add a new Script Zone Step. Set its Script parameter to <code>GenerateJobInFloor</code>.
Now save your changes, and that's it! This function will be responsible for dynamically adding the necessary steps and events whenever a destination floor is reached.

Everything we did up until now takes care of everything when it comes to generating and handling jobs inside dungeons, but there is still nothing that allows players to take new jobs, or to hand in completed ones. Not to worry: all you need to do is to add a call to <code>MissionGen:BoardInteract(board_id)</code>, and your players will be able to access your job board of choice and take its contents. <code>board_id</code>s will be discussed in the page about [[User:MistressNebula/MissionGen: Editing settings|Settings]].
As for how handing in missions works, you will need to write a cutscene for it. Nebula's Mission Board mod already has one inside <code>Data/Script/nebula_mission_board/ground/base_camp_2</code> if you want to copy it, but here's a basic rundown of how the job completion cutscene is handled:

<ol>
<li>If any mission has been completed in the last dungeon run, the library will send the player to the location set inside the <code>end_dungeon_day_destination</code> setting. This location will need to call the <code>MissionGen:PlayJobsCompletedCutscene(callback)</code> function. If you have multiple maps with job boards, this function will also handle switching between maps as needed. You will have to provide the callback. (see step 3 for more details)</li>
<li><code>PlayJobsCompletedCutscene</code> will generate a list of characters, that will be passed to the callback along with the job struct itself.</li>
<li>the callback is ran. This is a modder-defined function with the following arguments:
<ul>
<li>a job table</li>
<li>a list of <code>GroundChar</code>s. The first one is always the client, while the second, if present, is always the target. Third and fourth are only generated for law enforcement jobs, and represent the background officers that would normally keep the outlaw restrained during the cutscene.</li>
</ul>
The callback is supposed to handle the cutscene itself, moving the characters where they need to be and displaying dialogue. It also needs to call <code>MissionGen:RewardPlayer(job, speaker, line1, line2)</code>, otherwise the player will not actually receive any rewards for the job they completed.
</li>
<li>Once the cutscene is finished, control goes back to <code>PlayJobsCompletedCutscene</code>, which will get rid of the current job and keep scanning for other completed ones until the end of the list, repeating steps 2 and 3 for each of them.</li>
<li>Finally, the function stored in the <>after_rewards_function<> settings is called, the boards are refreshed, and control is returned to the player.</li>
</ol>

That said, what you need to do is:
* call <code>MissionGen:PlayJobsCompletedCutscene(callback)</code> in any and all maps that have a board assigned to it.
* write the callback for the function above; it needs to use the current job's data and the given list of characters to actually implement the cutscene itself, and call <code>MissionGen:RewardPlayer(job, speaker, line1, line2)</code> so that players will receive their reward.
When that is done, the library will finally be fully set up and ready to use, though you will still need to edit its Settings to make sure that it generates jobs for your mod's dungeons.

Mod:Nebula's Mission Board

2025-07-29T16:33:41Z

MistressNebula: Add link to user page

[[User:MistressNebula|Nebula]]'s Mission Board is a mod that adds a mission board to the base PMDO game, allowing players to embark in missions to gain special items and money and to gain experience.
It looks and plays essentially the same as the base game's Enable Mission Board mod, except that all job generation and job handling functions are dealt with by a highly customizable library bundled within the mod, built with the express purpose of being as easy to import and implement as possible while giving experienced modders the tools they need to make even more complex systems and behaviors.

== PMDO Mission Generation Library ==
The library itself is fully contained inside the Data/Script/missiongen_lib folder inside the mod. By taking this folder and moving it to your mod, you will have access to all of its functions. Remember to credit MistressNebula if you include this library in your project!

Do keep in mind that simply moving the files inside your mod is not enough to set up the library: you will also need to hook all of the necessary events to your mod. Please refer to the links at the bottom of this page for a more in-depth guide on how to do it.

===== How the library is structured =====
The library is broken up into 5 files:
* <code>missiongen_lib.lua</code> is the core file of the library. It's where the most important structures, functions and global variables are defined and handled, as well as the one containing all the hooks that mods are expected to use to interface with it.
* <code>missiongen_settings.lua</code> contains a table of parameters and properties used by the library to function. This is the file that modders are supposed to edit to alter the behavior of the library. Every setting is documented individually, describing its format, what it is used for and what kind of data it requires. The file is loaded directly by the main file, and is not supposed to be loaded directly.
* <code>missiongen_menus.lua</code> is a file whose sole purpose is to contain the menus used by the library. It is loaded automatically by the main file, and its functions are not supposed to be interacted with directly.
* <code>missiongen_service.lua</code> is the file that contains the service required by the library to handle loading, menu edits and dungeon completion tracking. It needs to be loaded separately from the main file. This file also contains the only value outside of the settings file that MIGHT require changing. More details in the setup guide below.
* <code>missiongen_devcheck.lua</code> contains a function, called by the main file when loading, whose purpose is to check, to the best of its abilities, if the values inside the settings file are valid, and print the results of its test to the console. If this file is deleted or misplaced, the check will simply be skipped. This file is only loaded when the game is in [[Dev Mode]]. If you hear the music restart when loading your save data, it's because of this file.

===== Setup guides =====
* [[User:MistressNebula/MissionGen: Basic setup|Basic setup]]
* [[User:MistressNebula/MissionGen: Hook implementations|Hook implementations]]
* [[User:MistressNebula/MissionGen: Editing settings|Editing settings]]
* [[User:MistressNebula/MissionGen: String keys|String keys]]

===== Easy guides =====
* [[User:MistressNebula/MissionGen: Job boards|Setting up job boards]]
* [[User:MistressNebula/MissionGen: Reward cutscenes|Making reward cutscenes]]
** [[User:MistressNebula/MissionGen: Job Table|Job Table Documentation]]

===== Intermediate guide =====
* [[User:MistressNebula/MissionGen: Handcrafted jobs|Making handcrafted jobs]]

===== Advanced guide =====
* [[MissionGen guide: Job callbacks|Job callbacks]]

User:MistressNebula

2025-07-29T16:32:31Z

MistressNebula: Redirect

MistressNebula is a PMDO modder and source code contributor.

Notable modding works include:
* [[User:MistressNebula/Dungeon Recruitment List|Dungeon Recruitment List]] ([https://github.com/435THz/Dungeon_Recruitment_List github])
* [[Mod:Nebula's Mission Board Mod|Mission Generation Library]] ([https://github.com/435THz/NebulaMissionBoard github])
* [[User:MistressNebula/PMD:New Leaf|PMD:NewLeaf]] (WIP, currently unreleased)

User:MistressNebula/Nebula's Mission Board Mod

2025-07-29T16:31:15Z

MistressNebula: MistressNebula moved page User:MistressNebula/Nebula's Mission Board Mod to Mod:Nebula's Mission Board Mod: Moving to Mod namespce

#REDIRECT [[Mod:Nebula's Mission Board Mod]]

Mod:Nebula's Mission Board

2025-07-29T16:31:15Z

MistressNebula: MistressNebula moved page User:MistressNebula/Nebula's Mission Board Mod to Mod:Nebula's Mission Board Mod: Moving to Mod namespce

Nebula's Mission Board is a mod that adds a mission board to the base PMDO game, allowing players to embark in missions to gain special items and money and to gain experience.
It looks and plays essentially the same as the base game's Enable Mission Board mod, except that all job generation and job handling functions are dealt with by a highly customizable library bundled within the mod, built with the express purpose of being as easy to import and implement as possible while giving experienced modders the tools they need to make even more complex systems and behaviors.

== PMDO Mission Generation Library ==
The library itself is fully contained inside the Data/Script/missiongen_lib folder inside the mod. By taking this folder and moving it to your mod, you will have access to all of its functions. Remember to credit MistressNebula if you include this library in your project!

Do keep in mind that simply moving the files inside your mod is not enough to set up the library: you will also need to hook all of the necessary events to your mod. Please refer to the links at the bottom of this page for a more in-depth guide on how to do it.

===== How the library is structured =====
The library is broken up into 5 files:
* <code>missiongen_lib.lua</code> is the core file of the library. It's where the most important structures, functions and global variables are defined and handled, as well as the one containing all the hooks that mods are expected to use to interface with it.
* <code>missiongen_settings.lua</code> contains a table of parameters and properties used by the library to function. This is the file that modders are supposed to edit to alter the behavior of the library. Every setting is documented individually, describing its format, what it is used for and what kind of data it requires. The file is loaded directly by the main file, and is not supposed to be loaded directly.
* <code>missiongen_menus.lua</code> is a file whose sole purpose is to contain the menus used by the library. It is loaded automatically by the main file, and its functions are not supposed to be interacted with directly.
* <code>missiongen_service.lua</code> is the file that contains the service required by the library to handle loading, menu edits and dungeon completion tracking. It needs to be loaded separately from the main file. This file also contains the only value outside of the settings file that MIGHT require changing. More details in the setup guide below.
* <code>missiongen_devcheck.lua</code> contains a function, called by the main file when loading, whose purpose is to check, to the best of its abilities, if the values inside the settings file are valid, and print the results of its test to the console. If this file is deleted or misplaced, the check will simply be skipped. This file is only loaded when the game is in [[Dev Mode]]. If you hear the music restart when loading your save data, it's because of this file.

===== Setup guides =====
* [[User:MistressNebula/MissionGen: Basic setup|Basic setup]]
* [[User:MistressNebula/MissionGen: Hook implementations|Hook implementations]]
* [[User:MistressNebula/MissionGen: Editing settings|Editing settings]]
* [[User:MistressNebula/MissionGen: String keys|String keys]]

===== Easy guides =====
* [[User:MistressNebula/MissionGen: Job boards|Setting up job boards]]
* [[User:MistressNebula/MissionGen: Reward cutscenes|Making reward cutscenes]]
** [[User:MistressNebula/MissionGen: Job Table|Job Table Documentation]]

===== Intermediate guide =====
* [[User:MistressNebula/MissionGen: Handcrafted jobs|Making handcrafted jobs]]

===== Advanced guide =====
* [[MissionGen guide: Job callbacks|Job callbacks]]