_________ __                 __
        /   _____//  |_____________ _/  |______     ____  __ __  ______
        \_____  \\   __\_  __ \__  \\   __\__  \   / ___\|  |  \/  ___/
        /        \|  |  |  | \// __ \|  |  / __ \_/ /_/  >  |  /\___ \
       /_______  /|__|  |__|  (____  /__| (____  /\___  /|____//____  >
               \/                  \/          \//_____/            \/
    ______________________                           ______________________
                          T H E   W A R   B E G I N S
                   Stratagus - A free fantasy real time strategy game engine

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
script_ui.cpp File Reference
#include "stratagus.h"
#include "ui.h"
#include "font.h"
#include "interface.h"
#include "map.h"
#include "menus.h"
#include "script.h"
#include "spells.h"
#include "title.h"
#include "util.h"
#include "ui/contenttype.h"
#include "ui/popup.h"
#include "unit.h"
#include "unit_manager.h"
#include "unittype.h"
#include "video.h"

script_ui.cpp - The ui ccl functions.

std::string ClickMissile
 The user interface. More...
 
std::string DamageMissile
 FIXME:docu. More...
 
std::map< std::string,
ButtonStyle * > 
ButtonStyleHash
 FIXME:docu. More...
 
static int HandleCount = 1
 
CPreference Preference
 Lua handler count. More...
 
static int CclSetKeyScrollSpeed (lua_State *l)
 
static int CclGetKeyScrollSpeed (lua_State *l)
 
static int CclSetMouseScrollSpeed (lua_State *l)
 
static int CclGetMouseScrollSpeed (lua_State *l)
 
static int CclSetMouseScrollSpeedDefault (lua_State *l)
 
static int CclGetMouseScrollSpeedDefault (lua_State *l)
 
static int CclSetMouseScrollSpeedControl (lua_State *l)
 
static int CclGetMouseScrollSpeedControl (lua_State *l)
 
static int CclSetClickMissile (lua_State *l)
 
static int CclSetDamageMissile (lua_State *l)
 
static int CclSetMaxOpenGLTexture (lua_State *l)
 
static int CclSetUseTextureCompression (lua_State *l)
 
static int CclSetUseOpenGL (lua_State *l)
 
static int CclGetUseOpenGL (lua_State *l)
 
static int CclSetZoomNoResize (lua_State *l)
 
static int CclSetVideoResolution (lua_State *l)
 
static int CclGetVideoResolution (lua_State *l)
 
static int CclSetVideoFullScreen (lua_State *l)
 
static int CclGetVideoFullScreen (lua_State *l)
 
static int CclSetTitleScreens (lua_State *l)
 
EnumVariable Str2EnumVariable (lua_State *l, const char *s)
 Damage calculation for missile. More...
 
static ConditionPanelParseConditionPanel (lua_State *l)
 
static CContentTypeCclParseContent (lua_State *l)
 
static int CclDefinePanelContents (lua_State *l)
 
static int CclDefinePopup (lua_State *l)
 
static int CclDefineViewports (lua_State *l)
 
static int CclRightButtonAttacks (lua_State *l)
 
static int CclRightButtonMoves (lua_State *l)
 
static int CclSetFancyBuildings (lua_State *l)
 
ButtonStyleFindButtonStyle (const std::string &style)
 Find a button style. More...
 
static void ParseButtonStyleProperties (lua_State *l, ButtonStyleProperties *p)
 
static int CclDefineButtonStyle (lua_State *l)
 
int AddHandler (lua_State *l)
 
void CallHandler (unsigned int handle, int value)
 
static int CclDefineButton (lua_State *l)
 
void SelectionChanged ()
 Called whenever the units selection is altered. More...
 
void SelectedUnitChanged ()
 Called whenever the selected unit was updated. More...
 
static int CclSetSelectionStyle (lua_State *l)
 
static int CclAddMessage (lua_State *l)
 
static int CclSetGroupKeys (lua_State *l)
 
static int CclPresentMap (lua_State *l)
 
static int CclDefineMapSetup (lua_State *l)
 
void UserInterfaceCclRegister ()
 Register ccl features. More...
 

Function Documentation

int AddHandler ( lua_State *  l)

Add a Lua handler FIXME: when should these be freed?

void CallHandler ( unsigned int  handle,
int  value 
)

Call a Lua handler

static int CclAddMessage ( lua_State *  l)
static

Add a new message.

Parameters
lLua state.
static int CclDefineButton ( lua_State *  l)
static

Define a button.

Parameters
lLua state.
static int CclDefineButtonStyle ( lua_State *  l)
static

Define a button style

Parameters
lLua state.
static int CclDefineMapSetup ( lua_State *  l)
static

Define the lua file that will build the map

Parameters
lLua state.
static int CclDefinePanelContents ( lua_State *  l)
static

Define the Panels. Define what is shown in the panel(text, icon, variables)

Parameters
lLua state.
Returns
0.
static int CclDefinePopup ( lua_State *  l)
static

Define the Panels. Define what is shown in the panel(text, icon, variables)

Parameters
lLua state.
Returns
0.
static int CclDefineViewports ( lua_State *  l)
static

Define the viewports.

Parameters
lLua state.
static int CclGetKeyScrollSpeed ( lua_State *  l)
static

Get speed of key scroll

Parameters
lLua state.
static int CclGetMouseScrollSpeed ( lua_State *  l)
static

Get speed of mouse scroll

Parameters
lLua state.
static int CclGetMouseScrollSpeedControl ( lua_State *  l)
static

Get speed of ctrl-middle-mouse scroll

Parameters
lLua state.
static int CclGetMouseScrollSpeedDefault ( lua_State *  l)
static

Get speed of middle-mouse scroll

Parameters
lLua state.
static int CclGetUseOpenGL ( lua_State *  l)
static
static int CclGetVideoFullScreen ( lua_State *  l)
static

Get the video fullscreen mode.

Parameters
lLua state.
static int CclGetVideoResolution ( lua_State *  l)
static

Get the video resolution.

Parameters
lLua state.
static CContentType* CclParseContent ( lua_State *  l)
static
static int CclPresentMap ( lua_State *  l)
static

Set basic map caracteristics.

Parameters
lLua state.
static int CclRightButtonAttacks ( lua_State *  l)
static

Fighter right button attacks as default.

Parameters
lLua state.
static int CclRightButtonMoves ( lua_State *  l)
static

Fighter right button moves as default.

Parameters
lLua state.
static int CclSetClickMissile ( lua_State *  l)
static

Set which missile is used for right click

Parameters
lLua state.
static int CclSetDamageMissile ( lua_State *  l)
static

Set which missile shows Damage

Parameters
lLua state.
static int CclSetFancyBuildings ( lua_State *  l)
static

Enable/disable the fancy buildings.

Parameters
lLua state.
static int CclSetGroupKeys ( lua_State *  l)
static

Set the keys which are use for grouping units, helpful for other keyboards

Parameters
lLua state.
static int CclSetKeyScrollSpeed ( lua_State *  l)
static

Set speed of key scroll

Parameters
lLua state.
static int CclSetMaxOpenGLTexture ( lua_State *  l)
static
static int CclSetMouseScrollSpeed ( lua_State *  l)
static

Set speed of mouse scroll

Parameters
lLua state.
static int CclSetMouseScrollSpeedControl ( lua_State *  l)
static

Set speed of ctrl-middle-mouse scroll

Parameters
lLua state.
static int CclSetMouseScrollSpeedDefault ( lua_State *  l)
static

Set speed of middle-mouse scroll

Parameters
lLua state.
static int CclSetSelectionStyle ( lua_State *  l)
static

Set selection style.

Parameters
lLua state.
static int CclSetTitleScreens ( lua_State *  l)
static

Default title screens.

Parameters
lLua state.
static int CclSetUseOpenGL ( lua_State *  l)
static
static int CclSetUseTextureCompression ( lua_State *  l)
static
static int CclSetVideoFullScreen ( lua_State *  l)
static

Set the video fullscreen mode.

Parameters
lLua state.
static int CclSetVideoResolution ( lua_State *  l)
static

Set the video resolution.

Parameters
lLua state.
static int CclSetZoomNoResize ( lua_State *  l)
static
ButtonStyle* FindButtonStyle ( const std::string &  style)

Find a button style.

Find a button style

Parameters
styleName of the style to find.
Returns
Button style, NULL if not found.
static void ParseButtonStyleProperties ( lua_State *  l,
ButtonStyleProperties p 
)
static

Parse button style properties

Parameters
lLua state.
pProperties to fill in.
static ConditionPanel* ParseConditionPanel ( lua_State *  l)
static

Parse the condition Panel.

Parameters
lLua State.
void SelectedUnitChanged ( )

Called whenever the selected unit was updated.

The selected unit has been altered.

void SelectionChanged ( )

Called whenever the units selection is altered.

Run the set-selection-changed-hook.

EnumVariable Str2EnumVariable ( lua_State *  l,
const char *  s 
)

Damage calculation for missile.

Return enum from string about variable component.

Parameters
lLua State.
sstring to convert.
Returns
Corresponding value.
Note
Stop on error.
void UserInterfaceCclRegister ( )

Register ccl features.

Register CCL features for UI.

Variable Documentation

std::map<std::string, ButtonStyle *> ButtonStyleHash

FIXME:docu.

Missile to show damage caused.

std::string ClickMissile

The user interface.

std::string DamageMissile

FIXME:docu.

Missile to show when you click.

int HandleCount = 1
static
CPreference Preference

Lua handler count.

(C) Copyright 1998-2012 by The Stratagus Project under the GNU General Public License.
All trademarks and copyrights on this page are owned by their respective owners.