---

OBJ_PLAYER Class Reference

List of all members.

Private Methods
void	SetShip (GALOBJ gship)
void	EnterSector (GALOBJ gsec)
void	WarpEnterSector (GALOBJ gsec, GALOBJ gate)
void	LeaveSector (GALOBJ gsec)
void	AddMoney (int val)
void	TradeMoney (int val)
void	SetNotoriety (GALOBJ race, int relation)
int	GetNotoriety (GALOBJ race)
int	GetClass ()
int	IsClass (int cl)
int	GetSectorX ()
int	GetSectorY ()
GALOBJ	GetSector ()
GALOBJ	GetShip ()
int	GetDamage ()
int	GetAge ()
int	GetMoney ()
string	GetName ()
BOOL	GetVisited (GALOBJ raceobj)
int	CheckEquipment (int equipment)
void	OwnShip (GALOBJ gship)
void	DisownShip (GALOBJ gship)
table	GetOwnedShips ()
void	OwnStation (GALOBJ gstation)
void	DisownStation (GALOBJ gstation)
table	GetOwnedStations ()
void	AddHiredShip (GALOBJ gship)
void	RemoveHiredShip (GALOBJ gship)
table	GetHiredShips ()
void	UpdateAge ()
BOOL	AddTradeNotoriety (GALOBJ grace)
void	LoseLicense (GALOBJ grace1)
int	GetID ()
int	GetTradeRanking ()
int	GetFightRanking ()
int	AddTradeRanking (int score)
int	AddTradeRankingFromTrade (int credits)
int	AddFightRanking (int score)
void	AddSector (GALOBJ sec)
Private Attributes
string	pl_Name
int	pl_Money
GALOBJ	pl_Ship
GALOBJ	pl_Sector
int	pl_SectorX
int	pl_SectorY
int	pl_GameTime
int	pl_Damage
int	pl_TradeRanking
int	pl_FightRanking
table	pl_OwnedShips
table	pl_Sectors
table	pl_OwnedStations
table	pl_HiredShips
table	pl_KilledObjects

---

Detailed Description

Player specific data and functionality. Game code instantiates one global object of this class.

---

Member Function Documentation

int AddFightRanking (  int    score )  [private]

increases and returns pl_FightRanking . See Notoriety and Ranking System .

void AddHiredShip (  GALOBJ    gship )  [private]

adds a ship to pl_HiredShips

void AddMoney (  int    val )  [private]

increases pl_Money

void AddSector (  GALOBJ    sec )  [private]

adds sector to pl_Sectors

BOOL AddTradeNotoriety (  GALOBJ    grace )  [private]

Increases notoriety of player amongst the given race by "1" when certain time has passed (>30s+random). See also Global Variables ga_Races[].

int AddTradeRanking (  int    score )  [private]

increases and returns pl_FightRanking .

int AddTradeRankingFromTrade (  int    credits )  [private]

Increases pl_TradeRanking according to the credits given as parameter and returns the new trade-rank. See Notoriety and Ranking System .

int CheckEquipment (  int    equipment )  [private]

returns number of given tech-wares on the player ship. equipment must be a subtype of SGTYPE_W_TECH (*_W_TECH subtype constants-definitions ).

void DisownShip (  GALOBJ    gship )  [private]

removes given OBJ_SHIP from pl_OwnedShips

void DisownStation (  GALOBJ    gstation )  [private]

removes given OBJ_STATION from pl_OwnedStations

void EnterSector (  GALOBJ    gsec )  [private]

playership warps in a given sector. Sector already exists in sector engine.

int GetAge (    )  [private]

returns pl_GameTime (Mission Critical Variable Access).

int GetClass (    )  [private]

See Functions common in every object.

int GetDamage (    )  [private]

returns pl_Damage

int GetFightRanking (    )  [private]

returns pl_FightRanking .

table GetHiredShips (    )  [private]

returns pl_HiredShips

int GetID (    )  [private]

returns the race ID of this object. (RACE_PLAYER)

int GetMoney (    )  [private]

returns pl_Money

string GetName (    )  [private]

returns the web user name (via OBJ_CLIENT)

int GetNotoriety (  GALOBJ    race )  [private]

returns the notoriety of the player amongst the given race. See also Global Variables ga_Races[].

table GetOwnedShips (    )  [private]

returns pl_OwnedShips

table GetOwnedStations (    )  [private]

returns pl_OwnedStations

GALOBJ GetSector (    )  [private]

returns pl_Sector

int GetSectorX (    )  [private]

returns pl_SectorX

int GetSectorY (    )  [private]

returns pl_SectorY

GALOBJ GetShip (    )  [private]

returns pl_Ship

int GetTradeRanking (    )  [private]

returns pl_TradeRanking

BOOL GetVisited (  GALOBJ    raceobj )  [private]

Returns wether the player has already visited a sector of the given race. See also Global Variables ga_Races[].

int IsClass (  int    cl )  [private]

See Functions common in every object.

void LeaveSector (  GALOBJ    gsec )  [private]

removes playership from given sector

void LoseLicense (  GALOBJ    grace1 )  [private]

player looses licence from given race. See also Global Variables ga_Races[].

void OwnShip (  GALOBJ    gship )  [private]

adds given OBJ_SHIP to pl_OwnedShips

void OwnStation (  GALOBJ    gstation )  [private]

adds given OBJ_STATION to pl_OwnedStations

void RemoveHiredShip (  GALOBJ    gship )  [private]

removes a ship from pl_HiredShips

void SetNotoriety (  GALOBJ    race, int    relation )  [private]

Direct setting of relation between a given race and player (for manual global notoriety settings over main menu). Notoriety and Ranking System

void SetShip (  GALOBJ    gship )  [private]

sets pl_Ship to given OBJ_SHIP

void TradeMoney (  int    val )  [private]

same as AddMoney()

void UpdateAge (    )  [private]

sets pl_GameTime to actual game time

void WarpEnterSector (  GALOBJ    gsec, GALOBJ    gate )  [private]

Playership enters the sector through the given gate. (sector already exists in sector engine).

---

Member Data Documentation

int pl_Damage [private]

damage on playership

int pl_FightRanking [private]

The fight rank of the player. See Notoriety and Ranking System .

int pl_GameTime [private]

total time passed for this player in sec

table pl_HiredShips [private]

Ships that are hired by the player, (a TL class ship).

table pl_KilledObjects [private]

table of "ware types" the player has destroyed [ waretype, amount ]

int pl_Money [private]

available money

string pl_Name [private]

name of player

table pl_OwnedShips [private]

player owned ships

table pl_OwnedStations [private]

Player "owned" stations.

GALOBJ pl_Sector [private]

actual sector

table pl_Sectors [private]

Player "owned" sectors.

int pl_SectorX [private]

x coordinate of actual sector

int pl_SectorY [private]

y coordinate of actual sector

GALOBJ pl_Ship [private]

ship that player flies (OBJ_SHIP)

int pl_TradeRanking [private]

The trade rank of the player. See Notoriety and Ranking System .

---