unreal.UAFGraphNodeTemplate

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

Bases: Object

A template defining the appearance and behavior of a node in an animation graph ~This class is not instanced, rather its functions are called on its default object

C++ Source:

  • Plugin: UAFAnimGraph

  • Module: UAFAnimGraphUncookedOnly

  • File: UAFGraphNodeTemplate.h

Editor Properties: (see get_editor_property/set_editor_property)

  • category (Text): [Read-Write] The default category of the node

  • color (LinearColor): [Read-Write] The default color of the node

  • drag_drop_asset_types (Array[type(Class)]): [Read-Write] Asset types that we handle for drag-drop

  • icon (SlateBrush): [Read-Write] The icon of the node

  • menu_description (Text): [Read-Write] The default menu description of the node

  • node_layout (RigVMNodeLayout): [Read-Write]

  • sub_title (Text): [Read-Write] The default subtitle of the node

  • title (Text): [Read-Write] The default title of the node

  • tooltip_text (Text): [Read-Write] The default tooltip text of the node

  • traits (Array[InstancedStruct]): [Read-Write] The traits that we will instantiate

property category: Text

[Read-Only] The default category of the node

Type:

(Text)

property color: LinearColor

[Read-Only] The default color of the node

Type:

(LinearColor)

configure_new_node(controller, node) → bool

Called in editor when a node is first spawned

Parameters:
Return type:

bool

property drag_drop_asset_types: None

[Read-Only] Asset types that we handle for drag-drop

Type:

(Array[type(Class)])

get_category() → Text

Get the category of this node

Return type:

Text

get_color() → LinearColor

Get the title color of this node

Return type:

LinearColor

get_default_category_layout() → RigVMNodeLayout

Get a layout that assigns all trait pins to the default category

Return type:

RigVMNodeLayout

get_icon() → SlateBrush

Get the icon of this node

Return type:

SlateBrush

get_menu_description() → Text

Get the menu description of this node

Return type:

Text

get_node_layout() → RigVMNodeLayout

Get the node layout

Return type:

RigVMNodeLayout

get_per_trait_categories_layout() → RigVMNodeLayout

Get a layout that assigns all trait pins categories of their traits

Return type:

RigVMNodeLayout

get_sub_title() → Text

Get the subtitle of this node

Return type:

Text

get_title() → Text

Get the title of this node

Return type:

Text

get_tooltip_text() → Text

Get the tooltip text of this node

Return type:

Text

handle_asset_dropped(controller, node, asset) → None

Called in editor when an asset is drag/dropped. Called after ConfigureNewNode.

Parameters:
handle_pin_default_value_changed(controller, pin) → None

Called in editor when a pin default value is changed, e.g. to be used to reconfigure the nodes appearance

Parameters:
property icon: SlateBrush

[Read-Only] The icon of the node

Type:

(SlateBrush)

property menu_description: Text

[Read-Only] The default menu description of the node

Type:

(Text)

property node_layout: RigVMNodeLayout

[Read-Only]

Type:

(RigVMNodeLayout)

classmethod set_category_for_pins_in_layout(pin_paths, category_path, expanded_by_default=True) → RigVMNodeLayout

Sets the category of the supplied pins in a node layout

Parameters:
Returns:

layout (RigVMNodeLayout):

Return type:

RigVMNodeLayout

classmethod set_display_name_for_pin_in_layout(pin_path, pin_display_name) → RigVMNodeLayout

Sets the display name for a supplied pin in a node layout

Parameters:

  • pin_path (str)

  • pin_display_name (str)

Returns:

layout (RigVMNodeLayout):

Return type:

RigVMNodeLayout

property sub_title: Text

[Read-Only] The default subtitle of the node

Type:

(Text)

property title: Text

[Read-Only] The default title of the node

Type:

(Text)

property tooltip_text: Text

[Read-Only] The default tooltip text of the node

Type:

(Text)

property traits: None

[Read-Only] The traits that we will instantiate

Type:

(Array[InstancedStruct])