Interface LegacyBattleAISupport

All Known Subinterfaces:
BattleController
All Known Implementing Classes:
MultiLaneBattleController, StandardBattleController

@Deprecated(since="9.4.0", forRemoval=true) public interface LegacyBattleAISupport
Deprecated, for removal: This API element is subject to removal in a future version.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use ContextKeys.SIMULATION in the battle context instead.
    void
    simulateMode(boolean simulateMode)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use ContextKeys.SIMULATION in the battle context instead.
    boolean
    Deprecated, for removal: This API element is subject to removal in a future version.
    This is only retained for legacy AI compatibility.
    void
    simulateStats(boolean simulateStats)
    Deprecated, for removal: This API element is subject to removal in a future version.
    This is only retained for legacy AI compatibility.
  • Method Details

    • simulateMode

      @Deprecated(since="9.4.0", forRemoval=true) boolean simulateMode()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use ContextKeys.SIMULATION in the battle context instead. The value can be read with get(ContextKey) and written with set(ContextKey, Object).
      Returns whether this battle is currently running in the legacy AI simulation mode.

      This flag is only used by the legacy BattleAI.ADVANCED, BattleAI.TACTICAL, and BattleAI.AGGRESSIVE implementations. New simulation-aware code should use the battle context instead.

      Returns:
      true if the battle is being simulated by legacy AI logic; false otherwise
    • simulateMode

      @Deprecated(since="9.4.0", forRemoval=true) void simulateMode(boolean simulateMode)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use ContextKeys.SIMULATION in the battle context instead.
      Sets whether this battle is currently running in the legacy AI simulation mode.
      Parameters:
      simulateMode - whether the battle should be treated as simulated by legacy AI logic
    • simulateStats

      @Deprecated(since="9.4.0", forRemoval=true) boolean simulateStats()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This is only retained for legacy AI compatibility. New code should not use this flag.
      Returns whether the legacy AI should use simulated stat handling for this battle.

      This is an artifact of the older battle AI system. It is separate from the modern battle context simulation flag and does not represent a general-purpose battle state setting.

      Returns:
      true if legacy AI stat simulation handling is enabled; false otherwise
    • simulateStats

      @Deprecated(since="9.4.0", forRemoval=true) void simulateStats(boolean simulateStats)
      Deprecated, for removal: This API element is subject to removal in a future version.
      This is only retained for legacy AI compatibility. New code should not use this flag.
      Sets whether the legacy AI should use simulated stat handling for this battle.
      Parameters:
      simulateStats - whether legacy AI stat simulation handling should be enabled