class

MontagePlayer

Module
Animation
Header
#include "Animation/Montage.h"
Namespace
Mowo

Properties

TypeNameDescription
std::function<void(const std::string& section)>onSectionEndFired when a section reaches its endTime (before any chain/blend-out).
std::function<void()>onEndedFired once when the montage fully blends out / stops.
std::function<void(const std::string& notifyName)>onBranchingPointFired mid-tick at a branching point's exact time. The handler may call JumpToSection/Stop and the rest of the frame's dt runs from there.

Public functions

ReturnsNameDescription
voidPlayStart a montage (optionally at a named section, else the first).
voidStopBegin blending out (blendOut < 0 → use the montage's blendOutTime).
voidJumpToSectionJump to a named section immediately (no blend).
voidSetTimeSet the playhead without touching phase, weight or notifies — the network snap needs a seek, and a re-Play restarts the blend-in.
voidTick
boolIsPlaying
PhaseGetPhase
floatGetWeight
floatGetTime0..1 blend vs base pose
int32_tGetClipIndexseconds into the clip
const Montage*GetMontage
const std::string&GetCurrentSection
const std::vector<std::string>&FiredNotifiesMontage-own notifies crossed by the LAST Tick, in time order.
floatGetCurveValueSample a montage-own curve at the current playhead.

Function details

Play

C++
void Play(const Montage* montage, const std::string& startSection = "")

Start a montage (optionally at a named section, else the first).

Stop

C++
void Stop(float blendOut = -1.0f)

Begin blending out (blendOut < 0 → use the montage's blendOutTime).

JumpToSection

C++
void JumpToSection(const std::string& name)

Jump to a named section immediately (no blend).

SetTime

C++
void SetTime(float seconds)

Set the playhead without touching phase, weight or notifies — the network snap needs a seek, and a re-Play restarts the blend-in.

Tick

C++
void Tick(float dt)

IsPlaying

C++
bool IsPlaying() const

GetPhase

C++
Phase GetPhase() const

GetWeight

C++
float GetWeight() const

GetTime

C++
float GetTime() const

0..1 blend vs base pose

GetClipIndex

C++
int32_t GetClipIndex() const

seconds into the clip

GetMontage

C++
const Montage* GetMontage() const

GetCurrentSection

C++
const std::string& GetCurrentSection() const

FiredNotifies

C++
const std::vector<std::string>& FiredNotifies() const

Montage-own notifies crossed by the LAST Tick, in time order. Branching points appear here too, after their handler has already run. Cleared at the top of every Tick, so a caller drains it once per frame.

GetCurveValue

C++
float GetCurveValue(const std::string& name, float fallback = 0.0f) const

Sample a montage-own curve at the current playhead.

Generated from Animation/Montage.h via animation.json · Oct 26, 2026Version 1.0.0