Documentation

Smr

Table of Contents

Namespaces

Admin
Blackjack
Chess
Combat
Container
Discord
Exceptions
Login
Page
PlanetTypes
Routes
SocialLogin
Traits

Classes

AbstractPlayer
AbstractShip
Properties and methods for a ship instance.
Account
AdminPermissions
Album
Alliance
AllianceInvite
Object interfacing with the alliance_invites_player table.
BarDrink
Provides details about bar drinks
Bounty
Changelog
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).
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.
Force
Galaxy
Game
Globals
HallOfFame
Collection of functions to help display the Hall of Fame tables.
HardwareType
Location
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.
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.
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.
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
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.

Enums

BountyType
BuyerRestriction
Enumeration of buyer restrictions for ships and weapons.
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.

Functions

create_sub_menu()  : void

Functions

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

        
On this page

Search results