Struct Headless 

pub struct Headless<G: GameData> { /* private fields */ }

A Session over a game’s Harness.

Implementations

impl<G: GameData> Headless<G>

pub fn new(harness: Harness<G>) -> Self

A session of harness, with no scene and no events of the game’s.

pub fn with_scene( self, scene: impl Fn(&Harness<G>) -> Result<Scene, String> + 'static, ) -> Self

This session, its scene from scene.

pub fn with_events( self, events: impl Fn(&Harness<G>) -> Vec<String> + 'static, ) -> Self

This session, the game’s events from events.

pub fn with_picture( self, picture: impl Fn(&Harness<G>, Option<u32>) -> Result<Image, String> + 'static, ) -> Self

This session, its frame painted by picture (most simply the game’s frame-png painter over the Harness’s frame).

pub fn harness(&self) -> &Harness<G>

The Harness it drives.

Trait Implementations

impl<G: GameData> Session for Headless<G>

fn set_perf(&mut self, on: bool)

Gives the Harness this machine’s clock, and in a build that counts the heap this program’s heap counter and its memory tags (and tags the asset decodes), each unless its platform has one already (a test’s fake, kept so its records stay the same); false takes away what it gave. Before the game has loaded it does nothing.

fn play(&mut self, script: &Script)

Plays script’s steps, in order.

fn idle(&mut self, frames: u32)

Runs frames frames with no input.

fn actions(&self) -> Vec<String>

The game’s actions that have a key or a button now, in its action set’s order: those a script’s act step can press (none by default).

fn play_record(&mut self) -> Option<Played>

Plays the session record it was made ready for (GameTools::session_from) to its end, or its first frame that plays differently, and says how far it has got. Asked again, it plays nothing more: its limits then say what a script’s frames took over from it. None for a session started from options, the default.

fn frame_count(&self) -> u32

How many frames have run.

fn screens(&self) -> Vec<String>

The open screens’ names, bottom first.

fn quit_frame(&self) -> Option<u32>

The frame the game asked to quit in, if it has.

fn snapshot(&self) -> String

The current frame in the snapshot text format.

fn events(&self) -> Vec<Event>

What happened, in frame order: screens opening and closing, music, voices, the quit, then the game’s own events.

fn sounds(&self) -> Vec<Sound>

The sound cues asked for, in order.

fn sounds_added(&self) -> Vec<AddedSound>

The sounds the game added at run time and hasn’t removed, in cue order (none by default).

fn scene(&self) -> Result<Scene, String>

The scene on screen, or why there is none.

fn log(&self) -> Vec<LogEntry>

The game’s log, oldest first: its last lines (none by default).

fn log_dropped(&self) -> u32

How many older lines the log dropped (0 by default).

fn modules(&self) -> Vec<ModuleEntry>

The modules installed in the game, in install order (none by default).

fn counts_process_heap(&self) -> bool

Whether its records’ heap counts are this tool program’s own heap counter’s, which counts the whole program (every thread’s allocations), not a fake’s. By default not.

fn perf(&self, since: u64, max: u32) -> PerfRead

The frames’ records kept, numbered since or more, the first max of them (PerfRead). By default nothing, measured.

fn heap_snapshot(&mut self) -> Option<HeapSnapshot>

What holds the heap now, by memory tag, at the frames run: a fake memory’s, or with perf on (set_perf) this program’s heap counter’s, in a build that counts it. By default none.

fn picture(&self, scale: Option<u32>) -> Result<Image, String>

The current frame as the game paints it, each console pixel scale × scale (the game’s choice if None). By default the game offers none.