Documentation

Application

Classes

AbstractPlayer
AbstractShip: Properties and methods for a ship instance.
Account
UniGenLocationCategories: Helper class for organizing Locations into categories.
AdminPermissions
Album
Alliance
AllianceInvite: Object interfacing with the alliance_invites_player table.
BarDrink: Provides details about bar drinks
Card: Classic playing card for blackjack.
Deck: Deck of Blackjack cards to be drawn from.
Hand: Hand of Blackjack cards.
Table: A game of blackjack between the dealer and a player.
Bounty
Changelog
Board
ChessGame
ChessPiece
AbstractWeapon
CombatDrones
Mines
ScoutDrones
Weapon: Defines a concrete realization of a weapon type for ships/planets.
DiContainer: A wrapper around the DI\Container functionality that will allow static usage of container methods.
ResettableCompiledContainer
ResettableContainer
Council
CouncilVoting: Collection of functions to help process council voting.
Database: Wraps an active connection to the database.
DatabaseProperties: Expects the following environment variables to be set by the OS:
DatabaseRecord
DatabaseResult: Holds the result of a Database query (e.g. read or write).
Command
Forces: Use for any discord commands that require a database connection.
Game: Use for any discord commands that require a database connection.
Invite
MagicEightBall
Money: Use for any discord commands that require a database connection.
Op: Use for any discord commands that require a database connection.
OpList: Use for any discord commands that require a database connection.
OpTurns: Use for any discord commands that require a database connection.
Seed: Use for any discord commands that require a database connection.
Seedlist: Use for any discord commands that require a database connection.
SeedlistAdd: Use for any discord commands that require a database connection.
SeedlistDel: Use for any discord commands that require a database connection.
Turns: Use for any discord commands that require a database connection.
DatabaseCommand: Use for any discord commands that require a database connection.
PlayerLink: Holds information linking the received message and the game data
DisplayNameValidator: Displayed names (player names, Hall of Fame names, etc.) must all follow a basic set of rules, which are defined here.
DummyPlayer
DummyShip: Properties and methods for a ship instance.
EnhancedWeaponEvent: Defines enhanced weapon sale events for weapon shops.
Epoch: Stores the current time as a fixed value.
AccountNotFound: Exception thrown when an account cannot be found in the database
AlbumNotFound: Exception thrown when an album entry cannot be found in the database
AllianceInvitationNotFound: Exception thrown when an alliance invitation cannot be found in the database
AllianceNotFound: Exception thrown when an alliance cannot be found in the database
CachedPortNotFound: Exception thrown when a CachedPort cannot be found in the database
GalaxyNotFound: Exception thrown when a galaxy cannot be found in the database
GameNotFound: Exception thrown when a game cannot be found in the database
PathNotFound: Exception thrown when Plotter cannot find a Path
PlayerNotFound: Exception thrown when a player cannot be found in the database
SectorNotFound: Exception thrown when a sector cannot be found in the database
SocialLoginInvalidType: Exception thrown when a SocialLogin type is not valid
UserError: This exception should be used to pass an error message to the user.
Force
Galaxy
Game
Globals
HallOfFame: Collection of functions to help display the Hall of Fame tables.
HardwareType
Location
Redirect: Collection of functions to help with login redirection.
Lotto: Collection of functions to help with Lotto processing.
Menu: Creates menu navigation bars.
Messages: Collection of functions to help display messages and message boxes.
News: Collection of functions to help with displaying news.
AccountPage: A container that holds data needed to create a new page.
AccountPageProcessor: A container that holds data needed to create a new page.
Page: A container that holds data needed to create a new page.
PlayerPage: A container that holds data needed to create a new page.
PlayerPageProcessor: A container that holds data needed to create a new page.
Path: Class used to keep track of paths between two sectors.
Planet
PlanetList: Collection of functions to help prepare Planet List pages.
PlanetStructureType: Defines intrinsic properties of planetary structure types.
AridPlanet: Defines intrinsic properties of planet types.
DefenseWorld: Defines intrinsic properties of planet types.
DwarfPlanet: Defines intrinsic properties of planet types.
PlanetType: Defines intrinsic properties of planet types.
ProtoPlanet: Defines intrinsic properties of planet types.
TerranPlanet: Defines intrinsic properties of planet types.
Player
PlayerLevel
Plotter
Port
Race: Provides methods to map race IDs to basic race properties.
RaceDetails: Detailed race information for the Game Join page.
Rankings
Request: Should be used for getting request data for processing pages.
MultiplePortRoute
OneWayRoute
Route
RouteGenerator
RouteIterator: Cyclically iterate over actions on a trade route
Sector
SectorLock: This class is responsible for ensuring that page processing occurs sequentially as requests come in, avoiding race conditions by using a blocking queue.
SectorsFile
Session
Ship: Adds a database layer to an AbstractShip instance.
ShipIllusion: Data storage for the Ship::illusionShip property.
ShipType: Defines the base ship types
Facebook: Defines the methods to be implemented by each social login platform.
Google: Defines the methods to be implemented by each social login platform.
SocialIdentity
SocialLogin: Defines the methods to be implemented by each social login platform.
Twitter: Defines the methods to be implemented by each social login platform.
StoredDestination: Data class for course plotting destinations stored by the player.
Template
TradeGood
TradeGoodTransaction: Data class for defining the good and transaction type of a TradeGood transaction.
Treaty
VoteLink: Site-independent handling of links to external game voting sites.
WeaponType: Defines the base weapon types for ships/planets.
WeightedRandom: Weighted random number generator used to make events achieve their expected rate of success faster than a pure random number generator.

