condition

Author: JaskRendix

tests/tuxemon/test_event_condition_manager.py

@@ -1,5 +1,6 @@
 # SPDX-License-Identifier: GPL-3.0
 # Copyright (c) 2014-2026 William Edwards <shadowapex@gmail.com>, Benjamin Bean <superman2k5@gmail.com>
+from dataclasses import dataclass
 from unittest.mock import MagicMock, patch
 
 import pytest
@@ -18,8 +19,12 @@ def mock_plugin_manager():
 @pytest.fixture
 def condition_manager(mock_plugin_manager):
 
+    @dataclass
     class DummyCondition(EventCondition):
         name = "char_at"
+        a: str = ""
+        b: int = 0
+        c: str = ""
 
         def test(self, session, condition_data):
             return True
@@ -35,6 +40,7 @@ def test_get_condition_found(condition_manager):
     mock_cond_data = MagicMock(spec=SpatialCondition)
     mock_cond_data.type = "char_at"
     mock_cond_data.operator = "is"
+    mock_cond_data.parameters = []
     condition = condition_manager.get_condition(mock_cond_data)
     assert condition is not None
     assert condition.is_expected is True

tuxemon/event/conditions/afk_state.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
+from typing import ClassVar
 
 from tuxemon.db import SpatialCondition
 from tuxemon.event.eventcondition import EventCondition
@@ -24,9 +25,10 @@ class AFKStateCondition(EventCondition):
         is afk_state warn:kick
     """
 
-    name = "afk_state"
+    name: ClassVar[str] = "afk_state"
+    level: str
 
     def test(self, session: Session, condition: SpatialCondition) -> bool:
         afk_manager = session.client.afk_manager
-        levels = condition.parameters[0].split(":")
+        levels = self.level.split(":")
         return any(afk_manager.is_threshold_met(level) for level in levels)

tuxemon/event/conditions/battle_outcome.py

@@ -4,6 +4,7 @@
 
 import logging
 from dataclasses import dataclass
+from typing import ClassVar
 
 from tuxemon.db import SpatialCondition
 from tuxemon.event.eventcondition import EventCondition
@@ -33,22 +34,24 @@ class BattleOutcomeCondition(EventCondition):
         Checks if the 'player' has won against 'npc_maple'.
     """
 
-    name = "battle_outcome"
+    name: ClassVar[str] = "battle_outcome"
+    fighter: str
+    outcome: str
+    opponent: str
 
     def test(self, session: Session, condition: SpatialCondition) -> bool:
-        fighter, outcome, opponent = condition.parameters[:3]
 
-        if outcome not in {"won", "lost", "draw"}:
-            logger.error(f"Invalid outcome '{outcome}'")
+        if self.outcome not in {"won", "lost", "draw"}:
+            logger.error(f"Invalid outcome '{self.outcome}'")
             return False
 
-        character = session.get_npc(fighter)
+        character = session.get_npc(self.fighter)
         if character is None:
-            logger.error(f"Character '{fighter}' not found")
+            logger.error(f"Character '{self.fighter}' not found")
             return False
 
         if not character.battle_handler:
             return False
         return character.battle_handler.has_fought_and_outcome(
-            outcome=outcome, opponent=opponent
+            outcome=self.outcome, opponent=self.opponent
         )

tuxemon/event/conditions/battle_outcome_count.py

@@ -4,6 +4,7 @@
 
 import logging
 from dataclasses import dataclass
+from typing import ClassVar
 
 from tuxemon.db import SpatialCondition
 from tuxemon.event.eventcondition import EventCondition
