CEGUI Wiki - Crazy Eddie's GUI System (Open Source) - User contributions [en]

Adding LuaScriptModule to Sample FirstWindow

2005-07-02T15:54:42Z

Acrion: /* Create a Lua State */

This applies to the CEGUI 0.3.0 Release.

== Enable logging ==

Lua scripts get a lot of bugs. Without logging, you will never know why your application simply quits without stepping through every line of code.

In CEGuiSample.cpp
bool CEGuiSample::initialise()
{
. . .
default:
// TODO: Throw exception or something!
+ return false;
- break;
}
+ CEGUI::Logger *logger = &CEGUI::Logger::getSingleton();
+ logger->setLoggingLevel( CEGUI::Informative );
+#if defined( __WIN32__ ) || defined( _WIN32 )
+ logger->setLogFilename( "C:\\Sample_FirstWindow.log", true );
+#elif defined(linux)
+ logger->setLogFilename( "~/Sample_FirstWindow.log", true );
+#else
+ logger->setLogFilename( "Sample_FirstWindow.log", true );
+#endif
// execute the base application (which sets up the demo via 'this' and runs it.
if (d_sampleApp->execute(this))

== Create a Lua State ==

In Sample_FirstWindow.cpp
#include "CEGUI.h"
+ #include "../ScriptingModules/CEGUILua/LuaScriptModule/include/LuaScriptModule.h"

In Sample_FirstWindow.cpp
bool FirstWindowSample::initialiseSample()
{
using namespace CEGUI;

+ // create a lua_state by using [[User:Lindquist|Lindquist]]'s awesome LuaScriptModule
+ LuaScriptModule* lua = new LuaScriptModule();
+ // create the CEGUI namespace in the Lua environment
+ lua->createBindings();
. . .
// DefaultWindow which we will be using as the root of the displayed gui.
root->addChildWindow(wnd);
+ // call a script from our the datafiles
+ lua->executeScriptFile("../datafiles/scripts/sample.lua", "test");

== Create a Lua Script ==

In the Samples\datafiles directory
Create a scripts directory

Create sample.lua
-- get the GUI sheet
local sheet = CEGUI.WindowManager:getSingleton():getWindow("Root");

-- create a FrameWindow
local fw = CEGUI.WindowManager:getSingleton():createWindow ("TaharezLook/FrameWindow","framewnd");
-- add it to the sheet
sheet:addChildWindow(fw)

-- set its size and position
local sz = CEGUI.Size:new_local(0.5,0.5)
local pos = CEGUI.Point:new_local(0.2,0.1)
fw:setSize(sz)
fw:setPosition(pos)
fw:setText("Lua says Hello World!")
-- disable user sizing
fw:setProperty("SizingEnabled","False")

== Running ==

Now just compile and run.

Adding LuaScriptModule to Sample FirstWindow

2005-07-02T15:38:37Z

Acrion:

This applies to the CEGUI 0.3.0 Release.

== Enable logging ==

Lua scripts get a lot of bugs. Without logging, you will never know why your application simply quits without stepping through every line of code.

In CEGuiSample.cpp
bool CEGuiSample::initialise()
{
. . .
default:
// TODO: Throw exception or something!
+ return false;
- break;
}
+ CEGUI::Logger *logger = &CEGUI::Logger::getSingleton();
+ logger->setLoggingLevel( CEGUI::Informative );
+#if defined( __WIN32__ ) || defined( _WIN32 )
+ logger->setLogFilename( "C:\\Sample_FirstWindow.log", true );
+#elif defined(linux)
+ logger->setLogFilename( "~/Sample_FirstWindow.log", true );
+#else
+ logger->setLogFilename( "Sample_FirstWindow.log", true );
+#endif
// execute the base application (which sets up the demo via 'this' and runs it.
if (d_sampleApp->execute(this))

== Create a Lua State ==

In Sample_FirstWindow.cpp
bool FirstWindowSample::initialiseSample()
{
using namespace CEGUI;

+ // create a lua_state by using [[User:Lindquist|Lindquist]]'s awesome LuaScriptModule
+ LuaScriptModule* lua = new LuaScriptModule();
+ // create the CEGUI namespace in the Lua environment
+ lua->createBindings();
. . .
// DefaultWindow which we will be using as the root of the displayed gui.
root->addChildWindow(wnd);
+ // call a script from our the datafiles
+ lua->executeScriptFile("../datafiles/scripts/sample.lua", "test");

== Create a Lua Script ==

In the Samples\datafiles directory
Create a scripts directory

Create sample.lua
-- get the GUI sheet
local sheet = CEGUI.WindowManager:getSingleton():getWindow("Root");

-- create a FrameWindow
local fw = CEGUI.WindowManager:getSingleton():createWindow ("TaharezLook/FrameWindow","framewnd");
-- add it to the sheet
sheet:addChildWindow(fw)

-- set its size and position
local sz = CEGUI.Size:new_local(0.5,0.5)
local pos = CEGUI.Point:new_local(0.2,0.1)
fw:setSize(sz)
fw:setPosition(pos)
fw:setText("Lua says Hello World!")
-- disable user sizing
fw:setProperty("SizingEnabled","False")

== Running ==

Now just compile and run.

Tutorials

2005-07-02T15:38:30Z

Acrion:

=== CrazyEddie's Beginner Guides ===
* [[The Beginner Guide to Getting CEGUI Rendering]] - How to initialise CEGUI to render properly.
* [[The Beginner Guide to Loading Data Files and Initialisation]] - How to load some data files and perform basic system initialisation.
* [[The Beginner Guide to Creating a CEGUI Window]] - How to create a simple window and get it on screen.
* [[The Beginner Guide to Injecting Inputs]] - How to inject inputs into CEGUI and get interactive.

=== Lua Scripting with CEGUI ===
* [[Getting Started with Lua and CEGUI]] - How to initialise CEGUI with a Lua script module and configuration file.
* [[Handling Events from Lua]] - How to load Lua script files and bind CEGUI events to Lua functions.
* [[Writing CEGUI scripts]] - Code snippets
* [[Adding LuaScriptModile to Sample_FirstWindow]] - Experience adding scripting to an existing sample.

=== SDL Tutorials ===
* [[Using CEGUI with SDL and OpenGL]] - Guidelines on how to get SDL, OpenGL and CEGUI running together.