Interface RoomsConfig

Hierarchy

Properties

Advanced room options for mod and plugin developers, or knowledgeable server owners.

chatCommands: boolean | ChatCommandConfig

Whether to allow players to use chat commands.

Default

true

checkChatMode: boolean

Whether or not to make sure players have the same chat mode as the host before joining.

Default

false

createTimeout: number

The timeout in seconds to wait for a player joins before considering the room empty and destroying it.

Default

10

doFixedUpdate?: boolean

Whether or not to do a fixed update interval.

Default

false

enforceSettings: Partial<AllGameSettings>

Enforce certain settings, preventing the host from changing them.

gameCodes: "v1" | "v2"

The type of game code to generate for rooms, "v1" for a 4-letter code and "v2" for a 6-letter code.

Default

"v2"

plugins: PluginConfig

Options regarding room plugins.

serverAsHost: boolean

Whether the server should act as the host of the room. (experimental)

Default

false

serverPlayer: ServerPlayerOptions

Default appearance for a message sent by the server in game chat

Generated using TypeDoc