Skip to content

PlayElements

github-actions[bot] edited this page Oct 27, 2025 · 32 revisions
list(publishStates?, includeDenied?): PlayElement[] | null
Parameters
Name Type Description
publishStates (optional)
PublishState[]
(default: [ PublishState.ARCHIVED, PublishState.DRAFT, PublishState.PUBLISHED ])
includeDenied (optional)
boolean
(default: false)
Returns
Promise<PlayElement[] | null>

listV2(publishStates?, includeDenied?): GetOwnedPlayElementsResponseV2 | null
Parameters
Name Type Description
publishStates (optional)
PublishState[]
(default: [])
includeDenied (optional)
boolean
(default: false)
Returns
Promise<GetOwnedPlayElementsResponseV2 | null>

delete(playElementId): DeletePlayElementResponse | null
Parameters
Name Type Description
playElementId
string | PlayElement
Returns
Promise<DeletePlayElementResponse | null>

create(data): PlayElementResponse | null
Parameters
Name Type Description
data
any
Returns
Promise<PlayElementResponse | null>

update(playElement): PlayElementResponse | null
Parameters
Name Type Description
playElement
PlayElement
Returns
Promise<PlayElementResponse | null>

get(id, includeDenied?): PlayElement | null
Parameters
Name Type Description
id
string
includeDenied (optional)
boolean
(default: false)
Returns
Promise<PlayElement | null>

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