unreal.ObjectMixerBlueprintObjectFilter¶
- class unreal.ObjectMixerBlueprintObjectFilter(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
ObjectMixerObjectFilterScript 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.
- 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.
- 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.
- 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.
- 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.
- 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:
- 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:
- get_properties_that_require_list_refresh() Set[Name]¶
If a property is changed that has a name found in this set, the panel will be refreshed. Add a property name to this list if you expect the list to change in some way after changing that property.