unreal.InteractableInterfaceLibrary

class unreal.InteractableInterfaceLibrary(outer: Object | None = None, name: Name | str = 'None')

Bases: BlueprintFunctionLibrary

BP function helpers to utilize the Interactable Interface.

C++ Source:

  • Plugin: InteractionInterface

  • Module: InteractableInterface

  • File: InteractableInterfaceLibrary.h

classmethod append_target_configuration(target, context, out_results) → InteractionQueryResults

Determines what the configuration of this target is. Gather information about this specific target so that it can be displayed to the player and provide access to what behavior should occur in response to this interaction.

Parameters:
Returns:

out_results (InteractionQueryResults): Output results that this target will populate

Return type:

InteractionQueryResults

classmethod begin_interaction_on_target(target, context) → None

Called when this target is interacted with. Implement any state changes or gameplay affects you want this interaction to have here

Parameters:
classmethod get_interactable_targets_from_actor(actor) → Array[InteractionTarget]

Populates the given OutInteractionTargets array with all IInteractionTarget interface objects on the given actor.

Parameters:

actor (Actor) – The actor to check for targets on

Returns:

out_interaction_targets (Array[InteractionTarget]): Array of pointers to any interaction targets on the given actor

Return type:

Array[InteractionTarget]

classmethod reset_query_results(to_reset) → InteractionQueryResults

Resets the values of the given interaction query results to be empty.

Parameters:

to_reset (InteractionQueryResults)

Returns:

to_reset (InteractionQueryResults):

Return type:

InteractionQueryResults