Debug UI API

Immediate mode debug UI APIPer frame usage example: More...

Data Structures
class	DbgUI

Functions
void	DbgUI ()
void	~DbgUI ()
static proto native void	Begin (string windowTitle, float x=0, float y=0)
static proto void	BeginCleanupScope ()
static proto native bool	Button (string txt, int minWidth=0)
static proto void	Check (string label, out bool checked)
static proto native void	ColoredText (int color, string label)
static proto void	Combo (string label, out int selection, TStringArray elems)
static proto native void	DoUnitTest ()
	Creates all possible DbgUI widgets. Just for the testing purposes.
static proto native void	End ()
static proto native void	EndCleanupScope ()
static bool	FloatOverride (string id, inout float value, float min, float max, int precision=1000, bool sameLine=true)
	Draw an "override" checkbox that unrolls into a slider in provided range when checked.
static proto void	InputFloat (string txt, out float value, int pxWidth=150)
static proto void	InputInt (string txt, out int value, int pxWidth=150)
static proto void	InputText (string txt, out string value, int pxWidth=150)
static proto void	List (string label, out int selection, TStringArray elems)
static proto native void	Panel (string label, int width, int height, int color=0xaa555555)
static proto native void	PlotLive (string label, int sizeX, int sizeY, float val, int timeStep=100, int historySize=30, int color=0xFFFFFFFF)
static proto native void	PopID ()
static proto native void	PushID_Int (int int_id)
static proto native void	PushID_Str (string str_id)
static proto native void	SameLine ()
static proto native void	SameSpot ()
static proto void	SliderFloat (string label, out float value, float min, float max, int pxWidth=150)
static proto native void	Spacer (int height)
static proto native void	Text (string label)

Detailed Description

Immediate mode debug UI API

Per frame usage example:

bool m_ShowDbgUI = false;
int m_DbgListSelection = 0;
float m_DbgSliderValue = 0.0;
autoptr array<string> m_DbgOptions = {"jedna", "dva", "tri"};
 
void OnUpdate(float timeslice)
{  
   DbgUI.Begin("Test");
   DbgUI.Check("Show DbgUI", m_ShowDbgUI);
   if (m_ShowDbgUI)
   {
       DbgUI.Text("DbgUI Test");       
 
       string name = "";
       DbgUI.InputText("name", name);      
       
       if (DbgUI.Button("Print name"))
       {
           Print(name);        
       }
       
       DbgUI.List("test list", m_DbgListSelection, m_DbgOptions);
       
       DbgUI.Text("Choice = " + m_DbgListSelection.ToString());    
       
       DbgUI.Spacer(10);
       DbgUI.SliderFloat("slider", m_DbgSliderValue, 0, 100);
       DbgUI.Text("Slider value = " + ftoa(m_DbgSliderValue)); 
   }
   DbgUI.End();
}

For non-per frame usage example:

int m_DbgEventCount = 0;
void OnEvent(EventType eventTypeId, Param params)
{
   m_DbgEventCount++;
 
   DbgUI.BeginCleanupScope();      
   DbgUI.Begin("events", 300, 0);
   DbgUI.Text("Events count = " + m_DbgEventCount.ToString());
   DbgUI.End();
   DbgUI.EndCleanupScope();
}

Function Documentation

DbgUI()

void DbgUI ( )

inlineprivate

Definition at line 61 of file dbgui.c.

Referenced by FloatOverride().

~DbgUI()

void ~DbgUI ( )

inlineprivate

Definition at line 62 of file dbgui.c.

Begin()

proto native void Begin ( string windowTitle, float x = 0, float y = 0 )

staticprivate

References x, and y.

Referenced by CalculateLinePointFade(), BleedingSourcesManagerBase::CleanDebug(), BleedingSourcesManagerBase::DisplayDebug(), WeaponDebug::DisplayGeneralInfo(), WeaponDebug::DisplayTargetInfo(), PluginBase::DrawDebugs(), OnGUI(), PluginBase::OnGUITimer(), MissionBase::OnUpdate(), ShowCoefsDbg(), PluginBase::ShowDebug(), Managed::ShowDebugValues(), and MissionBase::ShowHairDebugValues().

BeginCleanupScope()

proto void BeginCleanupScope ( )

staticprivate

Referenced by BleedingSourcesManagerBase::CleanDebug(), BleedingSourcesManagerBase::DisplayDebug(), OnGUI(), OnGUI_CommandsEdit(), OnGUI_Variables(), OnGUI_VariablesEdit(), PluginBase::OnGUITimer(), ShowCoefsDbg(), PluginBase::ShowDebug(), Managed::ShowDebugValues(), and MissionBase::ShowHairDebugValues().

Button()

proto native bool Button ( string txt, int minWidth = 0 )

staticprivate

Referenced by OnGUI(), OnGUI_AIControlEdit(), OnGUI_AnimEvents(), OnGUI_BulkSet(), OnGUI_CommandsEdit(), OnGUI_VariablesEdit(), and PluginBase::OnGUITimer().

