unreal.MovieSceneDataLayerSection

class unreal.MovieSceneDataLayerSection(outer=None, name='None')

Bases: unreal.MovieSceneSection

Movie Scene Data Layer Section

C++ Source:

  • Module: MovieSceneTracks

  • File: MovieSceneDataLayerSection.h

Editor Properties: (see get_editor_property/set_editor_property)

  • data_layers (Array(ActorDataLayer)): [Read-Write] Data Layers: A list of data layers that should be loaded or unloaded by this section

  • desired_state (DataLayerRuntimeState): [Read-Write] Desired State: The desired state for the data layers on this section when the section is actively evaluating.

  • easing (MovieSceneEasingSettings): [Read-Write] Easing

  • eval_options (MovieSceneSectionEvalOptions): [Read-Write] Eval Options

  • flush_on_unload (bool): [Read-Write] Flush on Unload: Determine if we need to flush level streaming when the data layers unloads.

  • is_active (bool): [Read-Write] Is Active: Toggle whether this section is active/inactive

  • is_locked (bool): [Read-Write] Is Locked: Toggle whether this section is locked/unlocked

  • post_roll_frames (FrameNumber): [Read-Write] Post Roll Frames: The amount of time to continue ‘postrolling’ this section for after evaluation has ended.

  • pre_roll_frames (FrameNumber): [Read-Write] Pre Roll Frames: The amount of time to prepare this section for evaluation before it actually starts.

  • preroll_state (DataLayerRuntimeState): [Read-Write] Preroll State: The desired state for the data layers on this section when the section is pre or post-rolling.

  • section_range (MovieSceneFrameRange): [Read-Write] Section Range: The range in which this section is active

  • timecode_source (MovieSceneTimecodeSource): [Read-Write] Timecode Source: The timecode at which this movie scene section is based (ie. when it was recorded)

get_data_layers()

Get Data Layers

Return type

Array(ActorDataLayer)

get_desired_state() DataLayerRuntimeState

Get Desired State

Return type

DataLayerRuntimeState

get_flush_on_unload() bool

Get Flush on Unload

Return type

bool

get_preroll_state() DataLayerRuntimeState

Get Preroll State

Return type

DataLayerRuntimeState

set_data_layers(data_layers) None

Set Data Layers

Parameters

data_layers (Array(ActorDataLayer)) –

set_desired_state(desired_state) None

Set Desired State

Parameters

desired_state (DataLayerRuntimeState) –

set_flush_on_unload(flush_on_unload) None

Set Flush on Unload

Parameters

flush_on_unload (bool) –

set_preroll_state(preroll_state) None

Set Preroll State

Parameters

preroll_state (DataLayerRuntimeState) –