unreal.ObjectMixerBlueprintObjectFilter

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

Bases: ObjectMixerObjectFilter

Script class for filtering object types to Object Mixer. Blueprint classes should inherit directly from this class.

C++ Source:

  • Plugin: ObjectMixer

  • Module: ObjectMixerEditor

  • File: ObjectMixerEditorObjectFilter.h

get_columns_to_exclude() → Set[Name]

Specify a list of property names corresponding to columns you don’t want to ever show. For example, you can specify “Intensity” and “LightColor” to ensure that they can’t be enabled or shown in the UI. Columns not specified can be enabled by the user in the UI.

Return type:

Set[Name]

get_columns_to_show_by_default() → Set[Name]

Specify a list of property names corresponding to columns you want to show by default. For example, you can specify “Intensity” and “LightColor” to show only those property columns by default in the UI. Columns not specified will not be shown by default but can be enabled by the user in the UI.

Return type:

Set[Name]

get_force_added_columns() → Set[Name]

Specify a list of property names found in parent classes you want to show that aren’t in the specified classes. Note that properties specified here do not override the properties specified in GetColumnsToExclude(). For example, a ULightComponent displays “LightColor” in the editor’s details panel, but ULightComponent itself doesn’t have a property named “LightColor”. Instead it’s in its parent class, ULightComponentBase. In this scenario, ULightComponent is specified and PropertyInheritanceInclusionOptions is None, so “LightColor” won’t appear by default. Specify “LightColor” in this function to ensure that “LightColor” will appear as a column as long as the property is accessible to one of the specified classes regardless of which parent class it comes from.

Return type:

Set[Name]

get_object_classes_to_filter() → Set[type(Class)]

Return the basic object types you want to filter for in your level. For example, if you want to work with Lights, return ULightComponentBase. If you also want to see the properties for parent or child classes, override the GetObjectMixerPropertyInheritanceInclusionOptions and GetForceAddedColumns functions.

Return type:

Set[type(Class)]

get_object_classes_to_place() → Set[type(Class)]

Return the basic actor types you want to be able to place using the Add button. Note that only subclasses of AActor are supported and only those which have a registered factory. This includes most engine actor types.

Return type:

Set[type(Class)]

get_object_mixer_placement_class_inclusion_options() → ObjectMixerInheritanceInclusionOptions

Specify whether we should return only the specified classes or the parent and child classes in placement mode. Defaults to ‘None’ which only considers the specified classes.

Return type:

ObjectMixerInheritanceInclusionOptions

get_object_mixer_property_inheritance_inclusion_options() → ObjectMixerInheritanceInclusionOptions

Specify whether we should return only the properties of the specified classes or the properties of parent and child classes. Defaults to ‘None’ which only considers the properties of the specified classes. If you’re not seeing all the properties you expected, try overloading this function.

Return type:

ObjectMixerInheritanceInclusionOptions

get_row_display_name(object, is_hybrid_row) → Text

Get the text to display for the object name/label. This is useful if one of your classes is a component type and you want the label of the component’s owning actor, for example. If not overridden, this returns the actor’s label if it’s an actor and the object’s name for all other objects.

Parameters:

  • object (Object) –

  • is_hybrid_row (bool) – If true, this row represents a single matching component condensed into a single row with its actor parent.

Return type:

Text

get_row_editor_visibility(object) → bool

Controls how to display the row’s visibility icon. Return true if the object should be visible. Generally this should work like the Scene Outliner does. If not overridden, we use the Editor Visibility of the object’s AActor outer (unless it’s an actor itself).

Parameters:

object (Object) –

Return type:

bool

get_row_tooltip_text(object, is_hybrid_row) → Text

Get the text to display for the row’s tooltip when hovering over it.

Parameters:

  • object (Object) –

  • is_hybrid_row (bool) – If true, this row represents a single matching component condensed into a single row with its actor parent. (unused)

Return type:

Text

on_set_row_editor_visibility(object, new_is_visible) → None

Controls what happens when the row’s visibility icon is clicked. Generally this should work like the Scene Outliner does. If not overridden, we set the Editor Visibility of the object’s AActor outer (unless it’s an actor itself).

Parameters:
should_include_unsupported_properties() → bool

If true, properties that are not visible in the details panel and properties not supported by SSingleProperty will be selectable. Defaults to false.

Return type:

bool