UConversationContextHelpers

Wrapper methods from [FConversationContext](API\Plugins\CommonConversationRuntime\FConversationContext).

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

CommonConversationRuntime

Header

/Engine/Plugins/Experimental/CommonConversation/Source/CommonConversationRuntime/Public/ConversationContext.h

Include

#include "ConversationContext.h"

Syntax

UCLASS()
class UConversationContextHelpers : public UBlueprintFunctionLibrary

Remarks

Wrapper methods from FConversationContext.

Functions

Name Description

Public function Static UFunction BlueprintCallable, BlueprintAuthorityOnly, Category

FConversatio...

 

AbortConversation

(
    const FConversationContext& Contex...
)

Constructs and returns a FConversationTaskResult configured with EConversationTaskResultType::AbortConversation.

Public function Static UFunction BlueprintCallable, BlueprintAuthorityOnly, Category

FConversatio...

 

AdvanceConversation

(
    const FConversationContext& Contex...
)

Constructs and returns a FConversationTaskResult configured with EConversationTaskResultType::AdvanceConversation.

Public function Static UFunction BlueprintCallable, BlueprintAuthorityOnly, Category, Meta

FConversatio...

 

AdvanceConversationWithChoice

(
    const FConversationContext& Contex...,
    const FAdvanceConversationRequest&...
)

Constructs and returns a FConversationTaskResult configured with EConversationTaskResultType::AdvanceConversationWithChoice.

Public function Static UFunction BlueprintCallable, BlueprintAuthorityOnly, Category

bool

 

CanConversationContinue

(
    const FConversationTaskResult& Con...
)

Checks the provided task result against any which would end the conversation e.g. EConversationTaskResultType::Invalid or EConversationTaskResultType::AbortConversation

Public function Static UFunction BlueprintPure, Category

UConversatio...

 

FindConversationComponent

(
    AActor* Actor
)

Wrapper to find and return any UConversationParticipantComponent belonging to the provided parameter actor.

Public function Static UFunction BlueprintPure, BlueprintAuthorityOnly, Category

UConversatio...

 

GetConversationInstance

(
    const FConversationContext& Contex...
)

SERVER ONLY.

Public function Static UFunction BlueprintPure, Category

UConversatio...

 

GetConversationParticipant

(
    const FConversationContext& Contex...,
    FGameplayTag ParticipantTag
)

SERVER or CLIENT.

Public function Static UFunction BlueprintPure, Category

AActor *

 

GetConversationParticipantActor

(
    const FConversationContext& Contex...,
    FGameplayTag ParticipantTag
)

Returns the conversation participant actor indicated by 'ParticipantTag', or nullptr if not found.

Public function Static UFunction BlueprintPure, BlueprintAuthorityOnly, Category

FConversatio...

 

GetCurrentConversationNodeHandle

(
    const FConversationContext& Contex...
)

Returns the FConversationNodeHandle of the conversation instance associated with this context, or a handle with an invalid FGuid if not possible.

Public function Static UFunction BlueprintCallable, BlueprintAuthorityOnly, Category

void

 

MakeConversationParticipant

(
    const FConversationContext& Contex...,
    AActor* ParticipantActor,
    FGameplayTag ParticipantTag
)

Registers an actor as part of the conversation, that actor doesn't need to have the UConversationParticipantComponent it won't be added though.

Public function Static UFunction BlueprintCallable, BlueprintAuthorityOnly, Category

FConversatio...

 

PauseConversationAndSendClientChoices

(
    const FConversationContext& Contex...,
    const FClientConversationMessage& ...
)

Constructs and returns a FConversationTaskResult configured with EConversationTaskResultType::PauseConversationAndSendClientChoices.

Public function Static UFunction BlueprintCallable, BlueprintAuthorityOnly, Category

FConversatio...

 

ReturnToConversationStart

(
    const FConversationContext& Contex...
)

Constructs and returns a FConversationTaskResult configured with EConversationTaskResultType::ReturnToConversationStart.

Public function Static UFunction BlueprintCallable, BlueprintAuthorityOnly, Category

FConversatio...

 

ReturnToCurrentClientChoice

(
    const FConversationContext& Contex...
)

Constructs and returns a FConversationTaskResult configured with EConversationTaskResultType::ReturnToCurrentClientChoice.

Public function Static UFunction BlueprintCallable, BlueprintAuthorityOnly, Category

FConversatio...

 

ReturnToLastClientChoice

(
    const FConversationContext& Contex...
)

Constructs and returns a FConversationTaskResult configured with EConversationTaskResultType::ReturnToLastClientChoice.