Documentation

Globals
in package

Table of Contents

Properties

$AVAILABLE_LINKS  : array<string, string>
$FEATURE_REQUEST_OPEN  : bool
$HIDDEN_PLAYERS  : array<string|int, int>
$RACE_RELATIONS  : array<int, array<int, array<int, int>>>

Methods

canAccessPage()  : void
getAllianceBankHREF()  : string
getAllianceForcesHREF()  : string
getAllianceHREF()  : string
getAllianceListHREF()  : string
getAllianceMessageBoardHREF()  : string
getAllianceMessageHREF()  : string
getAllianceMotdHREF()  : string
getAllianceNewsHREF()  : string
getAllianceOptionsHREF()  : string
getAllianceRosterHREF()  : string
getAttackTraderHREF()  : string
getAvailableColourSchemes()  : array<string|int, string>
getAvailableLinks()  : array<string, string>
getAvailableTemplates()  : array<string|int, string>
getBetaFunctionsHREF()  : string
getBugReportProcessingHREF()  : string
getBuyMessageNotificationsHREF()  : string
getBuyShipNameCosts()  : array<string, int>
getBuyShipNameHREF()  : string
getCasinoHREF()  : string
getChessCreateHREF()  : string
getChessHREF()  : string
getColouredRaceName()  : string
getColouredRaceNameForRace()  : string
getCouncilHREF()  : string
getCurrentPlayersHREF()  : string
getCurrentSectorHREF()  : string
getCurrentSectorMoveHREF()  : string
getFeatureRequestHREF()  : string
getGalacticPostEditorIDs()  : array<string|int, int>
getHiddenPlayers()  : array<string|int, int>
getHistoryDatabases()  : array<string, string>
Returns an array of history databases for which we have ancient saved game data. Array keys are database names and values are the columns in the `account` table with the linked historical account ID's.
getLocalMapHREF()  : string
getManageBlacklistHREF()  : string
getPlanetListFinancialHREF()  : string
getPlanetListHREF()  : string
getPlotCourseHREF()  : string
getRaceRelations()  : array<int, int>
getSectorBBLink()  : string
getSectorMoveHREF()  : string
getSectorScanHREF()  : string
getSendCouncilMessageHREF()  : string
getSendGlobalMessageHREF()  : string
getSmrFileCreateHREF()  : string
getTradeHREF()  : string
getTraderBountiesHREF()  : string
getTraderRelationsHREF()  : string
getTraderStatusHREF()  : string
getViewMessageBoxesHREF()  : string
getWeaponReorderHREF()  : string
isFeatureRequestOpen()  : bool

Properties

$AVAILABLE_LINKS

protected static array<string, string> $AVAILABLE_LINKS = []

$FEATURE_REQUEST_OPEN

protected static bool $FEATURE_REQUEST_OPEN

$HIDDEN_PLAYERS

protected static array<string|int, int> $HIDDEN_PLAYERS

$RACE_RELATIONS

protected static array<int, array<int, array<int, int>>> $RACE_RELATIONS

Methods

canAccessPage()

public static canAccessPage(string $pageName, AbstractPlayer $player, array<string, int> $extraInfo) : void
Parameters
$pageName : string
$player : AbstractPlayer
$extraInfo : array<string, int>

getAllianceBankHREF()

public static getAllianceBankHREF(int $allianceID) : string
Parameters
$allianceID : int
Return values
string

getAllianceForcesHREF()

public static getAllianceForcesHREF(int $allianceID) : string
Parameters
$allianceID : int
Return values
string

getAllianceHREF()

public static getAllianceHREF([int $allianceID = null ]) : string
Parameters
$allianceID : int = null
Return values
string

getAllianceListHREF()

public static getAllianceListHREF() : string
Return values
string

getAllianceMessageBoardHREF()

public static getAllianceMessageBoardHREF(int $allianceID) : string
Parameters
$allianceID : int
Return values
string

getAllianceMessageHREF()

public static getAllianceMessageHREF(int $allianceID) : string
Parameters
$allianceID : int
Return values
string

getAllianceMotdHREF()

public static getAllianceMotdHREF(int $allianceID) : string
Parameters
$allianceID : int
Return values
string

getAllianceNewsHREF()

public static getAllianceNewsHREF(int $gameID, int $allianceID) : string
Parameters
$gameID : int
$allianceID : int
Return values
string

getAllianceOptionsHREF()

public static getAllianceOptionsHREF() : string
Return values
string

getAllianceRosterHREF()

public static getAllianceRosterHREF([int $allianceID = null ]) : string
Parameters
$allianceID : int = null
Return values
string

getAttackTraderHREF()

public static getAttackTraderHREF(int $accountID) : string
Parameters
$accountID : int
Return values
string

getAvailableColourSchemes()

