Interaction

The Interaction System provides a data-driven framework for defining and executing interactions between game entities. An Interactor (e.g., a character) interacts with an Interactable (e.g., a door, NPC, workbench) by executing an Interaction — an async action resolved through an InteractionTable that filters by triggers and conditions.

Architecture

Data Flow

Key Concepts

Concept	Description
Interactable	MonoBehaviour placed on interactive GameObjects. Holds an InteractionTable and manages outline highlighting.
Interactor	Serializable object attached to entities that can initiate interactions (characters, NPCs).
Interaction	Abstract Action subclass defining the async logic of a specific interaction (e.g., sit, pick up, talk).
InteractionTable	Serializable list of InteractionContext entries attached to an Interactable.
InteractionContext	Glue object binding an Interaction to its triggers and conditions. Manages execution lifecycle.
InteractionTrigger	Abstract matcher that determines how an interaction is initiated (e.g., click, proximity, key press).
InteractionCondition	Abstract evaluator that determines whether an interaction is available in a given context.

Interaction Lifecycle

Quick Start

Creating a Custom Interaction

using System;
using System.Threading.Tasks;
using Paragon.Core.Async;
using Paragon.Townskeep.InteractionSystem;

[Serializable]
public class SitInteraction : Interaction
{
    [Variable]
    private Transform seatTransform;

    protected override async Task OnExecute()
    {
        // Move interactor to seat
        Interactor.gameObject.transform.position = seatTransform.position;

        // Wait until interaction is cancelled (e.g., player stands up)
        while (true)
        {
            await Yield.WaitForUpdate();
        }
    }

    protected override void OnCancel()
    {
        base.OnCancel();
        // Custom cleanup when standing up
    }
}

Triggering an Interaction by Type

if (interactor.TryInteractWith<SitInteraction>(interactable, out var sit))
{
    // Interaction started successfully
}

Triggering via InteractionTrigger

var trigger = new MyCustomTrigger();
if (interactor.TryInteractWith(interactable, trigger, out var interaction))
{
    // Matched and started
}

Subsystems

Folder	Description
Trigger	Abstract trigger matching for interaction initiation
Condition	Condition evaluation for interaction availability
Context	Glue binding interactions to triggers and conditions
Input	Reflection-based input binding for player-controlled interactions

Classes

Class	Description
Interactable	MonoBehaviour component for interactive GameObjects
Interaction	Abstract base class for interaction logic
InteractionTable	Serializable collection of interaction contexts
Interactor	Entity that initiates interactions
InteractionTrigger	Abstract trigger matching base class