unreal.ConversationContextHelpers

class unreal.ConversationContextHelpers(outer=None, name='None')

Bases: unreal.BlueprintFunctionLibrary

Wrapper methods from FConversationContext

C++ Source:

• Plugin: CommonConversation

• Module: CommonConversationRuntime

• File: ConversationContext.h

classmethod advance_conversation(context) → ConversationTaskResult

Advance Conversation

Parameters

context (ConversationContext) –

Returns

Return type

ConversationTaskResult

classmethod advance_conversation_with_choice(context, choice) → ConversationTaskResult

Advance Conversation with Choice

Parameters

• context (ConversationContext) –

• choice (AdvanceConversationRequest) –

Returns

Return type

ConversationTaskResult

classmethod find_conversation_component(actor) → ConversationParticipantComponent

Find Conversation Component

Parameters

actor (Actor) –

Returns

Return type

ConversationParticipantComponent

classmethod get_conversation_instance(context) → ConversationInstance

Get Conversation Instance

Parameters

context (ConversationContext) –

Returns

Return type

ConversationInstance

classmethod get_conversation_participant(context, participant_tag) → ConversationParticipantComponent

Get Conversation Participant

Parameters

• context (ConversationContext) –

• participant_tag (GameplayTag) –

Returns

Return type

ConversationParticipantComponent

classmethod get_conversation_participant_actor(context, participant_tag) → Actor

Get Conversation Participant Actor

Parameters

• context (ConversationContext) –

• participant_tag (GameplayTag) –

Returns

Return type

Actor

classmethod get_current_conversation_node_handle(context) → ConversationNodeHandle

Get Current Conversation Node Handle

Parameters

context (ConversationContext) –

Returns

Return type

ConversationNodeHandle

classmethod make_conversation_participant(context, participant_actor, participant_tag) → None

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

Parameters

• context (ConversationContext) –

• participant_actor (Actor) –

• participant_tag (GameplayTag) –

classmethod pause_conversation_and_send_client_choices(context, message) → ConversationTaskResult

Pause Conversation and Send Client Choices

Parameters

• context (ConversationContext) –

• message (ClientConversationMessage) –

Returns

Return type

ConversationTaskResult

classmethod return_to_conversation_start(context) → ConversationTaskResult

Return to Conversation Start

Parameters

context (ConversationContext) –

Returns

Return type

ConversationTaskResult

classmethod return_to_current_client_choice(context) → ConversationTaskResult

Return to Current Client Choice

Parameters

context (ConversationContext) –

Returns

Return type

ConversationTaskResult

classmethod return_to_last_client_choice(context) → ConversationTaskResult

Return to Last Client Choice

Parameters

context (ConversationContext) –

Returns

Return type

ConversationTaskResult