ActionUnfoldMapCB Class Reference

Inheritance diagram for ActionUnfoldMapCB:

Collaboration diagram for ActionUnfoldMapCB:

Private Member Functions
void	ActionUnfoldMapCB ()
void	~ActionUnfoldMapCB ()
override void	SetActionData (ActionData action_data)
bool	CancelCondition ()
override void	OnStateChange (int pOldState, int pCurrentState)
override void	OnAnimationEvent (int pEventID)
override void	OnFinish (bool pCanceled)
void	PerformMapChange ()
bool	StateCheck ()
Private Member Functions inherited from ActionBaseCB
void	ActionBaseCB ()
int	GetPossileStanceMask ()
override void	OnFinish (bool pCanceled)
void	SetCommand (int command_uid)
void	CreateActionComponent ()
void	InitActionComponent ()
void	ProgressActionComponent ()
void	EndActionComponent ()
void	Interrupt ()
void	SetActionData (ActionData action_data)
override bool	IsUserActionCallback ()
float	GetActionComponentProgress ()
int	GetActionState ()
ActionTarget	GetTarget ()

Private Attributes
bool	m_MapFolding
bool	m_HasReceivedEvent
bool	m_CancelCondition
int	m_InitMovementState
int	m_FinalMovementState
Private Attributes inherited from ActionBaseCB
ActionData	m_ActionData
SoundOnVehicle	m_SoundObject
bool	m_Canceled
bool	m_Interrupted

Detailed Description

Definition at line 1 of file ActionUnfoldMap.c.

Constructor & Destructor Documentation

ActionUnfoldMapCB()

void ActionUnfoldMapCB::ActionUnfoldMapCB ( )

inlineprivate

Definition at line 9 of file ActionUnfoldMap.c.

  {
    RegisterAnimationEvent("ActionExec", UA_ANIM_EVENT);
    EnableStateChangeCallback();
    EnableCancelCondition(true);
  }

References EnableCancelCondition(), EnableStateChangeCallback(), RegisterAnimationEvent(), and UA_ANIM_EVENT.

~ActionUnfoldMapCB()

void ActionUnfoldMapCB::~ActionUnfoldMapCB ( )

inlineprivate

Definition at line 16 of file ActionUnfoldMap.c.

  {
    if (GetGame() && GetGame().GetMission())
    {
      if (!CfgGameplayHandler.GetUse3DMap())
      {
        GetGame().GetMission().RemoveActiveInputExcludes({"map"}, false);
      }
      else
      {
        GetGame().GetMission().RemoveActiveInputExcludes({"loopedactions"}, false);
      }
      GetGame().GetMission().RemoveActiveInputRestriction(EInputRestrictors.MAP);
    }
 
    if (!m_ActionData || !m_ActionData.m_Player)
      return;
 
    ItemMap chernomap = ItemMap.Cast(m_ActionData.m_Player.GetItemInHands());
    if (chernomap && m_ActionData.m_Player.IsMapOpen())
      chernomap.SetMapStateOpen(false, m_ActionData.m_Player);
  }

References GetGame(), CfgGameplayHandler::GetUse3DMap(), ActionBaseCB::m_ActionData, and ActionData::m_Player.

Member Function Documentation

CancelCondition()

bool ActionUnfoldMapCB::CancelCondition ( )

inlineprivate

Definition at line 45 of file ActionUnfoldMap.c.

  {
    return m_CancelCondition;
  }

References m_CancelCondition.

OnAnimationEvent()

override void ActionUnfoldMapCB::OnAnimationEvent ( int pEventID )

inlineprivate

Definition at line 59 of file ActionUnfoldMap.c.

  {
    if (!m_ActionData || !m_ActionData.m_Player)
      return;
 
    switch (pEventID)
    {
    case UA_ANIM_EVENT:
      m_HasReceivedEvent = true;
      m_FinalMovementState = m_ActionData.m_Player.m_MovementState.m_iStanceIdx;
 
      if (StateCheck())
      {
        PerformMapChange();
        m_CancelCondition = false;
      }
      else
        m_CancelCondition = true;
      break;
    }
  }

References ActionBaseCB::m_ActionData, m_CancelCondition, m_FinalMovementState, m_HasReceivedEvent, ActionData::m_Player, PerformMapChange(), StateCheck(), and UA_ANIM_EVENT.

OnFinish()

override void ActionUnfoldMapCB::OnFinish ( bool pCanceled )

inlineprivate

Definition at line 81 of file ActionUnfoldMap.c.

  {
    if (m_ActionData && m_ActionData.m_Player)
    {
      if (m_ActionData && m_ActionData.m_ActionComponent)
        m_ActionData.m_State = m_ActionData.m_ActionComponent.Interrupt(m_ActionData);
 
      if ((!GetGame().IsDedicatedServer()) && GetGame().GetUIManager() && GetGame().GetUIManager().IsMenuOpen(MENU_MAP))
        GetGame().GetUIManager().FindMenu(MENU_MAP).Close();
 
      ActionUnfoldMap action = ActionUnfoldMap.Cast(m_ActionData.m_Action);
      m_InitMovementState = -1;
      m_FinalMovementState = -1;
 
      m_ActionData.m_Player.SetMapClosingSyncSet(false); //reset
 
      ItemMap chernomap = ItemMap.Cast(m_ActionData.m_Player.GetItemInHands());
      if (chernomap && m_ActionData.m_Player.IsMapOpen())
        chernomap.SetMapStateOpen(false, m_ActionData.m_Player);
 
      if (action)
        action.End(m_ActionData);
    }
  }

