unreal.AIESelectionSets

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

Bases: AssetUserData

Link To Set of Anim Sequences that we may be linked to.

C++ Source:

  • Plugin: ControlRig

  • Module: ControlRigEditor

  • File: SelectionSets.h

Editor Properties: (see get_editor_property/set_editor_property)

  • selection_sets (Map[Guid, AIESelectionSetItem]): [Read-Write]

add_selection_to_set_item(guid) → bool

Add selection to specified selection set

Parameters:

guid (Guid)

Return type:

bool

create_mirror(guid) → Guid

Create a mirrored selection set from an existing set. Will return empty FGuid if no set created

Parameters:

guid (Guid)

Return type:

Guid

create_set_item_from_selection() → Guid

Create a selection set from current selection. Will return empty FGuid if no set created

Return type:

Guid

delete_set_item(guid) → bool

Delete selection set

Parameters:

guid (Guid)

Return type:

bool

export_as_json_file(json_file_path) → bool

Export sets to a JSON file

Parameters:

json_file_path (FilePath)

Return type:

bool

export_as_json_string() → str or None

Export sets from a string

Returns:

out_json_string (str):

Return type:

str or None

get_active_actors() → Array[Actor]

Get the actors which are selectable

Return type:

Array[Actor]

get_active_selection_sets() → Array[Guid]

Get the current set of active selection sets based upon active actors. This function will set it up also if needed

Return type:

Array[Guid]

get_all_actors() → Array[Actor]

Get all the actors which are present to be selected by a selection set

Return type:

Array[Actor]

get_item_color(guid) → LinearColor or None

Get selection set color

Parameters:

guid (Guid)

Returns:

out_color (LinearColor):

Return type:

LinearColor or None

get_item_guids(item_name) → Array[Guid]

Get the guids of set items associated with this name

Parameters:

item_name (Text)

Returns:

out_guids (Array[Guid]):

Return type:

Array[Guid]

get_item_name(guid) → Text or None

Get selection set name

Parameters:

guid (Guid)

Returns:

out_name (Text):

Return type:

Text or None

get_item_row(guid) → int32 or None

Get selection set row

Parameters:

guid (Guid)

Returns:

out_row (int32):

Return type:

int32 or None

get_show_and_set_selected_only() → bool

Whether we are only showing and setting selections on current selections

Return type:

bool

is_multi_asset(guid) → bool

Rename selection set

Parameters:

guid (Guid)

Return type:

bool

isolate_controls(guid) → bool

Isolate controls from just this selection set on active actors

Parameters:

guid (Guid)

Return type:

bool

key_all(guid) → bool

Key the selection sets on active actors

Parameters:

guid (Guid)

Return type:

bool

load_from_json_file(json_file_path) → bool

Load sets from a JSON file

Parameters:

json_file_path (FilePath)

Return type:

bool

load_from_json_string(json_string) → bool

Load sets from a string

Parameters:

json_string (str)

Return type:

bool

remove_selection_from_set_item(guid) → bool

Remove selection from specified selection set

Parameters:

guid (Guid)

Return type:

bool

rename_set_item(guid, new_name) → bool

Rename selection set

Parameters:
Return type:

bool

select_item(guid, do_mirror, add, toggle, select=True) → bool

Select from selection set, will select on the active actors

Parameters:
Return type:

bool

property selection_sets: None

[Read-Only]

Type:

(Map[Guid, AIESelectionSetItem])

set_actor_as_active(actor, set_active) → bool
Set the AActor as Active or not, so it will or won’t be selected from a selection set. Will return false if it doesn’t match any sets*.

Note if GetShowAndSetSelectedOnly() is true the selected state of the Actor will take precedence over this

Parameters:
Return type:

bool

set_item_color(guid, color) → bool

Set selection set color

Parameters:
Return type:

bool

set_item_row(guid, row) → bool

Set selection set row

Parameters:

  • guid (Guid)

  • row (int32)

Return type:

bool

set_show_and_set_selected_only(show_selected_only) → None

Set whether we are only showing and setting selections on current selections

Parameters:

show_selected_only (bool)

show_all_controls(guid) → bool

Show all controls from this selection set’s active actors

Parameters:

guid (Guid)

Return type:

bool

show_or_hide_controls(guid, show, do_mirror) → bool

Show or hide controls on the active actors from the specified set

Parameters:
Return type:

bool