ActionMenu Class Reference

Collaboration diagram for ActionMenu:

Private Member Functions
void	ActionMenu ()
void	Init (Widget actions_panel_widget, TextWidget default_action_widget)
void	UpdateWidgets ()
void	NextAction ()
void	PrevAction ()
void	NextActionCategory ()
void	PrevActionCategory ()
void	Show ()
void	Refresh ()
void	Hide ()
void	HideWithFadeout ()

Private Attributes
const float	FADE_IN_TIME = 0.3
const float	FADE_OUT_TIME = 0.3
const float	HIDE_MENU_TIME = 5
ref WidgetFadeTimer	m_FadeTimer
ref array< TextWidget >	m_actionItems
TextWidget	m_defaultActionWidget
Widget	m_actionsPanelWidget
ref Timer	m_hide_timer
bool	m_visible

Detailed Description

Definition at line 1 of file ActionMenu.c.

Constructor & Destructor Documentation

ActionMenu()

void ActionMenu::ActionMenu ( )

inlineprivate

Definition at line 15 of file ActionMenu.c.

  {
    m_actionItems = new array<TextWidget>;
    m_FadeTimer = new WidgetFadeTimer;
    m_hide_timer = new Timer(CALL_CATEGORY_GUI);
    m_visible = false;
  }

References CALL_CATEGORY_GUI, m_actionItems, m_FadeTimer, m_hide_timer, and m_visible.

Member Function Documentation

Hide()

void ActionMenu::Hide ( )

inlineprivate

Definition at line 155 of file ActionMenu.c.

  {
    if (!m_visible)
      return;
 
    m_visible = false;
    m_hide_timer.Stop();
    m_FadeTimer.Stop();
    //m_defaultActionWidget.Show(false);
    m_actionsPanelWidget.Show(false);
  }

References m_actionsPanelWidget, m_FadeTimer, m_hide_timer, and m_visible.

HideWithFadeout()

void ActionMenu::HideWithFadeout ( )

inlineprivate

Definition at line 167 of file ActionMenu.c.

  {
    //m_defaultActionWidget.Show(false);
    if (m_actionsPanelWidget.IsVisible())
      m_FadeTimer.FadeOut(m_actionsPanelWidget, FADE_OUT_TIME, true);
  }

References FADE_OUT_TIME, m_actionsPanelWidget, and m_FadeTimer.

Init()

void ActionMenu::Init ( Widget actions_panel_widget, TextWidget default_action_widget )

inlineprivate

Definition at line 23 of file ActionMenu.c.

  {
    m_defaultActionWidget = default_action_widget;
    m_actionsPanelWidget = actions_panel_widget;
    m_actionItems.Clear();
    int i = 0;
    TextWidget w = TextWidget.Cast(m_actionsPanelWidget.FindAnyWidget("ActionListItem" + i.ToString()));
 
    while (w)
    {
      m_actionItems.Insert(w);
      w.Show(false);
      i++;
      w = TextWidget.Cast(m_actionsPanelWidget.FindAnyWidget("ActionListItem" + i.ToString()));
    }
 
    m_defaultActionWidget.Show(false);
    m_actionsPanelWidget.Show(true);
    m_actionsPanelWidget.SetAlpha(0);
  }

References m_actionItems, m_actionsPanelWidget, and m_defaultActionWidget.

NextAction()

void ActionMenu::NextAction ( )

inlineprivate

Definition at line 96 of file ActionMenu.c.

  {
    PlayerBase player = PlayerBase.Cast(GetGame().GetPlayer());
    player.GetActionManager().SelectNextAction();
 
    UpdateWidgets();
 
    m_hide_timer.Run(HIDE_MENU_TIME, this, "HideWithFadeout");
  }

References GetGame(), GetPlayer(), HIDE_MENU_TIME, m_hide_timer, and UpdateWidgets().

NextActionCategory()

void ActionMenu::NextActionCategory ( )

inlineprivate

Definition at line 116 of file ActionMenu.c.

  {
    PlayerBase player = PlayerBase.Cast(GetGame().GetPlayer());
    player.GetActionManager().SelectNextActionCategory();
 
    UpdateWidgets();
 
    m_hide_timer.Run(HIDE_MENU_TIME, this, "HideWithFadeout");
  }

References GetGame(), GetPlayer(), HIDE_MENU_TIME, m_hide_timer, and UpdateWidgets().

PrevAction()

void ActionMenu::PrevAction ( )

inlineprivate

Definition at line 106 of file ActionMenu.c.

  {
    PlayerBase player = PlayerBase.Cast(GetGame().GetPlayer());
    player.GetActionManager().SelectPrevAction();
 
    UpdateWidgets();
 
    m_hide_timer.Run(HIDE_MENU_TIME, this, "HideWithFadeout");
  }

References GetGame(), GetPlayer(), HIDE_MENU_TIME, m_hide_timer, and UpdateWidgets().

PrevActionCategory()

void ActionMenu::PrevActionCategory ( )

inlineprivate

Definition at line 126 of file ActionMenu.c.

  {
    PlayerBase player = PlayerBase.Cast(GetGame().GetPlayer());
    player.GetActionManager().SelectPrevActionCategory();
 
    UpdateWidgets();
 
    m_hide_timer.Run(HIDE_MENU_TIME, this, "HideWithFadeout");
  }

