Command Window class for Debug purpose. More...

Inheritance diagram for VerticesEngine.Diagnostics.vxDebugCommandUI:

Public Member Functions
override bool	RegisterCommand ()

	vxDebugCommandUI ()
	Constructor.

void	RegisterCommand (string command, string description, DebugCommandExecute callback)
	Register new command with the Debug Command UI.

void	RegisterCommand (string[] commands, string description, DebugCommandExecute callback)
	Register an array of new commands for a specific function with the Debug Command UI.

void	UnregisterCommand (string command)
	Unregister new command with the Debug Command UI.

void	ExecuteCommand (string command, bool IsCmdLine=false)
	Executes command.

void	RegisterEchoListner (IDebugEchoListner listner)
	Register message listener.

void	UnregisterEchoListner (IDebugEchoListner listner)
	Unregister message listener.

void	Echo (DebugCommandMessage messageType, string text)
	Output message.

void	Echo (string text)
	Output Standard message.

void	EchoCMD (string text)

void	PushExecutioner (IDebugCommandExecutioner executioner)
	Output Warning message.

void	PopExecutioner ()
	Remote Command executioner.

override string	GetCommand ()
	Gets the command.

override string	GetDescription ()
	Gets the description.

void	Show ()
	Show Debug Command window.

void	Hide ()
	Hide Debug Command window.

void	ProcessKeyInputs (float dt)
	Hand keyboard input.

Public Member Functions inherited from VerticesEngine.Diagnostics.vxDebugUIControlBaseClass
	vxDebugUIControlBaseClass (string toolName)

virtual void	CommandExecute (IDebugCommandHost host, string command, IList< string > args)
	Called when the main 'command' linked to this debug tool is called.

Public Member Functions inherited from VerticesEngine.vxGameObject
virtual void	OnEnabled ()
	Called on Component Enabled.

virtual void	OnDisabled ()
	Called on Component Disabled.

virtual void	OnSelected ()
	Called when Selected.

virtual void	OnUnSelected ()
	Called when Unselected.

virtual string	GetTitle ()
	Gets the title.

virtual Texture2D	GetIcon (int w, int h)
	Gets the icon for this game object. Override this to provide per-entity cusomtization.

	vxGameObject ()
	Creates a new vxGameObject.

void	Dispose ()
	Dispposes this Object.

virtual void	OnGraphicsRefresh ()
	Called when there is a reset or refresh of Graphic settings such as resolution or setting.

Public Attributes
string	Prompt
	Gets/Sets Prompt string.

Public Attributes inherited from VerticesEngine.vxGameObject
bool	OnlySelectInSandbox = false

Static Public Attributes
const string	DefaultPrompt = "CMD>"
	Default Prompt string.

Static Public Attributes inherited from VerticesEngine.vxGameObject
static List< string >	NameRegister = new List<string>()
	The name register.

Properties
bool	Focused `[get]`
	Is it waiting for key inputs?

Properties inherited from VerticesEngine.Diagnostics.vxDebugUIControlBaseClass
string	DebugToolName `[get]`

Properties inherited from VerticesEngine.vxGameObject
bool	IsVisible `[get, set]`
	Is this Game Object currently visible? Note that an Object can be Enabled, but not visible.

bool	IsEnabled `[get, set]`
	Is this Game Object Enabled currently.

string	Id `[get, set]`
	A unqiue string id which allows references to items to be serialised between sessions.

Texture2D	DefaultTexture `[get]`
	Gets the default texture.

vxEnumSandboxStatus	SandboxState `[get]`
	State of the Entity which is triggered by the simulation.

vxSelectionState	SelectionState `[get, set]`
	Gets or sets the selection state.

vxSelectionState	PreviousSelectionState `[get]`
	Get's the previous selection state.

bool	IsDisposed `[get]`

Additional Inherited Members
Protected Member Functions inherited from VerticesEngine.Diagnostics.vxDebugUIControlBaseClass
virtual void	AddArgument (string arg, string description, DebugCommandExecute callback)

Protected Member Functions inherited from VerticesEngine.vxGameObject
virtual void	OnVisibilityChanged ()
	Called when an Objects Visibility Changes.

virtual bool	HasId ()

virtual void	OnSelectionStateChange ()
	Called when the selection state changes.

virtual string	GetIdPrefix ()

virtual void	OnDisposed ()
	Called when the entity is disposed.

Events inherited from VerticesEngine.vxGameObject
EventHandler< EventArgs >	Selected
	Event Fired when the Items Selection stat Changes too Hovered.

EventHandler< EventArgs >	UnSelected
	Event Fired when the Items Selection stat Changes too unselected (or unhovered)

Detailed Description

Command Window class for Debug purpose.

Debug command UI that runs in the Game. You can type commands using the keyboard, even on the Xbox just connect a USB keyboard to it This works on all 3 platforms (Xbox, Windows, Phone)

