Tutorial:Creating Map Statuses - Revision history

Imbion: Imbion moved page Creating Map Statuses to Tutorial:Creating Map Statuses

2025-10-16T15:42:16Z

Imbion moved page Creating Map Statuses to Tutorial:Creating Map Statuses

← Older revision	Revision as of 15:42, 16 October 2025
(No difference)

Shitpost Sunkern: typo fix

2024-04-16T19:37:40Z

typo fix

← Older revision		Revision as of 19:37, 16 April 2024
Line 2:		Line 2:

	We want to add a terrain that does the following:		We want to add a terrain that does the following:
	* Boosts the power of Dark-type ~~mover~~		* Boosts the power of Dark-type moves
	* Lowers the Attack Range of non-Dark and Ghost type Pokémon		* Lowers the Attack Range of non-Dark and Ghost type Pokémon

Trio at 19:45, 18 June 2023

2023-06-18T19:45:32Z

← Older revision		Revision as of 19:45, 18 June 2023
Line 253:		Line 253:
	* Our player information is found in the context.User variable. We check the user's first type and see if it's not Dark or Ghost and then the second type and see if it's not Dark or Ghost		* Our player information is found in the context.User variable. We check the user's first type and see if it's not Dark or Ghost and then the second type and see if it's not Dark or Ghost
	* We then create an AddRangeEvent which is a BattleEvent defined [https://github.com/PMDCollab/PMDC/blob/af9993668fa6f609d582624daf88eda4042e343c/PMDC/Dungeon/GameEffects/BattleEvent.cs#L4210-L4231 here] and apply the range modification with "TASK:WaitTask(effect:Apply(owner, ownerChar, context))"		* We then create an AddRangeEvent which is a BattleEvent defined [https://github.com/PMDCollab/PMDC/blob/af9993668fa6f609d582624daf88eda4042e343c/PMDC/Dungeon/GameEffects/BattleEvent.cs#L4210-L4231 here] and apply the range modification with "TASK:WaitTask(effect:Apply(owner, ownerChar, context))"
			* Note: the methods for context is defined [https://github.com/RogueCollab/RogueEssence/blob/73d0421a2ec567117af46047c6629bb9131dc984/RogueEssence/Dungeon/GameEffects/BattleContext.cs#LL17C18-L17C31 here].
			* Also note: the methods for User is defined [https://github.com/RogueCollab/RogueEssence/blob/73d0421a2ec567117af46047c6629bb9131dc984/RogueEssence/Dungeon/Characters/Character.cs#LL18C1-L18C1 here].
	We have defined the logic of MurkyTerrainOnActionEvent! The last step is create our move to initiate Murky Terrain.		We have defined the logic of MurkyTerrainOnActionEvent! The last step is create our move to initiate Murky Terrain.

Trio at 19:37, 18 June 2023

2023-06-18T19:37:13Z

← Older revision		Revision as of 19:37, 18 June 2023
Line 274:		Line 274:
	We'll do something similar before and use the Skill electric_terrain as the base. Find electric_terrain.json in PMDO/Data/Skills and open it with your text editor of choice and copy the contents over to murky_terrain.json in PMDO/MODS/{MOD_NAME}/Data/Skills		We'll do something similar before and use the Skill electric_terrain as the base. Find electric_terrain.json in PMDO/Data/Skills and open it with your text editor of choice and copy the contents over to murky_terrain.json in PMDO/MODS/{MOD_NAME}/Data/Skills

	~~murky_terrain.json~~ should now look like the following		The move Murky Terrain should now look like the following:


	[[File:MapStatus_SkillStart.png\|frameless]]		[[File:MapStatus_SkillStart.png\|frameless]]

Trio at 19:35, 18 June 2023

2023-06-18T19:35:39Z

← Older revision		Revision as of 19:35, 18 June 2023
Line 252:		Line 252:
	* To let the engine know we're creating a BattleEvent, we must initialize BATTLE_SCRIPT and then define our function MurkyTerrainOnActionEvent		* To let the engine know we're creating a BattleEvent, we must initialize BATTLE_SCRIPT and then define our function MurkyTerrainOnActionEvent
	* Our player information is found in the context.User variable. We check the user's first type and see if it's not Dark or Ghost and then the second type and see if it's not Dark or Ghost		* Our player information is found in the context.User variable. We check the user's first type and see if it's not Dark or Ghost and then the second type and see if it's not Dark or Ghost
	* We then create an AddRangeEvent which is a BattleEvent defined		* We then create an AddRangeEvent which is a BattleEvent defined [https://github.com/PMDCollab/PMDC/blob/af9993668fa6f609d582624daf88eda4042e343c/PMDC/Dungeon/GameEffects/BattleEvent.cs#L4210-L4231 here] and apply the range modification with "TASK:WaitTask(effect:Apply(owner, ownerChar, context))"
	[https://github.com/PMDCollab/PMDC/blob/af9993668fa6f609d582624daf88eda4042e343c/PMDC/Dungeon/GameEffects/BattleEvent.cs#L4210-L4231 here] and apply the range modification with "TASK:WaitTask(effect:Apply(owner, ownerChar, context))"

	We have defined the logic of MurkyTerrainOnActionEvent! The last step is create our move to initiate Murky Terrain.		We have defined the logic of MurkyTerrainOnActionEvent! The last step is create our move to initiate Murky Terrain.

Trio at 15:55, 18 June 2023

2023-06-18T15:55:04Z

← Older revision		Revision as of 15:55, 18 June 2023
Line 108:		Line 108:

	Scroll down to "On Map Status Removes"		Scroll down to "On Map Status Removes"

	[[File:MapStatus_OnMapStatusRemoves.png\|frameless]]		[[File:MapStatus_OnMapStatusRemoves.png\|frameless]]

Line 235:		Line 236:

	Create a file called "event_battle.lua" in "PMDO/MODS/{MOD_NAME}/SCRIPT". And copy the code below into the file.		Create a file called "event_battle.lua" in "PMDO/MODS/{MOD_NAME}/SCRIPT". And copy the code below into the file.

	~~[[File:MapStatus_ElectricTerrainState.png\|frameless]]~~

	<pre>		<pre>
Line 251:		Line 250:
	end		end
	</pre>		</pre>
			* To let the engine know we're creating a BattleEvent, we must initialize BATTLE_SCRIPT and then define our function MurkyTerrainOnActionEvent
	* We check the user's first type and see if it's not Dark or Ghost and then the second type and see if it's not Dark or Ghost		* Our player information is found in the context.User variable. We check the user's first type and see if it's not Dark or Ghost and then the second type and see if it's not Dark or Ghost
	* We then create an AddRangeEvent which is a BattleEvent defined ~~here~~..~~. <>~~ and apply the range modification with "TASK:WaitTask(effect:Apply(owner, ownerChar, context))"		* We then create an AddRangeEvent which is a BattleEvent defined
			[https://github.com/PMDCollab/PMDC/blob/af9993668fa6f609d582624daf88eda4042e343c/PMDC/Dungeon/GameEffects/BattleEvent.cs#L4210-L4231 here] and apply the range modification with "TASK:WaitTask(effect:Apply(owner, ownerChar, context))"

	We have defined the logic of MurkyTerrainOnActionEvent! The last step is create our move to initiate Murky Terrain.		We have defined the logic of MurkyTerrainOnActionEvent! The last step is create our move to initiate Murky Terrain.

Trio at 15:40, 18 June 2023

2023-06-18T15:40:53Z

← Older revision		Revision as of 15:40, 18 June 2023
Line 219:		Line 219:

	The lines of interests shown below, which define the name of the key and value messages our new terrain will use:		The lines of interests shown below, which define the name of the key and value messages our new terrain will use:

	<pre>		<pre>
	<data name="MSG_MURKY_TERRAIN_START" xml:space="preserve">		<data name="MSG_MURKY_TERRAIN_START" xml:space="preserve">
Line 236:		Line 237:

	[[File:MapStatus_ElectricTerrainState.png\|frameless]]		[[File:MapStatus_ElectricTerrainState.png\|frameless]]

	<pre>		<pre>
	BATTLE_SCRIPT = {}		BATTLE_SCRIPT = {}
Line 251:		Line 253:

	* We check the user's first type and see if it's not Dark or Ghost and then the second type and see if it's not Dark or Ghost		* We check the user's first type and see if it's not Dark or Ghost and then the second type and see if it's not Dark or Ghost
	* We then create an AddRangeEvent which is a BattleEvent defined here... ~~[add link to ]~~ and apply the range modification with "TASK:WaitTask(effect:Apply(owner, ownerChar, context))"		* We then create an AddRangeEvent which is a BattleEvent defined here... <> and apply the range modification with "TASK:WaitTask(effect:Apply(owner, ownerChar, context))"

	We have defined the logic of MurkyTerrainOnActionEvent! The last step is create our move to initiate Murky Terrain.		We have defined the logic of MurkyTerrainOnActionEvent! The last step is create our move to initiate Murky Terrain.
Line 265:		Line 267:
	Click on [Add]		Click on [Add]

	[[File:~~MapStatus_ElectricTerrainState~~.png\|frameless]]		[[File:MapStatus_SkillList.png\|frameless]]
	[~~[File:MapStatus_ElectricTerrainState~~.~~png\|frameless]]~~
	[[File:~~MapStatus_ElectricTerrainState~~.png\|frameless]]		Name the Move and click [OK].
	[[File:~~MapStatus_ElectricTerrainState~~.png\|frameless]]
	~~[[File~~:~~MapStatus_ElectricTerrainState~~.~~png\|frameless]~~]		[[File:MapStatus_Name.png\|frameless\|150px]]
	[[File:~~MapStatus_ElectricTerrainState~~.png\|frameless]]
	[[File:~~MapStatus_ElectricTerrainState~~.png\|frameless]]		We'll do something similar before and use the Skill electric_terrain as the base. Find electric_terrain.json in PMDO/Data/Skills and open it with your text editor of choice and copy the contents over to murky_terrain.json in PMDO/MODS/{MOD_NAME}/Data/Skills
	[[File:~~MapStatus_ElectricTerrainState~~.png\|frameless]]
	[~~[File:MapStatus_ElectricTerrainState.png\|frameless]~~]		murky_terrain.json should now look like the following
	[[File:~~MapStatus_ElectricTerrainState~~.png\|frameless]]
	[[File:~~MapStatus_ElectricTerrainState~~.png\|frameless]]
	[[~~File~~:~~MapStatus_ElectricTerrainState.png\|frameless~~]]		[[File:MapStatus_SkillStart.png\|frameless]]

			Similar to previously, do the following:
			* Set the Name to Murky Terrain (Remove all the Local Text)
			* Set the Desc to be "The user shrouds the battlefield with darkness. All non-Dark and Ghost type Pokemon have their Attack Range lowered."
			* Double-click on [Edit] under Data

			[[File:MapStatus_SkillDataStart.png\|frameless]]

			Set Element to be Dark. Then scroll down until you see "On Hits"

			[[File:MapStatus_SkillOnHits.png\|frameless]]

			Double-click on PMDC.Dungeon.GiveMapStatusEvent

			Change the Status ID to Murky Terrain. This is our map status that we just created!

			[[File:MapStatus_SkillMapStatusChange.png\|frameless]]

			Click [OK] and save close out all the windows and save!

			Enter a dungeon and teach someone Murky Terrain through the Dev Menu

			[[File:MapStatus_MurkyDevMenu.png\|frameless]]

			If everything is working correctly, you should see the following result! You'll notice that ranged moves, such as Quick Attack reach 1-tile shorter.

			[[File:MapStatus_MurkyTerrain.png\|frameless]]

			This concludes adding your own map statuses! This tutorial was more involved and covered topics such as adding your own strings and custom Lua BattleEvents!

			[[Category:Modding Data]]

Trio: Created page with "Before starting, it is highly recommended that you follow the other modding tutorials like Creating Moves tutorial as this tutorial is more involved and will move quicker. Make your game is set to a mod in Modding Intro so that you’re editing a mod instead of the base game. We want to add a terrain that does the following: * Boosts the power of Dark-type mover * Lowers the Attack Range of non-Dark and Ghost type Pokémon This will involve modding the terrain,..."

2023-06-18T15:26:31Z

Created page with "Before starting, it is highly recommended that you follow the other modding tutorials like Creating Moves tutorial as this tutorial is more involved and will move quicker. Make your game is set to a mod in Modding Intro so that you’re editing a mod instead of the base game. We want to add a terrain that does the following: * Boosts the power of Dark-type mover * Lowers the Attack Range of non-Dark and Ghost type Pokémon This will involve modding the terrain,..."

New page

Before starting, it is highly recommended that you follow the other modding tutorials like [[Creating Moves]] tutorial as this tutorial is more involved and will move quicker. Make your game is set to a mod in [[Modding Intro]] so that you’re editing a mod instead of the base game.

We want to add a terrain that does the following:
* Boosts the power of Dark-type mover
* Lowers the Attack Range of non-Dark and Ghost type Pokémon

This will involve modding the terrain, creating the move to spawn the terrain, and also writing a custom Lua BattleScript! We'll be using Electric Terrain as the base.

== Creating the Terrain ==
Begin by creating a new map status in the MapStatus list.

[[File:DevPanel_Data.png|frameless]]

Click on [Add]. Name the map status and click [OK].

[[File:MapStatus_Name.png|frameless|150px]]

You should see your new map status at the bottom of the list! A new file called "murky_terrain.json" should have also appeared in "PMDO/MODS/{MOD_NAME}/Data/MapStatus".

[[File:MapStatus_FileLocation.png|frameless]]

Now, locate "electric_terrain.json" in "PMDO/MapStatus" and open it with your text editor of choice. You should see something like so:

<pre>
{

"Version": "0.7.12.0",
"Object": {
"$type": "RogueEssence.Data.MapStatusData, RogueEssence",
"Name": {
"DefaultText": "Electric Terrain",
"LocalTexts": {
"fr": "Champ Électrifié",
"de": "Elektrofeld",
"es": "Campo Eléctrico",
"zh-hans": "电气场地"
},
...
</pre>

Copy everything in "electric_terrain.json" and replace the contents of "murky_terrain.json". If you click on murky_terrain in the MapStatus, you should see something similar to below:

[[File:MapStatus_ElectricTerrainState.png|frameless]]

Do the following actions shown below:
* Rename the Name to Murky Terrain (Delete the other Local Texts)
* Rename the Desc to "Dark-type attacks are boosted, and non-Dark and Ghost type Pokémon have their Attack Range lowered." (Delete the other Local Texts)

Then, click on [Edit] under Emitter

[[File:MapStatus_EmitterStart.png|frameless]]

If you click [Test] while in a dungeon, you'll see the effect below.

[[File:MapStatus_TerrainInitialTest.png|frameless]]

We want to have a dark fog effect instead!

Click on [Anim]. Set the Anim Index to be Fog_2 and click [OK].

[[File:MapStatus_EmitterAnim.png|frameless]]

Then do the following and compare to the results below:
* Under Movement, set X = -32 and set Y = -32. This will shift the background continuously
* Under Color, set R, G, B = 0 and set A = 160.

[[File:MapStatus_EmitterEnd.png|frameless]]

If you enter another floor and test the Emitter again, you'll see the follow animated effect!

[[File:MapStatus_TerrainFinishTest.png|frameless]]

[[File:MapStatus_EmitterEnd.png|frameless]]

Click [OK]

We'll now modify/add events to better suit Murky Terrain!

First, scroll down until you see "Before Status Adds"

[[File:MapStatus_BeforeStatus.png|frameless]]

Delete all the PMDC.Dungeon.PreventStatusCheck events shown above. These are specific events to Electric Terrain to prevent Sleep, which are not needed for Murky Terrain.

Scroll down down until you see "On Map Status Adds"

[[File:MapStatus_MapStatusAdd.png|frameless]]

Click on PMDC.Dungeon.MapStatusSoundEvent

[[File:MapStatus_MapStatusSound.png|frameless]]

Change the Sound to DUN_Night_Shade_3 and click [OK]

[[File:MapStatus_MapStatusAdd.png|frameless]]

Then, click on PMDC.Dungeon.MapStatusBattleLogEvent

[[File:MapStatus_MapStatusBattleLog.png|frameless]]

Change the Message to MSG_MURKY_TERRAIN_START and click [OK]. We'll later define our own strings for Murky Terrain.

Then finally, delete all the PMDC.Dungeon.MapStatusCharEvent events. You should have the results shown below.

[[File:MapStatus_MapStatusAddAfter.png|frameless]]

Scroll down to "On Map Status Removes"
[[File:MapStatus_OnMapStatusRemoves.png|frameless]]

Double-click on PMDC.Dungeon.MapStatusBattleLogEvent and change the Message to MSG_MURKY_TERRAIN_END, and then click [OK]

Scroll down to "On Action"

[[File:MapStatus_OnAction.png|frameless]]

Double-click on PMDC.Dungeon.MultiplyElementEvent and change the Mult Element from Electric -> Dark, then click [OK].

[[File:MapStatus_TypeChange.png|frameless]]

We will add a new custom "On Action" event for our lower Attack Range effect.

[[File:MapStatus_OnAction.png|frameless]]

Click on [Add]

Do the following:
* Set the Type to be BattleScriptEvent
* Set the Script to be MurkyTerrainOnActionEvent

[[File:MapStatus_BattleScriptEvent.png|frameless]]

We'll later write our own BattleScriptEvent to lower the Attack Range of non-Dark and Ghost type Pokémon!

Click [OK] on all the sub-windows and save! We have just completed a majority of our new terrain! Let's create the strings and then code the logic for our new terrain.

== Creating the Strings ==

We have two strings that we need to define:
* MSG_MURKY_TERRAIN_START
* MSG_MURKY_TERRAIN_END

First create a new file called "stringsEx.resx" in "PMDO/MODS/{MOD_NAME}/Strings". The structure should look like so:

[[File:MapStatus_Strings.png|frameless]]

Copy the following lines below into the file.

<pre>
<?xml version="1.0" encoding="utf-8"?>
<root>
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
<xsd:element name="root" msdata:IsDataSet="true">
<xsd:complexType>
<xsd:choice maxOccurs="unbounded">
<xsd:element name="metadata">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" />
</xsd:sequence>
<xsd:attribute name="name" use="required" type="xsd:string" />
<xsd:attribute name="type" type="xsd:string" />
<xsd:attribute name="mimetype" type="xsd:string" />
<xsd:attribute ref="xml:space" />
</xsd:complexType>
</xsd:element>
<xsd:element name="assembly">
<xsd:complexType>
<xsd:attribute name="alias" type="xsd:string" />
<xsd:attribute name="name" type="xsd:string" />
</xsd:complexType>
</xsd:element>
<xsd:element name="data">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
</xsd:sequence>
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
<xsd:attribute ref="xml:space" />
</xsd:complexType>
</xsd:element>
<xsd:element name="resheader">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
</xsd:sequence>
<xsd:attribute name="name" type="xsd:string" use="required" />
</xsd:complexType>
</xsd:element>
</xsd:choice>
</xsd:complexType>
</xsd:element>
</xsd:schema>
<resheader name="resmimetype">
<value>text/microsoft-resx</value>
</resheader>
<resheader name="version">
<value>2.0</value>
</resheader>
<resheader name="reader">
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
</resheader>
<resheader name="writer">
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
</resheader>
<data name="MSG_MURKY_TERRAIN_START" xml:space="preserve">
<value>Darkness shrouded the battlefield!</value>
<comment></comment> </data>
<data name="MSG_MURKY_TERRAIN_END" xml:space="preserve">
<value>The darkness disappeared from the battlefield.</value>
<comment></comment> </data>
</root>
</pre>

The lines of interests shown below, which define the name of the key and value messages our new terrain will use:
<pre>
<data name="MSG_MURKY_TERRAIN_START" xml:space="preserve">
<value>Darkness shrouded the battlefield!</value>
<comment></comment> </data>
<data name="MSG_MURKY_TERRAIN_END" xml:space="preserve">
<value>The darkness disappeared from the battlefield.</value>
<comment></comment> </data>
</pre>

We have just created our dungeon log messages for Murky Terrain!

== Battle Script ==
We will now need to code the logic for MurkyTerrainOnActionEvent.

Create a file called "event_battle.lua" in "PMDO/MODS/{MOD_NAME}/SCRIPT". And copy the code below into the file.

[[File:MapStatus_ElectricTerrainState.png|frameless]]
<pre>
BATTLE_SCRIPT = {}

function BATTLE_SCRIPT.MurkyTerrainOnActionEvent(owner, ownerChar, context, args)
local type1 = context.User.Element1
local type2 = context.User.Element2
local apply_effect = not (type1 == "dark" or type2 == "dark" or type1 == "ghost" or type2 == "ghost")
if apply_effect then
local effect = PMDC.Dungeon.AddRangeEvent(-1)
TASK:WaitTask(effect:Apply(owner, ownerChar, context))
end
end
</pre>

* We check the user's first type and see if it's not Dark or Ghost and then the second type and see if it's not Dark or Ghost
* We then create an AddRangeEvent which is a BattleEvent defined here... [add link to ] and apply the range modification with "TASK:WaitTask(effect:Apply(owner, ownerChar, context))"

We have defined the logic of MurkyTerrainOnActionEvent! The last step is create our move to initiate Murky Terrain.

The last thing we have to do is create our move to use.

== Creating the Move ==

Begin by creating a new move in the Skills list.

[[File:DevPanel_Data.png|frameless]]

Click on [Add]

[[File:MapStatus_ElectricTerrainState.png|frameless]]
[[File:MapStatus_ElectricTerrainState.png|frameless]]
[[File:MapStatus_ElectricTerrainState.png|frameless]]
[[File:MapStatus_ElectricTerrainState.png|frameless]]
[[File:MapStatus_ElectricTerrainState.png|frameless]]
[[File:MapStatus_ElectricTerrainState.png|frameless]]
[[File:MapStatus_ElectricTerrainState.png|frameless]]
[[File:MapStatus_ElectricTerrainState.png|frameless]]
[[File:MapStatus_ElectricTerrainState.png|frameless]]
[[File:MapStatus_ElectricTerrainState.png|frameless]]
[[File:MapStatus_ElectricTerrainState.png|frameless]]
[[File:MapStatus_ElectricTerrainState.png|frameless]]