Documentation

OneWayRoute extends Route
in package

Table of Contents

Properties

$buyDi  : int
$buyPortRace  : int
$buySectorId  : int
$goodId  : int
$path  : Path
$sellDi  : int
$sellPortRace  : int
$sellSectorId  : int

Methods

__construct()  : mixed
Construct a one-way route for buying a specific trade good at one port and selling it at another.
containsPort()  : bool
getBuyDi()  : int
getBuyPortRace()  : int
getBuySectorId()  : int
getExpMultiplierSum()  : int
getGoodID()  : int
getGoodName()  : string
getMoneyMultiplierSum()  : int
getOneWayRoutes()  : array<string|int, OneWayRoute>
Recurse through the Route tree to get an ordered list.
getOverallExpMultiplier()  : float
getOverallMoneyMultiplier()  : float
getPath()  : Path
getPortSectorIDs()  : array<string|int, int>
Provides a list of sector IDs for all ports in the Route.
getRouteString()  : string
getSellDi()  : int
getSellPortRace()  : int
getSellSectorId()  : int
getTurnsForRoute()  : int

Properties

Methods

__construct()

Construct a one-way route for buying a specific trade good at one port and selling it at another.

public __construct(int $buySectorId, int $sellSectorId, int $buyPortRace, int $sellPortRace, int $buyDi, int $sellDi, Path $path, int $goodId) : mixed

NOTE: Transactions are from the perspective of the player (not the port).

Parameters
$buySectorId : int
$sellSectorId : int
$buyPortRace : int
$sellPortRace : int
$buyDi : int
$sellDi : int
$path : Path
$goodId : int

containsPort()

public containsPort(int $sectorID) : bool
Parameters
$sectorID : int
Return values
bool

getBuyDi()

public getBuyDi() : int
Return values
int

getBuyPortRace()

public getBuyPortRace() : int
Return values
int

getBuySectorId()

public getBuySectorId() : int
Return values
int

getExpMultiplierSum()

public getExpMultiplierSum() : int
Return values
int

getGoodID()

public getGoodID() : int
Return values
int

getGoodName()

public getGoodName() : string
Return values
string

getMoneyMultiplierSum()

public getMoneyMultiplierSum() : int
Return values
int

getOneWayRoutes()

Recurse through the Route tree to get an ordered list.

public getOneWayRoutes() : array<string|int, OneWayRoute>
Return values
array<string|int, OneWayRoute>

getOverallExpMultiplier()

public getOverallExpMultiplier() : float
Return values
float

getOverallMoneyMultiplier()

public getOverallMoneyMultiplier() : float
Return values
float

getPortSectorIDs()

Provides a list of sector IDs for all ports in the Route.

public getPortSectorIDs() : array<string|int, int>
Return values
array<string|int, int>

getRouteString()

public getRouteString() : string
Return values
string

getSellDi()

public getSellDi() : int
Return values
int

getSellPortRace()

public getSellPortRace() : int
Return values
int

getSellSectorId()

public getSellSectorId() : int
Return values
int

getTurnsForRoute()

public getTurnsForRoute() : int
Return values
int 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results