@@ -47,35 +48,31 @@ class BattleOutcomeCountCondition(EventCondition):
         Checks if the 'player' has won at least 2 times against 'npc_maple'.
     """
 
-    name = "battle_outcome_count"
+    name: ClassVar[str] = "battle_outcome_count"
+    fighter: str
+    outcome: str
+    opponent: str
+    required_count: int
 
     def test(self, session: Session, condition: SpatialCondition) -> bool:
-        try:
-            fighter, outcome, opponent, count_str = condition.parameters[:4]
-            required_count = int(count_str)
-        except (ValueError, IndexError) as e:
-            logger.error(
-                f"Invalid parameters for battle_outcome_count: {condition.parameters}"
-            )
-            return False
 
-        if outcome not in {"won", "lost", "draw"}:
-            logger.error(f"Invalid outcome '{outcome}'")
+        if self.outcome not in {"won", "lost", "draw"}:
+            logger.error(f"Invalid outcome '{self.outcome}'")
             return False
 
-        character = session.get_npc(fighter)
+        character = session.get_npc(self.fighter)
         if character is None or not character.battle_handler:
             logger.error(
-                f"Character '{fighter}' not found or has no battle handler"
+                f"Character '{self.fighter}' not found or has no battle handler"
             )
             return False
 
         actual_count = sum(
             1
             for battle in character.battle_handler.get_battles()
-            if battle.fighter == fighter
-            and battle.opponent == opponent
-            and battle.outcome.value == outcome
+            if battle.fighter == self.fighter
+            and battle.opponent == self.opponent
+            and battle.outcome.value == self.outcome
         )
 
-        return actual_count >= required_count
+        return actual_count >= self.required_count

tuxemon/event/conditions/bill_exists.py

@@ -4,6 +4,7 @@
 
 import logging
 from dataclasses import dataclass
+from typing import ClassVar
 
 from tuxemon.db import SpatialCondition
 from tuxemon.event.eventcondition import EventCondition
@@ -29,15 +30,16 @@ class BillExistsCondition(EventCondition):
     eg. "is bill_exists player,my_bill"
     """
 
-    name = "bill_exists"
+    name: ClassVar[str] = "bill_exists"
+    character: str
+    bill_slug: str
 
     def test(self, session: Session, condition: SpatialCondition) -> bool:
-        character_name, bill_slug = condition.parameters[:2]
-        character = session.get_npc(character_name)
+        character = session.get_npc(self.character)
         if character is None:
-            logger.error(f"Character '{character_name}' not found")
+            logger.error(f"Character '{self.character}' not found")
             return False
 
         money_manager = character.money_controller.money_manager
-        bill = money_manager.get_bill(bill_slug)
+        bill = money_manager.get_bill(self.bill_slug)
         return bill is not None

tuxemon/event/conditions/bill_is.py

@@ -4,6 +4,7 @@
 
 import logging
 from dataclasses import dataclass
+from typing import ClassVar
 
 from tuxemon.db import SpatialCondition
 from tuxemon.event.eventcondition import EventCondition
@@ -35,29 +36,32 @@ class BillIsCondition(EventCondition):
     eg. "is bill_is player,bill_slug,equals,name_variable" (name_variable:75)
     """
 
-    name = "bill_is"
+    name: ClassVar[str] = "bill_is"
+    character: str
+    bill_slug: str
+    operator: str
+    amount: str | int
 
     def test(self, session: Session, condition: SpatialCondition) -> bool:
         player = session.player
-        character_name, _bill, operator, _amount = condition.parameters[:4]
-        character = session.get_npc(character_name)
+        character = session.get_npc(self.character)
         if character is None:
-            logger.error(f"Character '{character_name}' not found")
+            logger.error(f"Character '{self.character}' not found")
             return False
 
         money_manager = character.money_controller.money_manager
-        bill = money_manager.get_bill(_bill)
+        bill = money_manager.get_bill(self.bill_slug)
         if bill is None:
             return False
 
-        if not _amount.isdigit():
+        if isinstance(self.amount, str):
             amount = 0
-            if player.game_variables.has(_amount):
-                amount = int(player.game_variables.get(_amount, 0))
+            if player.game_variables.has(self.amount):
+                amount = int(player.game_variables.get(self.amount, 0))
         else:
-            amount = int(_amount)
+            amount = self.amount
 
         if bill.amount == 0:
             return False
         else:
-            return compare(operator, bill.amount, amount)
+            return compare(self.operator, bill.amount, amount)

tuxemon/event/conditions/button_combo.py

@@ -2,6 +2,8 @@
 # Copyright (c) 2014-2026 William Edwards <shadowapex@gmail.com>, Benjamin Bean <superman2k5@gmail.com>
 from __future__ import annotations
 
+from typing import ClassVar
+
 from tuxemon.db import SpatialCondition
 from tuxemon.event.eventcondition import EventCondition
 from tuxemon.platform.const.intentions import constants
@@ -21,10 +23,11 @@ class ButtonComboCondition(EventCondition):
         buttons: A sequence of button/intention keys (E.g. "up:down:interact").
     """
 
