Merge branch 'burmy-cloak-change' into 'implement_pokemon'

Burmy Cloak Changing & Battle Ended Event Refinements

See merge request cable-mc/cobblemon!2452

CHANGELOG.md

@@ -14,6 +14,7 @@
 - Wearable items can now be equipped by a player by holding it and right-clicking (or rebound use/interact)
   - Wearable items that can be placed down are exempt from this behaviour.
 - New Cosmetic Item for Pikachu: Paper
+- Burmy changes its cloak after a battle it took part in, based on the biome: Trash Cloak in the Deep Dark, Nether and End, Plant Cloak in lush biomes such as forests, jungles, plains and swamps, and Sandy Cloak in sandy biomes, beaches and caves.
 
 ### Fixes
 - Fixed #updateMovesOnFormChange not properly initializing a form-swapped Pokemon's non-form_change moves.
@@ -138,6 +139,9 @@
 ### Molang & Datapacks
 - A new `negate` variant for evolution requirements has been added, which will negate (invert) the provided inner condition.
 - Added Molang functions for individual Pokédex ids, wherein a subdex is passed in as a string to `dex_caught_count` etc.
+- Added a `battle_ended` callback, backed by the new `BATTLE_ENDED` event, which fires whenever a battle ends for any reason, alongside a multitude of flags not previously covered by `BATTLE_VICTORY`.
+- Added `battle_pokemon` to battle actor structs and `has_faced_opponents` to battle Pokémon structs.
+- Added the `cobblemon:form_change/bagworm_cloak/plant_cloak`, `sandy_cloak` and `trash_cloak` biome tags, which control Burmy's cloak after battle.
 
 ### Particles
 

common/src/main/kotlin/com/cobblemon/mod/common/api/battles/model/BattleEndResult.kt

@@ -0,0 +1,25 @@
+/*
+ * Copyright (C) 2023 Cobblemon Contributors
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
+
+package com.cobblemon.mod.common.api.battles.model
+
+/**
+ * How a [PokemonBattle] came to an end.
+ */
+enum class BattleEndResult {
+    /** One side defeated the other. */
+    VICTORY,
+    /** A wild Pokémon was captured, ending the battle. */
+    CAPTURE,
+    /** An actor forfeited, giving the victory to the other side. */
+    FORFEIT,
+    /** A player fled from a wild Pokémon. */
+    FLED,
+    /** The battle was stopped without a winner, such as by a command, a player disconnecting or an error. */
+    STOPPED
+}

common/src/main/kotlin/com/cobblemon/mod/common/api/battles/model/PokemonBattle.kt

@@ -21,6 +21,7 @@ import com.cobblemon.mod.common.api.battles.model.actor.BattleActor
 import com.cobblemon.mod.common.api.battles.model.actor.EntityBackedBattleActor
 import com.cobblemon.mod.common.api.battles.model.actor.FleeableBattleActor
 import com.cobblemon.mod.common.api.events.CobblemonEvents
+import com.cobblemon.mod.common.api.events.battles.BattleEndedEvent
 import com.cobblemon.mod.common.api.events.battles.BattleFledEvent
 import com.cobblemon.mod.common.api.events.battles.BattleFleeAttemptEvent
 import com.cobblemon.mod.common.api.molang.MoLangFunctions.asMoLangValue
