Inheritance diagram for ActionInput:

Collaboration diagram for ActionInput:

Protected Member Functions
void	SetInput (string input_name)

int	GetInputType ()

UAInput	GetUAInput ()

bool	JustActivate ()

bool	IsActive ()

bool	WasEnded ()

void	Update ()

void	Reset ()

void	UpdatePossibleActions (PlayerBase player, ActionTarget target, ItemBase item, int action_condition_mask)

ActionBase	GetAction ()

ActionTarget	GetUsedActionTarget ()

ItemBase	GetUsedMainItem ()

array< ActionBase >	GetPossibleActions ()

ActionBase	GetPossibleAction ()

int	GetPossibleActionIndex ()

bool	HasTarget ()

void	OnActionStart ()

void	OnActionEnd ()

void	ActionsSelectReset ()

void	ForceAction (ActionBase action, ActionTarget target, ItemBase item)

void	ForceActionTarget (ActionTarget target)

void	ClearForcedAction ()

void	ClearForcedTarget ()

bool	ForceActionCheck (PlayerBase player)

void	SelectNextAction ()

void	SelectPrevAction ()

int	GetPossibleActionsCount ()

bool	HasInput ()

int	GetPriority ()

Private Member Functions
void	ActionInput ()

void	Init (PlayerBase player, ActionManagerClient am)

void	SetEnablity (bool value)

Detailed Description

Definition at line 19 of file ActionInput.c.

Constructor & Destructor Documentation

◆ ActionInput()

void ActionInput::ActionInput ( )

inlineprivate

Definition at line 43 of file ActionInput.c.

  {
    m_Active = false;
    m_Enabled = true;
    m_ForcedTarget = null;
    m_ForcedActionData = null;
 
    m_HasTarget = false;
 
    m_JustActivate = false;
    m_DetectFromTarget = false;
    m_DetectFromItem = true;
    m_DetectFromPlayer = true;
 
    m_Priority = 100;
  }

References m_Active, m_DetectFromItem, m_DetectFromPlayer, m_DetectFromTarget, m_Enabled, m_ForcedActionData, m_ForcedTarget, m_HasTarget, m_JustActivate, and m_Priority.

Member Function Documentation

◆ ActionsSelectReset()

void ActionInput::ActionsSelectReset ( )

inlineprotected

Definition at line 221 of file ActionInput.c.

222 {}

Referenced by OnActionStart(), and Reset().

◆ ClearForcedAction()

void ActionInput::ClearForcedAction ( )

inlineprotected

Definition at line 237 of file ActionInput.c.

  {
    m_ForcedActionData = null;
  }

References m_ForcedActionData.

◆ ClearForcedTarget()

void ActionInput::ClearForcedTarget ( )

inlineprotected

Definition at line 242 of file ActionInput.c.

  {
    m_ForcedTarget = NULL;
  }

References m_ForcedTarget.

◆ ForceAction()

void ActionInput::ForceAction	(	ActionBase	action,
		ActionTarget	target,
		ItemBase	item )

inlineprotected

Definition at line 224 of file ActionInput.c.

  {
    m_ForcedActionData = new ForcedActionData;
    m_ForcedActionData.m_Action = action;
    m_ForcedActionData.m_Target = target;
    m_ForcedActionData.m_Item = item;
  }

References m_ForcedActionData.

◆ ForceActionCheck()

bool ActionInput::ForceActionCheck ( PlayerBase player )

inlineprotected

Definition at line 247 of file ActionInput.c.

  {
    if (m_ForcedActionData)
    {
      if (m_ForcedActionData.m_Action.Can(player, m_ForcedActionData.m_Target, m_ForcedActionData.m_Item))
      {
        m_MainItem = m_ForcedActionData.m_Item;
        m_Target = m_ForcedActionData.m_Target;
        return true;
      }
    }
    return false;
  }

References m_ForcedActionData, m_MainItem, and m_Target.

Referenced by NoIndicationActionInputBase::GetAction().

◆ ForceActionTarget()

void ActionInput::ForceActionTarget ( ActionTarget target )

inlineprotected

Definition at line 232 of file ActionInput.c.

  {
    m_ForcedTarget = target;
  }

References m_ForcedTarget.

◆ GetAction()

ActionBase ActionInput::GetAction ( )

inlineprotected