Check()

proto void Check ( string label, out bool checked )

staticprivate

Referenced by OnGUI(), OnGUI_CommandsEdit(), and OnGUI_VariablesEdit().

ColoredText()

proto native void ColoredText ( int color, string label )

staticprivate

Combo()

proto void Combo ( string label, out int selection, TStringArray elems )

staticprivate

DoUnitTest()

proto native void DoUnitTest ( )

staticprivate

Creates all possible DbgUI widgets. Just for the testing purposes.

End()

proto native void End ( )

staticprivate

Referenced by CalculateLinePointFade(), BleedingSourcesManagerBase::CleanDebug(), BleedingSourcesManagerBase::DisplayDebug(), WeaponDebug::DisplayGeneralInfo(), WeaponDebug::DisplayTargetInfo(), PluginBase::DrawDebugs(), OnGUI(), PluginBase::OnGUITimer(), MissionBase::OnUpdate(), ShowCoefsDbg(), PluginBase::ShowDebug(), Managed::ShowDebugValues(), and MissionBase::ShowHairDebugValues().

EndCleanupScope()

proto native void EndCleanupScope ( )

staticprivate

Referenced by BleedingSourcesManagerBase::CleanDebug(), BleedingSourcesManagerBase::DisplayDebug(), OnGUI(), OnGUI_CommandsEdit(), OnGUI_Variables(), OnGUI_VariablesEdit(), PluginBase::OnGUITimer(), ShowCoefsDbg(), PluginBase::ShowDebug(), Managed::ShowDebugValues(), and MissionBase::ShowHairDebugValues().

FloatOverride()

bool FloatOverride ( string id, inout float value, float min, float max, int precision = 1000, bool sameLine = true )

inlinestaticprivate

Draw an "override" checkbox that unrolls into a slider in provided range when checked.

Definition at line 94 of file dbgui.c.

References DbgUI(), and float::ToString().

InputFloat()

proto void InputFloat ( string txt, out float value, int pxWidth = 150 )

staticprivate

Referenced by PluginBase::OnGUITimer().

InputInt()

proto void InputInt ( string txt, out int value, int pxWidth = 150 )

staticprivate

Referenced by OnGUI().

InputText()

proto void InputText ( string txt, out string value, int pxWidth = 150 )

staticprivate

Referenced by OnGUI_AnimEvents(), OnGUI_CommandsEdit(), OnGUI_VariablesEdit(), and PluginBase::OnGUITimer().

List()

proto void List ( string label, out int selection, TStringArray elems )

staticprivate

Panel()

proto native void Panel ( string label, int width, int height, int color = 0xaa555555 )

staticprivate

Referenced by OnGUI(), OnGUI_AnimEvents(), ShowCoefsDbg(), and PluginBase::ShowDebug().

PlotLive()

proto native void PlotLive ( string label, int sizeX, int sizeY, float val, int timeStep = 100, int historySize = 30, int color = 0xFFFFFFFF )

staticprivate

PopID()

proto native void PopID ( )

staticprivate

Referenced by OnGUI_AnimEvents(), OnGUI_CommandsEdit(), OnGUI_VariablesEdit(), and PluginBase::OnGUITimer().

PushID_Int()

proto native void PushID_Int ( int int_id )

staticprivate

Referenced by OnGUI_AnimEvents(), OnGUI_CommandsEdit(), OnGUI_VariablesEdit(), and PluginBase::OnGUITimer().

PushID_Str()

proto native void PushID_Str ( string str_id )

staticprivate

Referenced by OnGUI_AnimEvents(), OnGUI_CommandsEdit(), OnGUI_VariablesEdit(), and PluginBase::OnGUITimer().

SameLine()

proto native void SameLine ( )

staticprivate

Referenced by OnGUI(), OnGUI_CommandsEdit(), OnGUI_VariablesEdit(), and PluginBase::OnGUITimer().

SameSpot()

proto native void SameSpot ( )

staticprivate

SliderFloat()

proto void SliderFloat ( string label, out float value, float min, float max, int pxWidth = 150 )

staticprivate

Spacer()

proto native void Spacer ( int height )

staticprivate

Referenced by OnGUI(), and ShowCoefsDbg().

Text()

proto native void Text ( string label )

staticprivate

Referenced by CalculateLinePointFade(), BleedingSourcesManagerBase::DisplayDebug(), WeaponDebug::DisplayGeneralInfo(), WeaponDebug::DisplayTargetInfo(), PluginBase::DrawDebugs(), OnGUI(), OnGUI_AnimEvents(), OnGUI_CommandsEdit(), OnGUI_Variables(), OnGUI_VariablesEdit(), PluginBase::OnGUITimer(), MissionBase::OnUpdate(), UIScriptedMenu::SetCameraData(), ShowCoefsDbg(), PluginBase::ShowDebug(), Managed::ShowDebugValues(), and MissionBase::ShowHairDebugValues().