unreal.ActorModifierSplinePathModifier

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

Bases: ActorModifierCoreBase

This modifier allows to sample a spline and update the actor transform based on the spline path

C++ Source:

  • Plugin: ActorModifier

  • Module: ActorModifierLayout

  • File: ActorModifierSplinePathModifier.h

Editor Properties: (see get_editor_property/set_editor_property)

  • base_orientation (Rotator): [Read-Write] Base rotation added on top of the orientation rotation computed

  • distance (float): [Read-Write] Distance to sample the spline at

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

  • orient (bool): [Read-Write] Orient actor based on spline tangent

  • point_index (int32): [Read-Write] Point index to sample the spline at

  • progress (float): [Read-Write] Percentage progress to sample the spline at

  • sample_mode (ActorModifierLayoutSplinePathSampleMode): [Read-Write] How to sample the spline

  • scale (bool): [Read-Write] Apply scale based on spline point scale

  • spline_actor_weak (Actor): [Read-Write] Spline actor to retrieve the USplineComponent from

  • time (float): [Read-Write] Time to sample the spline at

get_base_orientation() → Rotator

Get Base Orientation

Return type:

Rotator

get_distance() → float

Get Distance

Return type:

float

get_orient() → bool

Get Orient

Return type:

bool

get_point_index() → int32

Get Point Index

Return type:

int32

get_progress() → float

Get Progress

Return type:

float

get_sample_mode() → ActorModifierLayoutSplinePathSampleMode

Get Sample Mode

Return type:

ActorModifierLayoutSplinePathSampleMode

get_scale() → bool

Get Scale

Return type:

bool

get_spline_actor() → Actor

Get Spline Actor

Return type:

Actor

get_time() → float

Get Time

Return type:

float

set_base_orientation(orientation) → None

Set Base Orientation

Parameters:

orientation (Rotator)

set_distance(distance) → None

Set Distance

Parameters:

distance (float)

set_orient(orient) → None

Set Orient

Parameters:

orient (bool)

set_point_index(index) → None

Set Point Index

Parameters:

index (int32)

set_progress(progress) → None

Set Progress

Parameters:

progress (float)

set_sample_mode(mode) → None

Set Sample Mode

Parameters:

mode (ActorModifierLayoutSplinePathSampleMode)

set_scale(scale) → None

Set Scale

Parameters:

scale (bool)

set_spline_actor(actor) → None

Set Spline Actor

Parameters:

actor (Actor)

set_time(time) → None

Set Time

Parameters:

time (float)