Window Scripts Entry Points

Back

You can define these functions in your window Lua scripts and they will be called by the engine. Most of these functions are called during the normal gameplay in the game Lua state. An exception is __get_name.

There are two types of windows: Game Windows and HUD windows. Some of these functions only apply to Game Windows and others only apply to HUD windows.

Window Lua scripts are Lua scripts found in the Windows directory (and its subdirectories) of your package.

Window Script Functions

string __get_name(int wid);
void __start(int wid);                  //Game windows only.
void __end(int wid);                    //Game windows only.
void __pop(int wid);                    //Game windows only.
void __pushed_upon(int wid);            //Game windows only.
void __hud_add(int wid);                //HUD windows only.
void __hud_remove(int wid);             //HUD windows only.
void __process_input(int wid);
void __render(int wid);
void __update_always(int wid);
void __update_on_stack(int wid);        //Game windows only.
void __update_on_stack_top(int wid);    //Game windows only.
void __update_on_hud(int wid);          //HUD windows only.