Class: Territory

Source Location: /objects/territory.php

Class Overview

Holds Territory data for orders, and performs other territory/terrstatus related functions such as de-coasting coastal territory names.

Variables

Methods

Class Details

[line 30]
Holds Territory data for orders, and performs other territory/terrstatus related functions such as de-coasting coastal territory names.

[ Top ]

Class Variables

$coast =

[line 43]

Coast type: 'No','Parent','South','North'

Type:

string

[ Top ]

$country =

[line 86]

The country which initially owns this territory

Type:

string

[ Top ]

$mapX =

[line 62]

Large map x coordinate

Type:

int

[ Top ]

$mapY =

[line 68]

Large map y coordinate

Type:

int

[ Top ]

$smallMapX =

[line 74]

Small map x coordinate

Type:

int

[ Top ]

$smallMapY =

[line 80]

Small map y coordinate

Type:

int

[ Top ]

$supply =

[line 56]

Supply center present: 'Yes'/'No'

Type:

string

[ Top ]

$terr =

[line 36]

The territory name

Type:

string

[ Top ]

$type =

[line 49]

'Coast','Land','Sea'

Type:

string

[ Top ]

Class Methods

static method deCoast [line 94]

static string deCoast(
string
$coast)

Remove coast info from a territory name

Tags:

return:	Territory name without coast info
access:	public

Parameters:

string

$coast

The coastal territory to de-coast

[ Top ]

static method newCache [line 106]

static Territory newCache(
string
$terr)

Territories are cached so that repeated requests to the database don't need to be made for the same territory. This isn't as much of a problem as it was

Tags:

access:

public

Parameters:

string

$terr

Territory name

[ Top ]

constructor __construct [line 122]

Territory __construct(
string
$terr)

The Territory constructor

Parameters:

string

$terr

Territory name

[ Top ]

Documentation generated on Thu, 13 Nov 2008 18:16:38 +0900 by phpDocumentor 1.4.1