unreal.MovieSceneParameterSection

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

Bases: unreal.MovieSceneSection

A single movie scene section which can contain data for multiple named parameters.

C++ Source:

• Module: MovieSceneTracks

• File: MovieSceneParameterSection.h

Editor Properties: (see get_editor_property/set_editor_property)

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

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

• 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.

• 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)

add_bool_parameter_key(parameter_name, time, value) → None

Adds a a key for a specific bool parameter at the specified time with the specified value.

Parameters

• parameter_name (Name) –

• time (FrameNumber) –

• value (bool) –

add_color_parameter_key(parameter_name, time, value) → None

Adds a a key for a specific color parameter at the specified time with the specified value.

Parameters

• parameter_name (Name) –

• time (FrameNumber) –

• value (LinearColor) –

add_scalar_parameter_key(parameter_name, time, value) → None

Adds a a key for a specific scalar parameter at the specified time with the specified value.

Parameters

• parameter_name (Name) –

• time (FrameNumber) –

• value (float) –

add_transform_parameter_key(parameter_name, time, value) → None

Adds a a key for a specific color parameter at the specified time with the specified value.

Parameters

• parameter_name (Name) –

• time (FrameNumber) –

• value (Transform) –

add_vector2d_parameter_key(parameter_name, time, value) → None

Adds a a key for a specific vector2D parameter at the specified time with the specified value.

Parameters

• parameter_name (Name) –

• time (FrameNumber) –

• value (Vector2D) –

add_vector_parameter_key(parameter_name, time, value) → None

Adds a a key for a specific vector parameter at the specified time with the specified value.

Parameters

• parameter_name (Name) –

• time (FrameNumber) –

• value (Vector) –

get_parameter_names()

Gets the set of all parameter names used by this section.

Returns

parameter_names (Set(Name)):

Return type

Set(Name)

remove_bool_parameter(parameter_name) → bool

Removes a bool parameter from this section.

Parameters

parameter_name (Name) – The name of the bool parameter to remove.

Returns

True if a parameter with that name was found and removed, otherwise false.

Return type

bool

remove_color_parameter(parameter_name) → bool

Removes a color parameter from this section.

Parameters

parameter_name (Name) – The name of the color parameter to remove.

Returns

True if a parameter with that name was found and removed, otherwise false.

Return type

bool

remove_scalar_parameter(parameter_name) → bool

Removes a scalar parameter from this section.

Parameters

parameter_name (Name) – The name of the scalar parameter to remove.

Returns

True if a parameter with that name was found and removed, otherwise false.

Return type

bool

remove_transform_parameter(parameter_name) → bool

Removes a transform parameter from this section.

Parameters

parameter_name (Name) – The name of the transform parameter to remove.

Returns

True if a parameter with that name was found and removed, otherwise false.

Return type

bool

remove_vector2d_parameter(parameter_name) → bool

Removes a vector2D parameter from this section.

Parameters

parameter_name (Name) – The name of the vector2D parameter to remove.

Returns

True if a parameter with that name was found and removed, otherwise false.

Return type

bool

remove_vector_parameter(parameter_name) → bool

Removes a vector parameter from this section.

Parameters

parameter_name (Name) – The name of the vector parameter to remove.

Returns

True if a parameter with that name was found and removed, otherwise false.

Return type

bool