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 abort_conversation(context) ConversationTaskResult ¶
Constructs and returns a FConversationTaskResult configured with EConversationTaskResultType::AbortConversation
- Parameters
context (ConversationContext) –
- Return type
- classmethod advance_conversation(context) ConversationTaskResult ¶
Constructs and returns a FConversationTaskResult configured with EConversationTaskResultType::AdvanceConversation
- Parameters
context (ConversationContext) –
- Return type
- classmethod advance_conversation_with_choice(context, choice) ConversationTaskResult ¶
Constructs and returns a FConversationTaskResult configured with EConversationTaskResultType::AdvanceConversationWithChoice
- Parameters
context (ConversationContext) –
choice (AdvanceConversationRequest) –
- Return type
- classmethod can_conversation_continue(conversation_tas_result) bool ¶
Checks the provided task result against any which would end the conversation e.g. EConversationTaskResultType::Invalid or EConversationTaskResultType::AbortConversation
- Parameters
conversation_tas_result (ConversationTaskResult) –
- Return type
- classmethod find_conversation_component(actor) ConversationParticipantComponent ¶
Wrapper to find and return any UConversationParticipantComponent belonging to the provided parameter actor
- Parameters
actor (Actor) –
- Return type
- classmethod get_conversation_instance(context) ConversationInstance ¶
Returns the conversation instance object associated with the conversation context provided, or nullptr if not valid
- Parameters
context (ConversationContext) –
- Return type
- classmethod get_conversation_participant(context, participant_tag) ConversationParticipantComponent ¶
Returns the conversation participant component belonging to the participant indicated by ‘ParticipantTag’, or nullptr if not found
- Parameters
context (ConversationContext) –
participant_tag (GameplayTag) –
- Return type
- classmethod get_conversation_participant_actor(context, participant_tag) Actor ¶
Returns the conversation participant actor indicated by ‘ParticipantTag’, or nullptr if not found
- Parameters
context (ConversationContext) –
participant_tag (GameplayTag) –
- Return type
- classmethod get_current_conversation_node_handle(context) ConversationNodeHandle ¶
Returns the FConversationNodeHandle of the conversation instance associated with this context, or a handle with an invalid FGuid if not possible
- Parameters
context (ConversationContext) –
- Return type
- 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 ¶
Constructs and returns a FConversationTaskResult configured with EConversationTaskResultType::PauseConversationAndSendClientChoices
- Parameters
context (ConversationContext) –
message (ClientConversationMessage) –
- Return type
- classmethod return_to_conversation_start(context) ConversationTaskResult ¶
Constructs and returns a FConversationTaskResult configured with EConversationTaskResultType::ReturnToConversationStart
- Parameters
context (ConversationContext) –
- Return type
- classmethod return_to_current_client_choice(context) ConversationTaskResult ¶
Constructs and returns a FConversationTaskResult configured with EConversationTaskResultType::ReturnToCurrentClientChoice
- Parameters
context (ConversationContext) –
- Return type
- classmethod return_to_last_client_choice(context) ConversationTaskResult ¶
Constructs and returns a FConversationTaskResult configured with EConversationTaskResultType::ReturnToLastClientChoice
- Parameters
context (ConversationContext) –
- Return type