DashboardItemInputState

Inherits DashboardItem

This DashboardItem shows the current state of the different methods to provide user input: keyboard, mouse, and/or joystick.

Each input method has the ability to be selectively disabled, meaning that all inputs from that input method are ignored by the system entirely.

Members

Name	Documentation	Type	Description	Optional
FontName	This value is the name of the font that is used. It can either refer to an internal name registered previously, or it can refer to a path that is used.	String	Value of type ‘String’	Yes
FontSize	This value determines the size of the font that is used to render the distance.	Double	Value of type ‘Double’	Yes
ShowJoystick	Display the state of the joystick input.	Boolean	Value of type ‘Boolean’	Yes
ShowKeyboard	Display the state of the keyboard input.	Boolean	Value of type ‘Boolean’	Yes
ShowMouse	Display the state of the mouse input.	Boolean	Value of type ‘Boolean’	Yes
ShowWhenDisabled	Show text when the input is disabled.	Boolean	Value of type ‘Boolean’	Yes
ShowWhenEnabled	Show text when the input is enabled.	Boolean	Value of type ‘Boolean’	Yes

Inherited members from DashboardItem

Name	Documentation	Type	Description	Optional
Identifier	The unique identifier for this DashboardItem.	Identifier	An identifier string. May not contain ‘.’, spaces, newlines, or tabs	No
Type	Determines the type of the DashbordItem that should be created.	String	Value of type ‘String’	No
Enabled	If this value is set to ‘true’ this dashboard item is shown in the dashboard. Otherwise it will be hidden.	Boolean	Value of type ‘Boolean’	Yes
GuiName	The name for the DashboardItem that is used when showing it in the user interface.	String	Value of type ‘String’	Yes

Asset Examples

Only disabled

This example adds a dashboard item that shows the input state of the mouse, keyboard, and joystick input devices but only when they are disabled.

local Item = {
  Identifier = "DashboardItemInputState_Example_OnlyDisabled",
  Type = "DashboardItemInputState",
  ShowWhenDisabled = true
}

asset.onInitialize(function()
  openspace.dashboard.addDashboardItem(Item)
end)

asset.onDeinitialize(function()
  openspace.dashboard.removeDashboardItem(Item)
end)

Mouse Only

This example adds a dashboard item that only shows the input state of the mouse inputs.

local Item = {
  Identifier = "DashboardItemInputState_Example_MouseOnly",
  Type = "DashboardItemInputState",
  ShowKeyboard = false,
  ShowJoystick = false
}

asset.onInitialize(function()
  openspace.dashboard.addDashboardItem(Item)
end)

asset.onDeinitialize(function()
  openspace.dashboard.removeDashboardItem(Item)
end)

Basic

This example adds a dashboard item that shows the input state of the mouse, keyboard, and joystick input devices.

local Item = {
  Identifier = "DashboardItemInputState_Example",
  Type = "DashboardItemInputState"
}

asset.onInitialize(function()
  openspace.dashboard.addDashboardItem(Item)
end)

asset.onDeinitialize(function()
  openspace.dashboard.removeDashboardItem(Item)
end)