Example menu

Author: kiwi515

base/symbols_resort.txt

@@ -3637,7 +3637,10 @@ CreateView2D__13RPGrpRendererFUcP11RPGrpScreen=0x80253e1c
 CorrectView__13RPGrpRendererFv=0x80253d68
 __vt__11RPGrpScreen=0x806b5358
 
-playSound__Q23Sp27SndUtilFUlUl=0x802b735c
+startSeWithRemote__Q23Sp23SndFUlUl=0x802b735c
+startSe__Q23Sp23SndFUl=0x802b73bc
+startBgm__Q23Sp23SndFUl=0x802b7228
+
 sInstance__Q33Sp23Swf5Scene=0x806f5ff0
 spInstance__Q33Sp23Cmn9StaticMem=0x806f4e98
 spInstance__17RPSysSystemWinMgr=0x806f4cd0

include/Sports2/Snd/Sp2SndUtil.h

@@ -3,13 +3,13 @@
 #include <Sports2/Sp2Types.h>
 
 namespace Sp2 {
+namespace Snd {
 
-class SndUtil {
-public:
-    static void playBgm(u32 id);
-    static void playSound(u32 id, u32 spkFlag);
-};
+void startBgm(u32 id);
+void startSe(u32 id);
+void startSeWithRemote(u32 id, u32 spkFlag);
 
+} // namespace Snd
 } // namespace Sp2
 
-#endif
+#endif

lib/libkiwi/debug/kiwiDebugMenu.cpp

@@ -27,7 +27,18 @@ EDebugMenuResult DebugMenu::Calculate() {
         return EDebugMenuResult_None;
     }
 
-    return mPageStack.Top().Calculate();
+    EDebugMenuResult result = mPageStack.Top().Calculate();
+
+    if (result == EDebugMenuResult_Close) {
+        // Can't close the root page
+        if (mPageStack.Size() > 1) {
+            mPageStack.Pop();
+        } else {
+            result = EDebugMenuResult_Invalid;
+        }
+    }
+
+    return result;
 }
 
 /**
@@ -59,7 +70,9 @@ bool DebugPage::AddOption(DebugOptionBase& rOption) {
         return false;
     }
 
+    rOption.SetParent(*this);
     mOptions.PushBack(&rOption);
+
     return true;
 }
 
@@ -93,18 +106,14 @@ EDebugMenuResult DebugPage::Calculate() {
 
         // Change option with Left/Right
         if (rCtrl.IsTrig(EButton_Right)) {
-            pOption->Increment();
-            return EDebugMenuResult_Change;
-
+            return pOption->Increment();
         } else if (rCtrl.IsTrig(EButton_Left)) {
-            pOption->Decrement();
-            return EDebugMenuResult_Change;
+            return pOption->Decrement();
         }
 
         // Select option with A
         if (rCtrl.IsTrig(EButton_A)) {
-            pOption->Select();
-            return EDebugMenuResult_Select;
+            return pOption->Select();
         }
 
         // Close page with B

lib/libkiwi/debug/kiwiDebugOption.cpp

@@ -227,8 +227,8 @@ EDebugMenuResult DebugProcOption::Select() {
 EDebugMenuResult DebugOpenPageOption::OpenPageProc(void* pArg) {
     K_ASSERT(pArg != nullptr);
 
-    DebugPage* pPage = static_cast<DebugPage*>(pArg);
-    pPage->GetParent().OpenPage(*pPage);
+    DebugOpenPageOption* p = static_cast<DebugOpenPageOption*>(pArg);
+    p->GetParent().GetParent().OpenPage(*p->mpPage);
 
     return EDebugMenuResult_Select;
 }

lib/libkiwi/debug/kiwiDebugOption.h

@@ -45,6 +45,22 @@ class DebugOptionBase {
      */
     virtual ~DebugOptionBase() {}
 
+    /**
+     * @brief Gets the options's parent menu page
+     */
+    DebugPage& GetParent() const {
+        K_ASSERT(mpParent != nullptr);
+        return *mpParent;
+    }
+    /**
+     * @brief Sets the options's parent menu page
+     *
+     * @param rPage Parent menu page
+     */
+    void SetParent(DebugPage& rPage) {
+        mpParent = &rPage;
+    }
+
     /**
      * @brief Gets the type of the option
      */
