Mod:Nebula's Mission Board/ Editing settings - Revision history

MistressNebula: Update documentation

2026-01-03T15:27:41Z

Update documentation

← Older revision		Revision as of 15:27, 3 January 2026
Line 840:		Line 840:
	<pre>COMMON</pre>		<pre>COMMON</pre>

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

	Adds a new dungeon section to the list of possible job destinations.		Adds a new dungeon section to the list of possible job destinations.
Line 853:		Line 853:
	* <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>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>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 ===		=== Example ===
Line 858:		Line 859:
	<pre>		<pre>
	settings.AddDungeonSection("faultline_ridge", 0, 6, "D", 10)		settings.AddDungeonSection("faultline_ridge", 0, 6, "D", 10)
	settings.AddDungeonSection("sickly_hollow", 0, 9, "S", 16, false)		settings.AddDungeonSection("sickly_hollow", 0, 9, "S", 16, false, 8)
	settings.AddDungeonSection("sickly_hollow", 0, 13, "STAR_1")		settings.AddDungeonSection("sickly_hollow", 0, 13, "STAR_1")

MistressNebula: /* boards */ 1.0.3 changes

2025-08-24T09:02:50Z

boards: 1.0.3 changes

← Older revision		Revision as of 09:02, 24 August 2025
Line 28:		Line 28:
	},		},
	condition: function(library),		condition: function(library),
			dungeons: string[],
	job_types: {id = string, weight = integer}[]		job_types: {id = string, weight = integer}[]
	}</nowiki></pre>		}</nowiki></pre>
Line 35:		Line 36:
	* 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.		* 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.		* 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.		* job_types: a list of job types and their probability weight. Higher weight means more common.

Line 72:		Line 74:
	}		}
	}</pre>		}</pre>


	== end_dungeon_day_destination ==		== end_dungeon_day_destination ==

MistressNebula: Account for 1.0.1 changes

2025-08-01T14:17:59Z

Account for 1.0.1 changes

← Older revision		Revision as of 14:17, 1 August 2025
Line 625:		Line 625:

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

	=== Example ===		=== Example ===
Line 653:		Line 654:

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

	=== Example ===		=== Example ===
Line 743:		Line 745:

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

	=== Example ===		=== Example ===

MistressNebula: /* mission_callback_root */ Redirect

2025-07-30T13:55:49Z

mission_callback_root: Redirect

← Older revision		Revision as of 13:55, 30 July 2025
Line 831:		Line 831:
	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.		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]].		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 ===		=== Example ===
	<pre>COMMON</pre>		<pre>COMMON</pre>



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

MistressNebula: Redirect

2025-07-29T17:41:02Z

Redirect

← Older revision		Revision as of 17:41, 29 July 2025
Line 304:		Line 304:

	This is where dungeon difficulty is set. Quests can only generate for dungeons inside this list.		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.		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.

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

2025-07-29T17:38:05Z

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

← Older revision	Revision as of 17:38, 29 July 2025
(No difference)

MistressNebula: /* target_items */ Warning regarding mission items

2025-07-28T13:04:10Z

target_items: Warning regarding mission items

← Older revision		Revision as of 13:04, 28 July 2025
Line 545:		Line 545:
	Make sure they're either easy enough to obtain or impossible to lose, depending on the job.		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.</br>		Using stackable items is highly discouraged for all job types, as it may result in odd behaviors.</br>
			''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.''</br>
	Format: <code><job_type_id>: <item_id>[]</code>		Format: <code><job_type_id>: <item_id>[]</code>
	* <job_type_id>: the id of a job type defined inside "job_types"		* <job_type_id>: the id of a job type defined inside "job_types"
Line 570:		Line 571:
	[...]		[...]
	}</pre>		}</pre>


	== difficulty_to_tier ==		== difficulty_to_tier ==

MistressNebula: Minor docs fix

2025-07-27T09:27:05Z

Minor docs fix

← Older revision		Revision as of 09:27, 27 July 2025
Line 33:		Line 33:
	* 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)		* 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		* size: the amount of quests this board can hold at a time
	* location: a zone id, a map index ~~and~~ the ~~board's X and Y coordinates. These coordinates~~ will be ~~used as the center point~~ for ~~the "client" area of~~ the job completion cutscene. All of these maps must call library:PlayJobsCompletedCutscene before fade-in for the reward sequence to work correctly.		* 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.		* 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.		* job_types: a list of job types and their probability weight. Higher weight means more common.

MistressNebula: Make layout more consistent

2025-07-26T09:47:12Z

Make layout more consistent

Show changes

MistressNebula: Make page in mostly done state

2025-07-25T17:19:35Z

Make page in mostly done state

Show changes