Struct Guide 

#[non_exhaustive]
pub struct Guide;

A guide that provides hints to the player during the tutorial.

Implementations

impl Guide

pub fn hint<T: GuideTopic>(&self, topic: T) -> !

Provides a hint about the specified topic and exits the program.

Examples found in repository

examples/tutorial_new_game.rs (line 27)

fn user_main(mut tick: Tick, starting_resources: StartingResources) -> (Tick, Bundle<Copper, 4>) {
    tick.log(true);

    let StartingResources {
        iron,
        mut iron_territory,
        mut copper_territory,
        guide,
    } = starting_resources;

    // To start, run the game using `rustorio play tutorial` (or whatever this save is called), and follow the hint.
    // If you get stuck, try giving the guide other objects you've found, like the `tick` object.
    guide.hint(iron)
}