GameMode

Asset path: Server/Entity/GameMode/*.json

Parent

When set this asset will inherit properties from the named asset.

When inheriting from another GameModeType most properties will simply be copied from the parent asset to this asset. In the case where both child and parent provide a field the child field will simply replace the value provided by the parent, in the case of nested structures this will apply to the fields within the structure. In some cases the field may decide to act differently, for example: by merging the parent and child fields together.

Type information: String

Tags

Tags are a general way to describe an asset that can be interpreted by other systems in a way they see fit.

For example you could tag something with a Material tag with the values Solid and Stone, And another single tag Ore.

Tags will be expanded into a single list of tags automatically. Using the above example with Material and Ore the end result would be the following list of tags: Ore, Material, Solid, Stone, Material=Solid and Material=Stone.

Type information:

(Nullable) Map of the following:

InteractionsOnEnter

Type information:

(Nullable) Either String or RootInteraction

Reference to a RootInteraction asset

Spectator

Whether players in this gamemode type are spectators: hidden from non-spectators, ignored by NPCs, unable to pick up items, and able to attach their camera to other players.

Type information: Boolean defaults to: false

MovementConfigId

When set, the named MovementConfig is applied as the player's movement settings on enter, including its Fly. On exit the player's default movement settings are restored. When unset the player's movement settings are left unchanged.

Type information: (Nullable) String

Reference to a MovementConfig asset

Flying

When set, forces the player into (or out of) the flying state on enter. When unset the player's flying state is left unchanged.

Type information: Boolean

NoClip

When set, enables or disables no-clip on enter. When unset the player's no-clip state is left unchanged.

Type information: Boolean

Invulnerable

When set, adds or removes the Invulnerable component on enter. When unset the player's invulnerability is left unchanged.

Type information: Boolean

Intangible

When set, adds or removes the Intangible component on enter. When unset the player's tangibility is left unchanged.

Type information: Boolean

ItemDrops

When set, allows or blocks the player dropping items while this gamemode type is active. When unset the underlying game mode's behavior applies.

Type information: Boolean

PreventInventoryAccess

When set, blocks or allows the player opening and manipulating their inventory on enter. When unset the player's inventory access is left unchanged.

Type information: Boolean

PreventEmotes

When set, blocks or allows the player playing emotes on enter, and entering with it set to true stops an emote in progress. When unset the player's emote access is left unchanged.

Type information: Boolean

TriggerBlocks

When set, enables or disables the player firing trigger blocks and taking block contact damage on enter. When unset the player's trigger block processing is left unchanged.

Type information: Boolean

VoiceChannel

When set, assigns the player to the named voice channel on enter: their speech is heard only by members of that channel. When unset the player's voice channel is left unchanged.

Type information: (Nullable) String

HudComponents

When set, replaces the player's visible HUD components on enter. When unset the player's HUD is left unchanged.

Type information:

(Nullable) Array of the type: Any one of the following String:

LockedCameraView

When set to FirstPerson or ThirdPerson, locks the player's camera to that view on enter, disabling the camera view toggle, and resets it on exit. When unset the camera is left unchanged.

Type information:

(Nullable) Any one of the following String:

EntityEffectId

When set, an entity effect applied to the player on enter and removed on exit, for example a ghostly spectator look. When unset no effect is applied.

Type information: (Nullable) String

Reference to a EntityEffect asset

DeathScreenMessage

When set, the death screen shown on dying into this gamemode type displays this localization key as a note, for example a permadeath notice, with a button that dismisses into the type. The screen appears only for deaths that show a death menu. When unset the type is entered silently.

Type information: (Nullable) String

InteractionOverrides

When set, inline root interactions mapped by interaction type, installed into the player's interaction overrides on enter and removed on exit. Lets a gamemode type rebind clicks, for example spectator camera controls, and gate the rest against the held item. When unset the player's interaction overrides are left unchanged.

Type information:

(Nullable) Map of the following:

OverrideAllInteractions

When true, interaction types the InteractionOverrides map does not bind resolve to no interaction rather than falling through to the held item, so a click can only run an interaction the map declares. When unset the unmapped types fall through as normal.

Type information: Boolean