class
MontagePlayer
- Module
- Animation
- Header
#include "Animation/Montage.h"- Namespace
Mowo
Properties
| Type | Name | Description |
|---|---|---|
std::function<void(const std::string& section)> | onSectionEnd | Fired when a section reaches its endTime (before any chain/blend-out). |
std::function<void()> | onEnded | Fired once when the montage fully blends out / stops. |
std::function<void(const std::string& notifyName)> | onBranchingPoint | Fired 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
| Returns | Name | Description |
|---|---|---|
void | Play | Start a montage (optionally at a named section, else the first). |
void | Stop | Begin blending out (blendOut < 0 → use the montage's blendOutTime). |
void | JumpToSection | Jump to a named section immediately (no blend). |
void | SetTime | Set the playhead without touching phase, weight or notifies — the network snap needs a seek, and a re-Play restarts the blend-in. |
void | Tick | |
bool | IsPlaying | |
Phase | GetPhase | |
float | GetWeight | |
float | GetTime | 0..1 blend vs base pose |
int32_t | GetClipIndex | seconds into the clip |
const Montage* | GetMontage | |
const std::string& | GetCurrentSection | |
const std::vector<std::string>& | FiredNotifies | Montage-own notifies crossed by the LAST Tick, in time order. |
float | GetCurveValue | Sample 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() constGetPhase
C++
Phase GetPhase() constGetWeight
C++
float GetWeight() constGetTime
C++
float GetTime() const0..1 blend vs base pose
GetClipIndex
C++
int32_t GetClipIndex() constseconds into the clip
GetMontage
C++
const Montage* GetMontage() constGetCurrentSection
C++
const std::string& GetCurrentSection() constFiredNotifies
C++
const std::vector<std::string>& FiredNotifies() constMontage-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) constSample a montage-own curve at the current playhead.
Generated from Animation/Montage.h via animation.json · Oct 26, 2026Version 1.0.0