public static getAvailableColourSchemes(string $templateName) : array<string|int, string>
Parameters
$templateName : string
Return values
array<string|int, string>

getAvailableLinks()

public static getAvailableLinks() : array<string, string>
Return values
array<string, string>

getAvailableTemplates()

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

getBetaFunctionsHREF()

public static getBetaFunctionsHREF() : string
Return values
string

getBugReportProcessingHREF()

public static getBugReportProcessingHREF() : string
Return values
string

getBuyMessageNotificationsHREF()

public static getBuyMessageNotificationsHREF() : string
Return values
string

getBuyShipNameCosts()

public static getBuyShipNameCosts() : array<string, int>
Return values
array<string, int>

getBuyShipNameHREF()

public static getBuyShipNameHREF() : string
Return values
string

getCasinoHREF()

public static getCasinoHREF() : string
Return values
string

getChessCreateHREF()

public static getChessCreateHREF() : string
Return values
string

getChessHREF()

public static getChessHREF() : string
Return values
string

getColouredRaceName()

public static getColouredRaceName(int $raceID, int $relations[, bool $linked = true ]) : string
Parameters
$raceID : int
$relations : int
$linked : bool = true
Return values
string

getColouredRaceNameForRace()

public static getColouredRaceNameForRace(int $raceID, int $gameID, int $fromRaceID[, bool $linked = true ]) : string
Parameters
$raceID : int
$gameID : int
$fromRaceID : int
$linked : bool = true
Return values
string

getCouncilHREF()

public static getCouncilHREF(int $raceID) : string
Parameters
$raceID : int
Return values
string

getCurrentPlayersHREF()

public static getCurrentPlayersHREF() : string
Return values
string

getCurrentSectorHREF()

public static getCurrentSectorHREF() : string
Return values
string

getCurrentSectorMoveHREF()

public static getCurrentSectorMoveHREF(AbstractPlayer $player, int $toSector) : string
Parameters
$player : AbstractPlayer
$toSector : int
Return values
string

getFeatureRequestHREF()

public static getFeatureRequestHREF() : string
Return values
string

getGalacticPostEditorIDs()

public static getGalacticPostEditorIDs(int $gameID) : array<string|int, int>
Parameters
$gameID : int
Return values
array<string|int, int>

getHiddenPlayers()

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

getHistoryDatabases()

Returns an array of history databases for which we have ancient saved game data. Array keys are database names and values are the columns in the `account` table with the linked historical account ID's.

public static getHistoryDatabases() : array<string, string>
Return values
array<string, string>

getLocalMapHREF()

public static getLocalMapHREF() : string
Return values
string

getManageBlacklistHREF()

public static getManageBlacklistHREF() : string
Return values
string

getPlanetListFinancialHREF()

public static getPlanetListFinancialHREF(int $allianceID) : string
Parameters
$allianceID : int
Return values
string

getPlanetListHREF()

public static getPlanetListHREF(int $allianceID) : string
Parameters
$allianceID : int
Return values
string

getPlotCourseHREF()

public static getPlotCourseHREF([int $fromSector = null ][, int $toSector = null ]) : string
Parameters
$fromSector : int = null
$toSector : int = null
Return values
string

getRaceRelations()

public static getRaceRelations(int $gameID, int $raceID) : array<int, int>
Parameters
$gameID : int
$raceID : int
Return values
array<int, int>

getSectorBBLink()

public static getSectorBBLink(int $sectorID) : string
Parameters
$sectorID : int
Return values
string

getSectorMoveHREF()

public static getSectorMoveHREF(AbstractPlayer $player, int $toSector, CurrentSector|LocalMap $targetPage) : string
Parameters
$player : AbstractPlayer
$toSector : int
$targetPage : CurrentSector|LocalMap
Return values
string

getSendCouncilMessageHREF()

public static getSendCouncilMessageHREF(int $raceID) : string
Parameters
$raceID : int
Return values
string

getSendGlobalMessageHREF()

public static getSendGlobalMessageHREF() : string
Return values
string

getSmrFileCreateHREF()

public static getSmrFileCreateHREF() : string
Return values
string

getTradeHREF()

public static getTradeHREF() : string
Return values
string

getTraderBountiesHREF()

public static getTraderBountiesHREF() : string
Return values
string

getTraderRelationsHREF()

public static getTraderRelationsHREF() : string
Return values
string

getTraderStatusHREF()

public static getTraderStatusHREF() : string
Return values
string

getViewMessageBoxesHREF()

public static getViewMessageBoxesHREF() : string
Return values
string

getWeaponReorderHREF()

public static getWeaponReorderHREF(int $weaponOrderID, string $direction) : string
Parameters
$weaponOrderID : int
$direction : string
Return values
string

isFeatureRequestOpen()

public static isFeatureRequestOpen() : bool
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results