Struct OrderKey 

pub struct OrderKey(pub i32, pub i32, pub u32);

A turn-ordering sort key produced by BattleProvider::turn_order_key.

The engine stable-sorts actors ascending by this key, so the game must encode “acts earlier” as a smaller key. The tuple is ordered (priority, speed, tiebreak):

• priority — move/action priority bracket. Higher-priority actions act first, so the game should store the negated bracket here (e.g. -1 for a +1 priority move) to make ascending order put them first.
• speed — likewise the negated effective speed, so the faster battler (larger speed → more-negative key) sorts first. The game applies its own speed modifiers (paralysis cut, badge boosts) before negating.
• tiebreak — a game-supplied tie-break value (e.g. a coin-flip drawn from the injected RNG for the Gen-1 speed tie). Smaller acts first.

Stability of the sort guarantees that equal keys preserve submission order, so a game that wants pure submission order on ties can leave tiebreak at 0.

Tuple Fields

0: i32

1: i32

2: u32

Trait Implementations

impl Clone for OrderKey

fn clone(&self) -> OrderKey

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for OrderKey

impl Debug for OrderKey

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for OrderKey

fn default() -> OrderKey

Returns the “default value” for a type.

impl Eq for OrderKey

impl Ord for OrderKey

fn cmp(&self, other: &OrderKey) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for OrderKey

fn eq(&self, other: &OrderKey) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for OrderKey

fn partial_cmp(&self, other: &OrderKey) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for OrderKey