Navigation
API > API/Runtime > API/Runtime/MovieScene > API/Runtime/MovieScene/Conditions
Inheritance Hierarchy
- UObject
- UMovieSceneSignedObject
- UMovieSceneCondition
- UMovieSceneGroupCondition
References
| Module | MovieScene |
| Header | /Engine/Source/Runtime/MovieScene/Public/Conditions/MovieSceneCondition.h |
| Include | #include "Conditions/MovieSceneCondition.h" |
Syntax
UCLASS (Abstract, Blueprintable, DefaultToInstanced, EditInlineNew, Meta=(ShowWorldContextPin),
CollapseCategories)
class UMovieSceneCondition : public UMovieSceneSignedObject
Remarks
Abstract condition class. Conditions can be applied to sections, tracks, and track rows to determine whether or not they are evaluated at runtime. This allows developers to create Sequences with dynamic behavior based on gameplay state, local player state, player hardware, etc.
Variables
| Type | Name | Description | |
|---|---|---|---|
    |
bool | bEditorForceTrue | If true, will skip evaluating the condition and always return true. |
    |
bool | bInvert | If true, inverts the result of the condition check. |
Functions
| Type | Name | Description | |
|---|---|---|---|
     |
bool | BP_EvaluateCondition
(
const FMovieSceneConditionContext& ConditionContext |
Override to implement your condition. |
     |
EMovieSceneConditionCheckFrequency | Returns the check frequency of the condition, which determines whether the condition result can change during playback and needs to get re-evaluated. | |
     |
EMovieSceneConditionScope | BP_GetScope () |
Returns the scope of the condition, which determines whether the condition needs to be re-evaluated for different bindings or entities in the Sequence. |
   |
bool | CanCacheResult
(
TSharedRef< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState |
|
   |
uint32 | ComputeCacheKey
(
FGuid BindingGuid, |
Called by Sequencer to compute a cache key for this condition given the passed in context. |
  |
bool | EvaluateCondition
(
FGuid BindingGuid, |
Called by Sequencer code to evaluate this condition, passing relevant context. |
   |
bool | EvaluateConditionInternal
(
FGuid BindingGuid, |
Override in native code to implement your condition. |
   |
EMovieSceneConditionCheckFrequency | Returns the check frequency of the condition, which determines whether the condition result can change during playback and needs to get re-evaluated. | |
  |
EMovieSceneConditionScope | ||
   |
EMovieSceneConditionScope | Returns the scope of the condition, which determines whether the condition needs to be re-evaluated for different bindings or entities in the Sequence. |