-    name = "button_combo"
+    name: ClassVar[str] = "button_combo"
+    buttons: str
 
     def test(self, session: Session, condition: SpatialCondition) -> bool:
-        _buttons = condition.parameters[0].split(":")
+        _buttons = self.buttons.split(":")
         ids: list[int] = []
         for _button in _buttons:
             try:

tuxemon/event/conditions/button_count.py

@@ -2,6 +2,8 @@
 # Copyright (c) 2014-2026 William Edwards <shadowapex@gmail.com>, Benjamin Bean <superman2k5@gmail.com>
 from __future__ import annotations
 
+from typing import ClassVar
+
 from tuxemon.db import SpatialCondition
 from tuxemon.event.eventcondition import EventCondition
 from tuxemon.platform.const.intentions import constants
@@ -26,16 +28,18 @@ class ButtonCountCondition(EventCondition):
         amount: The number of times the button was pressed.
     """
 
-    name = "button_count"
+    name: ClassVar[str] = "button_count"
+    button_id: str
+    operator: str
+    amount: int
 
     def test(self, session: Session, condition: SpatialCondition) -> bool:
-        button_id, operator, amount = condition.parameters[:3]
         try:
-            button = constants[button_id.upper()]
+            button = constants[self.button_id.upper()]
         except KeyError:
             raise ValueError("Constant not found")
         counter = (
             session.client.input_manager.input_history.count_button_clicks()
         )
         output = counter.get(button, 0)
-        return compare(operator, output, int(amount))
+        return compare(self.operator, output, self.amount)

tuxemon/event/conditions/button_held.py

@@ -2,6 +2,8 @@
 # Copyright (c) 2014-2026 William Edwards <shadowapex@gmail.com>, Benjamin Bean <superman2k5@gmail.com>
 from __future__ import annotations
 
+from typing import ClassVar
+
 from tuxemon.db import SpatialCondition
 from tuxemon.event.eventcondition import EventCondition
 from tuxemon.platform.const.intentions import constants
@@ -22,14 +24,15 @@ class ButtonHeldCondition(EventCondition):
         frames: The number of frames the button must be held.
     """
 
-    name = "button_held"
+    name: ClassVar[str] = "button_held"
+    button_id: str
+    time_ms: int
 
     def test(self, session: Session, condition: SpatialCondition) -> bool:
-        button_id, time_ms = condition.parameters[:2]
         try:
-            button = constants[button_id.upper()]
+            button = constants[self.button_id.upper()]
         except KeyError:
             raise ValueError("Constant not found")
         return session.client.input_manager.input_history.is_button_held(
-            button, int(time_ms)
+            button, self.time_ms
         )

tuxemon/event/conditions/button_pressed.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
+from typing import ClassVar
 
 from tuxemon.db import SpatialCondition
 from tuxemon.event.eventcondition import EventCondition
@@ -24,14 +25,13 @@ class ButtonPressedCondition(EventCondition):
         button: A button/intention key (E.g. "INTERACT").
     """
 
-    name = "button_pressed"
+    name: ClassVar[str] = "button_pressed"
+    button: str
 
     def test(self, session: Session, condition: SpatialCondition) -> bool:
-        button = str(condition.parameters[0])
-
         try:
-            button_id = constants[button]
+            button_id = constants[self.button]
         except KeyError:
-            raise ValueError(f"Cannot support key type: {button}")
+            raise ValueError(f"Cannot support key type: {self.button}")
 
         return session.client.input_cache.was_button_pressed(button_id)