Namespace LobsterFramework.Interaction

Classes

CollectableItem

GeneralInteractor

HealthPotion

InteractabilityCheckerAttribute

Registers a method as interactability checker for the interactor with respect to the specified interactable object. The method must have the correct signature:

  1. Accepts a IInteractable as the only argument
  2. Have a return type of bool
  3. Method must be private If mutiple checkers are registered for the same interactable object, only the last one will be considered.

InteractionHandlerAttribute

Registers a method as interaction handler for the interactor. The method must have the correct signature:

  1. Accepts a interactable object as the only argument
  2. Does not have a return type
  3. Method must be private If mutiple handlers are registered for the same interactable object, only the last one will be considered.

Interactor

Allows interaction with InteractableObjects. Inherit from this class to implement custom interaction behaviors. Use InteractionHandler and InteractabilityChecker attributes to mark methods responsible for implementations. Details see InteractionHandlerAttribute and InteractabilityCheckerAttribute.

Use RegisterInteractorAttribute to register marked methods as interaction handlers and interactability checkers for this interactor. Unregistered interactor will not be able to perform interactions even if handlers and checkers are defined.

Each interactor can only have 1 implementation of interation handling and interactability checker with 1 type of InteractableObject. Interactors without any interaction handlers are allowed but will not be able do interactions.

Inventory

Inventory used for storing items. Items with the same name are treated as the same type regardless of their other properties such as description, icon and itemLimit, and therefore are put into the same item slot.

InventoryItem

InventoryUI

Item

ItemEntryUI

RegisterInteractorAttribute

Enables interaction handlers and interactability checkers for this interactor.

SimpleItem

Structs

InteractionPrompt

Represents the avaibility of an object for interaction

Interfaces

IConsumable

IEquipable

IInteractable

A marker interface for interactable objects

Enums

InteractionType

The types of interactions that are possible

ItemType