MistressNebula: /* ObjectiveOverride */ Account for 1.0.1 changes

2025-08-01T15:03:46Z

ObjectiveOverride: Account for 1.0.1 changes

← Older revision		Revision as of 15:03, 1 August 2025
Line 132:		Line 132:


	==== ~~ObjectiveOverride~~ ====		==== MenuOverrides ====
	~~A string key that, if set, is~~ used instead of the ~~job type's objective key~~. It only ~~affects~~ menus.		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.

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

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

2025-07-29T18:00:42Z

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

← Older revision	Revision as of 18:00, 29 July 2025
(No difference)

MistressNebula: Fix mistake

2025-07-29T14:08:33Z

Fix mistake

← Older revision		Revision as of 14:08, 29 July 2025
Line 14:		Line 14:


	==== ~~Client~~ ====		==== Target ====
	MonsterID style table describing the target. Must be set if the job type expects a target.		MonsterID style table describing the target. Must be set if the job type expects a target.
	====== Type ======		====== Type ======

MistressNebula: Make page

2025-07-28T18:53:00Z

Make page

New page

This page contains a list of all fields contained inside a Job Table.</br>
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>

==== Client ====
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:</br>
<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:</br>
<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__

Mod:Nebula's Mission Board/ Job Table - Revision history

MistressNebula: /* ObjectiveOverride */ Account for 1.0.1 changes

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

MistressNebula: Fix mistake

MistressNebula: Make page