Diag menu API definition

Data Structures
class	DiagMenu

Functions
static proto bool	IsInitialized ()
	Checks if DiagMenu is initialized.
static proto void	InitScriptDiags ()
	To be used before registering scripted diags.
static proto void	ClearScriptDiags ()
	To be used when scripted diags should not be present.
static proto void	RegisterMenu (int id, string name, int parent)
	Register a new menu.
static proto void	RegisterItem (int id, string shortcut, string name, int parent, string values, func callback=null)
	Register a new item.
static proto void	RegisterBool (int id, string shortcut, string name, int parent, bool reverse=false, func callback=null)
	Register a new bool item.
static proto void	RegisterRange (int id, string shortcut, string name, int parent, string valuenames, func callback=null)
	Register a new range item.
static proto void	Unregister (int id)
	Unregister the item at given id.
static proto bool	IsRegistered (int id)
	Check if the item at given id has been registered.
static proto bool	BindCallback (int id, func callback)
	Bind a callback to the given id.
static proto void	UnbindCallback (int id)
	Unbind the callback from the given id.
static proto bool	GetBool (int id, bool reverse=false)
	Get value as bool from the given script id.
static proto int	GetValue (int id)
	Get value as int from the given script id.
static proto void	SetValue (int id, int value)
	Set value at the given script id.
static proto float	GetRangeValue (int id)
	Get range value at the given script id.
static proto void	SetRangeValue (int id, float value)
	Set range value at the given script id.
static proto int	GetEngineValue (int id)
	Get value at the given engine id.
static proto void	SetEngineValue (int id, int value)
	Set value at the given engine id.
static proto float	GetEngineRangeValue (int id)
	Get range value at the given engine id.
static proto void	SetEngineRangeValue (int id, float value)
	Set range value at the given engine id.
static proto bool	MenuExists (string name)
	Check if a menu with supplied name already exists.

Variables
	INFO
	WARNING
	ERROR
	FIRSTCONTACT
	NEARESTCONTACT
	ONLYSTATIC
	ONLYDYNAMIC
	ONLYWATER
	ALLOBJECTS
class DiagMenu	Shape ()
	don't call destructor directly. Use Destroy() instead

Detailed Description

Function Documentation

BindCallback()

static proto bool BindCallback ( int  id, func  callback  )

staticprivate

Bind a callback to the given id.

Note

Only one callback can be registered, so when attempting to registering multiple, only the last one will be present

The callbacks are required to have one of following signatures

• All Register... support: o static void Callback();
• RegisterItem & RegisterBool: o static void Callback(int value); o static void Callback(int value, int id); o static void Callback(bool value); o static void Callback(bool value, int id);
• RegisterRange: o static void Callback(float value); o static void Callback(float value, int id); o static void Callback(int value); o static void Callback(int value, int id);

Keep in mind that bool and int are interchangeable, so 'bool value' is possible for RegisterRange too

ClearScriptDiags()

static proto void ClearScriptDiags ( )

staticprivate

To be used when scripted diags should not be present.

GetBool()

static proto bool GetBool ( int  id, bool  reverse = false  )

staticprivate

Get value as bool from the given script id.

Referenced by ApplyEyeAcco(), CalculateBreadCrumbs(), CalculateLinePointFade(), MissionBase::DisplayHairDebug(), ManBase::EEHitBy(), ActionTargets::FilterObstructedObjectsEx(), GatherSurfaces(), EntityAI::GetFlipContext(), GetMeleeTargetEx(), Hologram::GetProjectionEntityPosition(), Hologram::IsCollidingBBox(), BaseBuildingBase::OnDebugSpawnBuildExcludes(), PlayerSoundEventBase::OnPlay(), Managed::OnScheduledTick(), EntityPlacementCallback::OnSetup(), SymptomManager::OnTick(), CGame::OnUpdate(), OnUpdate(), MissionBase::OnUpdate(), SpookyEventBase::Perform(), ProcessLighting(), SelectEvent(), DeveloperTeleport::TeleportAtCursor(), DeveloperTeleport::TeleportAtCursorEx(), Tick(), ActionTargets::Update(), ScriptedWidgetEventHandler::Update(), UIScriptedMenu::Update(), and ActionMenu::UpdateWidgets().

GetEngineRangeValue()

static proto float GetEngineRangeValue ( int  id )

staticprivate

Get range value at the given engine id.

Referenced by DayZPlayer::CommandHandlerDebug().

GetEngineValue()

static proto int GetEngineValue ( int  id )

staticprivate

Get value at the given engine id.

Referenced by CheckShowMode(), DayZPlayer::CommandHandler(), and DayZPlayer::HeadingModel().

GetRangeValue()

static proto float GetRangeValue ( int  id )

staticprivate

Get range value at the given script id.

Referenced by SymptomManager::OnTick().

GetValue()

