Gui Command

From LabRPS Documentation
Jump to navigation Jump to search

The GuiCommand is one of the most important functions of LabRPS in the main interaction point of the user. Every time the user selects a menu item or presses a toolbar button it activates a GuiCommand. Some of the attributes of a GuiCommand are:

  • Defines a name
  • Contains an icon
  • Defines the scope for an undo/redo
  • Has a help page
  • Opens and controls dialogs
  • Macro recording
  • and others.

Naming

The GuiCommand is named in a standard way: ModuleName_CommandName e.g., "Base_Open" this is the Open Gui Command in the Base system. The GuiCommand in a certain module is named with the module name in front e.g., "WindLab_New".

Help page

Every GuiCommand has to have a help page. The help page is hosted on the LabRPS documentation wiki. The article has the same name as the GuiCommand.