Class MinecraftEditor

The MinecraftEditor class is a namespace container for Editor functionality which does not have any player context.

Hierarchy

  • MinecraftEditor

Constructors

constructor

Properties

log simulation

Methods

registerExtension_Internal

Constructors

Private constructor

Properties

Readonly log

log: Logger

Remarks

A global instance of the log output class object. This is not contextualized to any particular player, and any messages sent to this instance will be broadcast to all connected editor client sessions

Throws

This property can throw when used.

Readonly simulation

simulation: SimulationState

Remarks

Allows querying and modifying some properties of the simulation.

Methods

registerExtension_Internal

  • Parameters

    • extensionName: string

      Unique name of the editor extension being registered

    • activationFunction: ((arg) => void)

      A code closure which is called during the activation process and is responsible for setting up all of the extension internal settings and UI definitions

    • shutdownFunction: ((arg) => void)

      A code closure which is called during the deactivation process (when the player disconnects) and is responsible for cleaning up any settings or allocations

    • Optional options: ExtensionOptionalParameters

      [ExtensionOptionalParameters] describes an optional object which contains a number of optional parameters which is used to register an extension with additional information

    Returns Extension

    Remarks

    This is an internal command which interfaces with the native C++ extension bindings and should not be used by creators. Using this command directly will not provide any of the additional functionality and wrappings that the TypeScript layer will provide. Creators should use the TypeScript binding registerEditorExtension instead

    This function can't be called in read-only mode.

Settings

Member Visibility

Theme

On This Page