Struct peppi::game_parser::GameParser

pub struct GameParser {
    pub start: Option<Start>,
    pub end: Option<End>,
    pub frames_start: Vec<Start>,
    pub frames_end: Vec<End>,
    pub frames_leaders: FrameEvents,
    pub frames_followers: FrameEvents,
    pub items: Vec<Vec<Item>>,
    pub metadata: Option<Map<String, Value>>,
}

Fields

start: Option<Start>

end: Option<End>

frames_start: Vec<Start>

frames_end: Vec<End>

frames_leaders: FrameEvents

frames_followers: FrameEvents

items: Vec<Vec<Item>>

metadata: Option<Map<String, Value>>

Implementations

impl GameParser

pub fn into_game(self) -> Result<Game>

Trait Implementations

impl Debug for GameParser

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

Formats the value using the given formatter.

impl Default for GameParser

fn default() -> GameParser

Returns the “default value” for a type.

impl Handlers for GameParser

fn game_start(&mut self, s: Start) -> Result<()>

How the game is set up; also includes the version of the extraction code.

fn game_end(&mut self, s: End) -> Result<()>

The end of the game.

fn frame_start(&mut self, evt: FrameEvent<FrameId, Start>) -> Result<()>

RNG seed and frame number at the start of a frame’s processing.

fn frame_pre(&mut self, evt: FrameEvent<PortId, Pre>) -> Result<()>

Pre-frame update, collected right before controller inputs are used to figure out the character’s next action. Used to reconstruct a replay.

fn frame_post(&mut self, evt: FrameEvent<PortId, Post>) -> Result<()>

Post-frame update, collected at the end of the Collision detection which is the last consideration of the game engine. Useful for making decisions about game states, such as computing stats.

fn frame_end(&mut self, evt: FrameEvent<FrameId, End>) -> Result<()>

Indicates an entire frame’s worth of data has been transferred/processed.

fn item(&mut self, evt: FrameEvent<FrameId, Item>) -> Result<()>

One event per frame per item, with a maximum of 15 updates per frame. Can be used for stats, training AIs, or visualization engines to handle items. Items include projectiles like lasers or needles.

fn metadata(&mut self, metadata: Map<String, Value>) -> Result<()>

Miscellaneous data not directly provided by Melee.

fn finalize(&mut self) -> Result<()>

Called after all parse events have been handled.