For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /server-editor/classes/Extension.md.

Class: Extension

Beta

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.

Properties

defaultToolGroupId

实验性

readonly defaultToolGroupId: string

Beta

Remarks

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


description

实验性

readonly description: string

Beta

Remarks

Description specified during registration for the extension.


name

实验性

readonly name: string

Beta

Remarks

Name of the extension.


notes

实验性

readonly notes: string

Beta

Remarks

Notes specified during registration for the extension.