Class UndoableCommandAbstract Hidden Children

The UndoableCommand class is the base implementation for undoable commands and actions in the UndoRedo system.

Note

It is highly advised to not create manual undo commands for changes to scene objects and other objects and instead rely on UndoRedo.createUndoForSceneObject or UndoRedo.createUndoForObject and similar APIs. The reason is that there might be important considerations such as Editor domain-reloading to consider, which are easily forgotten.

Hierarchy (view full)

Constructors

constructor

Accessors

description

Methods

commit initialize revert shouldGroup

Constructors

constructor

Accessors

description

  • get description(): string

  • Get the description of the command.

    Returns string

Methods

Abstractcommit

  • commit(undoRedo): void
  • Virtual

    Applies the command, committing the change.

    Parameters

    • undoRedo: UndoRedo

      The UndoRedo stack on which the command is inserted on.

    Returns void

Protectedinitialize

  • initialize(description, objectUUID?): void

  • Initializes undoable command.

    Parameters

    • description: string

      The description of the command.

    • OptionalobjectUUID: UUID

      The uuid of the object affected by the command.

    Returns void

Abstractrevert

  • revert(undoRedo): void
  • Virtual

    Reverts the command, reverting the change previously done with commit.

    Parameters

    • undoRedo: UndoRedo

      The UndoRedo stack on which the command is inserted on.

    Returns void

shouldGroup

  • shouldGroup(): boolean
  • Virtual

    Whether the command should be grouped with similar commands in the undo stack.

    Returns boolean

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods