plugindiagmenumodding.c

Go to the documentation of this file.

 
#ifdef DOXYGEN
#ifdef MODDING_TEST
#ifdef DIAG_DEVELOPER
 
#ifdef DOXYGEN
class PluginDiagMenuModded // Just to not have it show up for the regular entry... Doxygen doesn't know about modding
#else
modded class PluginDiagMenu
#endif
{   
    protected string m_ModdedDiagsExampleRootMenu = "BI - DiagsModdingExample";
    
    protected string m_ModdedDiagsExampleSubMenu = "Example Sub Menu";
    
    protected int m_ModdedDiagsExampleRootMenuID;
        protected int m_ModdedDiagsExampleBoolID;
        protected int m_ModdedDiagsExampleSubMenuID;
            protected int m_ModdedDiagsExampleRangeID;
    
    //---------------------------------------------
    override protected void RegisterModdedDiagsIDs()
    {
        super.RegisterModdedDiagsIDs();
        
        m_ModdedDiagsExampleRootMenuID = GetModdedDiagID();
            m_ModdedDiagsExampleBoolID = GetModdedDiagID();
            m_ModdedDiagsExampleSubMenuID = GetModdedDiagID();
                m_ModdedDiagsExampleRangeID = GetModdedDiagID();
    }
    
    //---------------------------------------------
    override protected void RegisterModdedDiags()
    {
        super.RegisterModdedDiags();
        
        // Register the root menu of your mod under the ModdedRootMenu
        // Then register all following menus and items under this menu
        // This can not be enforced, but it will help keep things clean
        // Including being able to easily identify where a debug is coming from
        // So that reports of a broken debug can be sent to the correct developer
        //
        // If you have multiple mods, you might even want to consider to create a root menu with your developer name
        // And then put the mod menus as a submenu
        // To prevent someone running a lot of mods from having an overflooded menu     
        // DiagMenu.MenuExists(...) could serve to help to identify if the root menu already exists when using this format
        // So that the multiple mods can know if they still have to register your root menu or not
        DiagMenu.RegisterMenu(m_ModdedDiagsExampleRootMenuID, m_ModdedDiagsExampleRootMenu, GetModdedRootMenu());
        {
            DiagMenu.RegisterBool(m_ModdedDiagsExampleBoolID, "", "Modded Example Bool", m_ModdedDiagsExampleRootMenuID);
            
            // A sub menu inside the root of the mod menu
            // The curly braces are simply for readability
            DiagMenu.RegisterMenu(m_ModdedDiagsExampleSubMenuID, m_ModdedDiagsExampleSubMenu, m_ModdedDiagsExampleRootMenuID);
            {
                DiagMenu.RegisterRange(m_ModdedDiagsExampleRangeID, "", "Modded Example Range", m_ModdedDiagsExampleSubMenuID, "3 9 6 3");
            }
        }
    }
}
 
#ifdef DOXYGEN
class DummyDoxygenClass
{
    int m_IgnoreThisVariable;
}
#endif
 
#ifdef DOXYGEN
class PluginDiagMenuClientModded // Just to not have it show up for the regular entry... Doxygen doesn't know about modding
#else
modded class PluginDiagMenuClient
#endif
{
    override protected void BindCallbacks()
    {
        super.BindCallbacks();
 
        DiagMenu.BindCallback(m_ModdedDiagsExampleBoolID, CBModdedDiadIDsExampleBool);
        DiagMenu.BindCallback(m_ModdedDiagsExampleRangeID, CBModdedDiadIDsExampleRange);
    }
    
    static void CBModdedDiadIDsExampleBool(bool enabled)
    {
        Print("CBModdedDiadIDsExampleBool: " + enabled);
    }
    
    static void CBModdedDiadIDsExampleRange(float value)
    {
        Print("CBModdedDiadIDsExampleRange: " + value);
    }
}
 
#endif
#endif
#endif
 
//@}