InteractionHandlerComponent Class Reference

Inheritance diagram for InteractionHandlerComponent:

Protected Member Functions
event bool	CanContextChange (UserActionContext currentContext, UserActionContext newContext)
bool	DoIntersectCheck (IEntity controlledEntity)
bool	GetIsInteractionAvailableScript ()
bool	GetCanInteractScript (IEntity controlledEntity)
BaseUserAction	GetSelectedActionScript ()

Detailed Description

Collects interactions by performing a sphere cast initially and then a sphere query at the end. Iterates through hit entities and tries to find closest entity with ActionsManagerComponent that has a valid context.

Definition at line 10 of file InteractionHandlerComponent.c.

Member Function Documentation

CanContextChange()

event bool InteractionHandlerComponent::CanContextChange ( UserActionContext currentContext, UserActionContext newContext )

inlineprotected

Called before a context is set to determine whether a change can occur.

Definition at line 15 of file InteractionHandlerComponent.c.

DoIntersectCheck()

bool InteractionHandlerComponent::DoIntersectCheck ( IEntity controlledEntity )

inlineprotected

Should preferred context collection use intersect checks? This will make a ray check against the context's radius. This works well in tight places where relying on physical collisions is impossible - e.g. in vehicle interiors.

Definition at line 24 of file InteractionHandlerComponent.c.

GetCanInteractScript()

bool InteractionHandlerComponent::GetCanInteractScript ( IEntity controlledEntity )

inlineprotected

Are we allowed to start collecting and processing interactions? Implement custom logic and return true if yes, false otherwise.

Parameters

controlledEntity

The entity that wants to be able to interact (player controlled)

Definition at line 37 of file InteractionHandlerComponent.c.

GetIsInteractionAvailableScript()

bool InteractionHandlerComponent::GetIsInteractionAvailableScript ( )

inlineprotected

Are any user actions available to interact with? Implement and return true if yes, false otherwise.

Definition at line 30 of file InteractionHandlerComponent.c.

GetSelectedActionScript()

BaseUserAction InteractionHandlerComponent::GetSelectedActionScript ( )

inlineprotected

Currently sected action or null if none. Implement and return currently selected action.

Definition at line 43 of file InteractionHandlerComponent.c.

---

The documentation for this class was generated from the following file:

• scripts/GameCode/UserAction/InteractionHandlerComponent.c