Changes between Version 4 and Version 5 of code/doc/GUI

Timestamp:

Apr 30, 2009, 2:31:05 PM (16 years ago)

Author:

bknecht

Comment:

—

code/doc/GUI

@@ -39 +39 @@
 Lua-scripts are written in Lua and implement the functionalities of CEGUI like interactivity. Each GUI needs a separate Lua-script which will be loaded by the main script. Our implementation ensures that a GUI cannot be loaded more than once.
 
-Usually you would set some variables and define some events inside the Lua-script. You may want for instance to define what layout you want to load. Check out the existing scripts to get an idea of the intended use.
+If you want to create a new GUI you need to create a lua file with the following header. Of course you would change ''mainmenu'' to the name of your GUI. The name of the GUI and the filename should be the same. 
+{{{
+gui = require("gui")
+local P = gui:new() --inherit everything from the gui package
 
-To load a GUI you can just call the showGUI()-function of the GUIManager with the file name of your Lua-script:
+mainmenu = P
+
+P.filename = "mainmenu"
+P.layoutString = "MainMenu.layout"
+
+...
+
+return mainmenu
+}}}
+
+Specify events in your GUI as follows:
+{{{
+-- events for mainmenu
+function P.button_quit_clicked(e)
+  ... -- do something
+end
+}}}
+
+To load a GUI from inside Orxonox, you can just call the showGUI()-function of the GUIManager with the file name of your Lua-script:
 {{{
 // shows the GUI called "mainmenu" and loads it beforehand if necessary