$GUI

From HEWIKI
Jump to: navigation, search

Contents

See also Adapting Clean Engine for instructions on how to adapt the Account System Node for your own game

The $GUI System Node is used for creating and managing GUI Controls, GUI Layers and other types of GUI elements via many utility methods. The $GUI System Node is implemented in the _GUIClassMethods client script.


Usage

Below is a list of commonly used $GUI system node methods. The full list of methods can be found in the _GUIClassMethods client script.


This is has the list of valid Clean Engine GUI Layers. This method can be overridden by HE_validGUILayersList().

method _validGUILayersList() as List of String


This returns the master GUI Layer or creates one if it's not found. In Clean Engine the master layer is the "default" layer. This method can be overridden by HE_getGUIMasterLayer().

method _getGUIMasterLayer() as NodeRef of Class _GUIMasterLayer.


This returns the GUI Layer Control with the specified name. If it's found the GUI Layer is cached for faster access later. This method can be overridden by HE_findLayerByName().

method _findLayerByName(layerName as String) as NodeRef of Class _GUILayer


This creates a new GUI Layer with the specified name. This method can be overriden by HE_newGUILayer().

method _newGUILayer(layerName as String) as NodeRef of Class _GUILayer


This method hides the GUI Layer with the specified name. This method can be overridden by HE_hideLayerByName().

method _hideLayerByName(layerName as String)


This checks if GUI Layers are enabled. The method HE_GUILayersEnabled() must be implemented to provide this with functionality.

method _GUILayersEnabled() as Boolean


This method returns if the Control, Alt or Shift key is being pressed. This method uses the GetKeyBoardModifiers() external function.

method GetKeyStates() as Class KeyBoardModifiers


This opens a file dialog window for a specific control. This uses the ShowFileDialog() external function.

method LaunchFileDialogForControl(theControl as NodeRef of Class GUIControl, title as String, filter as String, startpath as String, iconview as Boolean)


See Also

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox