Lua Script Migration - Revision history

Imbion at 17:39, 13 August 2025

2025-08-13T17:39:23Z

← Older revision		Revision as of 17:39, 13 August 2025
Line 203:		Line 203:
	* Functions identical to the base game are removed in the mod, for the files of common.lua and event.lua		* Functions identical to the base game are removed in the mod, for the files of common.lua and event.lua
	* Functions identical to the base game are removed in the mod, for the files in ground and zone		* Functions identical to the base game are removed in the mod, for the files in ground and zone
			[[Category:Maintenance]]

IDK: services clarification

2024-11-13T02:39:56Z

services clarification

← Older revision		Revision as of 02:39, 13 November 2024
Line 34:		Line 34:
	=== Services ===		=== Services ===

	Services behave slightly differently. Originally, creating a new service in the ~~mod~~ would add its events on top of the base game's events. However, it now replaces the original service and removes the base game's event triggers in favor of your new ones.		Services behave slightly differently. Originally, creating a new service with the same name as an existing base game service would add its events on top of the base game's events. However, it now replaces the original service and removes the base game's event triggers in favor of your new ones.

IDK: Reserialization advice

2024-07-15T02:46:30Z

Reserialization advice

← Older revision		Revision as of 02:46, 15 July 2024
Line 1:		Line 1:
	Between 0.8.1 and 0.8.2, the lua scripting system has changed.		Between 0.8.1 and 0.8.2, the lua scripting system has changed. This page explains all of the changes to the lua scripting system. There are many breaking changes, but when you reserialize mods between these versions, the lua scripts will go through an automatic conversion.
	~~When~~ you reserialize mods between these versions, the lua scripts will go through an automatic conversion.

			While PMDO tries to automatically convert as many things as it can, there are still a few points that must be handled by the mod developer. Consult the automatic conversion section at the bottom of this page for a general summary.

	== Diff Modding ==		== Diff Modding ==
Line 175:		Line 175:

	== Migration Checklist ==		== Migration Checklist ==

			You can reserialize your mod by running the command:

			<pre>
			PMDO.exe -quest My_Mod_Folder -reserialize all
			</pre>


	When you reserialize mods between these versions, the lua scripts will go through an automatic conversion. Some breaking changes detailed in the above section are automatically fixed. Some will not.		When you reserialize mods between these versions, the lua scripts will go through an automatic conversion. Some breaking changes detailed in the above section are automatically fixed. Some will not.

IDK: behavior on some improper ports

2024-07-15T02:39:15Z

behavior on some improper ports

← Older revision		Revision as of 02:39, 15 July 2024
Line 71:		Line 71:
	</pre>		</pre>

	★ This is done as a part of auto-conversion.		If this isn't done, the mod will complain about being unable to load modules that aren't there.


			References to these packages also need to be updated in places where they're used without require. Most notably, AI initialization. Ex: <code>AI:SetCharacterAI(partner, "ai.ground_partner", CH('PLAYER'), partner.Position)</code> should be changed to <code>AI:SetCharacterAI(partner, "origin.ai.ground_partner", CH('PLAYER'), partner.Position)</code> or <code>AI:SetCharacterAI(partner, "my_mod.ai.ground_partner", CH('PLAYER'), partner.Position)</code>, if your mod is overriding the original ai.

			If this isn't done, you will get AI errors on maps where ground character AI is supposed to work.

			★ This section is done as a part of auto-conversion.

	=== Starting Scripts ===		=== Starting Scripts ===
Line 92:		Line 99:
	<code>common.lua</code> and <code>event.lua</code> both make <code>require</code> calls to load their child scripts. If you have modded versions of the the child scripts, you will need to add the parent script with a single <code>require</code> call to the child. For example, if you modded <code>event_mapgen</code>, you will need to make sure you have an <code>event.lua</code> that has <code>require 'my_mod.event_mapgen</code> in it.		<code>common.lua</code> and <code>event.lua</code> both make <code>require</code> calls to load their child scripts. If you have modded versions of the the child scripts, you will need to add the parent script with a single <code>require</code> call to the child. For example, if you modded <code>event_mapgen</code>, you will need to make sure you have an <code>event.lua</code> that has <code>require 'my_mod.event_mapgen</code> in it.

	★ This is done as a part of auto-conversion.		★ This section is done as a part of auto-conversion.

	=== Automatic Tables ===		=== Automatic Tables ===
Line 117:		Line 124:
	** <code>FLOOR_GEN_SCRIPT = {}</code>		** <code>FLOOR_GEN_SCRIPT = {}</code>

	★ This is done as a part of auto-conversion.		★ This section is done as a part of auto-conversion.

	=== Services ===		=== Services ===
