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

Interface: PauseMenuProps

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

Props of the pause menu.

Properties

hosting?

optional hosting?: string[]

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

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

---

onLeaveRun?

optional onLeaveRun?: () => void

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

In a run's room: leaves the run for the page it came from (its lobby, or its game's page).

Returns

void

---

onQuit

onQuit: () => void

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

Leaves the game for the main menu.

Returns

void

---

onResume

onResume: () => void

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

Closes the menu: the game goes on.

Returns

void

---

onSound

onSound: (sound) => void

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

Plays a menu cue.

Parameters

sound

UiSound

Returns

void

---

pause

pause: object

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

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:30

The player's settings.