Class RecAnalystConfig

Description

Class RecAnalystConfig.

Configuration singleton class. RecAnalystConfig implements configuration constants used for RecAnalyst.

Located in /RecAnalystConfig.php (line 22)


	
			
Variable Summary
Method Summary
Variables
int $mapHeight (line 67)

Defines a height of the map image we wish to generate.

  • access: public
string $mapsDir (line 38)

Defines a path (absolute or relative) to directory where we wish to save generated maps.

Write permission is required.

  • access: public
int $mapWidth (line 60)

Defines a width of the map image we wish to generate.

  • access: public
string $researchBackgroundImage (line 90)

Defines background image for research timelines image.

  • access: public
array $researchCAColor (line 114)

Defines color for Dark Age in the research timelines image.

array $researchDAColor (line 98)

Defines color for Dark Age in the research timelines image.

Array consist of red, green, blue color and alpha.

  • access: public
string $researchesDir (line 46)

Defines a path (absolute or relative) to directory where we wish to save generated research timelines.

Write permission is required.

  • access: public
array $researchFAColor (line 106)

Defines color for Dark Age in the research timelines image.

array $researchIAColor (line 122)

Defines color for Dark Age in the research timelines image.

int $researchTileSize (line 76)

Defines width and height of one research tile in research timelines image.

  • access: public
int $researchVSpacing (line 83)

Defines vertical spacing between players in research timelines image.

  • access: public
string $resourcesDir (line 53)

Defines a path (absolute or relative) to directory where we store resources required for generating research timelines.

  • access: public
bool $showPositions (line 129)

Determines if to show players positions on the map.

  • var: true if it is desirable to show players positions, false otherwise
  • access: public
bool $useSnowColors (line 136)

Determines if to use snow colors for terrain instead of game's default ones.

  • var: true if it is desirable to use snow colors, false otherwise
  • access: public
Methods
static method getInstance (line 173)

Retrieves the singleton instance of this class.

  • return: A RecAnalystConfig implementation instance.
  • access: public
static RecAnalystConfig getInstance ()

Documentation generated on Mon, 11 May 2009 16:43:51 +0200 by phpDocumentor 1.4.1