unreal.ActorModifierCoreLibrary

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

Bases: BlueprintFunctionLibrary

Blueprint Create/Read/Update/Delete operations for modifiers

C++ Source:

  • Plugin: ActorModifierCore

  • Module: ActorModifierCore

  • File: ActorModifierCoreLibrary.h

classmethod add_modifier_metadata_dependency(metadata, modifier_class) -> (ActorModifierCoreMetadata, metadata=ActorModifierCoreMetadata)

Adds a modifier metadata dependency for this modifier

Parameters:
Returns:

The modifier metadata to chain operations

metadata (ActorModifierCoreMetadata): The modifier metadata to use

Return type:

ActorModifierCoreMetadata

classmethod clone_modifier(modifier_stack, operation) → ActorModifierCoreBase or None

Clones an existing modifier into a modifier stack

Parameters:
Returns:

true when a valid modifier is returned

out_new_modifier (ActorModifierCoreBase): [Out] The newly created modifier

Return type:

ActorModifierCoreBase or None

classmethod contains_modifier(modifier_stack, modifier) → bool

Checks if a modifier is contained in the stack

Parameters:
Returns:

true if the modifier is contained within that stack

Return type:

bool

classmethod enable_modifier(modifier, state) → bool

Sets the state of an existing modifier

Parameters:
Returns:

true when the operation was successful

Return type:

bool

classmethod find_modifier_by_class(modifier_stack, modifier_class) → ActorModifierCoreBase

Returns the first modifier of a specified class in the stack

Parameters:
Returns:

the modifier of the specified class, if any.

Return type:

ActorModifierCoreBase

classmethod find_modifier_by_name(modifier_stack, modifier_name) → ActorModifierCoreBase

Returns the first modifier with specified name in the stack

Parameters:

  • modifier_stack (ActorModifierCoreStack) – The modifier stack to search

  • modifier_name (Name) – The name of the modifier to look for

Returns:

the modifier with specified name, if any.

Return type:

ActorModifierCoreBase

classmethod find_modifier_of_class(modifier_stack: ActorModifierCoreStack, modifier_class: Class) → ActorModifierCoreBase

deprecated: ‘find_modifier_of_class’ was renamed to ‘find_modifier_by_class’.

classmethod find_modifier_stack(actor, create_if_none=False) → ActorModifierCoreStack or None

Retrieves the modifier stack or create one if none is found

Parameters:

  • actor (Actor) – The actor to get the modifier stack from

  • create_if_none (bool) – Whether to create the modifier stack if none is found

Returns:

true when a valid modifier stack is returned

out_modifier_stack (ActorModifierCoreStack): [Out] The modifier stack for this actor

Return type:

ActorModifierCoreStack or None

classmethod find_modifiers_by_class(modifier_stack, modifier_class) → Array[ActorModifierCoreBase]

Finds all modifiers with specified class in the stack

Parameters:
Returns:

the modifiers with specified class, if any.

Return type:

Array[ActorModifierCoreBase]

classmethod find_modifiers_by_name(modifier_stack, modifier_name) → Array[ActorModifierCoreBase]

Finds all modifiers with specified class in the stack

Parameters:

  • modifier_stack (ActorModifierCoreStack) – The modifier stack to search

  • modifier_name (Name) – The name of the modifier to look for

Returns:

the modifiers with specified name, if any.

Return type:

Array[ActorModifierCoreBase]

classmethod get_available_modifiers() → Set[type(Class)] or None

Gets all available modifier classes registered

Returns:

true when the operation was successful

out_available_modifier_classes (Set[type(Class)]): [Out] The modifier classes registered and available to use

Return type:

Set[type(Class)] or None

classmethod get_dependent_modifiers(modifier) → Set[ActorModifierCoreBase] or None

Retrieves all modifiers found after this one that depends on this modifier

Parameters:

modifier (ActorModifierCoreBase) – The modifier that is required by others

Returns:

true when the operation was successful

out_modifiers (Set[ActorModifierCoreBase]): [Out] The dependent modifiers that required the modifier

Return type:

Set[ActorModifierCoreBase] or None

classmethod get_modifier_actor(modifier) → Actor or None

Retrieves the actor modified by a modifier

Parameters:

modifier (ActorModifierCoreBase) – The modifier to read from

Returns:

true when a valid actor is returned

out_modified_actor (Actor): [Out] The actor modified by this modifier

Return type:

Actor or None

classmethod get_modifier_categories() → Set[Name] or None

Retrieves the modifier categories available

Returns:

true when the operation was successful

out_modifier_categories (Set[Name]): [Out] The modifier categories registered

Return type:

Set[Name] or None

classmethod get_modifier_category(modifier) → Name or None

Retrieves the modifier category of an existing modifier

Parameters:

modifier (ActorModifierCoreBase) – The modifier to read from

Returns:

true when a valid category is returned

out_modifier_category (Name): [Out] The modifier category

Return type:

Name or None

classmethod get_modifier_category_by_class(modifier_class) → Name or None

Retrieves the modifier category from a modifier class

Parameters:

modifier_class (type(Class)) – The modifier class to resolve the category from

Returns:

true when a valid category is returned

out_modifier_category (Name): [Out] The modifier category

Return type:

Name or None

classmethod get_modifier_class(modifier_name) → type(Class) or None

Retrieves the modifier class from a modifier name

Parameters:

modifier_name (Name) – The modifier name to resolve

Returns:

true when the operation was successful

out_modifier_class (type(Class)): [Out] The modifier class that matches the name

Return type:

type(Class) or None

