Arma Reforger Script API
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
BaseActionsManagerComponent Interface Reference
Inheritance diagram for BaseActionsManagerComponent:
[legend]

Public Member Functions

proto external UserActionContext GetContext (string contextName)
 Tries to find context with provided name in the actions manager.
 
proto external int GetActionsList (out notnull array< BaseUserAction > outActions)
 Fills the provided array with the list of all user actions that are registered in this ActionsManagerComponent.
 
proto external int GetActionsCount ()
 Returns the amount of actions of this (and all owned) managers.
 
proto external int GetContextList (out notnull array< UserActionContext > outContexts)
 Fills the provided array with the list of all contexts that are defined in this ActionsManagerComponent.
 
proto external int GetContextCount ()
 Returns the amount of contexts that exist in this ActionsManagerComponent.
 
proto external BaseUserAction GetFirstAction ()
 Return the first action from the list of all actions.
 
proto external BaseUserAction FindAction (int actionID)
 Return action by ID.
 
proto external bool IsEnabled ()
 Returns whether this manager is enabled and can provide actions.
 
proto bool AddUserActionEventListener (ScriptedUserAction action, UserActionEventListener listener)
 Add a script function of type 'UserActionEventListener' which will receive EUserActionEvent events.
 
proto void RemoveUserActionEventListener (ScriptedUserAction action, UserActionEventListener listener)
 Remove the listener added using AddUserActionEventListener(ScriptedUserAction, UserActionEventListener).
 
- Public Member Functions inherited from GameComponent
bool OnTicksOnRemoteProxy ()
 

Protected Member Functions

string NicifyGeneratedContextName (string name)
 

Member Function Documentation

◆ AddUserActionEventListener()

proto bool BaseActionsManagerComponent.AddUserActionEventListener ( ScriptedUserAction  action,
UserActionEventListener  listener 
)

Add a script function of type 'UserActionEventListener' which will receive EUserActionEvent events.

◆ FindAction()

proto external BaseUserAction BaseActionsManagerComponent.FindAction ( int  actionID)

Return action by ID.

◆ GetActionsCount()

proto external int BaseActionsManagerComponent.GetActionsCount ( )

Returns the amount of actions of this (and all owned) managers.

◆ GetActionsList()

proto external int BaseActionsManagerComponent.GetActionsList ( out notnull array< BaseUserAction outActions)

Fills the provided array with the list of all user actions that are registered in this ActionsManagerComponent.

Returns the number of output elements.

◆ GetContext()

proto external UserActionContext BaseActionsManagerComponent.GetContext ( string  contextName)

Tries to find context with provided name in the actions manager.

Returns UserActionContext with provided name or null if none exists

◆ GetContextCount()

proto external int BaseActionsManagerComponent.GetContextCount ( )

Returns the amount of contexts that exist in this ActionsManagerComponent.

◆ GetContextList()

proto external int BaseActionsManagerComponent.GetContextList ( out notnull array< UserActionContext outContexts)

Fills the provided array with the list of all contexts that are defined in this ActionsManagerComponent.

Returns the number of output elements.

◆ GetFirstAction()

proto external BaseUserAction BaseActionsManagerComponent.GetFirstAction ( )

Return the first action from the list of all actions.

◆ IsEnabled()

proto external bool BaseActionsManagerComponent.IsEnabled ( )

Returns whether this manager is enabled and can provide actions.

This is introduced because an entity can be inactive but still provide actions or the other way around. (e.g. a burning wreck can be active, but not provide actions.)

Returns
Returns true when active, false otherwise.

◆ NicifyGeneratedContextName()

string BaseActionsManagerComponent.NicifyGeneratedContextName ( string  name)
protected

Implemented in ActionsManagerComponent.

◆ RemoveUserActionEventListener()

proto void BaseActionsManagerComponent.RemoveUserActionEventListener ( ScriptedUserAction  action,
UserActionEventListener  listener 
)

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