Navigation
API > API/Runtime > API/Runtime/MovieScene
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.
| Name | UMovieSceneCondition |
| Type | class |
| Header File | /Engine/Source/Runtime/MovieScene/Public/Conditions/MovieSceneCondition.h |
| Include Path | #include "Conditions/MovieSceneCondition.h" |
Syntax
UCLASS (Abstract, Blueprintable, DefaultToInstanced, EditInlineNew, Meta=(ShowWorldContextPin),
CollapseCategories, MinimalAPI)
class UMovieSceneCondition : public UMovieSceneSignedObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMovieSceneSignedObject → UMovieSceneCondition
Derived Classes
- UMovieSceneDirectorBlueprintCondition
- UMovieSceneGroupCondition
- UMovieScenePlatformCondition
- UMovieSceneScalabilityCondition
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bEditorForceTrue | bool | If true, will skip evaluating the condition and always return true. | Conditions/MovieSceneCondition.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanCacheResult
(
TSharedRef< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState |
Conditions/MovieSceneCondition.h | ||
virtual uint32 ComputeCacheKey
(
FGuid BindingGuid, |
Called by Sequencer to compute a cache key for this condition given the passed in context. | Conditions/MovieSceneCondition.h | |
bool EvaluateCondition
(
FGuid BindingGuid, |
Called by Sequencer code to evaluate this condition, passing relevant context. | Conditions/MovieSceneCondition.h | |
EMovieSceneConditionScope GetConditionScope() |
Conditions/MovieSceneCondition.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool BP_EvaluateCondition
(
const FMovieSceneConditionContext& ConditionContext |
Override to implement your condition. | Conditions/MovieSceneCondition.h |
|
EMovieSceneConditionCheckFrequency BP_GetCheckFrequency() |
Returns the check frequency of the condition, which determines whether the condition result can change during playback and needs to get re-evaluated. | Conditions/MovieSceneCondition.h |
|
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. | Conditions/MovieSceneCondition.h |
|
virtual bool EvaluateConditionInternal
(
FGuid BindingGuid, |
Override in native code to implement your condition. | Conditions/MovieSceneCondition.h | |
virtual EMovieSceneConditionCheckFrequency GetCheckFrequencyInternal() |
Returns the check frequency of the condition, which determines whether the condition result can change during playback and needs to get re-evaluated. | Conditions/MovieSceneCondition.h | |
virtual EMovieSceneConditionScope GetScopeInternal() |
Returns the scope of the condition, which determines whether the condition needs to be re-evaluated for different bindings or entities in the Sequence. | Conditions/MovieSceneCondition.h |