unreal.MovieSceneAsyncAction_SequencePrediction

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

Bases: unreal.BlueprintAsyncActionBase

Async BP action that represents a pending prediction that is dispatched on a playing sequence.

C++ Source:

  • Module: MovieSceneTracks

  • File: MovieScenePredictionSystem.h

Editor Properties: (see get_editor_property/set_editor_property)

  • failure (MovieSceneActorPredictionFailure): [Read-Write] Failure: Called when a message is broadcast on the specified channel. Use GetPayload() to request the message payload.

  • result (MovieSceneActorPredictionResult): [Read-Write] Result: Called when a message is broadcast on the specified channel. Use GetPayload() to request the message payload.

property failure

[Read-Write] Failure: Called when a message is broadcast on the specified channel. Use GetPayload() to request the message payload.

Type

(MovieSceneActorPredictionFailure)

classmethod predict_local_transform_at_frame(player, target_component, frame_time) MovieSceneAsyncAction_SequencePrediction

Initiate an asynchronous prediction for the specified component’s local transform at a specific time in a sequence Changes in attachment between the sequence’s current time, and the predicted time are not accounted for Calling this function on a stopped sequence player is undefined.

Parameters
  • player (MovieSceneSequencePlayer) – An active, currently playing sequence player to use for predicting the transform

  • target_component (SceneComponent) – The component to predict a world transform for

  • frame_time (FrameTime) – The frame time to predict at in the sequence’s display rate

Returns

An asynchronous prediction object that contains Result and Failure delegates

Return type

MovieSceneAsyncAction_SequencePrediction

classmethod predict_local_transform_at_time(player, target_component, time_in_seconds) MovieSceneAsyncAction_SequencePrediction

Initiate an asynchronous prediction for the specified component’s local transform at a specific time in a sequence Changes in attachment between the sequence’s current time, and the predicted time are not accounted for Calling this function on a stopped sequence player is undefined.

Parameters
  • player (MovieSceneSequencePlayer) – An active, currently playing sequence player to use for predicting the transform

  • target_component (SceneComponent) – The component to predict a world transform for

  • time_in_seconds (float) – The time within the sequence to predict the transform at

Returns

An asynchronous prediction object that contains Result and Failure delegates

Return type

MovieSceneAsyncAction_SequencePrediction

classmethod predict_world_transform_at_frame(player, target_component, frame_time) MovieSceneAsyncAction_SequencePrediction

Initiate an asynchronous prediction for the specified component’s world transform at a specific time in a sequence Changes in attachment between the sequence’s current time, and the predicted time are not accounted for Calling this function on a stopped sequence player is undefined.

Parameters
  • player (MovieSceneSequencePlayer) – An active, currently playing sequence player to use for predicting the transform

  • target_component (SceneComponent) – The component to predict a world transform for

  • frame_time (FrameTime) – The frame time to predict at in the sequence’s display rate

Returns

An asynchronous prediction object that contains Result and Failure delegates

Return type

MovieSceneAsyncAction_SequencePrediction

classmethod predict_world_transform_at_time(player, target_component, time_in_seconds) MovieSceneAsyncAction_SequencePrediction

Initiate an asynchronous prediction for the specified component’s world transform at a specific time in a sequence Changes in attachment between the sequence’s current time, and the predicted time are not accounted for Calling this function on a stopped sequence player is undefined.

Parameters
  • player (MovieSceneSequencePlayer) – An active, currently playing sequence player to use for predicting the transform

  • target_component (SceneComponent) – The component to predict a world transform for

  • time_in_seconds (float) – The time within the sequence to predict the transform at

Returns

An asynchronous prediction object that contains Result and Failure delegates

Return type

MovieSceneAsyncAction_SequencePrediction

property result

[Read-Write] Result: Called when a message is broadcast on the specified channel. Use GetPayload() to request the message payload.

Type

(MovieSceneActorPredictionResult)