Interaction

Press and hold interactions with aim, nearby targets, and server requests for Unreal Engine.

👀 Summary

NsInteraction lets an actor, usually the player, use other actors. A sensor gives the targets. The interaction component asks each target for its option, keeps the best one, and runs it on a press or at the end of a hold. A ready-made interactable actor covers the simple case with no code.

NsInteraction has no UI and no input binding. Your game shows the prompt and calls the component from its input. NsInteraction depends on no other plugin.

📦 Features

• One interface: Implement INsInteractable in C++ or Blueprint. Return an option, then run it.
• Interactable actor: Make a Blueprint child of ANsInteractableActor, set its option in the Details panel, and handle On Interact.
• Press or hold: Hold for one action, and tap for another.
• More than one action: Give each part of an actor its own option and action name.
• Disabled options: Show the prompt with the reason, and run nothing.
• Aim sensor: A trace from the camera of the owner, with an optional aim assist cone.
• Nearby sensor: Bind any collision overlap, or give the targets from game code.
• Server requests: A server option goes to the server through a built-in RPC. The server builds the option again, so the server state decides.
• Custom scoring: Override ScoreOption to change which option wins.

⚙️ Requirements

Unreal Engine 5.7+

🛠️ Installation

1. Clone or download this repository.
2. Copy the NsInteraction folder into the Plugins folder of your project.
3. For C++, add "NsInteraction" to the dependencies of your game module in Build.cs.
4. Generate the project files and enable the plugin.

🚀 Getting Started

1. Make a Blueprint class with the parent NsInteractableActor. Add a static mesh to it.
2. Implement the On Interact event, and place the actor in the level.
3. On the player pawn, add the Ns Interaction and Ns Interaction View Sensor components. The pawn needs a camera.
4. In the input of the pawn, call Begin Interact when the input starts and End Interact when it ends.
5. Bind On Option Changed to show the prompt.

In C++, implement the interface on any actor:

// MyLever.h
#include "GameFramework/Actor.h"
#include "NsInteractable.h"
#include "MyLever.generated.h"

UCLASS()
class AMyLever : public AActor, public INsInteractable
{
    GENERATED_BODY()

public:
    virtual bool GetInteractionOption_Implementation(AActor* Interactor, UPrimitiveComponent* Part, FNsInteractionOption& OutOption) override
    {
        OutOption.Prompt = NSLOCTEXT("MyGame", "PullLever", "Pull the lever");
        return true;
    }

    virtual bool ExecuteInteraction_Implementation(AActor* Interactor, const FNsInteractionOption& Option) override
    {
        bPulled = !bPulled;
        return true;
    }

    bool bPulled = false;
};

🎯 Sensors

🔧 API

• INsInteractable – The interface of a usable actor: GetInteractionOption, ExecuteInteraction, OnInteractorEnter, and OnInteractorExit.
• ANsInteractableActor – An actor with one option from the Details panel. It fires On Interact and OnInteracted.
• FNsInteractionOption – The target, the action name, the texts, bEnabled, press or hold, the authority, and the priority.
• UNsInteractionComponent::BeginInteract / EndInteract – Start and end the input.
• UNsInteractionComponent::OnOptionChanged – Fires when the shown prompt changes.
• UNsInteractionComponent::OnServerRequest / ExecuteOnServer – Fires for a server option on a client, and runs a request on the server.
• UNsInteractionComponent::ScoreOption – Override it to change which option wins.
• UNsInteractionViewSensor::IsPartInView – Check a client aim on the server.

🚧 Limits

• One option for each target at a time. For two actions on one part, change the option, or use two parts.
• The view sensor gives one target at most.
• The aim assist measures the bounds box of a part, not its exact shape.
• The built-in server request does not check the aim of the client.

📚 Documentation

Contact

E-mail LinkedIn GitHub Bluesky