Hiyve Components - v1.0.0
    Preparing search index...

    Props for TrailGame.

    interface TrailGameProps {
        colors?: Partial<GameColors>;
        game?: string;
        instructions?: false | GameInstructions | readonly GameInstructions[];
        labels?: Partial<GameLabels>;
        mascot?: false | MascotName;
        names?: Partial<IntervalNames>;
        onAnother?: () => void;
        onError?: (error: Error) => void;
        onResult?: (result: GameResult) => void;
        onTrailCompleted?: (state: TrailState) => void;
        player?: { id: string; name?: string };
        resultStore?: ResultStore;
        retryUntilRight?: boolean;
        samples?: SampleSource;
        scene?: "night" | "day";
        seed: number;
        settings: Partial<TrailSettings>;
        showInstructionsFirst?: boolean;
        showScore?: boolean;
        sounds?: boolean;
        subtitle?: string;
        sx?: SxProps<Theme>;
        terrain?: TrailTerrain;
        theoryNames?: Partial<TheoryNames>;
        title?: string;
        trailLabels?: Partial<TrailLabels>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    colors?: Partial<GameColors>
    game?: string

    The game's name, stamped on its results (default: the kinds of its cards)

    instructions?: false | GameInstructions | readonly GameInstructions[]

    How to play, shown from the help button and on first play (default: made from the kinds of cards; false hides the help button)

    labels?: Partial<GameLabels>
    mascot?: false | MascotName

    The mascot who reacts to answers (default: 'owl'; false for none)

    names?: Partial<IntervalNames>
    onAnother?: () => void
    onError?: (error: Error) => void
    onResult?: (result: GameResult) => void

    A result was made, whether or not a store kept it

    onTrailCompleted?: (state: TrailState) => void
    player?: { id: string; name?: string }

    Who is playing, stamped on results

    resultStore?: ResultStore

    Where results go; nothing is kept without it

    retryUntilRight?: boolean
    samples?: SampleSource

    Recorded piano samples for the notes the cards play (see UseGameSoundsOptions); without them a small built-in voice plays

    scene?: "night" | "day"

    The look of the scene: moonlit (default) or daylight

    seed: number
    settings: Partial<TrailSettings>
    showInstructionsFirst?: boolean

    Show how to play before the first card (default: false)

    showScore?: boolean

    Show points, stars and streak as the game goes (default: true)

    sounds?: boolean
    subtitle?: string

    A line under the title

    sx?: SxProps<Theme>
    terrain?: TrailTerrain

    A river (default) or a forest path; the forest has its own words for the slides (see forestTrailLabels)

    theoryNames?: Partial<TheoryNames>
    title?: string

    The game's name over the board

    trailLabels?: Partial<TrailLabels>