Definition at line 176 of file ActionInput.c.

  {
    return NULL;
  }

◆ GetInputType()

int ActionInput::GetInputType ( )

inlineprotected

Definition at line 87 of file ActionInput.c.

  {
    return m_InputType;
  }

References m_InputType.

◆ GetPossibleAction()

ActionBase ActionInput::GetPossibleAction ( )

inlineprotected

Definition at line 196 of file ActionInput.c.

  {
    return NULL;
  }

◆ GetPossibleActionIndex()

int ActionInput::GetPossibleActionIndex ( )

inlineprotected

Definition at line 201 of file ActionInput.c.

  {
    return -1;
  }

◆ GetPossibleActions()

array< ActionBase > ActionInput::GetPossibleActions ( )

inlineprotected

Definition at line 191 of file ActionInput.c.

  {
    return NULL;
  }

◆ GetPossibleActionsCount()

int ActionInput::GetPossibleActionsCount ( )

inlineprotected

Definition at line 268 of file ActionInput.c.

  {
    return -1;
  }

◆ GetPriority()

int ActionInput::GetPriority ( )

inlineprotected

Definition at line 278 of file ActionInput.c.

  {
    return m_Priority;
  }

References m_Priority.

◆ GetUAInput()

UAInput ActionInput::GetUAInput ( )

inlineprotected

Definition at line 92 of file ActionInput.c.

  {
    return m_input.InputP();
  }

References UAIDWrapper::InputP(), and m_input.

◆ GetUsedActionTarget()

ActionTarget ActionInput::GetUsedActionTarget ( )

inlineprotected

Definition at line 181 of file ActionInput.c.

  {
    return m_Target;
  }

References m_Target.

◆ GetUsedMainItem()

ItemBase ActionInput::GetUsedMainItem ( )

inlineprotected

Definition at line 186 of file ActionInput.c.

  {
    return m_MainItem;
  }

References m_MainItem.

◆ HasInput()

bool ActionInput::HasInput ( )

inlineprotected

Definition at line 273 of file ActionInput.c.

  {
    return m_input != NULL;
  }

References m_input.

◆ HasTarget()

bool ActionInput::HasTarget ( )

inlineprotected

Definition at line 206 of file ActionInput.c.

  {
    return false;
  }

◆ Init()

void ActionInput::Init	(	PlayerBase	player,
		ActionManagerClient	am )

inlineprivate

Definition at line 60 of file ActionInput.c.

  {
    m_Player = player;
 
    if (LogManager.IsActionLogEnable())
      Debug.ActionLog("n/a", this.ToString(), "n/a", "Init()", player.ToString());
 
  }

References Debug::ActionLog(), LogManager::IsActionLogEnable(), m_Player, and ToString().

◆ IsActive()

bool ActionInput::IsActive ( )

inlineprotected

Definition at line 102 of file ActionInput.c.

  {
    return m_Active;
  }

References m_Active.

◆ JustActivate()

bool ActionInput::JustActivate ( )

inlineprotected

Definition at line 97 of file ActionInput.c.

  {
    return m_JustActivate;
  }

References m_JustActivate.

◆ OnActionEnd()

void ActionInput::OnActionEnd ( )

inlineprotected

Definition at line 216 of file ActionInput.c.

  {
    Reset();
  }

References Reset().

◆ OnActionStart()

void ActionInput::OnActionStart ( )

inlineprotected

Definition at line 211 of file ActionInput.c.

  {
    ActionsSelectReset();
  }

References ActionsSelectReset().

◆ Reset()

void ActionInput::Reset ( )

inlineprotected

Definition at line 166 of file ActionInput.c.

  {
    m_Active = false;
    ActionsSelectReset();
  }

References ActionsSelectReset(), and m_Active.

Referenced by OnActionEnd().

◆ SelectNextAction()

void ActionInput::SelectNextAction ( )

inlineprotected

Definition at line 261 of file ActionInput.c.

262 {

263 }

◆ SelectPrevAction()

void ActionInput::SelectPrevAction ( )

inlineprotected

Definition at line 265 of file ActionInput.c.

266 {}

◆ SetEnablity()

void ActionInput::SetEnablity ( bool value )

inlineprivate

Definition at line 69 of file ActionInput.c.

  {
    m_Enabled = value;
  }

References m_Enabled.

◆ SetInput()

void ActionInput::SetInput ( string input_name )