References ActionUnfoldMap(), GetGame(), ActionData::m_Action, ActionData::m_ActionComponent, ActionBaseCB::m_ActionData, m_FinalMovementState, m_InitMovementState, ActionData::m_Player, ActionData::m_State, and MENU_MAP.

OnStateChange()

override void ActionUnfoldMapCB::OnStateChange ( int pOldState, int pCurrentState )

inlineprivate

Definition at line 50 of file ActionUnfoldMap.c.

  {
    if (!m_ActionData || !m_ActionData.m_Player)
      return;
 
    if ((pOldState == STATE_LOOP_IN && pCurrentState == STATE_LOOP_LOOP) && !m_HasReceivedEvent)
      m_CancelCondition = true;
  }

References ActionBaseCB::m_ActionData, m_CancelCondition, m_HasReceivedEvent, ActionData::m_Player, STATE_LOOP_IN, and STATE_LOOP_LOOP.

PerformMapChange()

void ActionUnfoldMapCB::PerformMapChange ( )

inlineprivate

Definition at line 106 of file ActionUnfoldMap.c.

  {
    if (m_ActionData.m_Player.IsSwimming() || m_ActionData.m_Player.IsClimbing() || m_ActionData.m_Player.IsFalling() || m_ActionData.m_Player.IsClimbingLadder() || m_ActionData.m_Player.IsUnconscious() || m_ActionData.m_Player.IsRestrained())
      return;
 
    ItemMap chernomap = ItemMap.Cast(m_ActionData.m_Player.GetItemInHands());
    if (chernomap)
    {
      if (!m_ActionData.m_Player.IsMapOpen() && !m_MapFolding)
      {
        if (m_CancelCondition) //do not open when cancelling in progress
          return;
 
        chernomap.SetMapStateOpen(true, m_ActionData.m_Player);
 
        if (!GetGame().IsMultiplayer() || GetGame().IsServer())
        {
          //chernomap.SyncMapMarkers();
        }
 
        if (!GetGame().IsDedicatedServer())
        {
          UIManager m_UIManager;
          UIScriptedMenu mapMenu;
          m_UIManager = GetGame().GetUIManager();
          m_UIManager.CloseAll();
          if (!CfgGameplayHandler.GetUse3DMap())
          {
            mapMenu = m_UIManager.EnterScriptedMenu(MENU_MAP, null);
            mapMenu.InitMapItem(chernomap);
            mapMenu.LoadMapMarkers();
            GetGame().GetMission().AddActiveInputExcludes({"map"});
          }
          else
          {
            GetGame().GetMission().AddActiveInputExcludes({"loopedactions"});
          }
 
          GetGame().GetMission().AddActiveInputRestriction(EInputRestrictors.MAP);
        }
      }
      else if (m_ActionData.m_Player.IsMapOpen())
      {
        chernomap.SetMapStateOpen(false, m_ActionData.m_Player);
        m_MapFolding = true;
        m_ActionData.m_Player.SetMapOpen(false);
      }
    }
  }

References UIManager::CloseAll(), UIManager::EnterScriptedMenu(), GetGame(), CfgGameplayHandler::GetUse3DMap(), ActionBaseCB::m_ActionData, m_CancelCondition, m_MapFolding, ActionData::m_Player, and MENU_MAP.

Referenced by OnAnimationEvent().

SetActionData()

override void ActionUnfoldMapCB::SetActionData ( ActionData action_data )

inlineprivate

Definition at line 39 of file ActionUnfoldMap.c.

  {
    m_ActionData = action_data;
    m_InitMovementState = m_ActionData.m_Player.m_MovementState.m_iStanceIdx;
  }

References ActionBaseCB::m_ActionData, m_InitMovementState, and ActionData::m_Player.

StateCheck()

bool ActionUnfoldMapCB::StateCheck ( )

inlineprivate

Definition at line 156 of file ActionUnfoldMap.c.

  {
    return m_InitMovementState == m_FinalMovementState;
  }

References m_FinalMovementState, and m_InitMovementState.

Referenced by OnAnimationEvent().

Member Data Documentation

m_CancelCondition

bool ActionUnfoldMapCB::m_CancelCondition

private

Definition at line 5 of file ActionUnfoldMap.c.

Referenced by CancelCondition(), OnAnimationEvent(), OnStateChange(), and PerformMapChange().

m_FinalMovementState

int ActionUnfoldMapCB::m_FinalMovementState

private

Definition at line 7 of file ActionUnfoldMap.c.

Referenced by OnAnimationEvent(), OnFinish(), and StateCheck().

m_HasReceivedEvent

bool ActionUnfoldMapCB::m_HasReceivedEvent

private

Definition at line 4 of file ActionUnfoldMap.c.

Referenced by OnAnimationEvent(), and OnStateChange().

m_InitMovementState

int ActionUnfoldMapCB::m_InitMovementState

private

Definition at line 6 of file ActionUnfoldMap.c.

Referenced by OnFinish(), SetActionData(), and StateCheck().

m_MapFolding

bool ActionUnfoldMapCB::m_MapFolding

private

Definition at line 3 of file ActionUnfoldMap.c.

Referenced by PerformMapChange().

---

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

• scripts/4_World/Classes/UserActionsComponent/Actions/SingleUse/ActionUnfoldMap.c