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

CUserInterface Class Reference

#include <ui.h>

List of all members.


Public Member Functions

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

Public Attributes

bool MouseScroll
bool KeyScroll
 Enable mouse scrolling.
int MouseScrollSpeed
 Mouse Scroll Speed (screenpixels per mousepixel).
int MouseScrollSpeedDefault
 Middle-Mouse Scroll Speed (screenpixels per mousepixel).
int MouseScrollSpeedControl
 Middle-Mouse Scroll Speed with Control pressed.
int MouseWarpX
int MouseWarpY
 Cursor warp X position.
std::string NormalFontColor
 Cursor warp Y position.
std::string ReverseFontColor
 Color for normal text displayed.
std::vector< CFillerFillers
 Color for reverse text displayed.
CResourceInfo Resources [MaxResourceInfo]
 Filler graphics.
CInfoPanel InfoPanel
 Icon+Text of all resources.
std::vector< CUnitInfoPanel * > InfoPanelContents
 Info panel.
CUIButtonSingleSelectedButton
 Info panel contents.
std::vector< CUIButtonSelectedButtons
 Button for single selected unit.
CFontMaxSelectedFont
 Selected buttons.
int MaxSelectedTextX
 Font type to use.
int MaxSelectedTextY
 position to place '+#' text
CUIButtonSingleTrainingButton
 if > maximum units selected
std::string SingleTrainingText
 Button for single training.
CFontSingleTrainingFont
 Text for single training.
int SingleTrainingTextX
 Font for single traning.
int SingleTrainingTextY
 X text position single training.
std::vector< CUIButtonTrainingButtons
 Y text position single training.
std::string TrainingText
 Training buttons.
CFontTrainingFont
 Multiple Training Text.
int TrainingTextX
 Multiple Training Font.
int TrainingTextY
 Multiple Training X Text position.
CUIButtonUpgradingButton
 Multiple Training Y Text position.
CUIButtonResearchingButton
 Button info for upgrade.
std::vector< CUIButtonTransportingButtons
 Button info for researching.
SDL_Color CompletedBarColorRGB
 Button info for transporting.
Uint32 CompletedBarColor
 color for completed bar
bool CompletedBarShadow
 color for completed bar
CButtonPanel ButtonPanel
 should complete bar have shadow
CPieMenu PieMenu
ViewportModeType ViewportMode
CViewportMouseViewport
 Current viewport mode.
CViewportSelectedViewport
 Viewport containing mouse.
int NumViewports
 Current selected active viewport.
CViewport Viewports [MAX_NUM_VIEWPORTS]
 # Viewports currently used
CMapArea MapArea
 Parameters of all viewports.
CFontMessageFont
 geometry of the whole map area
int MessageScrollSpeed
 Font used for messages.
CUIButton MenuButton
 Scroll speed in seconds for messages.
CUIButton NetworkMenuButton
 menu button
CUIButton NetworkDiplomacyButton
 network menu button
CMinimap Minimap
 network diplomacy button
Uint32 ViewportCursorColor
 minimap
CStatusLine StatusLine
 minimap cursor color
CUITimer Timer
 status line
int Offset640X
 game timer
int Offset480Y
 Offset for 640x480 X position.
CursorConfig Point
 Offset for 640x480 Y position.
CursorConfig Glass
 General pointing cursor.
CursorConfig Cross
 HourGlass, system is waiting.
CursorConfig YellowHair
 Multi-select cursor.
CursorConfig GreenHair
 Yellow action,attack cursor.
CursorConfig RedHair
 Green action,attack cursor.
CursorConfig Scroll
 Red action,attack cursor.
CursorConfig ArrowE
 Cursor for scrolling map around.
CursorConfig ArrowNE
 Cursor pointing east.
CursorConfig ArrowN
 Cursor pointing north east.
CursorConfig ArrowNW
 Cursor pointing north.
CursorConfig ArrowW
 Cursor pointing north west.
CursorConfig ArrowSW
 Cursor pointing west.
CursorConfig ArrowS
 Cursor pointing south west.
CursorConfig ArrowSE
 Cursor pointing south.
CGraphicVictoryBackgroundG
 Cursor pointing south east.
CGraphicDefeatBackgroundG
 Victory background graphic.

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

Enable mouse scrolling.

Mouse Scroll Speed (screenpixels per mousepixel).

Enable keyboard scrolling

Middle-Mouse Scroll Speed (screenpixels per mousepixel).

Middle-Mouse Scroll Speed with Control pressed.

Cursor warp X position.

Cursor warp Y position.

Color for normal text displayed.

Color for reverse text displayed.

Filler graphics.

Icon+Text of all resources.

Button for single selected unit.

Font type to use.

position to place '+#' text

if > maximum units selected

Button for single training.

Text for single training.

Font for single traning.

X text position single training.

Y text position single training.

Training buttons.

Multiple Training Text.

Multiple Training Font.

Multiple Training X Text position.

Multiple Training Y Text position.

Button info for upgrade.

Button info for researching.

Button info for transporting.

color for completed bar

color for completed bar

should complete bar have shadow

Current viewport mode.

Viewport containing mouse.

Current selected active viewport.

# Viewports currently used

geometry of the whole map area

Font used for messages.

Scroll speed in seconds for messages.

network diplomacy button

Offset for 640x480 X position.

Offset for 640x480 Y position.

General pointing cursor.

HourGlass, system is waiting.

Yellow action,attack cursor.

Green action,attack cursor.

Red action,attack cursor.

Cursor for scrolling map around.

Cursor pointing east.

Cursor pointing north east.

Cursor pointing north.

Cursor pointing north west.

Cursor pointing west.

Cursor pointing south west.

Cursor pointing south.

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

Victory background graphic.


The documentation for this class was generated from the following files:
(C) Copyright 1998-2011 by The Stratagus Project under the GNU General Public License.
All trademarks and copyrights on this page are owned by their respective owners.