BaseInteractionHandlerComponent Interface Reference

Base class for interaction handler. More...

Inheritance diagram for BaseInteractionHandlerComponent:

Public Member Functions
proto external bool	IsInteractionAvailable ()
	Returns true if any interaction can be done at given moment, i.e. UI should be shown.
proto external BaseUserAction	GetSelectedAction ()
	Return currently selected user action or null if none.
proto external float	GetVisibilityRange ()
	Returns the global actions visibility range value defined by attribute in this component.
void	OnInit (IEntity owner)
	Called on initialization.
void	OnFrame (IEntity owner, float timeSlice)
	Called every frame, only for local player controller.
void	OnAfterPostSimulate (IEntity owner, float timeSlice)
	Called after post simulate, only for local player controller.
Public Member Functions inherited from GameComponent
bool	OnTicksOnRemoteProxy ()

Detailed Description

Base class for interaction handler.

This component must be attached to a PlayerController.

Member Function Documentation

GetSelectedAction()

proto external BaseUserAction BaseInteractionHandlerComponent.GetSelectedAction

(

)

Return currently selected user action or null if none.

GetVisibilityRange()

proto external float BaseInteractionHandlerComponent.GetVisibilityRange

(

)

Returns the global actions visibility range value defined by attribute in this component.

IsInteractionAvailable()

proto external bool BaseInteractionHandlerComponent.IsInteractionAvailable

(

)

Returns true if any interaction can be done at given moment, i.e. UI should be shown.

OnAfterPostSimulate()

void BaseInteractionHandlerComponent.OnAfterPostSimulate	(	IEntity	owner,
		float	timeSlice
	)

Called after post simulate, only for local player controller.

OnFrame()

void BaseInteractionHandlerComponent.OnFrame	(	IEntity	owner,
		float	timeSlice
	)

Called every frame, only for local player controller.

OnInit()

void BaseInteractionHandlerComponent.OnInit

(

IEntity

owner

)

Called on initialization.

Might not be called unless we already own this item.

Implemented in SCR_InteractionHandlerComponent.

---

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

• Game/generated/UserAction/BaseInteractionHandlerComponent.c