PokéRogue
    Preparing search index...

    Helper to manage pokemon

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    Methods

    • Helper function to return all on-field Pokemon in speed order (fastest first).

      Parameters

      • Optionalindices: false

        (Default false) Whether to only return BattlerIndexes instead of full Pokemon objects (such as for comparison with other speed order-related mechanisms)

      • OptionalignoreOverride: boolean

        (Default true) Whether to ignore preset turn orders and speed-reversing effects (like Trick Room)

      Returns Pokemon[]

      An array containing all on-field Pokemon in order of descending speed.

    • Helper function to return all on-field Pokemon in speed order (fastest first).

      Parameters

      • indices: true

        (Default false) Whether to only return BattlerIndexes instead of full Pokemon objects (such as for comparison with other speed order-related mechanisms)

      • OptionalignoreOverride: boolean

        (Default true) Whether to ignore preset turn orders and speed-reversing effects (like Trick Room)

      Returns BattlerIndex[]

      An array containing the BattlerIndexes of all on-field Pokemon in order of descending speed.