unreal.ProceduralDaySequenceBuilder

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

Bases: Object

A utility class for creating procedural Day Sequences. Before adding any keys, SetActiveBoundObject should be called and provided a Day Sequence Actor or a component owned by a Day Sequence Actor. All time values are currently normalized to the range [0, 1], inclusive on both ends. A time of 1 is handled as a special case and maps to the final frame. This class assumes the target Day Sequence Actor will stay alive and that users will keep the generated sequence alive, it manages no lifetimes.

Consider using FProceduralDaySequence instead of using this class directly.

C++ Source:

  • Plugin: DaySequence

  • Module: DaySequence

  • File: ProceduralDaySequenceBuilder.h

add_bool_key(property_name, key, value) → None

Add Bool Key

Parameters:
add_bool_override(property_name, value) → None

Key Creation:

Parameters:
add_color_material_parameter_override(parameter_name, material_index, value) → None

Add Color Material Parameter Override

Parameters:
add_color_override(property_name, value) → None

Add Color Override

Parameters:
add_material_override(material_index, value) → None

Add Material Override

Parameters:
add_rotation_key(key, value, interp_mode=RichCurveInterpMode.RCIM_CUBIC) → None

Add Rotation Key

Parameters:
add_scalar_key(property_name, key, value, interp_mode=RichCurveInterpMode.RCIM_CUBIC) → None

Add Scalar Key

Parameters:
add_scalar_material_parameter_override(parameter_name, material_index, value) → None

Add Scalar Material Parameter Override

Parameters:

  • parameter_name (Name)

  • material_index (int32)

  • value (float)

add_scalar_override(property_name, value) → None

Add Scalar Override

Parameters:

  • property_name (Name)

  • value (double)

add_scale_key(key, value, interp_mode=RichCurveInterpMode.RCIM_CUBIC) → None

Add Scale Key

Parameters:
add_transform_override(value) → None

Add Transform Override

Parameters:

value (Transform)

add_translation_key(key, value, interp_mode=RichCurveInterpMode.RCIM_CUBIC) → None

Add Translation Key

Parameters:
add_vector_key(property_name, key, value, interp_mode=RichCurveInterpMode.RCIM_CUBIC) → None

Add Vector Key

Parameters:
add_vector_override(property_name, value) → None

Add Vector Override

Parameters:
add_visibility_override(value) → None

Add Visibility Override

Parameters:

value (bool)

clear_keys() → None

Key Deletion:

initialize(actor, initial_sequence=None, clear_initial_sequence=True) → DaySequence

Initialize the procedural sequence and set the TargetActor for this builder.

Parameters:

  • actor (DaySequenceActor) – The target DaySequenceActor that will be animated by the generated sequence.

  • initial_sequence (DaySequence) – Optional sequence that this builder can operate on instead of allocating a new sequence.

  • clear_initial_sequence (bool) – If true, calls ClearKeys().

Returns:

The sequence which will be modified when calling SetActiveBoundObject and the Add*Key(s) functions.

Return type:

DaySequence

is_initialized() → bool

Returns true Initialize has been called with a valid actor.

Return type:

bool

set_active_bound_object(object) → None

Prepare the builder to begin adding keys animating properties on InObject.

Parameters:

object (Object)