Draft:Tutorial: Adding The Mission Board - Revision history

FlowerSnek: /* Troubleshooting */

2025-01-14T02:17:22Z

Troubleshooting

← Older revision		Revision as of 02:17, 14 January 2025
Line 860:		Line 860:
	Make sure to double-check the require lines for each imported file to ensure that they reference your own mod, and not Enable Mission Board.		Make sure to double-check the require lines for each imported file to ensure that they reference your own mod, and not Enable Mission Board.

	===~~Problems with~~ text ~~strings~~===		===Mission text not displaying===

	The strings required for custom missions to work are located in two locations:		The strings required for custom missions to work are located in two locations:
Line 870:		Line 870:
	Make sure to put these strings in the proper locations for your mod. Do not change the names of any of these strings, unless any references to the changed name are also updated.		Make sure to put these strings in the proper locations for your mod. Do not change the names of any of these strings, unless any references to the changed name are also updated.

	===~~Problems with spawning mission~~ Pokémon===		===Mission Pokémon not appearing===

	Double-check that GenerateMissionFromSV is being called in your mod's Universal Events, and that the function is present in your mod's event_mapgen.lua.		Double-check that GenerateMissionFromSV is being called in your mod's Universal Events, and that the function is present in your mod's event_mapgen.lua.

	===~~Problems with mission~~ items===		===Mission items causing errors===

	If adding the mission items via copying and pasting the item data is not working, then adding the items manually is recommended. Make sure to delete the data you added to your mod's index.idx file, as well as the item files you pasted.		If adding the mission items via copying and pasting the item data is not working, then adding the items manually is recommended. Make sure to delete the data you added to your mod's index.idx file, as well as the item files you pasted.

FlowerSnek: /* Problems with text strings */

2024-11-28T00:25:39Z

Problems with text strings

← Older revision		Revision as of 00:25, 28 November 2024
Line 866:		Line 866:
	1. The Enable Mission Board/Strings folder, in both strings.resx and stringsEx.resx. These contain the global strings used to display mission data on your job list and elsewhere.		1. The Enable Mission Board/Strings folder, in both strings.resx and stringsEx.resx. These contain the global strings used to display mission data on your job list and elsewhere.

	2. The strings.resx folder for the ground map which the mission boards are located in. These contain the strings used just on this map, when completing a mission and receiving rewards.		2. The strings.resx folder for the ground map which the mission boards are located in. This is base_camp_2 for Enable Mission Board and default_map for Mission Board Example Mod; for your mod, it will be in the ground scripts folder for the map with the mission boards. These contain the strings used just on this map, when completing a mission and receiving rewards.

	Make sure to put these strings in the proper locations for your mod. Do not change the names of any of these strings, unless any references to the changed name are also updated.		Make sure to put these strings in the proper locations for your mod. Do not change the names of any of these strings, unless any references to the changed name are also updated.

FlowerSnek: /* DUNGEON_LIST */

2024-11-28T00:20:45Z

DUNGEON_LIST

← Older revision		Revision as of 00:20, 28 November 2024
Line 56:		Line 56:
	MISSION_GEN.DUNGEON_LIST["example_dungeon_b"] = { [0] = "E", [1] = "D" } --Example Dungeon B; Example Subdungeon B		MISSION_GEN.DUNGEON_LIST["example_dungeon_b"] = { [0] = "E", [1] = "D" } --Example Dungeon B; Example Subdungeon B
	</pre>		</pre>
	This entry states that the main section of Example Dungeon B has E-rank missions, but the subdungeon has D-rank missions instead.		This entry states that the main section of Example Dungeon B has E-rank missions, but the subdungeon has D-rank missions instead. Example Dungeon C does not have a second entry like this one; as such, its subdungeon is not eligible for missions.

	====DIFFICULTY====		====DIFFICULTY====

FlowerSnek: /* Problems with mission items */

2024-11-28T00:19:56Z

Problems with mission items

← Older revision		Revision as of 00:19, 28 November 2024
Line 876:		Line 876:
	===Problems with mission items===		===Problems with mission items===

	If adding the mission items via copying and pasting the item data is not working, then adding the items manually is recommended. Make sure to delete the data you added to your mod's index.idx file.		If adding the mission items via copying and pasting the item data is not working, then adding the items manually is recommended. Make sure to delete the data you added to your mod's index.idx file, as well as the item files you pasted.

	The important qualities for your mission items to have:		The important qualities for your mission items to have:

