unreal.ActorModifierAutoFollowModifier

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

Bases: ActorModifierAttachmentBaseModifier

Moves the modifying actor along with a specified actor relative to the specified actor’s bounds.

C++ Source:

  • Plugin: ActorModifier

  • Module: ActorModifierLayout

  • File: ActorModifierAutoFollowModifier.h

Editor Properties: (see get_editor_property/set_editor_property)

  • default_distance (Vector): [Read-Write] The distance from this actor to the followed actor.

  • followed_alignment (ActorModifierAnchorAlignment): [Read-Write] The alignment for the followed actor’s center.

  • followed_axis (int32): [Read-Write] Which axis should we follow

  • ignore_hidden_actors (bool): [Read-Write] If true, will search for the next visible actor based on the selected reference container. deprecated: Use ReferenceActor instead

  • local_alignment (ActorModifierAnchorAlignment): [Read-Write] The alignment for this actor’s center.

  • max_distance (Vector): [Read-Write] The maximum distance from this actor to the followed actor.

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

  • offset_axis (Vector): [Read-Write] Based on followed axis, the direction to offset this actor from the followed actor’s bounds.

  • progress (Vector): [Read-Write] Percent % progress from the maximum distance to the default distance.

  • reference_actor (ActorModifierSceneTreeActor): [Read-Write]

  • reference_actor_weak (Actor): [Read-Write] The actor being followed by the modifier. This is user selectable if the Reference Container is set to “Other”. deprecated: Use ReferenceActor instead

  • reference_container (ActorModifierReferenceContainer): [Read-Write] The method for finding a reference actor based on it’s position in the parent’s hierarchy. deprecated: Use ReferenceActor instead

property default_distance: Vector

[Read-Write] The distance from this actor to the followed actor.

Type:

(Vector)

get_default_distance() → Vector

Gets the distance from this actor to the followed actor.

Return type:

Vector

get_followed_alignment() → ActorModifierAnchorAlignment

Gets the alignment for the followed actor’s center.

Return type:

ActorModifierAnchorAlignment

get_followed_axis() → int32

Get Followed Axis

Return type:

int32

get_local_alignment() → ActorModifierAnchorAlignment

Gets the alignment for this actor’s center.

Return type:

ActorModifierAnchorAlignment

get_max_distance() → Vector

Gets the maximum distance from this actor to the followed actor.

Return type:

Vector

get_offset_axis() → Vector

Gets the axis direction to offset this actor from the followed actor’s bounds.

Return type:

Vector

get_progress() → Vector

Gets the percent % progress from the maximum distance to the default distance.

Return type:

Vector

get_reference_actor() → ActorModifierSceneTreeActor

Get Reference Actor

Return type:

ActorModifierSceneTreeActor

property ignore_hidden_actors: bool

[Read-Write] If true, will search for the next visible actor based on the selected reference container. deprecated: Use ReferenceActor instead

Type:

(bool)

property max_distance: Vector

[Read-Write] The maximum distance from this actor to the followed actor.

Type:

(Vector)

property offset_axis: Vector

[Read-Write] Based on followed axis, the direction to offset this actor from the followed actor’s bounds.

Type:

(Vector)

property progress: Vector

[Read-Write] Percent % progress from the maximum distance to the default distance.

Type:

(Vector)

property reference_actor_weak: Actor

[Read-Write] The actor being followed by the modifier. This is user selectable if the Reference Container is set to “Other”. deprecated: Use ReferenceActor instead

Type:

(Actor)

property reference_container: ActorModifierReferenceContainer

[Read-Write] The method for finding a reference actor based on it’s position in the parent’s hierarchy. deprecated: Use ReferenceActor instead

Type:

(ActorModifierReferenceContainer)

set_default_distance(default_distance) → None

Sets the distance from this actor to the followed actor.

Parameters:

default_distance (Vector)

set_followed_alignment(followed_alignment) → None

Sets the alignment for the followed actor’s center.

Parameters:

followed_alignment (ActorModifierAnchorAlignment)

set_followed_axis(followed_axis) → None

Set Followed Axis

Parameters:

followed_axis (int32)

set_local_alignment(local_alignment) → None

Sets the alignment for this actor’s center.

Parameters:

local_alignment (ActorModifierAnchorAlignment)

set_max_distance(max_distance) → None

Sets the maximum distance from this actor to the followed actor.

Parameters:

max_distance (Vector)

set_offset_axis(offset_axis) → None

Sets the axis direction to offset this actor from the followed actor’s bounds.

Parameters:

offset_axis (Vector)

set_progress(progress) → None

Sets the percent % progress from the maximum distance to the default distance.

Parameters:

progress (Vector)

set_reference_actor(reference_actor) → None

Set Reference Actor

Parameters:

reference_actor (ActorModifierSceneTreeActor)