Skip to main content

Class: Extension

Editor Extensions are the basis for all player specific, editor specific functionality within the game. Almost all editor functionality is exported and available within the context of an ExtensionContext When the script manager initializes during level loading, the scripts are loaded from the behavior packs and executed. As part of the global execution context, the scripts are free to register any number of extensions. An Editor Extension is defined a name, an activation function and a shutdown function.

It is not recommended to directly use this function as the contract is not guaranteed to be stable, instead prefer registerEditorExtension as it provides additional functionality and a stable contract.

Constructors​

new Extension()​

private new Extension(): Extension

Returns​

Extension

Properties​

defaultToolGroupId​

readonly defaultToolGroupId: string

Remarks​

Default identifier for tool rail grouping. All modal tools created from the extension will use this.

description​

readonly description: string

Remarks​

Description specified during registration for the extension.

name​

readonly name: string

Remarks​

Name of the extension.

notes​

readonly notes: string

Remarks​

Notes specified during registration for the extension.