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

src/include/stratagus.h File Reference

#include <string.h>
#include "util.h"

Go to the source code of this file.


Classes

class  Parameters

stratagus.h - The main header file.

#define UNUSED(var)   (var)
#define PRINTF_VAARG_ATTRIBUTE(a, b)
#define _C_   ,
#define PrintFunction()   PrintLocation(__FILE__, __LINE__, __func__);
 Print function in debug macros.
#define Assert(cond)
#define DebugPrint(args)
#define RefsAssert(cond)
#define PlayerMax   16
#define UnitTypeMax   2048
#define UpgradeMax   2048
#define MAX_RACES   8
#define FRAMES_PER_SECOND   30
 Frames per second to display (original 30-40).
#define CYCLES_PER_SECOND   30
 Game cycles per second to simulate (original 30-40).
const char NameLine []
 Text string: Name, Version, Copyright.
std::string StratagusLibPath
std::string MenuRace
 Location of stratagus data.
unsigned long GameCycle
unsigned long FastForwardCycle
 Game simulation cycle counter.
void PrintLocation (const char *file, int line, const char *funcName)
 Cycle to fastforward to in a replay.
char * new_strdup (const char *str)
void Exit (int err)
 Game Replay Fast Forward Counter.
void ExitFatal (int err)
 Exit.
void UpdateDisplay ()
 Exit with fatal error.
void DrawMapArea ()
 Game display update.
void GameMainLoop ()
 Draw the map area.

Define Documentation

#define _C_   ,

This simulates vararg macros. Example: DebugPrint("Test %d %d\n" _C_ 1 _C_ 2);

#define Assert ( cond   ) 

#define CYCLES_PER_SECOND   30

Game cycles per second to simulate (original 30-40).

#define DebugPrint ( args   ) 

#define FRAMES_PER_SECOND   30

Frames per second to display (original 30-40).

#define MAX_RACES   8

#define PlayerMax   16

#define PRINTF_VAARG_ATTRIBUTE ( a,
 ) 

 
#define PrintFunction (  )     PrintLocation(__FILE__, __LINE__, __func__);

Print function in debug macros.

#define RefsAssert ( cond   ) 

#define UnitTypeMax   2048

#define UNUSED ( var   )     (var)

#define UpgradeMax   2048


Function Documentation

void DrawMapArea (  ) 

Game display update.

Draw map area

void Exit ( int  err  ) 

Game Replay Fast Forward Counter.

Exit the game.

Parameters:
err Error code to pass to shell.

void ExitFatal ( int  err  ) 

Exit.

Do a fatal exit. Called on out of memory or crash.

Parameters:
err Error code to pass to shell.

void GameMainLoop (  ) 

Draw the map area.

Game main loop.

Unit actions. Missile actions. Players (AI). Cyclic events (color cycle,...) Display update. Input/Network/Sound.

char* new_strdup ( const char *  str  )  [inline]

void PrintLocation ( const char *  file,
int  line,
const char *  funcName 
)

Cycle to fastforward to in a replay.

Todo:
Needs code cleanup.
Todo:
Needs compatibility checks.
Todo:
Needs error message unification.

void UpdateDisplay (  ) 

Exit with fatal error.

Display update.

This functions updates everything on screen. The map, the gui, the cursors.


Variable Documentation

unsigned long FastForwardCycle

Game simulation cycle counter.

unsigned long GameCycle

std::string MenuRace

Location of stratagus data.

const char NameLine[]

Text string: Name, Version, Copyright.

Text string: Name, Version, Copyright.

Name, Version, Copyright

std::string StratagusLibPath

(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.