References GetGame(), GetPlayer(), HIDE_MENU_TIME, m_hide_timer, and UpdateWidgets().

Refresh()

void ActionMenu::Refresh ( )

inlineprivate

Definition at line 145 of file ActionMenu.c.

  {
    if (!m_visible)
      Show();
 
    PlayerBase player = PlayerBase.Cast(GetGame().GetPlayer());
    if (player.GetActionManager().IsSelectableActionsChanged())
      UpdateWidgets();
  }

References GetGame(), GetPlayer(), m_visible, Show(), and UpdateWidgets().

Show()

void ActionMenu::Show ( )

inlineprivate

Definition at line 136 of file ActionMenu.c.

  {
    if (m_visible)
      return;
 
    m_visible = true;
    m_hide_timer.Run(HIDE_MENU_TIME, this, "HideWithFadeout");
  }

References HIDE_MENU_TIME, m_hide_timer, and m_visible.

Referenced by Refresh().

UpdateWidgets()

void ActionMenu::UpdateWidgets ( )

inlineprivate

Definition at line 44 of file ActionMenu.c.

  {
#ifdef DIAG_DEVELOPER
    // tmp
    bool newATSelection = DiagMenu.GetBool(DiagMenuIDs.MISC_ACTION_TARGETS_NEW, true);
 
    // read the action manager
    PlayerBase player = PlayerBase.Cast(GetGame().GetPlayer());
    TSelectableActionInfoArray actions = player.GetActionManager().GetSelectableActions();
    int selectedActionIndex = player.GetActionManager().GetSelectedActionIndex();
 
    // clear state
    m_defaultActionWidget.Show(false);
    if (actions.Count() <= 1)
      m_FadeTimer.FadeOut(m_actionsPanelWidget, FADE_OUT_TIME, true);
    else
      m_FadeTimer.FadeIn(m_actionsPanelWidget, FADE_IN_TIME, true);
 
    // update state
    for (int i = 0; i < m_actionItems.Count(); i++)
    {
      TextWidget w = m_actionItems.Get(i);
 
      if (i < actions.Count())
      {
        TSelectableActionInfo actionInfo = actions.Get(i);
        w.SetText(actionInfo.param3);
 
        if (i == selectedActionIndex)
        {
          w.SetColor(0xFFFFEC44);
 
          m_defaultActionWidget.SetText(actionInfo.param3);
          if (!newATSelection)
            m_defaultActionWidget.Show(true);
        }
        else
          w.SetColor(0xFFFFFFFF);
 
        w.Show(true);
      }
      else
        w.Show(false);
    }
 
    float sx;
    float sy;
    m_actionsPanelWidget.GetSize(sx, sy);
    m_actionsPanelWidget.SetSize(sx, 8 + (actions.Count() * 32));
#endif
  }

References FADE_IN_TIME, FADE_OUT_TIME, DiagMenu::GetBool(), GetGame(), GetPlayer(), m_actionItems, m_actionsPanelWidget, m_defaultActionWidget, and m_FadeTimer.

Referenced by NextAction(), NextActionCategory(), PrevAction(), PrevActionCategory(), and Refresh().

Member Data Documentation

FADE_IN_TIME

const float ActionMenu::FADE_IN_TIME = 0.3

private

Definition at line 3 of file ActionMenu.c.

Referenced by UpdateWidgets().

FADE_OUT_TIME

const float ActionMenu::FADE_OUT_TIME = 0.3

private

Definition at line 4 of file ActionMenu.c.

Referenced by HideWithFadeout(), and UpdateWidgets().

HIDE_MENU_TIME

const float ActionMenu::HIDE_MENU_TIME = 5

private

Definition at line 5 of file ActionMenu.c.

Referenced by NextAction(), NextActionCategory(), PrevAction(), PrevActionCategory(), and Show().

m_actionItems

ref array<TextWidget> ActionMenu::m_actionItems

private

Definition at line 8 of file ActionMenu.c.

Referenced by ActionMenu(), Init(), and UpdateWidgets().

m_actionsPanelWidget

Widget ActionMenu::m_actionsPanelWidget

private

Definition at line 10 of file ActionMenu.c.

Referenced by Hide(), HideWithFadeout(), Init(), and UpdateWidgets().

m_defaultActionWidget

TextWidget ActionMenu::m_defaultActionWidget

private

Definition at line 9 of file ActionMenu.c.

Referenced by Init(), and UpdateWidgets().

m_FadeTimer

ref WidgetFadeTimer ActionMenu::m_FadeTimer

private

Definition at line 7 of file ActionMenu.c.

Referenced by ActionMenu(), Hide(), HideWithFadeout(), and UpdateWidgets().

m_hide_timer

ref Timer ActionMenu::m_hide_timer

private

Definition at line 11 of file ActionMenu.c.

Referenced by ActionMenu(), Hide(), NextAction(), NextActionCategory(), PrevAction(), PrevActionCategory(), and Show().

m_visible

bool ActionMenu::m_visible

private

Definition at line 13 of file ActionMenu.c.

Referenced by ActionMenu(), Hide(), Refresh(), and Show().

---

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

• scripts/5_Mission/GUI/ActionMenu.c