Skip to content

Toolbar

Extends: VBoxContainer

Description

This is wrapper class to the category bar of a set of tools on the left side of the UI.

Properties

String Title
String ForceTool
Label title
Button backButton
Dictionary panels

Methods

void OnSelectTool ( String name, String label )
void OnDeselectTool ( String name )
ToolPanel CreateTool ( String name, String label, String icon, bool mod = false )

Property Descriptions

  • String Title:
    Gets the title displayed. Read only. Change title Label instead if you want to modify that text.
  • String ForceTool:
    The name of the Tool that would be enabled if this specific toolbar was displayed.
  • Label title:
    Gets the UI element that displays the title.
  • Button backButton:
    Gets the back button.

Method Descriptions

  • void OnSelectTool ( String name, String label ):
    Called when a tool is enabled so the toolbar would switch to the proper ToolPanel and update the title.
  • void OnDeselectTool ( String name ):
    Called when a tool is disabled so the toolbar would hide its ToolPanel.
  • ToolPanel CreateTool ( String name, String label, String icon, bool mod = false ):
    Creates a new tool to be added to the tool bar and return a new tool panel to modify. The real reason you came to this page.