unreal.MovieSceneScriptingFloatKey

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

Bases: unreal.MovieSceneScriptingKey

Exposes a Sequencer float type key to Python/Blueprints. Stores a reference to the data so changes to this class are forwarded onto the underlying data structures.

C++ Source:

  • Plugin: SequencerScripting
  • Module: SequencerScripting
  • File: MovieSceneScriptingFloat.h
get_arrive_tangent() → float

If Interpolation Mode is RCIM_Cubic, the arriving tangent at this key

Returns:Arrival Tangent value. Represents the geometric tangents in the form of “tan(y/x)” where y is the key’s value and x is the seconds (both relative to key)
Return type:float
get_arrive_tangent_weight() → float

If Tangent Weight Mode is RCTWM_WeightedArrive or RCTWM_WeightedBoth, the weight of the arriving tangent on the left side.

Returns:Tangent Weight. Represents the length of the hypotenuse in the form of “sqrt(x*x+y*y)” using the same definitions for x and y as tangents.
Return type:float
get_interpolation_mode() → RichCurveInterpMode

Gets the interpolation mode for this key from the owning channel.

Returns:Interpolation mode this key uses to interpolate between this key and the next.
Return type:RichCurveInterpMode
get_leave_tangent() → float

If Interpolation Mode is RCIM_Cubic, the leaving tangent at this key

Returns:Leaving Tangent value. Represents the geometric tangents in the form of “tan(y/x)” where y is the key’s value and x is the seconds (both relative to key)
Return type:float
get_leave_tangent_weight() → float

If Tangent Weight Mode is RCTWM_WeightedLeave or RCTWM_WeightedBoth, the weight of the leaving tangent on the right side.

Returns:Tangent Weight. Represents the length of the hypotenuse in the form of “sqrt(x*x+y*y)” using the same definitions for x and y as tangents.
Return type:float
get_tangent_mode() → RichCurveTangentMode

Gets the tangent mode for this key from the owning channel.

Returns:Tangent mode that this key is using specifying which tangent values are respected when evaluating.
Return type:RichCurveTangentMode
get_tangent_weight_mode() → RichCurveTangentWeightMode

If Interpolation Mode is RCIM_Cubic, the tangent weight mode at this key

Returns:Tangent Weight Mode. See ERichCurveTangentWeightMode for more detail on what each mode does.
Return type:RichCurveTangentWeightMode
get_time(time_unit=SequenceTimeUnit.DISPLAY_RATE) → FrameTime

Gets the time for this key from the owning channel.

Parameters:time_unit (SequenceTimeUnit) – Should the time be returned in Display Rate frames (possibly with a sub-frame value) or in Tick Resolution with no sub-frame values?
Returns:The time of this key which combines both the frame number and the sub-frame it is on. Sub-frame will be zero if you request Tick Resolution.
Return type:FrameTime
get_value() → float

Gets the value for this key from the owning channel.

Returns:The float value this key represents.
Return type:float
set_arrive_tangent(new_value) → None

If Interpolation Mode is RCIM_Cubic, the arriving tangent at this key.

Parameters:new_value (float) – Represents the geometric tangents in the form of “tan(y/x)” where y is the key’s value and x is the seconds (both relative to key)
set_arrive_tangent_weight(new_value) → None

If Tangent Weight Mode is RCTWM_WeightedArrive or RCTWM_WeightedBoth, the weight of the arriving tangent on the left side.

Parameters:new_value (float) – Specifies the new arriving tangent weight. Represents the length of the hypotenuse in the form of “sqrt(x*x+y*y)” using the same definitions for x and y as tangents.
set_interpolation_mode(new_value) → None

Sets the interpolation mode for this key, reflecting it in the owning channel.

Parameters:new_value (RichCurveInterpMode) – Interpolation mode this key should use to interpolate between this key and the next.
set_leave_tangent(new_value) → None

If Interpolation Mode is RCIM_Cubic, the leaving tangent at this key.

Parameters:new_value (float) – Represents the geometric tangents in the form of “tan(y/x)” where y is the key’s value and x is the seconds (both relative to key)
set_leave_tangent_weight(new_value) → None

If Tangent Weight Mode is RCTWM_WeightedLeave or RCTWM_WeightedBoth, the weight of the leaving tangent on the right side.

Parameters:new_value (float) – Specifies the new leaving tangent weight. Represents the length of the hypotenuse in the form of “sqrt(x*x+y*y)” using the same definitions for x and y as tangents.
set_tangent_mode(new_value) → None

Sets the tangent mode for this key, reflecting it in the owning channel.

Parameters:new_value (RichCurveTangentMode) – Tangent mode that this key should use to specify which tangent values are respected when evaluating. See ERichCurveTangentMode for more details.
set_tangent_weight_mode(new_value) → None

If Interpolation Mode is RCIM_Cubic, the tangent weight mode at this key.

Parameters:new_value (RichCurveTangentWeightMode) – Specifies which tangent weights should be respected when evaluating the key.
set_time(new_frame_number, sub_frame=0.000000, time_unit=SequenceTimeUnit.DISPLAY_RATE) → None

Sets the time for this key in the owning channel. Will replace any key that already exists at that frame number in this channel.

Parameters:
  • new_frame_number (FrameNumber) – What frame should this key be moved to? This should be in the time unit specified by TimeUnit.
  • sub_frame (float) – If using Display Rate time, what is the sub-frame this should go to? Clamped [0-1), and ignored with when TimeUnit is set to Tick Resolution.
  • time_unit (SequenceTimeUnit) – Should the NewFrameNumber be interpreted as Display Rate frames or in Tick Resolution?
set_value(new_value) → None

Sets the value for this key, reflecting it in the owning channel.

Parameters:new_value (float) – The new float value for this key.