FlowerSnek at 00:18, 28 November 2024

2024-11-28T00:18:43Z

@@ Line 281: / Line 281: @@
-==Implementing custom missions==
+==Implementing Custom Missions==
 Now that you have these files added, PMDO has the necessary code to generate custom missions. However, by itself, this code won't do anything unless you edit your mod to make use of it.
@@ Line 731: / Line 731: @@
 This code is used to handle the aftermath of a mission, with Outlaw_Job_Clear handling the results of outlaw missions, and Mission_Job_Clear handling other types of missions. RewardEXP gives all Pokémon in the party EXP for having completed a mission.
 ==Optional: Creating a Separate Outlaw Board==
@@ Line 841: / Line 853: @@
      end
 </pre>
 ==Conclusion==

FlowerSnek: /* mission_gen.lua */

2024-11-17T16:49:25Z

mission_gen.lua

← Older revision		Revision as of 16:49, 17 November 2024
Line 81:		Line 81:

	The tables here control which items are in each reward class, and how likely they are to be selected as a reward. A higher number means that item is more likely to be the reward for a mission with a reward in that class.		The tables here control which items are in each reward class, and how likely they are to be selected as a reward. A higher number means that item is more likely to be the reward for a mission with a reward in that class.

			====SPECIAL_LOVER_PAIRS====
			The pairs of Pokémon here are ones which are eligible for the lover rescue missions. As the comment above says, the first Pokémon is the mission client, while the second is the mission target.

			====SPECIAL_CHILD_PAIRS====
			The pairs of Pokémon here are ones which are eligible for the parent-child rescue missions.

			====SPECIAL_FRIEND_PAIRS====
			The pairs of Pokémon here are ones which are eligible for the friend rescue missions.

			====SPECIAL_RIVAL_PAIRS====
			The pairs of Pokémon here are ones which are eligible for the rival rescue missions.

	====LOST_ITEMS====		====LOST_ITEMS====
Line 90:		Line 102:
	====DELIVERABLE_ITEMS====		====DELIVERABLE_ITEMS====
	Any item on this list is eligible to be asked for by a mission which wants an item delivered.		Any item on this list is eligible to be asked for by a mission which wants an item delivered.


	===scriptvars.lua===		===scriptvars.lua===

FlowerSnek: /* event_misc.lua */

2024-11-17T16:45:15Z

event_misc.lua

← Older revision		Revision as of 16:45, 17 November 2024
Line 139:		Line 139:
	===event_misc.lua===		===event_misc.lua===

	This file contains the scripts relating to picking up mission items. Copy and paste these ~~script~~ into your own mod's event_misc.lua file.		This file contains the scripts relating to picking up mission items. Copy and paste these scripts into your own mod's event_misc.lua file.


	===event_single.lua===		===event_single.lua===

FlowerSnek at 16:44, 17 November 2024

2024-11-17T16:44:17Z