@@ -124,6 +125,12 @@ open class PokemonBattle(
     var winners = listOf<BattleActor>()
     var losers = listOf<BattleActor>()
     var ended = false
+    /** How the battle ended, or null if it hasn't ended yet. */
+    var endResult: BattleEndResult? = null
+    /** The actor that forfeited the battle, if any. */
+    var forfeitedBy: BattleActor? = null
+    /** Whether a player fled from the battle. */
+    var fled = false
     // TEMP battle showcase stuff
     var announcingRules = false
     var turn: Int = 0
@@ -251,6 +258,14 @@ open class PokemonBattle(
 
     fun end() {
         ended = true
+        val result = when {
+            winners.isNotEmpty() && showdownMessages.any { "capture" in it } -> BattleEndResult.CAPTURE
+            winners.isNotEmpty() && forfeitedBy != null -> BattleEndResult.FORFEIT
+            winners.isNotEmpty() -> BattleEndResult.VICTORY
+            fled -> BattleEndResult.FLED
+            else -> BattleEndResult.STOPPED
+        }
+        endResult = result
         val awardToFainted = Cobblemon.config.awardExperienceToFaintedPokemon
         val awardOnLoss = Cobblemon.config.awardExperienceOnBattleLoss
         this.actors.forEach { actor ->
@@ -332,6 +347,7 @@ open class PokemonBattle(
                 }
             }
         }
+        CobblemonEvents.BATTLE_ENDED.post(BattleEndedEvent(this, result, forfeitedBy.takeIf { result == BattleEndResult.FORFEIT }))
         sendUpdate(BattleEndPacket())
         BattleRegistry.closeBattle(this)
     }
@@ -502,6 +518,7 @@ open class PokemonBattle(
                 .forEach{it.pokemon.heal()}
             CobblemonEvents.BATTLE_FLED.post(BattleFledEvent(this, actors.asSequence().filterIsInstance<PlayerBattleActor>().iterator().next()))
             actors.filterIsInstance<EntityBackedBattleActor<*>>().mapNotNull { it.entity }.forEach { it.sendSystemMessage(battleLang("flee").yellow()) }
+            fled = true
             stop()
         }
     }