classmethod get_modifier_name(modifier) → Name or None

Retrieves the modifier name of an existing modifier

Parameters:

modifier (ActorModifierCoreBase) – The modifier to read from

Returns:

true when a valid name is returned

out_modifier_name (Name): [Out] The modifier name

Return type:

Name or None

classmethod get_modifier_name_by_class(modifier_class) → Name or None

Retrieves the modifier name from a modifier class

Parameters:

modifier_class (type(Class)) – The modifier class to resolve the name from

Returns:

true when a valid name is returned

out_modifier_name (Name): [Out] The modifier name

Return type:

Name or None

classmethod get_modifier_stack(modifier) → ActorModifierCoreStack or None

Retrieves the modifier stack this modifier is in

Parameters:

modifier (ActorModifierCoreBase) – The modifier to read from

Returns:

true when a valid stack is returned

out_modifier_stack (ActorModifierCoreStack): [Out] The modifier stack this modifier belongs to

Return type:

ActorModifierCoreStack or None

classmethod get_modifiers_by_category(category) → Set[type(Class)] or None

Retrieves the modifiers classes by a category

Parameters:

category (Name) – The modifier category to match

Returns:

true when the operation was successful

out_supported_modifier_classes (Set[type(Class)]): [Out] The modifier classes that match the category

Return type:

Set[type(Class)] or None

classmethod get_required_modifiers(modifier) → Set[ActorModifierCoreBase] or None

Retrieves all modifiers found before this one that are required for this modifier

Parameters:

modifier (ActorModifierCoreBase) – The modifier that requires other modifiers

Returns:

true when the operation was successful

out_modifiers (Set[ActorModifierCoreBase]): [Out] The required modifiers to use the modifier

Return type:

Set[ActorModifierCoreBase] or None

classmethod get_stack_modifiers(modifier_stack) → Array[ActorModifierCoreBase] or None

Retrieves all modifiers from a modifier stack

Parameters:

modifier_stack (ActorModifierCoreStack) – The modifier stack to read from

Returns:

true when the operation was successful

out_modifiers (Array[ActorModifierCoreBase]): [Out] The modifiers contained within the stack

Return type:

Array[ActorModifierCoreBase] or None

classmethod get_supported_modifiers(actor, context_position=ActorModifierCoreStackPosition.BEFORE, context_modifier=None) → Set[type(Class)] or None

Gets all modifier classes supported by this actor at a specific position

Parameters:
Returns:

true when the operation was successful

out_supported_modifier_classes (Set[type(Class)]): [Out] The modifier classes available

Return type:

Set[type(Class)] or None

classmethod insert_modifier(modifier_stack, operation) → ActorModifierCoreBase or None

Creates and insert a new modifier into a modifier stack

Parameters:
Returns:

true when a valid modifier is returned

out_new_modifier (ActorModifierCoreBase): [Out] The newly created modifier

Return type:

ActorModifierCoreBase or None

classmethod is_modifier_enabled(modifier) → bool or None

Checks the state of an existing modifier

Parameters:

modifier (ActorModifierCoreBase) – The modifier to read from

Returns:

true when the operation was successful

out_enabled (bool): The modifier enabled state

Return type:

bool or None

classmethod mark_modifier_dirty(modifier) → None

Marks the modifier dirty

Parameters:

modifier (ActorModifierCoreBase) – The modifier to dirty

classmethod move_modifier(modifier_stack, operation) → bool

Moves an existing modifier into a modifier stack

Parameters:
Returns:

true when the operation was successful

Return type:

bool

classmethod remove_modifier(modifier_stack, operation) → bool

Removes an existing modifier from a modifier stack

Parameters:
Returns:

true when the operation was successful

Return type:

bool

classmethod set_modifier_metadata_category(metadata, category) -> (ActorModifierCoreMetadata, metadata=ActorModifierCoreMetadata)

Sets the modifier metadata category

Parameters:
Returns:

The modifier metadata to chain operations

metadata (ActorModifierCoreMetadata): The modifier metadata to use

Return type:

ActorModifierCoreMetadata

classmethod set_modifier_metadata_compatibility_rule(metadata, delegate) -> (ActorModifierCoreMetadata, metadata=ActorModifierCoreMetadata)

Sets the modifier metadata compatibility rule

Parameters:
Returns:

The modifier metadata to chain operations

metadata (ActorModifierCoreMetadata): The modifier metadata to use

Return type:

ActorModifierCoreMetadata

classmethod set_modifier_metadata_description(metadata, description) -> (ActorModifierCoreMetadata, metadata=ActorModifierCoreMetadata)

Sets the modifier metadata description (EDITOR-ONLY)

Parameters:
Returns:

The modifier metadata to chain operations

metadata (ActorModifierCoreMetadata): The modifier metadata to use

Return type:

ActorModifierCoreMetadata

classmethod set_modifier_metadata_display_name(metadata, name) -> (ActorModifierCoreMetadata, metadata=ActorModifierCoreMetadata)

Sets the modifier metadata display name (EDITOR-ONLY)

Parameters:
Returns:

The modifier metadata to chain operations

metadata (ActorModifierCoreMetadata): The modifier metadata to use

Return type:

ActorModifierCoreMetadata

classmethod set_modifier_metadata_name(metadata, name) -> (ActorModifierCoreMetadata, metadata=ActorModifierCoreMetadata)

Sets the modifier metadata name

Parameters:
Returns:

The modifier metadata to chain operations

metadata (ActorModifierCoreMetadata): The modifier metadata to use

Return type:

ActorModifierCoreMetadata