1. Epic GamesDeveloper
  3. UConversationParticipantComponent

UConversationParticipantComponent

Active conversation participants should have this component on them.

API > API/Plugins > API/Plugins/CommonConversationRuntime

Active conversation participants should have this component on them. It keeps track of what conversations they are participating in (typically no more than one)

   
Name UConversationParticipantComponent
Type class
Header File /Engine/Plugins/Experimental/CommonConversation/Source/CommonConversationRuntime/Public/ConversationParticipantComponent.h
Include Path #include "ConversationParticipantComponent.h"

Syntax

UCLASS (MinimalAPI, BlueprintType)  
class UConversationParticipantComponent : public UActorComponent

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UConversationParticipantComponent()

   ConversationParticipantComponent.h  

Classes

Name Remarks
FConversationStartedEvent  
FConversationStatusChangedEvent Client and server notification of the conversation starting or ending.
FConversationTaskChoiceDataUpdatedEvent  
FConversationUpdatedEvent  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ConversationStarted FConversationStartedEvent   ConversationParticipantComponent.h  
ConversationStatusChanged FConversationStatusChangedEvent   ConversationParticipantComponent.h  
ConversationTaskChoiceDataUpdated FConversationTaskChoiceDataUpdatedEvent   ConversationParticipantComponent.h  
ConversationUpdated FConversationUpdatedEvent   ConversationParticipantComponent.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
Auth_Conversations TArray< TObjectPtr< UConversationInstance > >   ConversationParticipantComponent.h  
Auth_CurrentConversation TObjectPtr< UConversationInstance >   ConversationParticipantComponent.h  
bIsFirstConversationUpdateBroadcasted bool   ConversationParticipantComponent.h  
ConversationsActive int32   ConversationParticipantComponent.h
  • Replicated
  • ReplicatedUsing=OnRep_ConversationsActive
LastMessage FClientConversationMessagePayload   ConversationParticipantComponent.h  
MessageIndex int32   ConversationParticipantComponent.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers
The number of conversations active. ConversationParticipantComponent.h  

FConversationNodeHandle GetCurrentNodeHandle()

   ConversationParticipantComponent.h  

bool GetIsFirstConversationUpdateBroadcasted()

   ConversationParticipantComponent.h  

const FClientConversationMessagePayload & GetLastMessage()

 A cached version of the last conversation message payload data recieved. ConversationParticipantComponent.h  

const int32 GetLastMessageIndex()

 Gets the last message index recieved, this is just a monotomically increasing number each time we get a new message. ConversationParticipantComponent.h  

void GetOtherParticipantActors ( TArray< AActor* >& OutParticipantActors
) const

   ConversationParticipantComponent.h
  • BlueprintCallable
  • Category=Conversation

const FConversationParticipantEntry * GetParticipant ( const FGameplayTag& ParticipantTag
) const

   ConversationParticipantComponent.h  

AActor * GetParticipantActor ( const FGameplayTag& ParticipantTag
) const

   ConversationParticipantComponent.h
  • BlueprintPure
  • Category=Conversation

virtual FText GetParticipantDisplayName()

   ConversationParticipantComponent.h
  • BlueprintCallable
  • Category=Conversation

bool IsInActiveConversation()

   ConversationParticipantComponent.h
  • BlueprintCallable
  • Category=Conversation

void RequestServerAdvanceConversation ( const FAdvanceConversationRequest& InChoicePicked
)

   ConversationParticipantComponent.h
  • BlueprintCallable
  • Category=Conversation

void SendClientConversationMessage ( const FConversationContext& Context,
const FClientConversationMessagePayload& Payload
)

   ConversationParticipantComponent.h  

void SendClientRefreshedTaskChoiceData ( const FConversationNodeHandle& Handle,
const FConversationContext& Context
)

   ConversationParticipantComponent.h  

virtual void SendClientUpdatedChoices ( const FConversationContext& Context,
const bool bForcedRefresh
)

   ConversationParticipantComponent.h  

Protected

Name Remarks Include Path Unreal Specifiers

void ClientExecuteTaskAndSideEffects ( FConversationNodeHandle Handle,
const UConversationDatabase* Graph
)

   ConversationParticipantComponent.h
  • Client
  • Reliable

void ClientExitConversation ( const FConversationParticipants& InParticipants
)

   ConversationParticipantComponent.h
  • Client
  • Reliable

void ClientStartConversation ( const FConversationParticipants& InParticipants
)

   ConversationParticipantComponent.h
  • Client
  • Reliable

void ClientUpdateConversation ( const FClientConversationMessagePayload& Message
)

   ConversationParticipantComponent.h
  • Client
  • Reliable

void ClientUpdateConversations ( int32 InConversationsActive
)

   ConversationParticipantComponent.h
  • Client
  • Reliable

void ClientUpdateConversationTaskChoiceData ( FConversationNodeHandle Handle,
const FClientConversationOptionEntry& OptionEntry
)

   ConversationParticipantComponent.h
  • Client
  • Reliable

void ClientUpdateParticipants ( const FConversationParticipants& InParticipants
)

   ConversationParticipantComponent.h
  • Client
  • Reliable

virtual void OnClientExitConversation ( const FConversationParticipants& InParticipants
)

   ConversationParticipantComponent.h  

virtual void OnClientStartConversation ( const FConversationParticipants& InParticipants
)

   ConversationParticipantComponent.h  

virtual void OnConversationUpdated ( const FClientConversationMessagePayload& Message
)

   ConversationParticipantComponent.h  

virtual void OnEnterConversationState()

   ConversationParticipantComponent.h  

virtual void OnLeaveConversationState()

   ConversationParticipantComponent.h  

void OnRep_ConversationsActive ( int32 OldConversationsActive
)

   ConversationParticipantComponent.h  

void ServerAdvanceConversation ( const FAdvanceConversationRequest& InChoicePicked
)

   ConversationParticipantComponent.h
  • Server
  • Reliable

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page