Traits

ForcesTrait: Common interface used by the subset of AbstractWeapon classes that are used for forces (mines, combat drones, and scout drones).
ResettableContainerTrait: Extends a Di\Container to allow for introspection and resetting.
ReusableTrait
RaceID: Implements the interface for classes that need a $raceID property.

Enums

Result: Defines all the possible results of a Blackjack game from the perspective of the player.
BountyType
BuyerRestriction: Enumeration of buyer restrictions for ships and weapons.
Castling: Enum values are database types and must not be changed.
Colour: Enumeration of possible player colours in a chess game.
CombatLogType: Enumerates the types of combat log pages
MovementType: Enumerates the types of movements that players can take.
PlanetMenuOption: Enumerates menu options on planets. Backing value is the link display name.
PlotGroup: Enumerates the "Plot to Nearest" categories
PortPayoutType: Enumerates the actions that can trigger port payouts.
ScoutMessageGroupType: Enumeration of ways to group scout messages when viewing them.
ShipClass: Categorization of ship types.
TransactionType: Enumerates the types of trade transactions that players may have with ports.
TurnsLevel: Enumerates the warning levels that correspond to player turn thresholds
UserRanking: User ranking titles
VoteSite: Enumerates external game voting sites and their properties.

Constants

MISSION_ACTIONS = ['LeaveSector', 'EnterSector', 'WalkSector', 'JoinAlliance', 'LeaveAlliance', 'DisbandAlliance', 'KickPlayer', 'PlayerKicked', 'BuyDrink']
MISSIONS = [0 => ['Name' => 'Drunk Guy', 'Offerer' => 'Drunk', 'Time Limit' => 0, 'HasX' => ['Type' => \Smr\PlotGroup::Locations, 'X' => 'Bar'], 'Steps' => [['Step' => 'EnterSector', 'PickSector' => ['Type' => \Smr\PlotGroup::Locations, 'X' => \RACE_SALVENE + \LOCATION_GROUP_RACIAL_HQS], 'Detail' => ['SectorID' => '<Sector>'], 'Text' => '*Hiccup* Hey! I need you to...*Hiccup* do me a favor. All the ' . \Smr\BarDrink::SALVENE_SWAMP_SODA . ' in this bar is awful! Go to the Sal...*Hiccup*...the Salvene HQ, they\'ll know a good bar.', 'Task' => 'Go to the Salvene HQ at [sector=<Sector>]'], ['Step' => 'EnterSector', 'PickSector' => ['Type' => \Smr\PlotGroup::Locations, 'X' => 'Bar'], 'Detail' => ['SectorID' => '<Sector>'], 'Text' => 'Here we are! The Salvene HQ! You ask around a bit and find that the bar in [sector=<Sector>] does the best ' . \Smr\BarDrink::SALVENE_SWAMP_SODA . ' around!', 'Task' => 'Go to the bar at [sector=<Sector>] and buy a ' . \Smr\BarDrink::SALVENE_SWAMP_SODA . ' from the bartender. This may take many tries.'], ['Step' => 'BuyDrink', 'Detail' => ['SectorID' => '<Sector>', 'Drink' => \Smr\BarDrink::SALVENE_SWAMP_SODA], 'Text' => 'Here we are! Now let\'s get this ' . \Smr\BarDrink::SALVENE_SWAMP_SODA . '.', 'Task' => 'Go to the bar at [sector=<Sector>] and buy a ' . \Smr\BarDrink::SALVENE_SWAMP_SODA . ' from the bartender. This may take many tries.'], ['Step' => 'EnterSector', 'Detail' => ['SectorID' => '<Starting Sector>'], 'Text' => 'Finally! A true ' . \Smr\BarDrink::SALVENE_SWAMP_SODA . ', let\'s return to that drunk!', 'Task' => 'Return to [sector=<Starting Sector>] to claim your reward.'], ['Step' => 'Claim', 'Rewards' => ['Credits' => 500000, 'Experience' => 1000, 'Text' => '*Hiccup* For your...service *Hiccup* to me, take these *Hiccup* 500,000 credits and 1,000 experience *Hiccup*!'], 'Detail' => ['SectorID' => '<Starting Sector>'], 'Text' => 'You hand the ' . \Smr\BarDrink::SALVENE_SWAMP_SODA . ' to the drunk!']]]]