inlineprotected

Definition at line 74 of file ActionInput.c.

  {
    m_input = GetUApi().GetInputByName(input_name).GetPersistentWrapper();
 
    if (LogManager.IsActionLogEnable())
    {
      if (m_input && m_input.InputP())
        Debug.ActionLog("(+) input set to " + input_name, this.ToString(), "n/a", "SetInput()", "n/a");
      else
        Debug.ActionLog("(-) input is not set to " + input_name, this.ToString(), "n/a", "SetInput()", "n/a");
    }
  }

References Debug::ActionLog(), GetUApi(), UAIDWrapper::InputP(), LogManager::IsActionLogEnable(), m_input, and ToString().

Referenced by ContinuousWeaponManipulationActionInput::ContinuousWeaponManipulationActionInput(), DropActionInput::DropActionInput(), and WeaponManipulationActionInput::WeaponManipulationActionInput().

◆ Update()

void ActionInput::Update ( )

inlineprotected

Definition at line 112 of file ActionInput.c.

  {
    if (!m_Enabled)
    {
      m_Active = false;
      m_JustActivate = false;
      return;
    }
 
    switch (m_InputType)
    {
    case ActionInputType.AIT_CONTINUOUS:
      m_JustActivate = false;
      if (m_Active)
        m_Active = m_input.InputP().LocalHold();
      else
      {
        m_Active = m_input.InputP().LocalHoldBegin();
        m_JustActivate = m_Active;
      }
      break;
    case ActionInputType.AIT_SINGLE:
      m_Active = m_input.InputP().LocalClick();
      m_JustActivate = m_Active;
      break;
    case ActionInputType.AIT_DOUBLECLICK:
      m_Active = m_input.InputP().LocalDoubleClick();
      m_JustActivate = m_Active;
      break;
      break;
    case ActionInputType.AIT_HOLDSINGLE:
      m_Active = m_input.InputP().LocalHoldBegin();
      m_JustActivate = m_Active;
      break;
      break;
    case ActionInputType.AIT_CLICKCONTINUOUS:
      m_JustActivate = false;
      if (m_Active)
      {
        if (m_input.InputP().LocalClick())
          m_Active = false;
      }
      else
      {
        m_Active = m_input.InputP().LocalClick();
        m_JustActivate = m_Active;
      }
      break;
      break;
    default:
      break;
    }
  }

References UAIDWrapper::InputP(), m_Active, m_Enabled, m_input, m_InputType, and m_JustActivate.

◆ UpdatePossibleActions()

void ActionInput::UpdatePossibleActions	(	PlayerBase	player,
		ActionTarget	target,
		ItemBase	item,
		int	action_condition_mask )

inlineprotected

Definition at line 172 of file ActionInput.c.

173 {

174 }

◆ WasEnded()

bool ActionInput::WasEnded ( )

inlineprotected

Definition at line 107 of file ActionInput.c.

  {
    return !m_Active;
  }

References m_Active.

Member Data Documentation

◆ m_Active

bool ActionInput::m_Active

private

Definition at line 41 of file ActionInput.c.

Referenced by ActionInput(), IsActive(), Reset(), Update(), and WasEnded().

◆ m_ConditionMask

int ActionInput::m_ConditionMask

private

Definition at line 39 of file ActionInput.c.

Referenced by NoIndicationActionInputBase::GetAction(), and NoIndicationActionInputBase::UpdatePossibleActions().

◆ m_DetectFromItem

bool ActionInput::m_DetectFromItem

private

Definition at line 24 of file ActionInput.c.

Referenced by ActionInput().

◆ m_DetectFromPlayer

bool ActionInput::m_DetectFromPlayer

private

Definition at line 26 of file ActionInput.c.

Referenced by ActionInput().

◆ m_DetectFromTarget

bool ActionInput::m_DetectFromTarget

private

Definition at line 25 of file ActionInput.c.

Referenced by ActionInput(), and NoIndicationActionInputBase::NoIndicationActionInputBase().

◆ m_Enabled

bool ActionInput::m_Enabled

private

Definition at line 27 of file ActionInput.c.

Referenced by ActionInput(), SetEnablity(), and Update().

◆ m_ForcedActionData

ref ForcedActionData ActionInput::m_ForcedActionData

private

Definition at line 35 of file ActionInput.c.

