DayZ 1.24
Loading...
Searching...
No Matches
Classes | Functions
Debug UI API
Debug utilities

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

Collaboration diagram for Debug UI API:

Classes

class  DbgUI
 

Functions

void DbgUI::DbgUI ()
 
void DbgUI::~DbgUI ()
 
static proto native void DbgUI::DoUnitTest ()
 Creates all possible DbgUI widgets. Just for the testing purposes.
 
static proto native void DbgUI::Text (string label)
 
static proto native void DbgUI::ColoredText (int color, string label)
 
static proto void DbgUI::Check (string label, out bool checked)
 
static proto void DbgUI::Combo (string label, out int selection, TStringArray elems)
 
static proto void DbgUI::List (string label, out int selection, TStringArray elems)
 
static proto void DbgUI::SliderFloat (string label, out float value, float min, float max, int pxWidth=150)
 
static proto native void DbgUI::Spacer (int height)
 
static proto native void DbgUI::Panel (string label, int width, int height, int color=0xaa555555)
 
static proto native bool DbgUI::Button (string txt, int minWidth=0)
 
static proto void DbgUI::InputText (string txt, out string value, int pxWidth=150)
 
static proto void DbgUI::InputInt (string txt, out int value, int pxWidth=150)
 
static proto void DbgUI::InputFloat (string txt, out float value, int pxWidth=150)
 
static proto native void DbgUI::PlotLive (string label, int sizeX, int sizeY, float val, int timeStep=100, int historySize=30, int color=0xFFFFFFFF)
 
static proto native void DbgUI::SameLine ()
 
static proto native void DbgUI::SameSpot ()
 
static proto native void DbgUI::PushID_Int (int int_id)
 
static proto native void DbgUI::PushID_Str (string str_id)
 
static proto native void DbgUI::PopID ()
 
static proto void DbgUI::BeginCleanupScope ()
 
static proto native void DbgUI::EndCleanupScope ()
 
static proto native void DbgUI::Begin (string windowTitle, float x=0, float y=0)
 
static proto native void DbgUI::End ()
 

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();
}
name
PlayerSpawnPresetDiscreteItemSetSlotData name
one set for cargo
DbgUI
Definition DbgUI.c:60
Print
proto void Print(void var)
Prints content of variable to console/log.
DbgUI::List
static proto void List(string label, out int selection, TStringArray elems)
DbgUI::End
static proto native void End()
DbgUI::Begin
static proto native void Begin(string windowTitle, float x=0, float y=0)
DbgUI::Button
static proto native bool Button(string txt, int minWidth=0)
DbgUI::Text
static proto native void Text(string label)
DbgUI::InputText
static proto void InputText(string txt, out string value, int pxWidth=150)
DbgUI::Spacer
static proto native void Spacer(int height)
DbgUI::Check
static proto void Check(string label, out bool checked)
DbgUI::SliderFloat
static proto void SliderFloat(string label, out float value, float min, float max, int pxWidth=150)
OnUpdate
proto native void OnUpdate()
Definition tools.c:333

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();
}
OnEvent
override void OnEvent(EventType eventTypeId, Param params)
Handles VON-related events.
Definition ConnectErrorScriptModule.c:35
Param
Base Param Class with no parameters. Used as general purpose parameter overloaded with Param1 to Para...
Definition param.c:12
DbgUI::BeginCleanupScope
static proto void BeginCleanupScope()
DbgUI::EndCleanupScope
static proto native void EndCleanupScope()

Function Documentation

◆ Begin()

static proto native void DbgUI::Begin ( string windowTitle,
float x = 0,
float y = 0 )
staticprivate

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

◆ BeginCleanupScope()

static proto void DbgUI::BeginCleanupScope ( )
staticprivate

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

◆ Button()

static proto native bool DbgUI::Button ( string txt,
int minWidth = 0 )
staticprivate

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

◆ Check()

static proto void DbgUI::Check ( string label,
out bool checked )
staticprivate

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

◆ ColoredText()

static proto native void DbgUI::ColoredText ( int color,
string label )
staticprivate

◆ Combo()

static proto void DbgUI::Combo ( string label,
out int selection,
TStringArray elems )
staticprivate

◆ DbgUI()

void DbgUI::DbgUI ( )
inlineprivate

Definition at line 61 of file DbgUI.c.

61{}

◆ DoUnitTest()

static proto native void DbgUI::DoUnitTest ( )
staticprivate

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

◆ End()

static proto native void DbgUI::End ( )
staticprivate

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

◆ EndCleanupScope()

static proto native void DbgUI::EndCleanupScope ( )
staticprivate

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

◆ InputFloat()

static proto void DbgUI::InputFloat ( string txt,
out float value,
int pxWidth = 150 )
staticprivate

Referenced by PluginBase::OnGUITimer().

◆ InputInt()

static proto void DbgUI::InputInt ( string txt,
out int value,
int pxWidth = 150 )
staticprivate

Referenced by OnGUI().

◆ InputText()

static proto void DbgUI::InputText ( string txt,
out string value,
int pxWidth = 150 )
staticprivate

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

◆ List()

static proto void DbgUI::List ( string label,
out int selection,
TStringArray elems )
staticprivate

◆ Panel()

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

Referenced by OnGUI(), OnGUI_AnimEvents(), and ShowCoefsDbg().

◆ PlotLive()

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

◆ PopID()

static proto native void DbgUI::PopID ( )
staticprivate

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

◆ PushID_Int()

static proto native void DbgUI::PushID_Int ( int int_id)
staticprivate

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

◆ PushID_Str()

static proto native void DbgUI::PushID_Str ( string str_id)
staticprivate

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

◆ SameLine()

static proto native void DbgUI::SameLine ( )
staticprivate

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

◆ SameSpot()

static proto native void DbgUI::SameSpot ( )
staticprivate

◆ SliderFloat()

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

◆ Spacer()

static proto native void DbgUI::Spacer ( int height)
staticprivate

Referenced by OnGUI(), and ShowCoefsDbg().

◆ Text()

static proto native void DbgUI::Text ( string label)
staticprivate

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

◆ ~DbgUI()

void DbgUI::~DbgUI ( )
inlineprivate

Definition at line 62 of file DbgUI.c.

62{}