Functions

get_draft_teams() : array<int, array<string, mixed>>: Returns an array with all relevant information about draft teams, including their current size and if the leader can pick teammates.
course_plot_forward() : never: This function is called by "Conventional" and "Plot To Nearest" pages.
echo_nav() : void
echo_content() : void
echo_subsection() : void
echo_menu() : void
get_numbering() : string
replaceMissionTemplate() : void: Callback for array_walk_recursive in Player::rebuildMission.
checkMissionRequirements() : bool
createNHA() : void: Create the Newbie Help Alliance and populate its Message Board
hit_sector_mines() : void
parseBoolean() : bool
linkCombatLog() : string
smrBBCode() : bool|string: Converts a BBCode tag into some other text depending on the tag and value.
inify() : string
bbify() : string
create_error() : never
handleUserError() : never
create_link() : string
create_submit_link() : string
get_colored_text_range() : string
get_colored_text() : string
word_filter() : string
pluralise() : string
do_voodoo() : never: This function is a hack around the old style http forward mechanism.
saveAllAndReleaseLock() : void
doTickerAssigns() : void
doSkeletonAssigns() : void
format_list() : string: Join a list of items into a grammatically-correct sentence fragment.
in_time_or_now() : string: Convert an integer number of seconds into a human-readable time for grammatically-correct use in a sentence, i.e. prefixed with "in" when the amount is positive.
format_time() : string: Convert an integer number of seconds into a human-readable time.
number_colour_format() : string
getWeightedRandom() : T: Randomly choose an array key weighted by the array values.
create_sub_menu() : void

MISSION_ACTIONS


    public
        mixed
    MISSION_ACTIONS
    = ['LeaveSector', 'EnterSector', 'WalkSector', 'JoinAlliance', 'LeaveAlliance', 'DisbandAlliance', 'KickPlayer', 'PlayerKicked', 'BuyDrink']

MISSIONS


    public
        mixed
    MISSIONS
    = [0 => ['Name' => 'Drunk Guy', 'Offerer' => 'Drunk', 'Time Limit' => 0, 'HasX' => ['Type' => \Smr\PlotGroup::Locations, 'X' => 'Bar'], 'Steps' => [['Step' => 'EnterSector', 'PickSector' => ['Type' => \Smr\PlotGroup::Locations, 'X' => \RACE_SALVENE + \LOCATION_GROUP_RACIAL_HQS], 'Detail' => ['SectorID' => '<Sector>'], 'Text' => '*Hiccup* Hey! I need you to...*Hiccup* do me a favor. All the ' . \Smr\BarDrink::SALVENE_SWAMP_SODA . ' in this bar is awful! Go to the Sal...*Hiccup*...the Salvene HQ, they\'ll know a good bar.', 'Task' => 'Go to the Salvene HQ at [sector=<Sector>]'], ['Step' => 'EnterSector', 'PickSector' => ['Type' => \Smr\PlotGroup::Locations, 'X' => 'Bar'], 'Detail' => ['SectorID' => '<Sector>'], 'Text' => 'Here we are! The Salvene HQ! You ask around a bit and find that the bar in [sector=<Sector>] does the best ' . \Smr\BarDrink::SALVENE_SWAMP_SODA . ' around!', 'Task' => 'Go to the bar at [sector=<Sector>] and buy a ' . \Smr\BarDrink::SALVENE_SWAMP_SODA . ' from the bartender. This may take many tries.'], ['Step' => 'BuyDrink', 'Detail' => ['SectorID' => '<Sector>', 'Drink' => \Smr\BarDrink::SALVENE_SWAMP_SODA], 'Text' => 'Here we are! Now let\'s get this ' . \Smr\BarDrink::SALVENE_SWAMP_SODA . '.', 'Task' => 'Go to the bar at [sector=<Sector>] and buy a ' . \Smr\BarDrink::SALVENE_SWAMP_SODA . ' from the bartender. This may take many tries.'], ['Step' => 'EnterSector', 'Detail' => ['SectorID' => '<Starting Sector>'], 'Text' => 'Finally! A true ' . \Smr\BarDrink::SALVENE_SWAMP_SODA . ', let\'s return to that drunk!', 'Task' => 'Return to [sector=<Starting Sector>] to claim your reward.'], ['Step' => 'Claim', 'Rewards' => ['Credits' => 500000, 'Experience' => 1000, 'Text' => '*Hiccup* For your...service *Hiccup* to me, take these *Hiccup* 500,000 credits and 1,000 experience *Hiccup*!'], 'Detail' => ['SectorID' => '<Starting Sector>'], 'Text' => 'You hand the ' . \Smr\BarDrink::SALVENE_SWAMP_SODA . ' to the drunk!']]]]

