GameProps
Defined in: packages/engine/src/components/Game.tsx:33
Extends
Section titled “Extends”PropsWithChildren
Properties
Section titled “Properties”| Property | Type | Default value | Description |
|---|---|---|---|
children? |
ReactNode |
undefined |
- |
loadingScreen? |
false | ComponentType<GameLoadingScreenProps> |
the ui package’s LoadingScreen |
What covers the canvas from the moment Game mounts until the world can step and draw: the platform’s loading screen unless named, and nothing with false. |
name |
string |
undefined |
The game’s identity. |
room? |
RoomOptions |
undefined |
The room to play in: the world is then the room’s, streamed to this client, and only the player’s own hero steps here. The game mounts Replicas to draw the stream, her own hero among it. None plays alone. Read once, when Game mounts. |
start |
string |
undefined |
The scene that opens. |
systems? |
System[] |
undefined |
What the world’s step runs, in order: the engine’s baseSystems when left out. Read once, when Game mounts. |