RealDocs

50 results for "montage"

struct
FMontageSubStepper Engine

Internal helper struct, declared alongside UAnimMontage, that steps montage playback time forward or backward one section/branching-point/time-stretch-marker at a time per call to Advance().

class
UAnimMontage Engine

An animation asset that sequences animation segments into named sections, supports blend in/out, and can be played, stopped, and jumped between sections at runtime via UAnimInstance.

property
FMontageSubStepper::Montage Engine

Cached pointer to the UAnimMontage asset being sub-stepped, mirrored from the owning FAnimMontageInstance's Montage field.

property
FMontageSubStepper::MontageInstance Engine

The owning montage instance this sub-stepper is advancing time for, set by Initialize().

function
FMontageSubStepper::AddEvaluationTime Engine

Queues additional delta time onto the sub-stepper's TimeRemaining for Advance() to consume in subsequent sub-steps.

function
FMontageSubStepper::Advance Engine

Moves montage playback position forward or backward by up to one sub-step, stopping at section boundaries, branching points, or TimeStretchCurve markers, and reports what happened via EMontageSubStepResult.

property
FMontageSubStepper::Cached_CombinedPlayRate Engine

Cached combined play rate (montage rate scale times global rate scale) used to derive PlayRate and DeltaMove without recomputing it every sub-step.

property
FMontageSubStepper::Cached_P_Original Engine

Records the "original" authored-space position that Cached_P_Target was last derived from, used to detect when the target-space cache needs recomputing.

property
FMontageSubStepper::Cached_P_Target Engine

Cached montage position in time-stretched "target" space, lazily recomputed from Cached_P_Original whenever the source position changes.

function
FMontageSubStepper::ClearCachedData Engine

Invalidates the cached combined play rate so it is recomputed the next time ConditionallyUpdateCachedData runs.

property
FMontageSubStepper::CurrentSectionIndex Engine

Index into the montage's CompositeSections array for the section the sub-stepper is currently positioned in.

property
FMontageSubStepper::CurrentSectionLength Engine

Duration, in the montage's original timeline, of the section CurrentSectionIndex refers to.

property
FMontageSubStepper::CurrentSectionStartTime Engine

Start time, in the montage's original timeline, of the section CurrentSectionIndex refers to.

property
FMontageSubStepper::DeltaMove Engine

The signed distance the montage position moves during the current sub-step, exposed read-only via GetDeltaMove().

function
FMontageSubStepper::GetCurrentSectionIndex Engine

Returns the index into the montage's CompositeSections array for the section the sub-stepper currently occupies.

function
FMontageSubStepper::GetDeltaMove Engine

Returns the montage-position delta produced by the most recent Advance() call.

function
FMontageSubStepper::GetRemainingPlayTimeToSectionEnd Engine

Computes how much playback time remains between the given original-space position and the end of the current section, accounting for any TimeStretchCurve on the montage.

function
FMontageSubStepper::GetRemainingTime Engine

Returns the delta time still queued for the sub-stepper to consume across subsequent Advance() calls.

function
FMontageSubStepper::GetbPlayingForward Engine

Returns whether the sub-stepper is currently advancing the montage position forward rather than backward.

function
FMontageSubStepper::HasReachedEndOfSection Engine

Returns whether the most recent Advance() call landed exactly on the current section's boundary.

function
FMontageSubStepper::HasTimeRemaining Engine

Returns whether the sub-stepper still has unconsumed evaluation time to work through via further Advance() calls.

function
FMontageSubStepper::Initialize Engine

Binds the sub-stepper to a montage instance, caching its Montage pointer, resetting per-frame state, and re-evaluating the TimeStretchCurve if one is present.

property
FMontageSubStepper::PlayRate Engine

Effective play rate used for the current sub-step, derived from Cached_CombinedPlayRate and, if present, the TimeStretchCurve's local rate at the current position.

property
FMontageSubStepper::TimeRemaining Engine

How much evaluation time is still left to sub-step through this tick; drained by successive Advance() calls and refilled by AddEvaluationTime().