get_draft_teams()

Returns an array with all relevant information about draft teams, including their current size and if the leader can pick teammates.


    
                    get_draft_teams(int $gameId) : array<int, array<string, mixed>>

Parameters

$gameId : int

Return values

array<int, array<string, mixed>>

course_plot_forward()

This function is called by "Conventional" and "Plot To Nearest" pages.


    
                    course_plot_forward(AbstractPlayer $player, Path $path) : never

Parameters

$player : AbstractPlayer
$path : Path

Return values

never

echo_nav()


    
                    echo_nav(int $topic_id) : void

Parameters

$topic_id : int

echo_content()


    
                    echo_content(int $topic_id) : void

Parameters

$topic_id : int

echo_subsection()


    
                    echo_subsection(int $topic_id) : void

Parameters

$topic_id : int

echo_menu()


    
                    echo_menu(int $topic_id) : void

Parameters

$topic_id : int

get_numbering()


    
                    get_numbering(int $topic_id) : string

Parameters

$topic_id : int

Return values

string

replaceMissionTemplate()

Callback for array_walk_recursive in Player::rebuildMission.


    
                    replaceMissionTemplate(string|int|PlotGroup &$template, string $key, array<string, int> $replacements) : void

Searches for placeholders in template and replaces them with values derived from the supplied data.

Parameters

$template : string|int|PlotGroup
$key : string
$replacements : array<string, int>

checkMissionRequirements()


    
                    checkMissionRequirements(array<string, mixed> $values, array<string, mixed> $requirements) : bool

Parameters

$values : array<string, mixed>
$requirements : array<string, mixed>

Return values

bool

createNHA()

Create the Newbie Help Alliance and populate its Message Board


    
                    createNHA(int $gameID) : void

Parameters

$gameID : int

hit_sector_mines()


    
                    hit_sector_mines(AbstractPlayer $player) : void

Parameters

$player : AbstractPlayer

parseBoolean()


    
                    parseBoolean(mixed $check) : bool

Parameters

$check : mixed

Return values

bool

linkCombatLog()


    
                    linkCombatLog(int $logID) : string

Parameters

$logID : int

Return values

string

smrBBCode()

Converts a BBCode tag into some other text depending on the tag and value.


    
                    smrBBCode(BBCode $bbParser, int $action, string $tagName, string $default, array<string, string> $tagParams, string $tagContent) : bool|string

This is called in two stages: first with action BBCODE_CHECK (where the returned value must be a boolean) and second, if the first check passes, with action BBCODE_OUTPUT.

Parameters

$bbParser : BBCode
$action : int
$tagName : string
$default : string
$tagParams : array<string, string>
$tagContent : string

Return values

bool|string

inify()


    
                    inify(string $text) : string

Parameters

$text : string

Return values

string

bbify()


    
                    bbify(string $message[, int|null $gameID = null ][, bool $noLinks = false ]) : string

Parameters

$message : string
$gameID : int|null = null
$noLinks : bool = false

Return values

string

create_error()


    
                    create_error(string $message) : never

Parameters

$message : string

Return values

never

handleUserError()


    
                    handleUserError(string $message) : never

Parameters

$message : string

Return values

never

create_link()


    
                    create_link(Page|string $container, string $text[, string|null $class = null ]) : string

Parameters