Line 124:		Line 131:

	* If you have services with the same name as those of the base game (<code>debug_tools</code>, <code>menu_tools</code>, <code>upgrade_tools</code>), your service now overwrites the original instead of adding onto it. If you want to add new functionality without overwriting the old, make a new service with a new name.		* If you have services with the same name as those of the base game (<code>debug_tools</code>, <code>menu_tools</code>, <code>upgrade_tools</code>), your service now overwrites the original instead of adding onto it. If you want to add new functionality without overwriting the old, make a new service with a new name.
	* The base game's <code>debug_tools</code> service used to have an event for <code>OnMenuButtonPressed</code>. That event has been moved out of the service and into its own service, <code>menu_tools</code>.		* The base game's <code>debug_tools</code> service used to have an event for <code>OnMenuButtonPressed</code>. That event has been moved out of the service and into its own service, <code>menu_tools</code>. If you are overriding OnMenuPressed in any services and do not replace menu_tools, you will have the main menu opened twice when menu button is pressed!


Line 143:		Line 150:
	Then, you should change all references to <code>MapStrings</code> to <code>STRINGS.MapStrings</code>		Then, you should change all references to <code>MapStrings</code> to <code>STRINGS.MapStrings</code>

	★ This is done as a part of auto-conversion.		★ This section is done as a part of auto-conversion.

	=== Redundant Functions ===		=== Redundant Functions ===
Line 165:		Line 172:
	</pre>		</pre>

	★ This is done as a part of auto-conversion.		★ This section is done as a part of auto-conversion.

	== Migration Checklist ==		== Migration Checklist ==

IDK: remove extra require statements

2024-07-08T19:33:53Z

remove extra require statements

← Older revision		Revision as of 19:33, 8 July 2024
Line 157:		Line 157:
	* The folder <code>Data/Script/lib</code>		* The folder <code>Data/Script/lib</code>

	You can safely delete them.		You can safely delete them. Their require statements in <code>common.lua</code> are also no longer needed:

			<pre>
			Class = require 'lib.middleclass'
			Mediator = require 'lib.mediator'
			Serpent = require 'lib.serpent'
			</pre>

	★ This is done as a part of auto-conversion.		★ This is done as a part of auto-conversion.

IDK: auto-convert starting scripts

2024-07-08T18:50:38Z

auto-convert starting scripts

← Older revision		Revision as of 18:50, 8 July 2024
Line 92:		Line 92:
	<code>common.lua</code> and <code>event.lua</code> both make <code>require</code> calls to load their child scripts. If you have modded versions of the the child scripts, you will need to add the parent script with a single <code>require</code> call to the child. For example, if you modded <code>event_mapgen</code>, you will need to make sure you have an <code>event.lua</code> that has <code>require 'my_mod.event_mapgen</code> in it.		<code>common.lua</code> and <code>event.lua</code> both make <code>require</code> calls to load their child scripts. If you have modded versions of the the child scripts, you will need to add the parent script with a single <code>require</code> call to the child. For example, if you modded <code>event_mapgen</code>, you will need to make sure you have an <code>event.lua</code> that has <code>require 'my_mod.event_mapgen</code> in it.

			★ This is done as a part of auto-conversion.

	=== Automatic Tables ===		=== Automatic Tables ===
Line 170:		Line 171:
	* ★ References to your own scripts <code>require "yourscript"</code> changed to include your namespace <code>require "yournamespace.yourscript"</code>		* ★ References to your own scripts <code>require "yourscript"</code> changed to include your namespace <code>require "yournamespace.yourscript"</code>
	* ★ common and event scripts need their empty table declarations removed.		* ★ common and event scripts need their empty table declarations removed.
	* Scripts modded from children of <code>common.lua</code> or <code>event.lua</code> must have a modded version of their parent with an include to the child.		* ★ Scripts modded from children of <code>common.lua</code> or <code>event.lua</code> must have a modded version of their parent with an include to the child.
	* Services that have the same name as the base game's service need to be renamed.		* Services that have the same name as the base game's service need to be renamed, IF you don't want to overwrite the base logic.

	These are optional changes that you don't have to make, but is good to clean up files or code no longer needed:		These are optional changes that you don't have to make, but is good to clean up files or code no longer needed:

IDK at 18:29, 7 July 2024

2024-07-07T18:29:11Z

