unreal.ToolMenuEntryScript

class unreal.ToolMenuEntryScript(outer: Optional[Object] = None, name: Union[Name, str] = 'None')

Bases: Object

Tool Menu Entry Script

C++ Source:

• Module: ToolMenus

• File: ToolMenuEntryScript.h

Editor Properties: (see get_editor_property/set_editor_property)

• data (ToolMenuEntryScriptData): [Read-Write] Data

can_execute(context) → bool

Can Execute

Parameters:

context (ToolMenuContext) –

Return type:

bool

construct_menu_entry(menu, section_name, context) → None

Construct Menu Entry

Parameters:

• menu (ToolMenu) –

• section_name (Name) –

• context (ToolMenuContext) –

property data: ToolMenuEntryScriptData

[Read-Write] Data

Type:

(ToolMenuEntryScriptData)

execute(context) → None

Execute

Parameters:

context (ToolMenuContext) –

get_check_state(context) → CheckBoxState

Get Check State

Parameters:

context (ToolMenuContext) –

Return type:

CheckBoxState

get_icon(context) → ScriptSlateIcon

Get Icon

Parameters:

context (ToolMenuContext) –

Return type:

ScriptSlateIcon

get_label(context) → Text

Get Label

Parameters:

context (ToolMenuContext) –

Return type:

Text

get_tool_tip(context) → Text

Get Tool Tip

Parameters:

context (ToolMenuContext) –

Return type:

Text

init_entry(owner_name, menu, section, name, label='', tool_tip='') → None

Init Entry

Parameters:

• owner_name (Name) –

• menu (Name) –

• section (Name) –

• name (Name) –

• label (Text) –

• tool_tip (Text) –

is_visible(context) → bool

Is Visible

Parameters:

context (ToolMenuContext) –

Return type:

bool

register_menu_entry() → None

Register Menu Entry