Navigation
API > API/Plugins > API/Plugins/CommonConversationRuntime
An active conversation between one or more participants
| Name | UConversationInstance |
| Type | class |
| Header File | /Engine/Plugins/Experimental/CommonConversation/Source/CommonConversationRuntime/Public/ConversationInstance.h |
| Include Path | #include "ConversationInstance.h" |
Syntax
UCLASS (MinimalAPI)
class UConversationInstance : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UConversationInstance
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UConversationInstance() |
ConversationInstance.h |
Classes
| Name | Remarks |
|---|---|
| FOnAllParticipantsNotifiedOfStartEvent | Server notification sent after all participants have been individually notified of conversation start. |
Structs
| Name | Remarks |
|---|---|
| FCheckpoint |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnAllParticipantsNotifiedOfStart | FOnAllParticipantsNotifiedOfStartEvent | ConversationInstance.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActiveConversationGraph | TObjectPtr< const UConversationDatabase > | ConversationInstance.h | ||
| bConversationStarted | bool | ConversationInstance.h | ||
| ClientBranchPoints | TArray< FCheckpoint > | ConversationInstance.h | ||
| ConversationRNG | FRandomStream | ConversationInstance.h | ||
| CurrentBranchPoint | FConversationBranchPoint | ConversationInstance.h | ||
| CurrentBranchPoints | TArray< FConversationBranchPoint > | ConversationInstance.h | ||
| Participants | FConversationParticipants | ConversationInstance.h | ||
| ScopeStack | TArray< FConversationChoiceReference > | ConversationInstance.h | ||
| StartingBranchPoint | FConversationBranchPoint | ConversationInstance.h | ||
| StartingEntryGameplayTag | FGameplayTag | ConversationInstance.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const UConversationDatabase * GetActiveConversationGraph() |
ConversationInstance.h | ||
const FConversationChoiceReference & GetCurrentChoiceReference() |
ConversationInstance.h | ||
const FConversationNodeHandle & GetCurrentNodeHandle() |
ConversationInstance.h | ||
const TArray< FClientConversationOptionEntry > & GetCurrentUserConversationChoices() |
ConversationInstance.h | ||
const FConversationParticipantEntry * GetParticipant
(
FGameplayTag ParticipantID |
ConversationInstance.h | ||
UConversationParticipantComponent * GetParticipantComponent
(
FGameplayTag ParticipantID |
ConversationInstance.h | ||
const TArray< FConversationParticipantEntry > & GetParticipantList() |
ConversationInstance.h | ||
TArray< FConversationParticipantEntry > GetParticipantListCopy() |
ConversationInstance.h | ||
FConversationParticipants GetParticipantsCopy() |
ConversationInstance.h | ||
virtual UWorld * GetWorld() |
ConversationInstance.h | ||
const bool HasConversationStarted() |
ConversationInstance.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const FGameplayTagContainer & GetCurrentChoiceTags() |
ConversationInstance.h | ||
virtual void OnEnded() |
ConversationInstance.h | ||
virtual void OnStarted() |
ConversationInstance.h |