Skip to content
github-actions[bot] edited this page Oct 27, 2025 · 32 revisions
Gets the name of the map.
getName(): string
Returns
string

Sets the name of the map.
setName(name): void
Parameters
Name Type Description
name
string
The name of the map.

Gets the location of the map.
getLocation(): string
Returns
string

Sets the location of the map.
setLocation(location): void
Parameters
Name Type Description
location
string
The location of the map.

Gets the number of rounds.
getRounds(): number
Returns
number

Sets the number of rounds.
setRounds(rounds): void
Parameters
Name Type Description
rounds
number
The number of rounds.

Gets the allowed spectators.
getAllowedSpectators(): number
Returns
number

Sets the allowed spectators.
setAllowedSpectators(allowedSpectators): void
Parameters
Name Type Description
allowedSpectators
number
The allowed spectators.

Gets the team composition.
getTeamComposition(): TeamComposition
Returns
TeamComposition

Sets the team composition.
setTeamComposition(teamComposition): void
Parameters
Name Type Description
teamComposition
TeamComposition
The team composition.

Gets the blaze game settings.
getBlazeGameSettings(): any
Returns
any

Sets the blaze game settings.
setBlazeGameSettings(blazeGameSettings): void
Parameters
Name Type Description
blazeGameSettings
any
The blaze game settings.

Gets the mutators.
getMutators(): any[]
Returns
any[]

Sets the mutators.
setMutators(mutators): void
Parameters
Name Type Description
mutators
any[]
The mutators.

Gets the game server joinability settings.
getGameServerJoinabilitySettings(): any
Returns
any

Sets the game server joinability settings.
setGameServerJoinabilitySettings(settings): void
Parameters
Name Type Description
settings
any
The game server joinability settings.

Populates the map from a JSON object.
fromJSON(map): Map
Parameters
Name Type Description
map
any
The JSON object.
Returns
Map

Converts the map to a JSON object.
toJSON(): any
Returns
any

General

The actual abstraction layer for retrieving or sending data from the portal server.

⠀⠀ Installation

⠀⠀ Usage

⠀⠀ Examples

Backends

The actual abstraction layer for retrieving or sending data from the portal server.

⠀⠀ Blueprints

⠀⠀ Experience

⠀⠀ Mods⠀⠀⠀⠀

⠀⠀ PlayElements

Models

Model data for simplified use of the data.

⠀⠀ Blueprint

⠀⠀ Creator

⠀⠀ Design

⠀⠀ Map

⠀⠀ MapRotation

⠀⠀ Option

⠀⠀ PlayElement

⠀⠀ Settings

⠀⠀ Tag

⠀⠀ Team

⠀⠀ TeamComposition

Enum

Static data and informations.

⠀⠀ CreatorType

⠀⠀ OptionType

⠀⠀ Status


Clone this wiki locally