@@ -122,6 +138,9 @@ class DebugOptionBase {
     virtual void UpdateString() {}
 
 protected:
+    //! Parent menu page
+    DebugPage* mpParent;
+
     //! Enable option
     bool mIsEnabled;
 
@@ -409,7 +428,7 @@ class DebugOpenPageOption : public DebugProcOption {
      * @param rPage Sub-page to open
      */
     DebugOpenPageOption(const String& rName, DebugPage& rPage)
-        : DebugProcOption(rName, OpenPageProc, mpPage) {
+        : DebugProcOption(rName, OpenPageProc, this) {
 
         mpPage = &rPage;
     }

src/scene/DebugRootScene/MainPage.cpp

@@ -11,21 +11,23 @@ namespace DebugRoot {
 MainPage::MainPage()
     : mDummyIntOption("DummyInt", 0, 5),
       mDummyBoolOption("DummyBool"),
-      mDummyProcOption("DummyProc", ReturnToMenuProc) {
+      mDummyOpenPageOption("DummyOpenPage", mSubPage),
+      mGotoMenuOption("Goto Menu", GotoMenuProc) {
 
     AddOption(mDummyIntOption);
     AddOption(mDummyBoolOption);
-    AddOption(mDummyProcOption);
+    AddOption(mDummyOpenPageOption);
+    AddOption(mGotoMenuOption);
 }
 
 /**
  * @brief Returns to the main menu scene
  */
-kiwi::EDebugMenuResult MainPage::ReturnToMenuProc(void* pArg) {
+kiwi::EDebugMenuResult MainPage::GotoMenuProc(void* pArg) {
     kiwi::SceneCreator::GetInstance().ChangeSceneAfterFade(
         kiwi::SceneCreator::GetMenuScene());
 
-    return kiwi::EDebugMenuResult_Close;
+    return kiwi::EDebugMenuResult_Select;
 }
 
 } // namespace DebugRoot

src/scene/DebugRootScene/MainPage.h

@@ -1,6 +1,7 @@
 #ifndef APCLIENT_SCENE_DEBUGROOTSCENE_MAIN_PAGE_H
 #define APCLIENT_SCENE_DEBUGROOTSCENE_MAIN_PAGE_H
 #include "core/const.h"
+#include "scene/DebugRootScene/SubPage.h"
 
 #include <libkiwi.h>
 
@@ -25,12 +26,20 @@ class MainPage : public kiwi::DebugPage {
     /**
      * @brief Returns to the main menu scene
      */
-    static kiwi::EDebugMenuResult ReturnToMenuProc(void* pArg);
+    static kiwi::EDebugMenuResult GotoMenuProc(void* pArg);
 
 private:
+    //! Example integer option
     kiwi::DebugIntOption mDummyIntOption;
+    //! Example boolean option
     kiwi::DebugBoolOption mDummyBoolOption;
-    kiwi::DebugProcOption mDummyProcOption;
+
+    //! Example sub-page, and the option to open it
+    SubPage mSubPage;
+    kiwi::DebugOpenPageOption mDummyOpenPageOption;
+
+    //! Example procedure option (goto menu scene)
+    kiwi::DebugProcOption mGotoMenuOption;
 };
 
 } // namespace DebugRoot

src/scene/DebugRootScene/Scene.cpp

@@ -1,5 +1,7 @@
 #include "scene/DebugRootScene/Scene.h"
 
+#include <Sports2/Sp2Snd.h>
+
 #include <libkiwi.h>
 
 namespace AP {
@@ -23,7 +25,39 @@ void Scene::OnConfigure() {
  * @brief Calculate state user callback
  */
 void Scene::OnCalculate() {
-    mDebugMenu.Calculate();
+    kiwi::EDebugMenuResult result = mDebugMenu.Calculate();
+
+    switch (result) {
+    case kiwi::EDebugMenuResult_Invalid: {
+        Sp2::Snd::startSe(SE_CMN_NG_01);
+        break;
+    }
+
+    case kiwi::EDebugMenuResult_Cursor: {
+        Sp2::Snd::startSe(SE_CMN_CURSOR_01);
+        break;
+    }
+
+    case kiwi::EDebugMenuResult_Change: {
+        Sp2::Snd::startSe(SE_CMN_CURSOR_01);
+        break;
+    }
+
+    case kiwi::EDebugMenuResult_Select: {
+        Sp2::Snd::startSe(SE_CMN_DECIDE_01);
+        break;
+    }
+
+    case kiwi::EDebugMenuResult_Close: {
+        Sp2::Snd::startSe(SE_CMN_CANCEL_01);
+        break;
+    }
+
+    case kiwi::EDebugMenuResult_None:
+    default: {
+        break;
+    }
+    }
 }
 
 /**

src/scene/DebugRootScene/SubPage.cpp

@@ -0,0 +1,25 @@
+#include "scene/DebugRootScene/SubPage.h"
+
+#include <libkiwi.h>
+
+namespace AP {
+namespace DebugRoot {
+
+/**
+ * @brief Constructor
+ */
+SubPage::SubPage()
+    : mDummyProcOption("Nothing here - press B to close page", DummyProc) {
+
+    AddOption(mDummyProcOption);
+}
+
+/**
+ * @brief Placeholder procedure
+ */
+kiwi::EDebugMenuResult SubPage::DummyProc(void* pArg) {
+    return kiwi::EDebugMenuResult_Invalid;
+}
+
+} // namespace DebugRoot
+} // namespace AP

src/scene/DebugRootScene/SubPage.h

@@ -0,0 +1,38 @@
+#ifndef APCLIENT_SCENE_DEBUGROOTSCENE_SUB_PAGE_H
+#define APCLIENT_SCENE_DEBUGROOTSCENE_SUB_PAGE_H
+#include "core/const.h"
+
+#include <libkiwi.h>
+
+namespace AP {
+namespace DebugRoot {
+
+/**
+ * @brief Debug menu example sub-page
+ */
+class SubPage : public kiwi::DebugPage {
+public:
+    /**
+     * @brief Constructor
+     */
+    SubPage();
+
+    /**
+     * @brief Destructor
+     */
+    virtual ~SubPage() {}
+
+    /**
+     * @brief Placeholder procedure
+     */
+    static kiwi::EDebugMenuResult DummyProc(void* pArg);
+
+private:
+    //! Example procedure option (doesn't actually do anything)
+    kiwi::DebugProcOption mDummyProcOption;
+};
+
+} // namespace DebugRoot
+} // namespace AP
+
+#endif