← Older revision		Revision as of 16:44, 17 November 2024
Line 179:		Line 179:
	Copy and paste the services folder, as well as main.lua, into your own mod's Data/Script folder. Leave both of them as is.		Copy and paste the services folder, as well as main.lua, into your own mod's Data/Script folder. Leave both of them as is.

	Now, move to Enable Mission Board's Data/Item folder. ~~Copy~~ and paste ~~all the item files from it into your own mod's Item folder~~.		Now, move to Enable Mission Board's Data/Item folder. There are six entries for items in the mod, which are used for lost and stolen items for missions. You have two choices here: you can either add the items manually, or you can copy and paste their data.

	If your mod doesn't yet have any custom items, you can simply copy the index.idx file. Otherwise, open it in a text editor, and paste this code into it. This will let PMDO recognize the mission items.		If you add the items manually, open the Enable Mission Board mod in PMDO and look at the items to see which characteristics need to be added to your custom items.

			If you want to clone the existing items, copy and paste all the item files from Enable Mission Board's Item folder into your own mod's Item folder. If your mod doesn't yet have any custom items, you can simply copy the index.idx file. Otherwise, open it in a text editor, and paste this code into it. This will let PMDO recognize the mission items.
	<pre>		<pre>
	"mission_lost_band": {		"mission_lost_band": {
Line 263:		Line 265:
	</pre>		</pre>
	If PMDO is giving you an error after adding this code, go to https://jsonlint.com/ and paste the contents of index.idx into it to find any errors.		If PMDO is giving you an error after adding this code, go to https://jsonlint.com/ and paste the contents of index.idx into it to find any errors.

	Alternatively, if you don't want to edit the item files directly, you can simply add these items manually in PMDO's item editor. As long as you give them the same names as the ones used in your mission_gen.lua file for lost and stolen items, they'll work.

	Next, go to Enable Mission Board's Data/Strings folder, and copy strings.resx and stringsEx.resx. Then, paste them into your own mod's Strings folder. (If you've already edited these files for your own mod, just paste the strings from each into your own files.)		Next, go to Enable Mission Board's Data/Strings folder, and copy strings.resx and stringsEx.resx. Then, paste them into your own mod's Strings folder. (If you've already edited these files for your own mod, just paste the strings from each into your own files.)
Line 719:		Line 719:
	end		end
	</pre>		</pre>

			This code is used to handle the aftermath of a mission, with Outlaw_Job_Clear handling the results of outlaw missions, and Mission_Job_Clear handling other types of missions. RewardEXP gives all Pokémon in the party EXP for having completed a mission.

	==Optional: Creating a Separate Outlaw Board==		==Optional: Creating a Separate Outlaw Board==
Line 794:		Line 796:
	end		end
	</pre>		</pre>
	To fix this error, add a new function, MISSION_GEN.OutlawBoardIsEmpty(), with this code:		To fix this error, add a new function in mission_gen.lua, MISSION_GEN.OutlawBoardIsEmpty(), with this code:
	<pre>		<pre>
	function MISSION_GEN.OutlawBoardIsEmpty()		function MISSION_GEN.OutlawBoardIsEmpty()
Line 806:		Line 808:
	end		end
	</pre>		</pre>
	Then, ~~add this~~ function to BoardSelectionMenu~~:DrawMenu~~.		Then, make the DrawMenu function in BoardSelectionMenu use your new function.
	<pre>		<pre>
	function BoardSelectionMenu:DrawMenu()		function BoardSelectionMenu:DrawMenu()

FlowerSnek at 22:16, 16 November 2024

2024-11-16T22:16:32Z

← Older revision		Revision as of 22:16, 16 November 2024
Line 266:		Line 266:
	Alternatively, if you don't want to edit the item files directly, you can simply add these items manually in PMDO's item editor. As long as you give them the same names as the ones used in your mission_gen.lua file for lost and stolen items, they'll work.		Alternatively, if you don't want to edit the item files directly, you can simply add these items manually in PMDO's item editor. As long as you give them the same names as the ones used in your mission_gen.lua file for lost and stolen items, they'll work.

	Next, to Enable Mission Board's Data/Strings folder, and copy strings.resx and stringsEx.resx. Then, paste them into your own mod's Strings folder. (If you've already edited these files for your own mod, just paste the strings from each into your own files.)		Next, go to Enable Mission Board's Data/Strings folder, and copy strings.resx and stringsEx.resx. Then, paste them into your own mod's Strings folder. (If you've already edited these files for your own mod, just paste the strings from each into your own files.)

	Finally, go to Enable Mission Board's Content/Music folder, and copy the job clear music. Paste it into your own mod's Content/Music folder.		Finally, go to Enable Mission Board's Content/Music folder, and copy the job clear music. Paste it into your own mod's Content/Music folder.
Line 355:		Line 355:
	</pre>		</pre>
	These functions are interaction code for two objects on this map: MissionBoard, and OutlawBoard.		These functions are interaction code for two objects on this map: MissionBoard, and OutlawBoard.

			[[File:MissionTutorial_JobList.png\|frameless\|320px]]

	After these, add this function:		After these, add this function:

FlowerSnek: Fixed indentation

2024-11-16T21:54:54Z

Fixed indentation

← Older revision		Revision as of 21:54, 16 November 2024
Line 299:		Line 299:

	if SV.TemporaryFlags.MissionCompleted then		if SV.TemporaryFlags.MissionCompleted then
	default_map.Hand_In_Missions()		default_map.Hand_In_Missions()
	end		end

	GAME:FadeIn(20)		GAME:FadeIn(20)