Dialogue Manager

Full API reference for GS_DialogueManagerComponent — dialogue database management, performer marker registration, and the DialoguePerformerMarkerComponent.

GS_DialogueManagerComponent owns the active dialogue database and performer registry. It extends GS_Core::GS_ManagerComponent and participates in the standard Game Manager startup sequence.

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

Dialogue Manager component in the O3DE Inspector

 

Contents


GS_DialogueManagerComponent

Singleton GS_Play manager that owns the active .dialoguedb asset and the performer registry. Registered with the Game Manager startup sequence via GS_Core::GS_ManagerComponent.

PropertyValue
ExtendsGS_Core::GS_ManagerComponent
BusDialogueManagerRequestBus (Single address, single handler)
NotificationsDialogueManagerNotificationBus (inherited from ManagerBaseOutgoingEvents)

Request Bus: DialogueManagerRequestBus

Singleton bus — Single address, single handler.

MethodParametersReturnsDescription
StartDialogueSequenceByNameconst AZStd::string& sequenceNamevoidLooks up a sequence by name in the active database and starts playback through the sequencer.
ChangeDialogueDatabaseAZ::Data::Asset<DialogueDatabase> databasevoidSwaps the active .dialoguedb asset at runtime.
RegisterPerformerMarkerconst AZStd::string& name, AZ::EntityId entityvoidRegisters a DialoguePerformerMarkerComponent entity under the given performer name.
GetPerformerconst AZStd::string& nameAZ::EntityIdReturns the entity registered under the given performer name.

Notification Bus: DialogueManagerNotificationBus

Dialogue Manager notifications are inherited from ManagerBaseOutgoingEvents. See Manager for the full notification interface.


DialoguePerformerMarkerComponent

A world-space anchor component placed on NPC entities in the level. Performer markers register by name with the Dialogue Manager during activation. The dialogue system resolves actor names from the database to these world-space entities.

Request Bus: PerformerMarkerRequestBus

MethodParametersReturnsDescription
GetPerformerNameAZStd::stringReturns the registered name for this performer.
GetPosEntityAZ::EntityIdReturns the entity used as the position reference for this performer.
GetPosPointAZ::Vector3Returns the world-space position of the performer anchor.
ShouldTrackTargetboolReturns whether this performer should track a target entity.

Script Canvas Examples

Starting a dialogue sequence by name:


See Also

For usage guides:

For component references:

For related resources:


Get GS_Cinematics

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