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
-
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(int $topic_id) : void
Parameters
-
$topic_id
: int
-
get_numbering()
get_numbering(int $topic_id) : string
Parameters
-
$topic_id
: int
-
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
-
linkCombatLog()
linkCombatLog(int $logID) : string
Parameters
-
$logID
: int
-
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
-
bbify()
bbify(string $message[, int|null $gameID = null ][, bool $noLinks = false ]) : string
Parameters
-
$message
: string
-
-
$gameID
: int|null
= null
-
-
$noLinks
: bool
= false
-
create_error()
create_error(string $message) : never
Parameters
-
$message
: string
-
handleUserError()
handleUserError(string $message) : never
Parameters
-
$message
: string
-
create_link()
create_link(Page|string $container, string $text[, string|null $class = null ]) : string
Parameters
-
$container
: Page|string
-
-
$text
: string
-
-
$class
: string|null
= null
-
create_submit_link()
create_submit_link(Page $container, string $text) : string
Parameters
-
$container
: Page
-
-
$text
: string
-
create_submit_display()
Create a submit element that will not add any data to the submitted form.
create_submit_display(string $display[, array<string, string|int|true> $fields = [] ]) : string
Parameters
-
$display
: string
-
-
$fields
: array<string, string|int|true>
= []
-
create_submit()
Create a submit element that will add a name-value field to the submitted form data.
create_submit(string $name, string $value[, string|null $display = null ][, array<string, string|int|true> $fields = [] ]) : string
Parameters
-
$name
: string
-
-
$value
: string
-
-
$display
: string|null
= null
-
-
$fields
: array<string, string|int|true>
= []
-
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
-
get_colored_text()
get_colored_text(float $value[, string|null $text = null ]) : string
Parameters
-
$value
: float
-
-
$text
: string|null
= null
-
word_filter()
word_filter(string $string) : string
Parameters
-
$string
: string
-
pluralise()
pluralise(int|float $amount, string $word[, bool $includeAmount = true ]) : string
Parameters
-
$amount
: int|float
-
-
$word
: string
-
-
$includeAmount
: bool
= true
-
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).
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
-
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>
-
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
-
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
-
number_colour_format(float $number[, bool $justSign = false ]) : string
Parameters
-
$number
: float
-
-
$justSign
: bool
= false
-
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>
-
-
template
-
signed_sqrt()
signed_sqrt(float $x) : float
Parameters
-
$x
: float
-