Interactable Target

NAMESPACEMyDreamGameStudio.InteractAnything

MENU PATHInteraction System > Core > Interactable

COMPATIBILITYUnity 6.0+

DOC VERSIONv1.0.0 (Latest)Previous Versions...

The Interactable is the central, object-side brain of the interaction system. It defines how an object behaves when a player targets it, manages timing and state changes, and dispatches UnityEvents to mechanical utilities or your custom logic.

Because it handles no raycasting or input polling itself, it maintains zero Update() overhead until actively engaged by an Interactor.

---

Dynamic Behavior Configurations

The specific settings and output events of an Interactable change entirely based on the chosen Interaction Type. Select a type below to view its specific Inspector UI, parameters, and events.

Instant

Fires immediately upon a single button press. Best for simple light switches, item pickups, and basic triggers.

Type-Specific Implementation

The Instant type utilizes standard lifecycle events natively and requires no unique mechanical setup.

Hold

Requires the player to continuously hold the input for a set duration before completing. Excellent for heavy valves or actions that require commitment, like lockpicking.

Hold Configuration Settings

Hold Duration (s)

floatDef: 1.5

Time required to complete the interaction.

Can Cancel Early

boolDef: True

If false, releasing the button early is ignored and the hold keeps progressing automatically.

Reset On Release

boolDef: True

If true, progress resets to zero if the hold is stopped early.

Hold Events

On Hold Progress (Single)

UnityEvent<float>

Fires every frame while holding. Passes a normalized float (0.0 to 1.0). Perfect for driving circular UI fill bars.

On Hold Cancel ()

UnityEvent

Fires if the player releases the button before the duration is met.

On Hold Complete ()

UnityEvent

Fires when the hold duration is successfully met.

Toggle

Maintains an internal On/Off boolean state. Each press swaps the state and fires the corresponding event. Excellent for flashlights, engine toggles, and power breakers.

Toggle Configuration Settings

Start In 'On' State

boolDef: False

Determines the initial boolean state on Awake. The component automatically fires the corresponding Toggle event on Start() to visually sync listeners (like lights or materials).

Toggle Events

On Toggle On ()

UnityEvent

Fires whenever the internal boolean flips to True.

On Toggle Off ()

UnityEvent

Fires whenever the internal boolean flips to False.

Hold + Toggle

Combines both mechanics. Requires the player to hold the input continuously for a set duration. Upon successful completion, the internal On/Off boolean state flips and the corresponding events fire. Ideal for powering up heavy machinery.

Hold Configuration Settings

Hold Duration (s)

floatDef: 1.5

Time required to complete the interaction.

Can Cancel Early

boolDef: True

If false, releasing the button early is ignored and the hold keeps progressing automatically.

Reset On Release

boolDef: True

If true, progress resets to zero if the hold is stopped early.

Toggle Configuration Settings

Start In 'On' State

boolDef: False

Determines the initial boolean state on Awake. The component automatically fires the corresponding Toggle event on Start() to visually sync listeners (like lights or materials).

Hold Events

On Hold Progress (Single)

UnityEvent<float>

Fires every frame while holding. Passes a normalized float (0.0 to 1.0). Perfect for driving circular UI fill bars.

On Hold Cancel ()

UnityEvent

Fires if the player releases the button before the duration is met.

On Hold Complete ()

UnityEvent

Fires when the hold duration is successfully met.

Toggle Events

On Toggle On ()

UnityEvent

Fires whenever the internal boolean flips to True.

On Toggle Off ()

UnityEvent

Fires whenever the internal boolean flips to False.

Push / Pull

Translates raw mouse/thumbstick movement along a single axis into a clamped float value. Perfect for sliding drawers, throttle levers, and joysticks.

Push / Pull Configuration Settings

Input Movement Axis

EnumDef: Mouse Y

Determines which axis (Mouse X or Mouse Y) drives the value change.

Invert Input Axis

boolDef: False

Inverts the direction the value shifts relative to the raw mouse movement.