← Older revision		Revision as of 18:29, 7 July 2024
Line 177:		Line 177:
	* ★ MapStrings is deprecated.		* ★ MapStrings is deprecated.
	** ★ Remove variable declaration and initialization statements.		** ★ Remove variable declaration and initialization statements.
	** ★ ~~Instead of~~ <code>MapStrings</code>~~, use~~ STRINGS.MapStrings</code>		** ★ Replace references to <code>MapStrings</code> with <code>STRINGS.MapStrings</code>
	* ★ Deleted <code>Data/Script/bin</code> and <code>Data/Script/lib</code> subfolders		* ★ Deleted <code>Data/Script/bin</code> and <code>Data/Script/lib</code> subfolders
	* ★ Deleted <code>Data/Script/services/baseservice.lua</code> file		* ★ Deleted <code>Data/Script/services/baseservice.lua</code> file
	* Functions identical to the base game are removed in the mod, for the files of common.lua and event.lua		* Functions identical to the base game are removed in the mod, for the files of common.lua and event.lua
	* Functions identical to the base game are removed in the mod, for the files in ground and zone		* Functions identical to the base game are removed in the mod, for the files in ground and zone

IDK: Non-breaking changes.

2024-07-07T03:47:53Z

Non-breaking changes.

@@ Line 39: / Line 39: @@
 == Breaking Changes ==
-=== Namespaces ===
+=== Namespace Folders ===
 With the diff modding changes, a caveat is that all lua scripts are namespaced.  This way, you can reference methods from the base game specifically.  However, it means that all scripts need to be moved to a subfolder in the name of your mod's namespace.
