five-on-it / apps/client/src/ui/PauseMenu / PauseMenuProps

Interface: PauseMenuProps

Defined in: apps/client/src/ui/PauseMenu.tsx:22

Props of the pause menu.

Properties

hosting?

optional hosting?: string[]

Defined in: apps/client/src/ui/PauseMenu.tsx:26

Where friends on the network join, while this app hosts the game.

---

onQuit

onQuit: () => void

Defined in: apps/client/src/ui/PauseMenu.tsx:32

Leaves the game for the main menu.

Returns

void

---

onResume

onResume: () => void

Defined in: apps/client/src/ui/PauseMenu.tsx:30

Closes the menu: the game goes on.

Returns

void

---

onSound

onSound: (sound) => void

Defined in: apps/client/src/ui/PauseMenu.tsx:34

Plays a menu cue.

Parameters

sound

UiSound

Returns

void

---

pause

pause: object

Defined in: apps/client/src/ui/PauseMenu.tsx:24

Whether the room waits, and how many play in it.

frozen

frozen: boolean

players

players: number

---

settings

settings: Store<Settings>

Defined in: apps/client/src/ui/PauseMenu.tsx:28

The player's settings.