@@ -539,6 +556,7 @@ open class PokemonBattle(
     private fun checkForfeit(): Boolean {
         val forfeit = actors.find { it.responses.any { it is ForfeitActionResponse } }
         return forfeit?.let {
+            forfeitedBy = it
             this.dispatchWaiting { this.broadcastChatMessage(battleLang("forfeit", it.getName()).red()) }
             writeShowdownAction(">forcelose ${it.showdownId}")
             true

common/src/main/kotlin/com/cobblemon/mod/common/api/events/CobblemonEvents.kt

@@ -12,6 +12,7 @@ import com.cobblemon.mod.common.api.events.battles.BattleFaintedEvent
 import com.cobblemon.mod.common.api.events.battles.BattleFledEvent
 import com.cobblemon.mod.common.api.events.battles.BattleFleeAttemptEvent
 import com.cobblemon.mod.common.api.events.battles.BattleStartedEvent
+import com.cobblemon.mod.common.api.events.battles.BattleEndedEvent
 import com.cobblemon.mod.common.api.events.battles.BattleVictoryEvent
 import com.cobblemon.mod.common.api.events.battles.instruction.FormeChangeEvent
 import com.cobblemon.mod.common.api.events.battles.instruction.MegaEvolutionEvent
@@ -139,6 +140,9 @@ object CobblemonEvents {
     @JvmField
     val BATTLE_FAINTED = EventObservable<BattleFaintedEvent>()
 
+    @JvmField
+    val BATTLE_ENDED = EventObservable<BattleEndedEvent>()
+
     // instructions
     @JvmField
     val MEGA_EVOLUTION = EventObservable<MegaEvolutionEvent>()

common/src/main/kotlin/com/cobblemon/mod/common/api/events/battles/BattleEndedEvent.kt

@@ -0,0 +1,69 @@
+/*
+ * Copyright (C) 2023 Cobblemon Contributors
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
+
+package com.cobblemon.mod.common.api.events.battles
+
+import com.bedrockk.molang.runtime.value.DoubleValue
+import com.bedrockk.molang.runtime.value.MoValue
+import com.bedrockk.molang.runtime.value.StringValue
+import com.cobblemon.mod.common.api.battles.model.BattleEndResult
+import com.cobblemon.mod.common.api.battles.model.PokemonBattle
+import com.cobblemon.mod.common.api.battles.model.actor.BattleActor
+import com.cobblemon.mod.common.api.battles.model.actor.ActorType
+import com.cobblemon.mod.common.util.asArrayValue
+
+/**
+ * Event fired whenever a [PokemonBattle] ends, regardless of how it ended (victory, fleeing, being stopped, etc).
+ *
+ * [PokemonBattle.winners] and [PokemonBattle.losers] are only populated if the [result] has a winner,
+ * that is [BattleEndResult.VICTORY], [BattleEndResult.CAPTURE] or [BattleEndResult.FORFEIT].
+ *
+ * @param result How the battle ended.
+ * @param forfeitedBy The actor that forfeited, if the [result] is [BattleEndResult.FORFEIT].
+ */
+data class BattleEndedEvent(
+    override val battle: PokemonBattle,
+    val result: BattleEndResult,
+    val forfeitedBy: BattleActor?
+) : BattleEvent {
+    /** Whether one side won the battle, which includes captures and forfeits. */
+    val hasWinner = battle.winners.isNotEmpty()
+    val wasVictory = result == BattleEndResult.VICTORY
+    val wasCapture = result == BattleEndResult.CAPTURE
+    val wasForfeit = result == BattleEndResult.FORFEIT
+    val wasFled = result == BattleEndResult.FLED
+    val wasStopped = result == BattleEndResult.STOPPED
+
+    /** Whether the battle was between players and wild Pokémon. */
+    val isPvW = battle.isPvW
+    /** Whether the battle was between players and NPCs. */
+    val isPvN = battle.isPvN
+    /** Whether the battle was between players. */
+    val isPvP = battle.isPvP
+
+    val context = mutableMapOf<String, MoValue>(
+        "battle" to battle.struct,
+        "result" to StringValue(result.name.lowercase()),
+        "has_winner" to DoubleValue(hasWinner),
+        "was_victory" to DoubleValue(wasVictory),
+        "was_capture" to DoubleValue(wasCapture),
+        "was_forfeit" to DoubleValue(wasForfeit),
+        "was_fled" to DoubleValue(wasFled),
+        "was_stopped" to DoubleValue(wasStopped),
+        "is_pvw" to DoubleValue(isPvW),
+        "is_pvn" to DoubleValue(isPvN),
+        "is_pvp" to DoubleValue(isPvP),
+        "winners" to battle.winners.asArrayValue { it.struct },
+        "losers" to battle.losers.asArrayValue { it.struct },
+        "players" to battle.actors.filter { it.type == ActorType.PLAYER }.asArrayValue { it.struct },
+        "npcs" to battle.actors.filter { it.type == ActorType.NPC }.asArrayValue { it.struct },
+        "wild_pokemon" to battle.actors.filter { it.type == ActorType.WILD }.asArrayValue { it.struct }
+    ).apply {
+        forfeitedBy?.let { put("forfeited_by", it.struct) }
+    }
+}

common/src/main/kotlin/com/cobblemon/mod/common/api/molang/function/BattleActorMoLangFunctions.kt

@@ -16,6 +16,7 @@ import com.cobblemon.mod.common.api.molang.MoLangFunctions.asMoLangValue
 import com.cobblemon.mod.common.battles.actor.PlayerBattleActor
 import com.cobblemon.mod.common.battles.actor.PokemonBattleActor
 import com.cobblemon.mod.common.entity.npc.NPCBattleActor
+import com.cobblemon.mod.common.util.asArrayValue
 
 object BattleActorMoLangFunctions : AbstractMoLangFunctionHolder<BattleActor>() {
     override fun BattleActor.moLangFunctions(): MutableMap<String, (MoParams) -> Any> {
@@ -25,6 +26,7 @@ object BattleActorMoLangFunctions : AbstractMoLangFunctionHolder<BattleActor>()
         functions["is_npc"] = { DoubleValue(actor.type == ActorType.NPC) }
         functions["is_player"] = { DoubleValue(actor.type == ActorType.PLAYER) }
         functions["is_wild"] = { DoubleValue(actor.type == ActorType.WILD) }
+        functions["battle_pokemon"] = { actor.pokemonList.asArrayValue { it.struct } }
 
         when (actor) {
             is NPCBattleActor -> {

common/src/main/kotlin/com/cobblemon/mod/common/battles/pokemon/BattlePokemon.kt

@@ -83,7 +83,8 @@ open class BattlePokemon(
             "max_health" to Function { DoubleValue(maxHealth.toDouble()) },
             "ivs" to Function { effectedPokemon.ivs.struct },
             "nature" to Function { StringValue(effectedPokemon.nature.name.toString()) },
-            "moveset" to Function { effectedPokemon.moveSet.toStruct() }
+            "moveset" to Function { effectedPokemon.moveSet.toStruct() },
+            "has_faced_opponents" to Function { DoubleValue(facedOpponents.isNotEmpty()) }
         ))
 
     val uuid: UUID

common/src/main/kotlin/com/cobblemon/mod/common/events/CallbackHandler.kt

@@ -26,6 +26,7 @@ object CallbackHandler {
         CobblemonEvents.POKEMON_CAPTURED.subscribe { CobblemonCallbacks.run(cobblemonResource("pokemon_captured"), it.context) }
         CobblemonEvents.POKEMON_ENTITY_SPAWN.subscribe { entity -> CobblemonCallbacks.run(cobblemonResource("pokemon_entity_spawn"), mutableMapOf<String, MoValue>("pokemon_entity" to entity.entity.asMoLangValue()), functions = moLangFunctionMap("pokemon" to { entity.entity.pokemon.struct })) }
         CobblemonEvents.BATTLE_VICTORY.subscribe { CobblemonCallbacks.run(cobblemonResource("battle_victory"), it.context) }
+        CobblemonEvents.BATTLE_ENDED.subscribe { CobblemonCallbacks.run(cobblemonResource("battle_ended"), it.context) }
         CobblemonEvents.POKEDEX_DATA_CHANGED_PRE.subscribe { CobblemonCallbacks.run(cobblemonResource("pokedex_data_changed_pre"), it.getContext(), it.functions) }
         CobblemonEvents.POKEDEX_DATA_CHANGED_POST.subscribe { CobblemonCallbacks.run(cobblemonResource("pokedex_data_changed_post"), it.getContext()) }
         CobblemonEvents.FORME_CHANGE.subscribe { CobblemonCallbacks.run(cobblemonResource("forme_change"), it.context) }

common/src/main/resources/data/cobblemon/callbacks/battle_ended/burmy_cloak_change.molang

@@ -0,0 +1,15 @@
+for_each(t.actor, c.players, {
+  t.biome = t.actor.player.biome;
+  t.cloak = t.biome.is_in('#cobblemon:form_change/bagworm_cloak/sandy_cloak') ? 'sandy'
+    : (t.biome.is_in('#cobblemon:form_change/bagworm_cloak/trash_cloak') ? 'trash'
+    : (t.biome.is_in('#cobblemon:form_change/bagworm_cloak/plant_cloak') ? 'plant' : ''));
+
+  !q.is_blank(t.cloak) ? {
+    for_each(t.battle_pokemon, t.actor.battle_pokemon, {
+      t.pokemon = t.battle_pokemon.original_pokemon;
+      (t.battle_pokemon.has_faced_opponents && t.pokemon.matches('burmy') && !t.pokemon.matches('burmy bagworm_cloak=' + t.cloak)) ? {
+        t.pokemon.apply('bagworm_cloak=' + t.cloak);
+      };
+    });
+  };
+});

common/src/main/resources/data/cobblemon/tags/worldgen/biome/form_change/bagworm_cloak/plant_cloak.json

@@ -0,0 +1,15 @@
+{
+  "replace": false,
+  "values": [
+    "#cobblemon:is_lush",
+    "#cobblemon:is_forest",
+    "#cobblemon:is_jungle",
+    "#cobblemon:is_bamboo",
+    "#cobblemon:is_floral",
+    "#cobblemon:is_plains",
+    "#cobblemon:is_swamp",
+    "#cobblemon:is_tropical_island",
+    "#cobblemon:nether/is_forest",
+    "#cobblemon:nether/is_overgrowth"
+  ]
+}

common/src/main/resources/data/cobblemon/tags/worldgen/biome/form_change/bagworm_cloak/sandy_cloak.json

@@ -0,0 +1,11 @@
+{
+  "replace": false,
+  "values": [
+    "#cobblemon:is_sandy",
+    "#cobblemon:is_beach",
+    "#cobblemon:is_cave",
+    "#cobblemon:is_dripstone",
+    "#cobblemon:nether/is_desert",
+    "#cobblemon:nether/is_soul_sand"
+  ]
+}

common/src/main/resources/data/cobblemon/tags/worldgen/biome/form_change/bagworm_cloak/trash_cloak.json

@@ -0,0 +1,18 @@
+{
+  "replace": false,
+  "values": [
+    "#cobblemon:is_deep_dark",
+    "#minecraft:is_end",
+    {
+      "id": "#cobblemon:nether/is_snowy",
+      "required": false
+    },
+    {
+      "id": "#cobblemon:nether/is_taiga",
+      "required": false
+    },
+    "#cobblemon:is_mushroom",
+    "#cobblemon:nether/is_fungus",
+    "#cobblemon:nether/is_frozen"
+  ]
+}