@@ Line 45: / Line 45: @@
 For example, your mod has the namespace <code>my_mod</code>, and your scripts are currently in the <code>Data/Script</code> folder of your mod (You can find/specify your mod's namespace in the <code>Mod.xml</code>).  In this situation, you should move all your code to a new folder, <code>Data/Script/my_mod</code>
 Additionally, your <code>require</code> calls must be updated to specify whether you're importing code from the <code>origin</code> namespace or your own namespace.  And meanwhile, if you made custom scripts on your own mod, you need to instead change the require to reflect your namespace, because the code is in your namespace of mod.  For example, the header of a ground map script you created may look like this:
@@ Line 67: / Line 70: @@
 require 'my_mod.ground.my_town.my_town_ch_2'
 </pre>
 === Starting Scripts ===
@@ Line 111: / Line 116: @@
 ** <code>FLOOR_GEN_SCRIPT = {}</code>
 === Services ===
@@ Line 118: / Line 124: @@
 * If you have services with the same name as those of the base game (<code>debug_tools</code>, <code>menu_tools</code>, <code>upgrade_tools</code>), your service now overwrites the original instead of adding onto it.  If you want to add new functionality without overwriting the old, make a new service with a new name.
 * The base game's <code>debug_tools</code> service used to have an event for <code>OnMenuButtonPressed</code>.  That event has been moved out of the service and into its own service, <code>menu_tools</code>.
 == Migration Checklist ==
@@ Line 135: / Line 176: @@
 * ★ MapStrings is deprecated.
-** ★ This means the initial variable declaration is removed
+** ★ Remove variable declaration and initialization statements.
 ** ★ Instead of <code>MapStrings</code>, use STRINGS.MapStrings</code>
 * ★ Deleted <code>Data/Script/bin</code> and <code>Data/Script/lib</code> subfolders
 * ★ Deleted <code>Data/Script/services/baseservice.lua</code> file
-* ★ Functions identical to the base game are removed in the mod, for the files of common.lua and event.lua
+* Functions identical to the base game are removed in the mod, for the files of common.lua and event.lua
 * Functions identical to the base game are removed in the mod, for the files in ground and zone

IDK: common script

2024-07-04T21:31:53Z

common script

IDK: remove declarations

2024-07-04T18:49:13Z

remove declarations

← Older revision		Revision as of 18:49, 4 July 2024
Line 67:		Line 67:
	require 'my_mod.ground.my_town.my_town_ch_2'		require 'my_mod.ground.my_town.my_town_ch_2'
	</pre>		</pre>


	=== Starting Scripts ===		=== Starting Scripts ===
Line 75:		Line 74:
	* <code>main.lua</code>		* <code>main.lua</code>
	* <code>common.lua</code>		* <code>common.lua</code>
	** <code>common_talk</code>		** <code>common_talk.lua</code>
	** <code>common_shop</code>		** <code>common_shop.lua</code>
	** <code>common_vars</code>		** <code>common_vars.lua</code>
	** <code>common_tutor</code>		** <code>common_tutor.lua</code>
	* <code>event.lua</code>		* <code>event.lua</code>
	** <code>event_single</code>		** <code>event_single.lua</code>
	** <code>event_battle</code>		** <code>event_battle.lua</code>
	** <code>event_misc</code>		** <code>event_misc.lua</code>
	** <code>event_mapgen</code>		** <code>event_mapgen.lua</code>
	* <code>include.lua</code>		* <code>include.lua</code>

	<code>common.lua</code> and <code>event.lua</code> both make <code>require</code> calls to load their child scripts. If you have modded versions of the the child scripts, you will need to add the parent script with a single <code>require</code> call to the child. For example, if you modded <code>event_mapgen</code>, you will need to make sure you have an <code>event.lua</code> that has <code>require 'my_mod.event_mapgen</code> in it.		<code>common.lua</code> and <code>event.lua</code> both make <code>require</code> calls to load their child scripts. If you have modded versions of the the child scripts, you will need to add the parent script with a single <code>require</code> call to the child. For example, if you modded <code>event_mapgen</code>, you will need to make sure you have an <code>event.lua</code> that has <code>require 'my_mod.event_mapgen</code> in it.


			=== Automatic Event Tables ===

			The tables for event scripts, such as <code>SINGLE_CHAR_SCRIPT</code>, <code>BATTLE_SCRIPT</code>, and so on, are now declared by the game's code, so you don't need to declare them as empty tables anymore. You shouldn't, because the modding system stacks the base game's methods with your mod's on top, and redefining the variable would result in your mod removing the base game's functions.

			You will need to remove these lines from the event scripts:

			* <code>event_single.lua</code>:
			** <code>SINGLE_CHAR_SCRIPT = {}</code>
			* <code>event_battle.lua</code>:
			** <code>BATTLE_SCRIPT= {}</code>
			* <code>event_misc.lua</code>:
			** <code>STATUS_SCRIPT = {}</code>
			** <code>MAP_STATUS_SCRIPT = {}</code>
			** <code>ITEM_SCRIPT = {}</code>
			** <code>REFRESH_SCRIPT = {}</code>
			** <code>SKILL_CHANGE_SCRIPT = {}</code>
			** <code>GROUND_ITEM_EVENT_SCRIPT = {}</code>
			* <code>event_mapgen.lua</code>:
			** <code>ZONE_GEN_SCRIPT = {}</code>
			** <code>FLOOR_GEN_SCRIPT = {}</code>


	=== Services ===		=== Services ===
Line 104:		Line 126:
	* ★ References to <code>require "common"</code> become <code>require "origin.common"</code>		* ★ References to <code>require "common"</code> become <code>require "origin.common"</code>
	* ★ References to your own scripts <code>require "yourscript"</code> changed to include your namespace <code>require "yournamespace.yourscript"</code>		* ★ References to your own scripts <code>require "yourscript"</code> changed to include your namespace <code>require "yournamespace.yourscript"</code>
			* ★ event scripts need their empty table declarations removed.
	* Scripts modded from children of <code>common.lua</code> or <code>event.lua</code> must have a modded version of their parent with an include to the child.		* Scripts modded from children of <code>common.lua</code> or <code>event.lua</code> must have a modded version of their parent with an include to the child.
	* Services that have the same name as the base game's service need to be renamed.		* Services that have the same name as the base game's service need to be renamed.

← Older revision		Revision as of 21:31, 4 July 2024
Line 88:		Line 88:


	=== Automatic ~~Event~~ Tables ===		=== Automatic Tables ===

	The tables for event scripts, such as <code>SINGLE_CHAR_SCRIPT</code>, <code>BATTLE_SCRIPT</code>, and so on, are now declared by the game's code, so you don't need to declare them as empty tables anymore. You shouldn't, because the modding system stacks the base game's methods with your mod's on top, and redefining the variable would result in your mod removing the base game's functions.		The tables for common scripts and event scripts, such as <code>SINGLE_CHAR_SCRIPT</code>, <code>BATTLE_SCRIPT</code>, and so on, are now declared by the game's code, so you don't need to declare them as empty tables anymore. You shouldn't, because the modding system stacks the base game's methods with your mod's on top, and redefining the variable would result in your mod removing the base game's functions.

	You will need to remove these lines from the event scripts:		You will need to remove these lines from the event scripts:

			* <code>common.lua</code>:
			** <code>COMMON = {}</code>
	* <code>event_single.lua</code>:		* <code>event_single.lua</code>:
	** <code>SINGLE_CHAR_SCRIPT = {}</code>		** <code>SINGLE_CHAR_SCRIPT = {}</code>
Line 126:		Line 128:
	* ★ References to <code>require "common"</code> become <code>require "origin.common"</code>		* ★ References to <code>require "common"</code> become <code>require "origin.common"</code>
	* ★ References to your own scripts <code>require "yourscript"</code> changed to include your namespace <code>require "yournamespace.yourscript"</code>		* ★ References to your own scripts <code>require "yourscript"</code> changed to include your namespace <code>require "yournamespace.yourscript"</code>
	* ★ event scripts need their empty table declarations removed.		* ★ common and event scripts need their empty table declarations removed.
	* Scripts modded from children of <code>common.lua</code> or <code>event.lua</code> must have a modded version of their parent with an include to the child.		* Scripts modded from children of <code>common.lua</code> or <code>event.lua</code> must have a modded version of their parent with an include to the child.
	* Services that have the same name as the base game's service need to be renamed.		* Services that have the same name as the base game's service need to be renamed.