unreal.UTBBaseCommand

class unreal.UTBBaseCommand(outer: Object | None = None, name: Name | str = 'None')

Bases: Object

UUTBBaseCommand is the base class for any command of the usertoolbox framework. Inherit directly from this class if you want to create a new command implemented in c++

C++ Source:

  • Plugin: UserToolBoxCore

  • Module: UserToolBoxCore

  • File: UTBBaseCommand.h

Editor Properties: (see get_editor_property/set_editor_property)

  • category (str): [Read-Write]

  • icon_path (str): [Read-Write] The icon path for the command

  • keyboard_shortcut (InputChord): [Read-Write]

  • name (str): [Read-Write] The name of the command

  • show_parameters (bool): [Read-Write]

  • tooltip (str): [Read-Write]

  • ui_override (type(Class)): [Read-Write]

add_object_to_transaction(object) None

Add Object to Transaction

Parameters:

object (Object) –

add_objects_to_transaction(objects) None

Add Objects to Transaction

Parameters:

objects (Array[Object]) –

property category: str

[Read-Write]

Type:

(str)

property icon_path: str

[Read-Write] The icon path for the command

Type:

(str)

property name: str

[Read-Write] The name of the command

Type:

(str)

property show_parameters: bool

[Read-Write]

Type:

(bool)

property tooltip: str

[Read-Write]

Type:

(str)

property ui_override: Class

[Read-Write]

Type:

(type(Class))