UserActionContext Interface Reference

Object that can be placed in ActionsManagerComponent to define a contextual collection of BaseUserActions. More...

Inheritance diagram for UserActionContext:

Public Member Functions
proto external owned string	GetContextName ()
	Returns the identifier of this context or string.Empty if none.
proto external owned string	GetName ()
	Returns the name of this context or string.Empty if none, as defined in UI Info.
proto external int	GetActionsList (out notnull array< BaseUserAction > outActions)
	Fills the provided outActions array with user actions that belong to this context.
proto external int	GetActionsCount ()
	Returns the amount of actions registered in this action context.
proto external bool	GetTransformationModel (out vector outMat[4])
	Fills the provided vector array with the transformation matrix of this context in model (local) space.
proto external bool	GetTransformationWorld (out vector outMat[4])
	Fills the provided vector array with the transformation matrix of this context in world (global) space.
proto external bool	IsOmnidirectional ()
	Returns whether this context is accessible from all directions or not.
proto external float	GetRadius ()
proto external float	GetHeight ()
proto external bool	IsCapsule ()
proto external vector	GetOrigin ()
	Returns the context position in world space.
proto external bool	ShouldCheckLineOfSight ()
	Returns true if visibility depends on line-of-sight, false otherwise.
proto external bool	ShouldDisplayAtReferencePoint ()
	Returns true if the actions ui display will be placed at the interaction reference point.
proto external float	GetVisibilityRange (float globalRange)
	Returns the highest visibility range from registered actions, if its higher than the 'globalRange' parameter, else return 'globalRange'.
proto external bool	IsInVisibilityAngle (vector position)
	Returns true if this context is in visibility angle for the provided position.
proto external UIInfo	GetUIInfo ()
	Returns the UIInfo set for this context or null if none.

Detailed Description

Object that can be placed in ActionsManagerComponent to define a contextual collection of BaseUserActions.

Member Function Documentation

GetActionsCount()

proto external int UserActionContext.GetActionsCount

(

)

Returns the amount of actions registered in this action context.

GetActionsList()

proto external int UserActionContext.GetActionsList

(

out notnull array< BaseUserAction >

outActions

)

Fills the provided outActions array with user actions that belong to this context.

Returns the number of output elements.

GetContextName()

proto external owned string UserActionContext.GetContextName

(

)

Returns the identifier of this context or string.Empty if none.

GetHeight()

proto external float UserActionContext.GetHeight

(

)

Returns

Returns the height of this context capsule in meters.

GetName()

proto external owned string UserActionContext.GetName

(

)

Returns the name of this context or string.Empty if none, as defined in UI Info.

GetOrigin()

proto external vector UserActionContext.GetOrigin

(

)

Returns the context position in world space.

GetRadius()

proto external float UserActionContext.GetRadius

(

)

Returns

Returns the radius of this context in meters.

GetTransformationModel()

proto external bool UserActionContext.GetTransformationModel

(

out vector

outMat[4]

)

Fills the provided vector array with the transformation matrix of this context in model (local) space.

Returns true if PointInfo is valid and matrix is output, false otherwise

GetTransformationWorld()

proto external bool UserActionContext.GetTransformationWorld

(

out vector

outMat[4]

)

Fills the provided vector array with the transformation matrix of this context in world (global) space.

Returns true if PointInfo is valid and matrix is output, false otherwise.

GetUIInfo()

proto external UIInfo UserActionContext.GetUIInfo

(

)

Returns the UIInfo set for this context or null if none.

GetVisibilityRange()

proto external float UserActionContext.GetVisibilityRange

(

float

globalRange

)

Returns the highest visibility range from registered actions, if its higher than the 'globalRange' parameter, else return 'globalRange'.

IsCapsule()

proto external bool UserActionContext.IsCapsule

(

)

Returns

Returns true if the context's shape is a capsule, false if it spherical.

IsInVisibilityAngle()

proto external bool UserActionContext.IsInVisibilityAngle

(

vector

position

)

Returns true if this context is in visibility angle for the provided position.

Does not perform any distance checks!

Parameters

position

Position in world space to check against.

IsOmnidirectional()

proto external bool UserActionContext.IsOmnidirectional

(

)

Returns whether this context is accessible from all directions or not.

ShouldCheckLineOfSight()

proto external bool UserActionContext.ShouldCheckLineOfSight

(

)

Returns true if visibility depends on line-of-sight, false otherwise.

ShouldDisplayAtReferencePoint()

proto external bool UserActionContext.ShouldDisplayAtReferencePoint

(

)

Returns true if the actions ui display will be placed at the interaction reference point.

---

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

• Game/generated/UserAction/UserActionContext.c