static proto int GetValue ( int  id )

staticprivate

Get value as int from the given script id.

Referenced by DayZPlayer::HandleWeapons(), MissionBase::ShowHairDebugValues(), and Weapon::UseWeaponObstruction().

InitScriptDiags()

static proto void InitScriptDiags ( )

staticprivate

To be used before registering scripted diags.

IsInitialized()

static proto bool IsInitialized ( )

staticprivate

Checks if DiagMenu is initialized.

Referenced by ScriptedWidgetEventHandler::RandomizePageIndex().

IsRegistered()

static proto bool IsRegistered ( int  id )

staticprivate

Check if the item at given id has been registered.

MenuExists()

static proto bool MenuExists ( string  name )

staticprivate

Check if a menu with supplied name already exists.

RegisterBool()

static proto void RegisterBool ( int  id, string  shortcut, string  name, int  parent, bool  reverse = false, func  callback = null  )

staticprivate

Register a new bool item.

Note

This is just a RegisterItem with value="true,false" or when reversed value="false,true"

Parameters

id	int The unique ID of the item in the range [0,512]
shortcut	string The keyboard shortcut of the item
name	string The name of the item
parent	string The index of the parent of the item
values	string The values of the item, separated by commas
reverse	bool Whether to reverse the bool (OPTIONAL)
callback	func Callback to call when the value is changed (OPTIONAL) (Also read BindCallback)

RegisterItem()

static proto void RegisterItem ( int  id, string  shortcut, string  name, int  parent, string  values, func  callback = null  )

staticprivate

Register a new item.

Parameters

id	int The unique ID of the item in the range [0,512]
shortcut	string The keyboard shortcut of the item
name	string The name of the item
parent	int The index of the parent of the item
values	string The values of the item separated by commas, internally this will be an int starting at 0 for the first item
callback	func Callback to call when the value is changed (OPTIONAL) (Also read BindCallback)

RegisterMenu()

static proto void RegisterMenu ( int  id, string  name, int  parent  )

staticprivate

Register a new menu.

Parameters

id	int The unique ID of the menu in the range [0,512]
name	string The name of the menu
parent	int The index of the parent of the menu

RegisterRange()

static proto void RegisterRange ( int  id, string  shortcut, string  name, int  parent, string  valuenames, func  callback = null  )

staticprivate

Register a new range item.

Parameters

id	int The unique ID of the item in the range [0,512]
shortcut	string The keyboard shortcut of the item
name	string The name of the item
parent	int The index of the parent of the item
values	string Range specification in format "min,max,startValue,step"
callback	func Callback to call when the value is changed (OPTIONAL) (Also read BindCallback)

SetEngineRangeValue()

static proto void SetEngineRangeValue ( int  id, float  value  )

staticprivate

Set range value at the given engine id.

SetEngineValue()

static proto void SetEngineValue ( int  id, int  value  )

staticprivate

Set value at the given engine id.

SetRangeValue()

static proto void SetRangeValue ( int  id, float  value  )

staticprivate

Set range value at the given script id.

SetValue()

static proto void SetValue ( int  id, int  value  )

staticprivate

Set value at the given script id.

Referenced by ManBase::SetBloodyHandsBase(), and SetModifiers().

UnbindCallback()

static proto void UnbindCallback ( int  id )

staticprivate

Unbind the callback from the given id.

Unregister()

static proto void Unregister ( int  id )

staticprivate

Unregister the item at given id.

Variable Documentation

ALLOBJECTS

ALLOBJECTS

ERROR

ERROR

FIRSTCONTACT

FIRSTCONTACT

INFO

INFO

NEARESTCONTACT

NEARESTCONTACT

ONLYDYNAMIC

ONLYDYNAMIC

ONLYSTATIC

ONLYSTATIC

ONLYWATER

ONLYWATER

Shape

class DiagMenu Shape

(

)

don't call destructor directly. Use Destroy() instead

Instance of created debug visualizer

Referenced by Debug::CleanupDrawShapes(), Transport::DebugFreeAreaAtDoor(), EntityAI::DebugFreeAreaAtDoor(), EntityAI::DetectFlippedUsingSurface(), ComponentEnergyManager::DrawArrow(), Debug::DrawArrow(), CfgPlayerRestrictedAreaHandler::DrawBoxesDebug(), Debug::DrawBoxEx(), Debug::DrawCube(), Debug::DrawCylinder(), Debug::DrawFrustum(), ScriptConsoleItemsTab::DrawItems(), ScriptConsoleItemsTab::DrawItemsClear(), Debug::DrawLine(), Debug::DrawLines(), CfgPlayerRestrictedAreaHandler::DrawPolygonLinesDebug(), Debug::DrawSphere(), EntityPlacementCallback::OnDebug(), OnUpdate(), and Debug::RemoveShape().

WARNING

WARNING