Functions

Get Narrative Component

When you want to start any dialogue or quest, you need to get hold of the Narrative component.

This component is the driver that handles all dialogue or quests.

This function will attempt to load the component from the target passed into it (self by default), then the owning controller then the pawn.

note

Under the hood, this function simply calls Get Narrative Component From Target passing in GetPlayerController.

If you are working in a multi-player environment with multiple Narrative components, use Get Narrative Component From Target instead.

Output

Name	Type	Description
Return Value	UNarrativeComponent	The Narrative component found on the actor.

Get Narrative Component From Target

Another method of getting hold of the Narrative component.

This function allows you to specify which target you want to get the Narrative Component from.

note

This function is more useful for multiplayer games when you have multiple Narrative Components.

If you are working in a single player environment, GetNarrativeComponent is sufficient.

Inputs

Name	Type	Description
Target	AActor	The actor to try and find the Narrative component on.

Output

Name	Type	Description
Return Value	UNarrativeComponent	The Narrative component found on the actor.

Begin Dialogue

The most used function in the entire dialogue system.

This function tells Narrative to start the specified dialogue. It will return a bool if it can start or if it has failed for any reason (replication issues, no conditions passed)

Inputs

Name	Type	Description
Target	UTalesComponent	The Narrative component to try and start the dialogue on.
Dialogue	TSubclassOf<UDialogue>	The dialogue class that you want to play.
StartFromID	FName	The ID the dialogue should start playing from, if empty will play from root node.
Priority	int32	The priority we want to play this dialogue at. -1 means use the dialogues default priority.

Output

Name	Type	Description
Return Value	bool	Whether or not the dialogue has began.

Has Dialogue Available

Whilst creating dialogue it is common to have dialogue assets that are not used anymore due to conditions blocking all routes - and this is okay.

Sometimes you want to check if a dialogue can be started before calling BeginDialogue or to fulfil some condition.

The HasDialogueAvailable function executes the initialize method of the provided dialogue and does not start the dialogue.

This will return you a bool to whether calling BeginDialogue would successfully enter the dialogue.

Inputs

Name	Type	Description
Target	UTalesComponent	The Narrative component to try and start the dialogue on.
Dialogue	TSubclassOf<UDialogue>	The dialogue class that you want to play.
StartFromID	FName	The ID the dialogue should start playing from, if empty will play from root node.
Priority	int32	The priority we want to play this dialogue at. -1 means use the dialogues default priority.

Output

Name	Type	Description
Return Value	bool	Whether or not the dialogue can begin.