Axis Sensitivity

floatDef: 0.05

Multiplier for how quickly the mouse delta scales the value up or down.

Min / Max Value

floatDef: 0 to 1

The hard clamp limits of the output float.

Spring Return To Min

boolDef: False

If enabled, releasing the input automatically interpolates the value back to the Min Value (e.g., a dead-man's switch or throttle).

Spring Return Speed

floatDef: 2.0

The speed multiplier applied when interpolating back to the Min Value.

Push / Pull Events

On Value Changed (Single)

UnityEvent<float>

Fires continuously as the value updates. Wire this directly to the SetAngle01 method of a HingeRotator or similar mechanical utilities.

Drag

Yields raw 2D input deltas and 3D world-space targets directly from the Interactor's raycast. Essential for physics-driven swinging doors, picking up physics rigidbodies, or steering wheels.

Drag Configuration Settings

Invert Mouse Delta

boolDef: True

Inverts the raw input delta before it reaches OnDragDelta. Defaults to true because raw mouse delta reads backwards for typical rotate/slide setups.

Drag Events

On Drag Moved (Vector3)

UnityEvent<Vector3>

Absolute world-space point the Interactor's raycast is currently pointing at.

On Drag Delta (Vector2)

UnityEvent<Vector2>

Raw per-frame input delta (mouse movement). Highly recommended for driving rotation/sliding mechanics because it cannot jump if the raycast hits an unrelated surface.

---

Global Properties

These variables and events are shared across all interaction types and dictate the foundational behavior of the object in the world.

Core State & Cooldowns

Interaction Enabled

boolDef: True

Master kill-switch. Uncheck to temporarily disable interactions via script or event without destroying the component.

Cooldown (Seconds)

floatDef: 0.5

Minimum time between completed interactions. Critical for preventing animation clipping or logic spam if a player rapidly clicks a switch.

Spatial Anchors & Points

Interaction Point

TransformDef: Self

The physical origin point for distance and line-of-sight checks. Useful if your collider is massive, but you only want the player to interact from a specific control panel.

UI Prompt Anchor

TransformDef: Self

Where 3D world-space prompts or examine panels should spawn relative to this object.

Contextual Prompts

The string text fed to the UI. The system automatically reads the correct prompt based on the object's current state.

Default Prompt

stringDef: interact

The standard fallback text used for Instant, Push/Pull, and Drag types.

Prompt When 'Off' / 'On'

string

Overrides the default prompt strictly based on the internal boolean state of a Toggle or Hold+Toggle interactable.

Prompt While Holding

string

Shown while actively holding, before completion (Hold/Hold+Toggle only). Leave empty to keep showing the normal prompt while holding.

Lifecycle Events

On Focus Enter ()

UnityEvent

Fires the moment the player's crosshair/raycast targets this object. Use this to trigger outline shaders or crosshair changes.

On Focus Exit ()

UnityEvent

Fires when the player looks away. Use this to disable outlines.

On Interaction Start ()

UnityEvent

Fires on the exact frame the input button is initially depressed.

On Interaction Complete ()

UnityEvent

Fires when the mechanic resolves successfully (e.g., the instant click registers or the hold duration completes).

On Interaction Cancel ()

UnityEvent

Fires if the interaction is forcefully interrupted by logic.

---

Scripting API

You can easily interface with the core Interactable state via C# to drive game logic or override behaviors programmatically.

using MyDreamGameStudio.InteractAnything;
using UnityEngine;

public class CustomTriggerLogic : MonoBehaviour
{
    private Interactable interactable;

    private void Awake()
    {
        interactable = GetComponent<Interactable>();
        
        // Listen for standard completion
        interactable.OnInteractionComplete.AddListener(HandleInteraction);
    }

    private void HandleInteraction()
    {
        Debug.Log("Object was interacted with!");
    }

    // Example of disabling the object programmatically
    public void LockObject()
    {
        interactable.SetEnabled(false);
    }
}