Skip to main content

PlayerInteractionPoint

A modular, network-aware component that enables interaction zones within the game world. When a player enters the collider area, it can dynamically offer contextual interactions, including support for ownership validation and extensibility through external providers.

public class PlayerInteractionPoint : NetworkKCCProcessor, IPlayerInteractionProvider

🎮 Purpose​

This script defines an interaction hotspot that:

  • Activates when a PlayerActor with authority enters its collider.
  • Presents a list of available interactions.
  • Filters interactions based on ownership if needed.
  • Supports extending interaction logic via IPlayerInteractionProvider.

🔑 Key Members​

interactions​

Type: PlayerInteraction[]
Description: Core interaction list directly assigned to this point.

interactionCollider​

Type: Collider
Description: Collider that defines the interaction trigger area.

_sourceName​

Type: string
Description: Label for debug/UI reference.

externalInteractionProviders​

Type: MonoBehaviour[]
Description: Optional external providers that implement IPlayerInteractionProvider for dynamic logic injection.

ownershipProvider​

Type: OwnershipProvider
Description: Optional logic module to restrict interactions to owning players.

🧠 Key Behaviors​

OnEnter(KCC kcc, KCCData data)​

Registers available interactions with the entering PlayerActor.

OnExit(KCC kcc, KCCData data)​

Removes registered interactions when the actor exits the zone.

GetInteractions(PlayerActor actor)​

Builds and filters the list of interactions based on:

  • Static list
  • External providers
  • Ownership rules

Enable() / Disable()​

Manually toggle the interaction collider and isActive state.

Spawned() / Render()​

Initial setup and change detection for enabling/disabling the collider via NetworkBool.

🧩 Interfaces​

IPlayerInteractionProvider​

public interface IPlayerInteractionProvider {
    PlayerInteraction[] GetInteractions(PlayerActor actor);
}

Allows external scripts to contribute dynamic interactions.

IOwnershipProvider​

public interface IOwnershipProvider {
    bool CheckOwnership(PlayerActor actor);
}

Used to verify if a player can access ownerOnly interactions.

🔗 Structs & Types​

PlayerInteraction​

Represents a single interaction option.

public struct PlayerInteraction {
    public string Label;
    public UnityEvent<PlayerActor> Action;
    public InputProvider.InputButton Button;
    public PlayerInteractionPoint point;
    public bool ownerOnly;
    public bool dismissAfterUsage;
}

🧪 Editor Utilities​

  • OnValidate(): Automatically finds a collider if none is set.

✅ Usage Tips​

  • Attach this to a GameObject with a Collider (set as trigger).
  • Define interactions via the inspector or via external components.
  • Use OwnershipProvider to restrict specific options.

This component is ideal for NPCs, terminals, doors, or any other in-world interactive element.