SingleEvent Scripts - Revision history

Imbion at 17:47, 13 August 2025

2025-08-13T17:47:09Z

← Older revision		Revision as of 17:47, 13 August 2025
Line 290:		Line 290:

	[[File:LowHP.PNG \| 500px]]		[[File:LowHP.PNG \| 500px]]
			[[Category:Scripting]]

Shitpost Sunkern at 18:26, 4 October 2024

2024-10-04T18:26:49Z

← Older revision		Revision as of 18:26, 4 October 2024
Line 1:		Line 1:
	These events go into the <code>event_single.lua</code> file of your mod. ~~As of version~~ v0.7.25, you will need to copy this file from base PMDO into your mod first, then paste these scripts into it.		These events go into the <code>event_single.lua</code> file of your mod. In PMDO v0.8.2 and later, you will need to create this file in the Data/Scripts/[your_mod_id] folder (which itself must be <code>include</code>d in your <code>event.lua</code> file). For PMDO versions before v0.8.2, you will need to copy this file from base PMDO into your mod first, then paste these scripts into it.

	== Custom Boss Fight Win Conditions / End effects: ==		== Custom Boss Fight Win Conditions / End effects: ==

Shitpost Sunkern: format and editing

2024-03-14T02:19:58Z

format and editing

Show changes

Palika at 21:52, 13 March 2024

2024-03-13T21:52:04Z

← Older revision		Revision as of 21:52, 13 March 2024
Line 135:		Line 135:
	# First, copy and rename your custom version of <code>LuaCheckBossClearEvent</code> to something more appropriately fitting.		# First, copy and rename your custom version of <code>LuaCheckBossClearEvent</code> to something more appropriately fitting.
	#* Let's say we want a win condition where you only have to defeat the leader of a gang to win the boss fight. We'll call this function instead <code>CheckDefeatedGangLeader</code>. Copy the <code>LuaCheckBossClearEvent</code> function above and rename it to <code>CheckDefeatedGangLeader</code>.		#* Let's say we want a win condition where you only have to defeat the leader of a gang to win the boss fight. We'll call this function instead <code>CheckDefeatedGangLeader</code>. Copy the <code>LuaCheckBossClearEvent</code> function above and rename it to <code>CheckDefeatedGangLeader</code>.
	# In <code>LuaBeginBattleEvent</code>, be sure to pass an argument of <code>CustomClearEvent = 'CheckDefeatedGangLeader'</code> when you define it in the MapEffects, so <code>LuaBeginBattleEvent</code> will knows to use your custom function instead of the default one given.		# In <code>LuaBeginBattleEvent</code>, be sure to pass an argument of <code>CustomClearEvent = 'CheckDefeatedGangLeader'</code> when you define it in the MapEffects, so <code>LuaBeginBattleEvent</code> will knows to use your custom function instead of the default one given. This is done in the Arg Table in the picture above. The value there should look something like {CustomClearEvent = 'CheckDefeatedGangLeader'}.
	# Next, you need to modify how <code>CheckDefeatedGangLeader</code> identifies the win condition. If the win condition is failed, the function should return early. The default one does this by checking all enemy teams, and if any members on any team are not dead, then that means an enemy is still alive and the win condition has failed.		# Next, you need to modify how <code>CheckDefeatedGangLeader</code> identifies the win condition. If the win condition is failed, the function should return early. The default one does this by checking all enemy teams, and if any members on any team are not dead, then that means an enemy is still alive and the win condition has failed.
	#* For our example, if our gang leader is a Scrafty, we should iterate through all enemy teams and see if we find a member that is both a Scrafty and alive. If so, then our win condition has failed and we should return early.		#* For our example, if our gang leader is a Scrafty, we should iterate through all enemy teams and see if we find a member that is both a Scrafty and alive. If so, then our win condition has failed and we should return early.

Palika at 21:41, 13 March 2024

2024-03-13T21:41:54Z

← Older revision		Revision as of 21:41, 13 March 2024
Line 151:		Line 151:

	Want to cause a party wipe in the event that a specific character faints? Perhaps the Hero/Partner characters? This is easily achievable again via pre-made Lua scripting to be placed within event_single.lua.		Want to cause a party wipe in the event that a specific character faints? Perhaps the Hero/Partner characters? This is easily achievable again via pre-made Lua scripting to be placed within event_single.lua.

			We'll start by setting up the functionality. Place the following code within event_single.lua:

	--Check to make sure nobody marked as "IsPartner" is dead. Check guests as well		--Check to make sure nobody marked as "IsPartner" is dead. Check guests as well
