RealDocs

50 results for "montage"

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.

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.

function
UAnimInstance::Montage_SetBlendingOutDelegate Engine

Binds a delegate that fires the moment a montage begins its blend-out phase — earlier than the end delegate, while the animation is still visible and weight is non-zero.

function
UAnimInstance::Montage_SetEndDelegate Engine

Binds a delegate that fires when a montage finishes playing and its instance is fully stopped.

function
UAnimInstance::Montage_SetNextSection Engine

Changes which section plays next after the specified section at runtime, overriding the static next-section link defined in the montage asset.

function
UAnimInstance::Montage_SetPlayRate Engine

Changes the playback speed of an active montage without restarting it.

function
UAnimInstance::Montage_SetPosition Engine

Jumps the montage playhead to a specific time position without restarting it.

function
UAnimInstance::Montage_SetSectionChangedDelegate Engine

Binds a delegate that fires each time the active montage transitions to a new section, enabling section-driven game logic such as combo windows or state changes keyed to montage sections.

function
UAnimInstance::Montage_Stop Engine

Stops a playing animation montage, blending it out over InBlendOutTime seconds.

function
UAnimInstance::Montage_StopGroupByName Engine

Stops all active montages belonging to the named slot group, blending each out over the specified duration.

function
UAnimInstance::Montage_StopWithBlendOut Engine

Stops a montage and blends it out using the provided FAlphaBlendArgs, overriding the blend-out values stored in the montage asset.

function
UAnimInstance::Montage_StopWithBlendSettings Engine

Stops a montage with fully customized blend-out settings via FMontageBlendSettings, supporting BlendProfiles for per-bone weighting during blend-out.

function
UAnimInstance::Blueprint_GetSlotMontageLocalWeight Engine

Returns the current local blend weight (0–1) of any montage playing in the named slot.

function
UAnimInstance::CalcSlotMontageLocalWeight Engine

Recalculates and returns the local montage blend weight for the named slot by iterating active montage instances directly.

function
UAnimInstance::ClearMontageInstanceReferences Engine

Removes all internal tracking references to a montage instance — slot weight maps, active instance lists, and slot node bookkeeping — in preparation for its destruction.

function
UAnimInstance::ConditionalFlushCompletedMontages Engine

Destroys any montage instances that have reached zero weight and are queued for removal.

function
UAnimInstance::DynamicMontage_IsPlayingFrom Engine

Returns true if there is currently an active dynamic montage that was created from the specified animation asset.

function
UAnimInstance::GetActiveInstanceForMontage Engine

Returns the active FAnimMontageInstance for a specific UAnimMontage asset, or nullptr if that montage is not currently playing.

function
UAnimInstance::GetActiveMontageInstance Engine

Returns the currently active (topmost weight-contributing) montage instance, or nullptr if no montage is playing.

function
UAnimInstance::GetCurrentActiveMontage Engine

Returns a pointer to the first active montage found on this anim instance.

function
ACharacter::GetCurrentMontage Engine

Returns the animation montage currently playing on the character's mesh, or nullptr if no montage is active.

function
UAnimInstance::GetInstanceForMontage Engine

Returns the FAnimMontageInstance for a given montage regardless of whether it is actively playing or in its blend-out phase.

function
UAnimInstance::GetLastMontageFlushFrame Engine

Returns the frame counter value from the last time completed montages were flushed.

function
UAnimInstance::GetMontageInstanceForID Engine

Returns the FAnimMontageInstance with the given unique ID, enabling reliable lookup of a specific instance even when the same montage asset is playing multiple times concurrently.

function
ACharacter::GetRootMotionAnimMontageInstance Engine

Returns the FAnimMontageInstance currently driving root motion on this character's animation instance, or nullptr if no root-motion montage is active.

function
UAnimInstance::GetRootMotionMontageInstance Engine

Returns a pointer to the currently active montage instance that is providing root motion, or nullptr if no montage is currently driving root motion.

function
UAnimInstance::GetSlotMontageGlobalWeight Engine

Returns the global blend weight (0–1) contributed by the montage playing in the named slot, factoring in the overall montage weight in the animation graph.

function
UAnimInstance::GetSlotMontageLocalWeight Engine

Returns the local blend weight (0–1) of any montage active in the named slot, without factoring in parent blend node weights.

function
UAnimInstance::IsAnyMontagePlaying Engine

Returns true if at least one montage is currently in the active list on this anim instance, including those that are blending out.