property
FMontageSubStepper::TimeStretchMarkerIndex Engine

Index into the montage's TimeStretchCurve marker list tracking which time-stretch segment the sub-stepper currently occupies.

property
FMontageSubStepper::bHasValidTimeStretchCurveData Engine

True when the montage has a usable TimeStretchCurve and its marker data was successfully built during Initialize(), enabling per-position play rate adjustment.

property
FMontageSubStepper::bPlayingForward Engine

True while the sub-stepper is moving montage time forward; false when the effective play rate is negative and it is stepping backward.

property
FMontageSubStepper::bReachedEndOfSection Engine

Set by Advance() when the sub-step landed exactly on the current section's boundary, signalling the caller should evaluate a section change, loop, or blend-out.

function
UAnimInstance::MontageSync_Follow Engine

Synchronizes a follower montage on this instance to track the position and play rate of a leader montage on another (or the same) anim instance.

function
UAnimInstance::MontageSync_StopFollowing Engine

Breaks the sync link established by MontageSync_Follow so that the follower montage resumes independent playback.

function
UAnimInstance::Montage_GetBlendTime Engine

Returns the current blend-in or blend-out time remaining for the montage in seconds.

function
UAnimInstance::Montage_GetBlendingOutDelegate Engine

Returns a pointer to the FOnMontageBlendingOutStarted delegate for the given montage instance, enabling inspection or late binding after the montage has started playing.

function
UAnimInstance::Montage_GetCurrentSection Engine

Returns the name of the section currently playing in the specified montage.

function
UAnimInstance::Montage_GetEffectivePlayRate Engine

Returns the actual playback speed of the montage as seen in-game, incorporating both the instance play rate and the montage asset's RateScale.

function
UAnimInstance::Montage_GetEndedDelegate Engine

Returns a pointer to the FOnMontageEnded delegate for the specified montage instance, allowing callers to inspect or directly bind to it after the fact.

function
UAnimInstance::Montage_GetIsStopped Engine

Returns true if the montage is not currently active — either it was never started, has fully ended, or is in a blend-out phase.

function
UAnimInstance::Montage_GetNextSectionID Engine

Returns the section index that will play after the specified section, respecting any per-instance section redirects set via Montage_SetNextSection.

function
UAnimInstance::Montage_GetPlayRate Engine

Returns the play rate set on the montage instance.

function
UAnimInstance::Montage_GetPosition Engine

Returns the current playback position of the montage in seconds from the start of the asset.

function
UAnimInstance::Montage_GetSectionChangedDelegate Engine

Returns a pointer to the FOnMontageSectionChanged delegate for the given montage instance, allowing inspection or late binding of a section-changed callback.

function
UAnimInstance::Montage_IsActive Engine

Returns true if the specified montage is currently active (playing or blending out).

function
UAnimInstance::Montage_IsPlaying Engine

Returns true if the specified montage is currently active and playing (not paused, not blending out).

function
UAnimInstance::Montage_JumpToSection Engine

Immediately moves the montage playback position to the start of the named section.

function
UAnimInstance::Montage_JumpToSectionsEnd Engine

Jumps the montage playback position to the end of the named section rather than its start.

function
UAnimInstance::Montage_Pause Engine

Pauses the specified montage at its current position.

function
UAnimInstance::Montage_Play Engine

Plays an animation montage on this anim instance.

function
UAnimInstance::Montage_PlayWithBlendIn Engine

Plays a UAnimMontage asset with a custom blend-in specified by FAlphaBlendArgs, overriding the blend-in time baked into the montage asset.

function
UAnimInstance::Montage_PlayWithBlendSettings Engine

Plays a UAnimMontage with fully customized blend-in settings via FMontageBlendSettings, which supports BlendProfiles for per-bone weighting in addition to the curve and timing options of FAlphaBlendArgs.

function
UAnimInstance::Montage_Resume Engine

Resumes a previously paused montage from the position at which it was paused.

function
UAnimInstance::Montage_SetBlendedInDelegate Engine

Binds a delegate that fires once a montage has finished blending in and reached full weight.