How to Use: 1) Add this component to the game. 2) Register command by RegisterCommand method. 3) Open/Close Debug window by Tab key.

Member Function Documentation

◆ Echo() [1/2]

void VerticesEngine.Diagnostics.vxDebugCommandUI.Echo	(	DebugCommandMessage	messageType,
		string	text )

Output message.

Parameters

messageType	type of message
text	message text

Implements VerticesEngine.Diagnostics.IDebugEchoListner.

◆ Echo() [2/2]

void VerticesEngine.Diagnostics.vxDebugCommandUI.Echo ( string text )

Output Standard message.

Parameters

text

Implements VerticesEngine.Diagnostics.IDebugCommandHost.

◆ EchoCMD()

void VerticesEngine.Diagnostics.vxDebugCommandUI.EchoCMD ( string text )

Implements VerticesEngine.Diagnostics.IDebugCommandHost.

◆ ExecuteCommand()

void VerticesEngine.Diagnostics.vxDebugCommandUI.ExecuteCommand	(	string	command,
		bool	IsCmdLine = false )

Executes command.

Parameters

command Command.

Implements VerticesEngine.Diagnostics.IDebugCommandExecutioner.

◆ GetCommand()

override string VerticesEngine.Diagnostics.vxDebugCommandUI.GetCommand ( )

virtual

Gets the command.

Returns: The command.

Reimplemented from VerticesEngine.Diagnostics.vxDebugUIControlBaseClass.

◆ GetDescription()

override string VerticesEngine.Diagnostics.vxDebugCommandUI.GetDescription ( )

virtual

Gets the description.

Returns: The description.

Reimplemented from VerticesEngine.Diagnostics.vxDebugUIControlBaseClass.

◆ PopExecutioner()

void VerticesEngine.Diagnostics.vxDebugCommandUI.PopExecutioner ( )

Remote Command executioner.

Implements VerticesEngine.Diagnostics.IDebugCommandHost.

◆ ProcessKeyInputs()

void VerticesEngine.Diagnostics.vxDebugCommandUI.ProcessKeyInputs ( float dt )

Hand keyboard input.

Parameters

dt

◆ PushExecutioner()

void VerticesEngine.Diagnostics.vxDebugCommandUI.PushExecutioner ( IDebugCommandExecutioner executioner )

Output Warning message.

Parameters

text

Add Command executioner.

Parameters

executioner Executioner.

Implements VerticesEngine.Diagnostics.IDebugCommandHost.

◆ RegisterCommand() [1/3]

override bool VerticesEngine.Diagnostics.vxDebugCommandUI.RegisterCommand ( )

virtual

Reimplemented from VerticesEngine.Diagnostics.vxDebugUIControlBaseClass.

◆ RegisterCommand() [2/3]

void VerticesEngine.Diagnostics.vxDebugCommandUI.RegisterCommand	(	string	command,
		string	description,
		DebugCommandExecute	callback )

Register new command with the Debug Command UI.

Parameters

command	command name
description	description of command
callback	Execute delegation

Implements VerticesEngine.Diagnostics.IDebugCommandHost.

◆ RegisterCommand() [3/3]

void VerticesEngine.Diagnostics.vxDebugCommandUI.RegisterCommand	(	string[]	commands,
		string	description,
		DebugCommandExecute	callback )

Register an array of new commands for a specific function with the Debug Command UI.

Parameters

command	command name
description	description of command
callback	Execute delegation

◆ RegisterEchoListner()

void VerticesEngine.Diagnostics.vxDebugCommandUI.RegisterEchoListner ( IDebugEchoListner listner )

Register message listener.

Parameters

listner

Implements VerticesEngine.Diagnostics.IDebugCommandHost.

◆ UnregisterCommand()

void VerticesEngine.Diagnostics.vxDebugCommandUI.UnregisterCommand ( string command )

Unregister new command with the Debug Command UI.

Parameters

command command name

Implements VerticesEngine.Diagnostics.IDebugCommandHost.

◆ UnregisterEchoListner()

void VerticesEngine.Diagnostics.vxDebugCommandUI.UnregisterEchoListner ( IDebugEchoListner listner )

Unregister message listener.

Parameters

listner

Implements VerticesEngine.Diagnostics.IDebugCommandHost.

The documentation for this class was generated from the following file:

/github/workspace/src/VerticesEngine/src.shared/Utilities/DebugTools/Controls/vxDebugCommandUI.cs

Public Member Functions

Public Attributes

Static Public Attributes

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Echo() [1/2]

◆ Echo() [2/2]

◆ EchoCMD()

◆ ExecuteCommand()

◆ GetCommand()

◆ GetDescription()

◆ PopExecutioner()

◆ ProcessKeyInputs()

◆ PushExecutioner()

◆ RegisterCommand() [1/3]

◆ RegisterCommand() [2/3]

◆ RegisterCommand() [3/3]

◆ RegisterEchoListner()

◆ UnregisterCommand()

◆ UnregisterEchoListner()