diff --git a/src/ScreenOptions.h b/src/ScreenOptions.h index a0ddfa948c..b07f8027bb 100644 --- a/src/ScreenOptions.h +++ b/src/ScreenOptions.h @@ -85,14 +85,16 @@ protected: int GetCurrentRow( PlayerNumber pn = PLAYER_1 ) const { return m_iCurrentRow[pn]; } bool AllAreOnLastRow() const; + OptionRow* GetRow( int iRow ) const { return m_pRows[iRow]; } protected: // derived classes need access to these enum Navigation { NAV_THREE_KEY, NAV_THREE_KEY_MENU, NAV_THREE_KEY_ALT, NAV_FIVE_KEY, NAV_TOGGLE_THREE_KEY, NAV_TOGGLE_FIVE_KEY }; void SetNavigation( Navigation nav ) { m_OptionsNavigation = nav; } void SetInputMode( InputMode im ) { m_InputMode = im; } - // Map menu lines to m_OptionRow entries. + /** @brief Map menu lines to m_OptionRow entries. */ vector m_pRows; + /** @brief The current row each player is on. */ int m_iCurrentRow[NUM_PLAYERS]; OptionRowType m_OptionRowTypeNormal; @@ -104,21 +106,22 @@ protected: // derived classes need access to these int m_iFocusX[NUM_PLAYERS]; bool m_bWasOnExit[NUM_PLAYERS]; - // TRICKY: People hold Start to get to PlayerOptions, then - // the repeat events cause them to zip to the bottom. So, ignore - // Start repeat events until we've seen one first pressed event. + /** @brief True if at least one player pressed Start after selecting the song. + * TRICKY: People hold Start to get to PlayerOptions, then the repeat events + * cause them to zip to the bottom. So, ignore Start repeat events until + * we've seen one first pressed event. */ bool m_bGotAtLeastOneStartPressed[NUM_PLAYERS]; // actors ActorFrame m_frameContainer; AutoActor m_sprPage; - OptionsCursor m_Cursor[NUM_PLAYERS]; + OptionsCursor m_Cursor[NUM_PLAYERS]; AutoActor m_sprLineHighlight[NUM_PLAYERS]; BitmapText m_textExplanation[NUM_PLAYERS]; BitmapText m_textExplanationTogether; - DualScrollBar m_ScrollBar; + DualScrollBar m_ScrollBar; AutoActor m_sprMore; RageSound m_SoundChangeCol; @@ -132,7 +135,7 @@ protected: // derived classes need access to these ThemeMetric ROW_INIT_COMMAND; ThemeMetric ROW_ON_COMMAND; ThemeMetric ROW_OFF_COMMAND; - LuaExpressionTransform m_exprRowPositionTransformFunction; // params: self,offsetFromCenter,itemIndex,numItems + LuaExpressionTransform m_exprRowPositionTransformFunction; // params: self,offsetFromCenter,itemIndex,numItems ThemeMetric SHOW_SCROLL_BAR; ThemeMetric SCROLL_BAR_HEIGHT; ThemeMetric SCROLL_BAR_TIME; @@ -144,8 +147,8 @@ protected: // derived classes need access to these ThemeMetric ALLOW_REPEATING_CHANGE_VALUE_INPUT; ThemeMetric CURSOR_TWEEN_SECONDS; ThemeMetric WRAP_VALUE_IN_ROW; - ThemeMetric OPTION_ROW_NORMAL_METRICS_GROUP; - ThemeMetric OPTION_ROW_EXIT_METRICS_GROUP; + ThemeMetric OPTION_ROW_NORMAL_METRICS_GROUP; + ThemeMetric OPTION_ROW_EXIT_METRICS_GROUP; }; #endif