Struct weasel::battle::Battle

pub struct Battle<R: BattleRules> { /* fields omitted */ }

Represent the in-game world from the point of view of the tactical combat system.

Battle is the core object in weasel, since it contains all entities, teams, the event timeline and all other modules necessary to have a representation of the world.

Methods

impl<R: BattleRules + 'static> Battle<R>

pub fn builder(rules: R) -> BattleBuilder<R>

Returns a battle builder.

pub fn phase(&self) -> BattlePhase

Returns in which phase is the battle.

pub fn entities(&self) -> &Entities<R>

Returns the entities manager for this battle.

pub fn history(&self) -> &History<R>

Returns the history of this battle.

pub fn rules(&self) -> &R

Returns this battle's rules.

pub fn space(&self) -> &Space<R>

Returns this battle's space representation.

pub fn entropy(&self) -> &Entropy<R>

Returns the entropy manager for this battle.

pub fn rounds(&self) -> &Rounds<R>

Returns the rounds manager for this battle.

pub fn metrics(&self) -> ReadMetrics<R>

Returns a handle from which metrics can be read.

pub fn versioned_events<'a>(
    &'a self,
    range: Range<usize>
) -> impl Iterator<Item = VersionedEventWrapper<R>> + 'a

Returns an iterator over all history events in a range, versioned.

The range must be valid.