Line 213:		Line 215:


			Once this code is in place, we need to set up Universal to call this code On Deaths. In the Dev menu, go to the Constants tab, click Universal, and scroll down to On Deaths. Expand the section there, and click Add. We'll add a SingleCharScriptEvent for AllyDeathCheck here. Once you do that, make sure you set the priority for this event to 10. This will make it so the AllyDeathCheck code we put in event_single.lua earlier will run whenever someone dies at the right timing relative to other scripts. Your config should look something like this after:

			[[File:AllyDeathUniversal.PNG]]

			You're all set now! There's only one more thing you need to do. The script we put only actually checks to see if characters marked as "IsPartner" are dead. IsPartner does not literally mean they are a partner; it is an attribute of Pokémon on your team you can set via scripting that determine whether they can leave the party or not, so it's important to give, say, the Hero character this attribute as well. However, the script code from earlier also uses that flag to determine if the character causes a party wipe upon their death. So be sure in your scripts to mark any important party members IsPartner flag to true if you want them to cause a wipe. You can, of course, change the code of the code above to check for other things instead if you want other attributes to be relevant for a party member death to cause a wipe, but IsPartner Pokémon is the most common kind of teammate you'd want to cause a wipe if they faint.

			An example of setting isPartner. This would set the character in the first slot of your partner to not be removable from your team, and cause a wipe with the code from earlier if they faint.:
			GAME:GetPlayerPartyMember(0).IsPartner = true

Palika: added crit HP status stuff

2024-03-13T21:25:44Z

added crit HP status stuff

@@ Line 138: / Line 138: @@
 # Next, you need to modify how <code>CheckDefeatedGangLeader</code> identifies the win condition. If the win condition is failed, the function should return early. The default one does this by checking all enemy teams, and if any members on any team are not dead, then that means an enemy is still alive and the win condition has failed.
 #* For our example, if our gang leader is a Scrafty, we should iterate through all enemy teams and see if we find a member that is both a Scrafty and alive. If so, then our win condition has failed and we should return early.
-#* Alternatively, you can assign a LuaTable property to the Scrafty that marks it as, say, <code>'GangLeader' = true</code>, and make sure that there are no NPCs with a LuaTable property of 'GangLeader' equal to true that are alive. Doing it like this would allow you to have as many GangLeaders as you may want that need to be defeated to meet the win condition.
+#* Alternatively, you can assign a LuaTable property to the Scrafty that marks it as, say, <code>.GangLeader = true</code>, and make sure that there are no NPCs with a LuaTable property of 'GangLeader' equal to true that are alive. Doing it like this would allow you to have as many GangLeaders as you may want that need to be defeated to meet the win condition.
 # With all this done, when the Scrafty is defeated, the map should end and call <code>end_sequence()</code> as long as we aren't watching a replay. <code>end_sequence()</code> is responsible for fading the map and music out.
 #* You can redefine it to anything you want if you want different things to happen when you actually win. For example, maybe you want your party members to face the camera and do a pose for a few seconds before the game fades out. You could accomplish this by writing code at the very top of end_sequence that makes all your party members do the face down and do the Pose animation!
 #* You can do anything of course, but be careful not to remove things that may be important to handling the end of the dungeon adventure, such as the line of code responsible for ending the segment as Cleared.

Palika: added serpent import

2024-03-13T20:43:23Z

added serpent import

← Older revision		Revision as of 20:43, 13 March 2024
Line 43:		Line 43:
	TASK:WaitTask(_DUNGEON:AddMapStatus(clear_status))		TASK:WaitTask(_DUNGEON:AddMapStatus(clear_status))
	end		end

			--Import Serpent library.
			Serpent = require 'lib.serpent'

	---		---

Shitpost Sunkern: format and editing

2024-03-13T20:35:22Z

format and editing

Show changes

Palika at 19:12, 13 March 2024

2024-03-13T19:12:23Z

← Older revision		Revision as of 19:12, 13 March 2024
Line 102:		Line 102:
	The first function, LuaBeginBattleEvent is responsible for letting PMDO know to look at LuaCheckBossClearEvent to determine when the map is won. Instead of the usual BeginBattleEvent in your boss fight's OnMapStart's Map Effects, you need to call a SingleCharScriptEvent for LuaBeginBattleEvent instead. It'll look like this:		The first function, LuaBeginBattleEvent is responsible for letting PMDO know to look at LuaCheckBossClearEvent to determine when the map is won. Instead of the usual BeginBattleEvent in your boss fight's OnMapStart's Map Effects, you need to call a SingleCharScriptEvent for LuaBeginBattleEvent instead. It'll look like this:

	[[File:LuaBeginBattleEvent.~~png~~]]		[[File:LuaBeginBattleEvent.PNG]]

Palika at 19:11, 13 March 2024

2024-03-13T19:11:53Z

← Older revision		Revision as of 19:11, 13 March 2024
Line 102:		Line 102:
	The first function, LuaBeginBattleEvent is responsible for letting PMDO know to look at LuaCheckBossClearEvent to determine when the map is won. Instead of the usual BeginBattleEvent in your boss fight's OnMapStart's Map Effects, you need to call a SingleCharScriptEvent for LuaBeginBattleEvent instead. It'll look like this:		The first function, LuaBeginBattleEvent is responsible for letting PMDO know to look at LuaCheckBossClearEvent to determine when the map is won. Instead of the usual BeginBattleEvent in your boss fight's OnMapStart's Map Effects, you need to call a SingleCharScriptEvent for LuaBeginBattleEvent instead. It'll look like this:

	[[File:<LuaBeginBattleEvent>.png]]		[[File:LuaBeginBattleEvent.png]]