Getting started with Lua script in CEGUI

HowCEGUIUsed inLua scriptThis document describes how to get started.Lua scriptLanguage inCEGUIFor more information about how to use it, see the details in this article.

CEGUIThe script used is based on Lua5.0.2 and tolua ++ 1.06pre2-1.

A large part of interface compilation can be implemented through scripts. We can modify scripts without re-compiling the entire program,

This saves us a lot of time to design the interface.

CurrentLua scriptThe module is still in the initial development stage. It supports the vast majority of kernel systems and grass-roots window classes. However, some special controls can only be set through the properties system currently.

OK. Let's get started! You must have a certain level of CEGUI basics, such as initialization and window creation. Of course, you must have a certain level of Lua basics.
Initialization

The Lua script module contains all management classes. Therefore, you can use the Lua script to initialize the CEGUI. For example:

 
 

  
  
# Include "CEGUILua. h"
  
  
CEGUI: YourRendererOfChoice * renderer = new YourRendererOfChoice;
  
  
CEGUI: LuaScriptModule * script_module = new CEGUI: LuaScriptModule ();
  
  
 
  
  
// Set the xml Parser for the second parameter. 0 indicates the default parser.
  
  
New CEGUI: System (renderer, 0, script_module );
 
 

Now the CEGUI: System has been created and the script module has been specified. At this point, the LuaScriptModule constructor automatically creates a lua_State for us. You can also pass a lua_State * to the LuaScriptModule constructor to use your own lua_State.

If you use a UDF in the initialization script, you need to do so. The Code is as follows:

 
 

  
  
...     
  
  
lua_State* s = your_lua_state;     
  
  
CEGUI::LuaScriptModule* script_module = new CEGUI::LuaScriptModule(s);     
  
  
...   
 
 

Initialization/exit script

CEGUIA configuration file is supported. Its file name is an optional parameter of the CEGUI: System constructor. The default value is "cegui. config ".

By setting this configuration file, you can control whether to execute a script during system creation and destruction. The content of the configuration file is similar to the following:

 
 

  
  
<?xml version="1.0" ?>     
  
  
<CEGUIConfig     
  
  
    InitScript="../datafiles/scripts/init_script.lua"     
  
  
    TerminateScript="../datafiles/scripts/exit_script.lua"     
  
  
/>   
 
 

Init_script.lua will be executed during system initializationLua scriptFile. The content can be as follows:

Obtain CEGUI singletons

 
 

  
  
local logger = CEGUI.Logger:getSingleton()     
  
  
logger:logEvent( ">>> Init script says hello" )     
  
  
--logger:setLoggingLevel( CEGUI.Informative )    
 
 

Create a local variable for the singletons to be used)

 
 

  
  
local system    = CEGUI.System:getSingleton()     
  
  
local fontman   = CEGUI.FontManager:getSingleton()     
  
  
local schememan = CEGUI.SchemeManager:getSingleton()    
 
 

Load schemes

 
 

  
  
schememan:loadScheme( "../datafiles/schemes/TaharezLook.scheme" )     
  
  
schememan:loadScheme( "../datafiles/schemes/WindowsLook.scheme" )    
 
 

Load default font

 
 

  
  
local font = fontman:createFont( "../datafiles/fonts/Commonwealth-10.font" )    
 
 

Set Default mouse cursor

 
 

  
  
system:setDefaultMouseCursor( "TaharezLook","MouseArrow" )     
  
  
     
  
  
logger:logEvent( "<<< Init script says goodbye" )   
 
 

Initialization and exit are not required at the same time.ScriptHowever, if you are initializingScriptIf you have applied for a globally used bucket, you must exitScriptTo release it or in other appropriate places ).

Summary: howCEGUIUsed inLua scriptI hope this article will be helpful to you!