unreal.ActorModifierCoreBlueprintBase

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

Bases: ActorModifierCoreBase

Abstract base class for all blueprint modifier

C++ Source:

  • Plugin: ActorModifierCore

  • Module: ActorModifierCore

  • File: ActorModifierCoreBlueprintBase.h

Editor Properties: (see get_editor_property/set_editor_property)

  • modifier_enabled (bool): [Read-Write] Is the modifier enabled or disabled

flag_modifier_dirty() → None

Flag this modifier as needing an update after a property value has changed

on_modifier_added_event(target_actor, reason) → None

Called when this modifier is added in a stack on an actor

Parameters:
on_modifier_apply_event(target_actor) → Text or None

Called to apply a custom action on an actor

Parameters:

target_actor (Actor)

Returns:

out_fail_reason (Text):

Return type:

Text or None

on_modifier_disabled_event(target_actor, reason) → None

Called when this modifier is disabled

Parameters:
on_modifier_enabled_event(target_actor, reason) → None

Called when this modifier is enabled

Parameters:
on_modifier_removed_event(target_actor, reason) → None

Called when this modifier is removed from a stack on an actor

Parameters:
on_modifier_replaced_event(target_actor) → None

Called when the modifier gets recompiled and replaced in the stack

Parameters:

target_actor (Actor)

on_modifier_restore_state_event(target_actor) → None

Called to restore this modifier actions on an actor

Parameters:

target_actor (Actor)

on_modifier_save_state_event(target_actor) → None

Called before this modifier is applied on an actor to save all relevant state

Parameters:

target_actor (Actor)

on_modifier_setup_event(metadata) -> (metadata=ActorModifierCoreMetadata, out_metadata=ActorModifierCoreMetadata)

Called once to setup modifier metadata

Parameters:

metadata (ActorModifierCoreMetadata)

Returns:

metadata (ActorModifierCoreMetadata):

out_metadata (ActorModifierCoreMetadata):

Return type:

tuple