$container : Page|string
$text : string
$class : string|null = null

Return values

string

create_submit_link()


    
                    create_submit_link(Page $container, string $text) : string

Parameters

$container : Page
$text : string

Return values

string

get_colored_text_range()


    
                    get_colored_text_range(float $value, int $maxValue[, string|null $text = null ][, int $minValue = 0 ]) : string

Parameters

$value : float
$maxValue : int
$text : string|null = null
$minValue : int = 0

Return values

string

get_colored_text()


    
                    get_colored_text(float $value[, string|null $text = null ]) : string

Parameters

$value : float
$text : string|null = null

Return values

string

word_filter()


    
                    word_filter(string $string) : string

Parameters

$string : string

Return values

string

pluralise()


    
                    pluralise(int|float $amount, string $word[, bool $includeAmount = true ]) : string

Parameters

$amount : int|float
$word : string
$includeAmount : bool = true

Return values

string

do_voodoo()

This function is a hack around the old style http forward mechanism.


    
                    do_voodoo() : never

It is also responsible for setting most of the global variables (see loader.php for the initialization of the globals).

Return values

never

saveAllAndReleaseLock()


    
                    saveAllAndReleaseLock([bool $updateSession = true ]) : void

Parameters

$updateSession : bool = true

doTickerAssigns()


    
                    doTickerAssigns(Template $template, AbstractPlayer $player, Database $db) : void

Parameters

$template : Template
$player : AbstractPlayer
$db : Database

doSkeletonAssigns()


    
                    doSkeletonAssigns(Template $template) : void

Parameters

$template : Template

format_list()

Join a list of items into a grammatically-correct sentence fragment.


    
                    format_list(array<string|int, string> $items) : string

Parameters

$items : array<string|int, string>

Return values

string

in_time_or_now()

Convert an integer number of seconds into a human-readable time for grammatically-correct use in a sentence, i.e. prefixed with "in" when the amount is positive.


    
                    in_time_or_now(int $seconds[, bool $short = false ]) : string

Parameters

$seconds : int
$short : bool = false

Return values

string

format_time()

Convert an integer number of seconds into a human-readable time.


    
                    format_time(int $seconds[, bool $short = false ]) : string

Seconds are omitted to avoid frequent and disruptive ajax updates. Use short=true to use 1-letter units (e.g. "1h and 3m"). If seconds is negative, will append "ago" to the result. If seconds is zero, will return only "now". If seconds is <60, will prefix "less than" or "<" (HTML-safe).

Parameters

$seconds : int
$short : bool = false

Return values

string

number_colour_format()


    
                    number_colour_format(float $number[, bool $justSign = false ]) : string

Parameters

$number : float
$justSign : bool = false

Return values

string

getWeightedRandom()

Randomly choose an array key weighted by the array values.


    
                    getWeightedRandom(array<string|int, mixed> $choices) : T

Probabilities are relative to the total weight. For example:

array( 'A' => 1, // 10% chance 'B' => 3, // 30% chance 'C' => 6, // 60% chance );

Parameters

$choices : array<string|int, mixed>

Return values

create_sub_menu()


    
                    create_sub_menu(array<string|int, array{entry: string, submenu?: string[]}> $menu, int $active_level1, int $active_level2) : void

Parameters

$menu : array<string|int, array{entry: string, submenu?: string[]}>
$active_level1 : int
$active_level2 : int

Application

Table of Contents

Classes

Traits

Enums

Constants

Functions

Constants

MISSION_ACTIONS

MISSIONS

Functions

get_draft_teams()

Parameters

Return values

course_plot_forward()

Parameters

Return values

echo_nav()

Parameters

echo_content()

Parameters

echo_subsection()

Parameters

echo_menu()

Parameters

get_numbering()

Parameters

Return values

replaceMissionTemplate()

Parameters

checkMissionRequirements()

Parameters

Return values

createNHA()

Parameters

hit_sector_mines()

Parameters

parseBoolean()

Parameters

Return values

linkCombatLog()

Parameters

Return values

smrBBCode()

Parameters

Return values

inify()

Parameters

Return values

bbify()

Parameters

Return values

create_error()

Parameters

Return values

handleUserError()

Parameters

Return values

create_link()

Parameters

Return values

create_submit_link()

Parameters

Return values

get_colored_text_range()

Parameters

Return values

get_colored_text()

Parameters

Return values

word_filter()

Parameters

Return values

pluralise()

Parameters

Return values

do_voodoo()

Return values

saveAllAndReleaseLock()

Parameters