Skip to content
github-actions[bot] edited this page Oct 27, 2025 · 3 revisions
Gets the ID of the design.
getId(): string
Returns
string

Sets the ID of the design.
setId(id): void
Parameters
Name Type Description
id
string
The ID of the design.

Gets the name of the design.
getName(): string
Returns
string

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

Gets the creation date of the design.
getCreated(): Date | null
Returns
Date | null

Sets the creation date of the design.
setCreated(created): void
Parameters
Name Type Description
created
Date
The creation date of the design.

Gets the design metadata.
getDesignMetadata(): any
Returns
any

Sets the design metadata.
setDesignMetadata(metadata): void
Parameters
Name Type Description
metadata
any
The design metadata.

Gets the map rotation.
getMapRotation(): MapRotation
Returns
MapRotation

Sets the map rotation.
setMapRotation(mapRotation): void
Parameters
Name Type Description
mapRotation
MapRotation
The map rotation.

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

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

Gets the asset categories.
getAssetCategories(): any[]
Returns
any[]

Sets the asset categories.
setAssetCategories(assetCategories): void
Parameters
Name Type Description
assetCategories
any[]
The asset categories.

Gets the license requirements.
getLicenseRequirements(): string[]
Returns
string[]

Sets the license requirements.
setLicenseRequirements(licenseRequirements): void
Parameters
Name Type Description
licenseRequirements
string[]
The license requirements.

Gets the mod rules.
getModRules(): any
Returns
any

Sets the mod rules.
setModRules(modRules): void
Parameters
Name Type Description
modRules
any
The mod rules.

Gets the tags.
getTags(): Tag[]
Returns
Tag[]

Sets the tags.
setTags(tags): void
Parameters
Name Type Description
tags
Tag[]
The tags.

Gets the blaze settings.
getBlazeSettings(): any
Returns
any

Sets the blaze settings.
setBlazeSettings(blazeSettings): void
Parameters
Name Type Description
blazeSettings
any
The blaze settings.

Gets the mod level data ID.
getModLevelDataId(): string | null
Returns
string | null

Sets the mod level data ID.
setModLevelDataId(modLevelDataId): void
Parameters
Name Type Description
modLevelDataId
string | null
The mod level data ID.

Gets the attachments.
getAttachments(): any[]
Returns
any[]

Sets the attachments.
setAttachments(attachments): void
Parameters
Name Type Description
attachments
any[]
The attachments.

Gets the group licenses.
getGroupLicenses(): string[]
Returns
string[]

Sets the group licenses.
setGroupLicenses(groupLicenses): void
Parameters
Name Type Description
groupLicenses
string[]
The group licenses.

Gets the attachment compile status.
getAttachmentCompileStatus(): number
Returns
number

Sets the attachment compile status.
setAttachmentCompileStatus(status): void
Parameters
Name Type Description
status
number
The attachment compile status.

Gets the server host license requirements.
getServerHostLicenseRequirements(): string[]
Returns
string[]

Sets the server host license requirements.
setServerHostLicenseRequirements(requirements): void
Parameters
Name Type Description
requirements
string[]
The server host license requirements.

Populates the design from a JSON object.
fromJSON(json): Design
Parameters
Name Type Description
json
any
The JSON object.
Returns
Design

Converts the design 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