_________ __                 __
        /   _____//  |_____________ _/  |______     ____  __ __  ______
        \_____  \\   __\_  __ \__  \\   __\__  \   / ___\|  |  \/  ___/
        /        \|  |  |  | \// __ \|  |  / __ \_/ /_/  >  |  /\___ \
       /_______  /|__|  |__|  (____  /__| (____  /\___  /|____//____  >
               \/                  \/          \//_____/            \/
    ______________________                           ______________________
                          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
Public Attributes | List of all members
CUserInterface Class Reference

#include <ui.h>

Public Member Functions

ui.cpp - The user interface globals.
 CUserInterface ()
 
 ~CUserInterface ()
 
void Load ()
 

Public Attributes

bool MouseScroll
 
bool KeyScroll
 Enable mouse scrolling. More...
 
int KeyScrollSpeed
 Key Scroll Speed. More...
 
int MouseScrollSpeed
 Mouse Scroll Speed (screenpixels per mousepixel) More...
 
int MouseScrollSpeedDefault
 Middle-Mouse Scroll Speed (screenpixels per mousepixel) More...
 
int MouseScrollSpeedControl
 Middle-Mouse Scroll Speed with Control pressed. More...
 
PixelPos MouseWarpPos
 
std::string NormalFontColor
 Cursor warp screen position. More...
 
std::string ReverseFontColor
 Color for normal text displayed. More...
 
std::vector< CFillerFillers
 Color for reverse text displayed. More...
 
CResourceInfo Resources [MaxResourceInfo]
 Filler graphics. More...
 
CInfoPanel InfoPanel
 Icon+Text of all resources. More...
 
std::vector< CUnitInfoPanel * > InfoPanelContents
 Info panel. More...
 
std::vector< CPopup * > ButtonPopups
 Info panel contents. More...
 
CUIButtonSingleSelectedButton
 Popup windows for buttons. More...
 
std::vector< CUIButtonSelectedButtons
 Button for single selected unit. More...
 
CFontMaxSelectedFont
 Selected buttons. More...
 
int MaxSelectedTextX
 Font type to use. More...
 
int MaxSelectedTextY
 position to place '+#' text More...
 
CUIButtonSingleTrainingButton
 if > maximum units selected More...
 
std::string SingleTrainingText
 Button for single training. More...
 
CFontSingleTrainingFont
 Text for single training. More...
 
int SingleTrainingTextX
 Font for single traning. More...
 
int SingleTrainingTextY
 X text position single training. More...
 
std::vector< CUIButtonTrainingButtons
 Y text position single training. More...
 
std::string TrainingText
 Training buttons. More...
 
CFontTrainingFont
 Multiple Training Text. More...
 
int TrainingTextX
 Multiple Training Font. More...
 
int TrainingTextY
 Multiple Training X Text position. More...
 
CUIButtonUpgradingButton
 Multiple Training Y Text position. More...
 
CUIButtonResearchingButton
 Button info for upgrade. More...
 
std::vector< CUIButtonTransportingButtons
 Button info for researching. More...
 
CColor CompletedBarColorRGB
 Button info for transporting. More...
 
IntColor CompletedBarColor
 color for completed bar More...
 
bool CompletedBarShadow
 color for completed bar More...
 
CButtonPanel ButtonPanel
 should complete bar have shadow More...
 
CPieMenu PieMenu
 
ViewportModeType ViewportMode
 
CViewportMouseViewport
 Current viewport mode. More...
 
CViewportSelectedViewport
 Viewport containing mouse. More...
 
int NumViewports
 Current selected active viewport. More...
 
CViewport Viewports [MAX_NUM_VIEWPORTS]
 

Viewports currently used

More...
 
CMapArea MapArea
 Parameters of all viewports. More...
 
CFontMessageFont
 geometry of the whole map area More...
 
int MessageScrollSpeed
 Font used for messages. More...
 
CUIButton MenuButton
 Scroll speed in seconds for messages. More...
 
CUIButton NetworkMenuButton
 menu button More...
 
CUIButton NetworkDiplomacyButton
 network menu button More...
 
std::vector< CUIUserButtonUserButtons
 network diplomacy button More...
 
CMinimap Minimap
 User buttons. More...
 
IntColor ViewportCursorColor
 minimap More...
 
CStatusLine StatusLine
 minimap cursor color More...
 
CUITimer Timer
 status line More...
 
int Offset640X
 game timer More...
 
int Offset480Y
 Offset for 640x480 X position. More...
 
CursorConfig Point
 Offset for 640x480 Y position. More...
 
CursorConfig Glass
 General pointing cursor. More...
 
CursorConfig Cross
 HourGlass, system is waiting. More...
 
CursorConfig YellowHair
 Multi-select cursor. More...
 
CursorConfig GreenHair
 Yellow action,attack cursor. More...
 
CursorConfig RedHair
 Green action,attack cursor. More...
 
CursorConfig Scroll
 Red action,attack cursor. More...
 
CursorConfig ArrowE
 Cursor for scrolling map around. More...
 
CursorConfig ArrowNE
 Cursor pointing east. More...
 
CursorConfig ArrowN
 Cursor pointing north east. More...
 
CursorConfig ArrowNW
 Cursor pointing north. More...
 
CursorConfig ArrowW
 Cursor pointing north west. More...
 
CursorConfig ArrowSW
 Cursor pointing west. More...
 
CursorConfig ArrowS
 Cursor pointing south west. More...
 
CursorConfig ArrowSE
 Cursor pointing south. More...
 
CGraphicVictoryBackgroundG
 Cursor pointing south east. More...
 
CGraphicDefeatBackgroundG
 Victory background graphic. More...
 

Detailed Description

Defines the user interface.

Constructor & Destructor Documentation

CUserInterface::CUserInterface ( )
CUserInterface::~CUserInterface ( )

Clean up a user interface.

Member Function Documentation

void CUserInterface::Load ( )

Load the user interface graphics.

Member Data Documentation

CursorConfig CUserInterface::ArrowE

Cursor for scrolling map around.

CursorConfig CUserInterface::ArrowN

Cursor pointing north east.

CursorConfig CUserInterface::ArrowNE

Cursor pointing east.

CursorConfig CUserInterface::ArrowNW

Cursor pointing north.

CursorConfig CUserInterface::ArrowS

Cursor pointing south west.

CursorConfig CUserInterface::ArrowSE

Cursor pointing south.

CursorConfig CUserInterface::ArrowSW

Cursor pointing west.

CursorConfig CUserInterface::ArrowW

Cursor pointing north west.

CButtonPanel CUserInterface::ButtonPanel

should complete bar have shadow

std::vector<CPopup *> CUserInterface::ButtonPopups

Info panel contents.

IntColor CUserInterface::CompletedBarColor

color for completed bar

CColor CUserInterface::CompletedBarColorRGB

Button info for transporting.

bool CUserInterface::CompletedBarShadow

color for completed bar

CursorConfig CUserInterface::Cross

HourGlass, system is waiting.

CGraphic* CUserInterface::DefeatBackgroundG

Victory background graphic.

std::vector<CFiller> CUserInterface::Fillers

Color for reverse text displayed.

CursorConfig CUserInterface::Glass

General pointing cursor.

CursorConfig CUserInterface::GreenHair

Yellow action,attack cursor.

CInfoPanel CUserInterface::InfoPanel

Icon+Text of all resources.

std::vector<CUnitInfoPanel *> CUserInterface::InfoPanelContents

Info panel.

bool CUserInterface::KeyScroll

Enable mouse scrolling.

int CUserInterface::KeyScrollSpeed

Key Scroll Speed.

Enable keyboard scrolling

CMapArea CUserInterface::MapArea

Parameters of all viewports.

CFont* CUserInterface::MaxSelectedFont

Selected buttons.

int CUserInterface::MaxSelectedTextX

Font type to use.

int CUserInterface::MaxSelectedTextY

position to place '+#' text

CUIButton CUserInterface::MenuButton

Scroll speed in seconds for messages.

CFont* CUserInterface::MessageFont

geometry of the whole map area

int CUserInterface::MessageScrollSpeed

Font used for messages.

CMinimap CUserInterface::Minimap

User buttons.

bool CUserInterface::MouseScroll
int CUserInterface::MouseScrollSpeed

Mouse Scroll Speed (screenpixels per mousepixel)

int CUserInterface::MouseScrollSpeedControl

Middle-Mouse Scroll Speed with Control pressed.

int CUserInterface::MouseScrollSpeedDefault

Middle-Mouse Scroll Speed (screenpixels per mousepixel)

CViewport* CUserInterface::MouseViewport

Current viewport mode.

PixelPos CUserInterface::MouseWarpPos
CUIButton CUserInterface::NetworkDiplomacyButton

network menu button

CUIButton CUserInterface::NetworkMenuButton

menu button

std::string CUserInterface::NormalFontColor

Cursor warp screen position.

int CUserInterface::NumViewports

Current selected active viewport.

int CUserInterface::Offset480Y

Offset for 640x480 X position.

int CUserInterface::Offset640X

game timer

CPieMenu CUserInterface::PieMenu
CursorConfig CUserInterface::Point

Offset for 640x480 Y position.

CursorConfig CUserInterface::RedHair

Green action,attack cursor.

CUIButton* CUserInterface::ResearchingButton

Button info for upgrade.

CResourceInfo CUserInterface::Resources[MaxResourceInfo]

Filler graphics.

std::string CUserInterface::ReverseFontColor

Color for normal text displayed.

CursorConfig CUserInterface::Scroll

Red action,attack cursor.

std::vector<CUIButton> CUserInterface::SelectedButtons

Button for single selected unit.

CViewport* CUserInterface::SelectedViewport

Viewport containing mouse.

CUIButton* CUserInterface::SingleSelectedButton

Popup windows for buttons.

CUIButton* CUserInterface::SingleTrainingButton

if > maximum units selected

CFont* CUserInterface::SingleTrainingFont

Text for single training.

std::string CUserInterface::SingleTrainingText

Button for single training.

int CUserInterface::SingleTrainingTextX

Font for single traning.

int CUserInterface::SingleTrainingTextY

X text position single training.

CStatusLine CUserInterface::StatusLine

minimap cursor color

CUITimer CUserInterface::Timer

status line

std::vector<CUIButton> CUserInterface::TrainingButtons

Y text position single training.

CFont* CUserInterface::TrainingFont

Multiple Training Text.

std::string CUserInterface::TrainingText

Training buttons.

int CUserInterface::TrainingTextX

Multiple Training Font.

int CUserInterface::TrainingTextY

Multiple Training X Text position.

std::vector<CUIButton> CUserInterface::TransportingButtons

Button info for researching.

CUIButton* CUserInterface::UpgradingButton

Multiple Training Y Text position.

std::vector<CUIUserButton> CUserInterface::UserButtons

network diplomacy button

CGraphic* CUserInterface::VictoryBackgroundG

Cursor pointing south east.

Todo:
could use different sounds/speech for the errors Is in gamesounds? SoundConfig PlacementError; /// played on placements errors SoundConfig PlacementSuccess; /// played on placements success SoundConfig Click; /// click noice used often
IntColor CUserInterface::ViewportCursorColor

minimap

ViewportModeType CUserInterface::ViewportMode
CViewport CUserInterface::Viewports[MAX_NUM_VIEWPORTS]

Viewports currently used

CursorConfig CUserInterface::YellowHair

Multi-select cursor.


The documentation for this class was generated from the following files:
(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.