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

    Props for GameHowTo: How to play in the game's own words, three steps with pictures, read aloud when the speaker is tapped.

    interface GameHowToProps {
        instructions: GameInstructions;
        labels?: Partial<GameShellLabels>;
        look?: GameLookName | GameLook;
        mascot?: false | MascotName;
        onClose: () => void;
        open: boolean;
        pictures?: readonly ReactNode[];
        readAloud?: boolean;
        speak?: (text: string) => void | Promise<void>;
        tip?: string;
    }
    Index

    Properties

    instructions: GameInstructions

    The words: a title, the goal and the steps (and a tip)

    labels?: Partial<GameShellLabels>
    mascot?: false | MascotName
    onClose: () => void
    open: boolean
    pictures?: readonly ReactNode[]

    A small picture for each step, in order

    readAloud?: boolean

    Whether the speaker button reads the words aloud (default: true)

    speak?: (text: string) => void | Promise<void>

    Your own recordings for the words (see useReadAloud)

    tip?: string

    Shown as the tip when the instructions have none, on a phone: the lightbulb's tip, which the HUD has no room for there