Interactable

The Interactable class lets you make any actor in your scene interactable by players. It displays a customizable prompt and supports multiple interaction options, each with its own text, input action, and callback or ability. You can attach it to existing actors or create new interactable static meshes, and adjust the interaction point as needed.

InteractionOption

{
    Text =  "string", -- The text to be displayed on the interaction option
    SubText = "string", -- The SubText to be displayed below the interaction option
    Input = "string", -- The path to the InputAction data asset
    Action? = function() end, -- The function to be used when no ability is specified
    Ability? = "string", -- The ability to be used when no callback Action is specified
}

Variables

Name	Type
Options	TArray<FInteractionOption>
InteractableProp	AStaticMeshActor

Constructors

local InteractableTransform = Transform()
InteractableTransform.Translation = Vector(0, 0, 0)
local InteractableActor = Interactable({
    {
        Text = 'Interact', -- Base text on interaction option
        SubText = 'Press F to interact', -- Subtext on interaction option
        Input = '/Game/Input/Actions/IA_Interact.IA_Interact', -- Input Action Mapping
        Action = function(CubeActor, Instigator) -- Callback function used for Lua interaction
            print('Interaction pressed on:', CubeActor, 'By:', Instigator)
        end,
    },
}, '/Engine/VREditor/BasicMeshes/SM_Cube_01.SM_Cube_01', InteractableTransform)
-- StaticMeshPath, Transform

local CubeActor = StaticMesh(Vector(0, 0, 0), Rotator(), '/Engine/VREditor/BasicMeshes/SM_Cube_01.SM_Cube_01')
local InteractableActor = Interactable({
    {
        Text = 'Interact', -- Base text on interaction option
        SubText = 'Press F to interact', -- Subtext on interaction option
        Input = '/Game/Input/Actions/IA_Interact.IA_Interact', -- Input Action Mapping
        Ability = '/Engine/Characters/Heroes/Abilities/GA_Hero_Heal.GA_Hero_Heal_C', -- Ability class
    }
})
InteractableActor:SetInteractableProp(CubeActor)
print(InteractableActor.Object) -- AActor

Type	Name	Default	Description
table<InteractionOption>	InteractionData		A table of interaction tables.
string?	StaticMeshPath		The path to a static mesh asset to be created as the interactable. (Optional)
Transform?	Transform		The transform to spawn the static mesh with. (Optional)

Functions

SetInteractableProp

Sets the Actor to be used for interactions if attaching to a pre-existing actor.

local CubeActor = StaticMesh(Vector(0, 0, 0), Rotator(), '/Engine/VREditor/BasicMeshes/SM_Cube_01.SM_Cube_01')
Interactable:SetInteractableProp(CubeActor)

---

MakeStaticMesh

The interactable creates its own static mesh instead of relying on another actor.

• Returns: UStaticMeshComponent

  Interactable:MakeStaticMesh(UE.UObject.Load('/Engine/VREditor/BasicMeshes/SM_Cube_01.SM_Cube_01'), false)
  

Info

This is the default behaviour for this class if the optional parameters are present.

---

AddInteractionOption

Adds an interaction option to the interactable.

local Option = UE.FInteractionOption()
Option.Text = 'Interact'
Option.InputAction = '/Game/Input/Actions/IA_Interact.IA_Interact'
Interactable:AddInteractionOption(Option)

---

SetInteractionPointRelativeLocation

Sets the relative location of the interaction point.

Interactable:SetInteractionPointRelativeLocation(Vector(0, 0, 0))

---

SetInteractivePointAbsoluteLocation

Sets the absolute location of the interaction point.

Interactable:SetInteractionPointAbsoluteLocation(Vector(0, 0, 0))