Referenced by ActionInput(), ClearForcedAction(), ForceAction(), ForceActionCheck(), and NoIndicationActionInputBase::GetAction().

◆ m_ForcedTarget

ref ActionTarget ActionInput::m_ForcedTarget

private

Definition at line 33 of file ActionInput.c.

Referenced by ActionInput(), ClearForcedTarget(), and ForceActionTarget().

◆ m_HasTarget

bool ActionInput::m_HasTarget

private

Definition at line 29 of file ActionInput.c.

Referenced by ActionInput().

◆ m_input

UAIDWrapper ActionInput::m_input

private

Definition at line 21 of file ActionInput.c.

Referenced by GetUAInput(), HasInput(), SetInput(), and Update().

◆ m_InputType

int ActionInput::m_InputType

private

Definition at line 22 of file ActionInput.c.

Referenced by ContinuousWeaponManipulationActionInput::ContinuousWeaponManipulationActionInput(), DropActionInput::DropActionInput(), ExternalControlledActionInput::ExternalControlledActionInput(), GetInputType(), InventoryOnlyActionInput::InventoryOnlyActionInput(), Update(), and WeaponManipulationActionInput::WeaponManipulationActionInput().

◆ m_JustActivate

bool ActionInput::m_JustActivate

private

Definition at line 28 of file ActionInput.c.

Referenced by ActionInput(), JustActivate(), and Update().

◆ m_MainItem

ItemBase ActionInput::m_MainItem

private

Definition at line 38 of file ActionInput.c.

Referenced by ForceActionCheck(), NoIndicationActionInputBase::GetAction(), GetUsedMainItem(), and NoIndicationActionInputBase::UpdatePossibleActions().

◆ m_Player

PlayerBase ActionInput::m_Player

private

Definition at line 31 of file ActionInput.c.

Referenced by NoIndicationActionInputBase::GetAction(), and Init().

◆ m_Priority

int ActionInput::m_Priority

private

Definition at line 23 of file ActionInput.c.

Referenced by ActionInput(), and GetPriority().

◆ m_Target

ref ActionTarget ActionInput::m_Target

private

Definition at line 37 of file ActionInput.c.

Referenced by ForceActionCheck(), NoIndicationActionInputBase::GetAction(), GetUsedActionTarget(), and NoIndicationActionInputBase::UpdatePossibleActions().

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

scripts/4_World/Classes/UserActionsComponent/ActionInput.c

Private Attributes
UAIDWrapper	m_input

int	m_InputType

int	m_Priority

bool	m_DetectFromItem

bool	m_DetectFromTarget

bool	m_DetectFromPlayer

bool	m_Enabled

bool	m_JustActivate

bool	m_HasTarget

PlayerBase	m_Player

ref ActionTarget	m_ForcedTarget

ref ForcedActionData	m_ForcedActionData

ref ActionTarget	m_Target

ItemBase	m_MainItem

int	m_ConditionMask

bool	m_Active

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ActionInput()

Member Function Documentation

◆ ActionsSelectReset()

◆ ClearForcedAction()

◆ ClearForcedTarget()

◆ ForceAction()

◆ ForceActionCheck()

◆ ForceActionTarget()

◆ GetAction()

◆ GetInputType()

◆ GetPossibleAction()

◆ GetPossibleActionIndex()

◆ GetPossibleActions()

◆ GetPossibleActionsCount()

◆ GetPriority()

◆ GetUAInput()

◆ GetUsedActionTarget()

◆ GetUsedMainItem()

◆ HasInput()

◆ HasTarget()

◆ Init()

◆ IsActive()

◆ JustActivate()

◆ OnActionEnd()

◆ OnActionStart()

◆ Reset()

◆ SelectNextAction()

◆ SelectPrevAction()

◆ SetEnablity()

◆ SetInput()

◆ Update()

◆ UpdatePossibleActions()

◆ WasEnded()

Member Data Documentation

◆ m_Active

◆ m_ConditionMask

◆ m_DetectFromItem

◆ m_DetectFromPlayer

◆ m_DetectFromTarget

◆ m_Enabled

◆ m_ForcedActionData

◆ m_ForcedTarget

◆ m_HasTarget

◆ m_input

◆ m_InputType

◆ m_JustActivate

◆ m_MainItem

◆ m_Player

◆ m_Priority

◆ m_Target