Performances

Performances are asynchronous actions executed from PerformanceNodeData nodes within a dialogue sequence. When the Dialogue Sequencer encounters a performance node, it instantiates the appropriate DialoguePerformance subclass, starts it, and waits for it to signal completion before advancing to the next node.

All performances are polymorphic by extending the class they automatically populate the performances list when adding performances to a node.

For usage guides and setup examples, see The Basics: GS_Cinematics.

Contents

• DialoguePerformance (Abstract Base)
• MoveTo_DialoguePerformance
• PathTo_DialoguePerformance
• RepositionPerformer_DialoguePerformance
• Complete Performance Type Reference
• Creating a Custom Performance
• See Also

DialoguePerformance (Abstract Base)

The base class for all dialogue performances. Extends AZ::TickBus::Handler so that performances can drive time-based behavior across multiple frames.

Virtual Methods

Lifecycle

1. The sequencer encounters a PerformanceNodeData and instantiates the corresponding DialoguePerformance subclass.
2. The sequencer calls DoPerformance().
3. DoPerformance() connects to TickBus and calls ExecutePerformance().
4. The performance runs across multiple ticks until its completion condition is met.
5. The performance calls FinishPerformance(), which disconnects from TickBus and notifies the sequencer.
6. The sequencer advances to the next node.

MoveTo_DialoguePerformance

Moves a performer entity to a named stage marker position over time using direct interpolation (no navmesh). Suitable for short-distance movements within a scene where pathfinding is unnecessary.

Request Bus: MoveTo_PerformanceRequestBus

Notification Bus: MoveTo_PerformanceNotificationBus

PathTo_DialoguePerformance

Navigates a performer entity to a named stage marker along a RecastNavigation navmesh path. Suitable for longer-distance movements where the performer must navigate around obstacles. Requires RecastNavigation to be enabled in the project.

Request Bus: PathTo_PerformanceRequestBus

Notification Bus: PathTo_PerformanceNotificationBus

RepositionPerformer_DialoguePerformance

Instantly teleports a performer entity to a named stage marker position. No interpolation, no pathfinding – the entity is moved in a single frame. Useful for off-screen repositioning between scenes or for snapping a performer to a mark before a sequence begins.

Notification Bus: RepositionPerformer_PerformanceNotificationBus

Complete Performance Type Reference

Creating a Custom Performance

To add a custom performance type from an external gem:

1. Define the class

#pragma once
#include <GS_Cinematics/Dialogue/Performances/DialoguePerformance.h>

namespace MyGem
{
    class PlayAnimation_DialoguePerformance : public GS_Cinematics::DialoguePerformance
    {
    public:
        AZ_RTTI(PlayAnimation_DialoguePerformance, "{YOUR-UUID-HERE}", GS_Cinematics::DialoguePerformance);
        AZ_CLASS_ALLOCATOR(PlayAnimation_DialoguePerformance, AZ::SystemAllocator);

        static void Reflect(AZ::ReflectContext* context);

    protected:
        void ExecutePerformance() override;
        void OnTick(float deltaTime, AZ::ScriptTimePoint time) override;

    private:
        AZStd::string m_animationName;
        bool m_animationComplete = false;
    };
}

2. Implement and register

void PlayAnimation_DialoguePerformance::ExecutePerformance()
{
    // Start the animation on the performer entity
    // Listen for animation completion
}

void PlayAnimation_DialoguePerformance::OnTick(float deltaTime, AZ::ScriptTimePoint time)
{
    if (m_animationComplete)
    {
        FinishPerformance();
    }
}

See Also

For conceptual overviews and usage guides:

• Dialogue System Overview – Manager APIs and extensible types
• GS_Cinematics Overview – Stage markers and cinematic mode

For component references:

• Dialogue Sequencer – How the sequencer drives performances
• Dialogue Actors – Performer markers that performances target

For related resources:

• Dialogue Data Structure – PerformanceNodeData and extension guide

Get GS_Cinematics

GS_Cinematics — Explore this gem on the product page and add it to your project.