CoreFunction
Table of Contents
- baseUrl() : string
- Add server name to url query.
- bdump() : void
- Function to use bdump of Tracy debugger.
- gameCopyright() : string
- Get copyright of game.
- gametime() : string
- Time in the game.
- gameVersion() : string
- Get version of game.
- getsetting() : string
- Get value of setting.
- isValidProtocol() : bool
- Validating a protocol.
- pvpListSleepers() : string
- Render a count of sleepers for zone.
- pvpListTable() : string
- Render a PvP table list.
- secondstonextgameday() : int
- Seconds to next game day.
- sessionCookieName() : string
- Get cookie name.
- triggerEvent() : mixed
- Activate a hook.
- varDump() : string
- Dump var and return a string.
Methods
baseUrl()
Add server name to url query.
public
baseUrl(string $query) : string
Parameters
- $query : string
Return values
string —bdump()
Function to use bdump of Tracy debugger.
public
bdump(mixed $param[, string $name = null ]) : void
Parameters
- $param : mixed
- $name : string = null
Return values
void —gameCopyright()
Get copyright of game.
public
gameCopyright() : string
Return values
string —gametime()
Time in the game.
public
gametime() : string
Return values
string —gameVersion()
Get version of game.
public
gameVersion() : string
Return values
string —getsetting()
Get value of setting.
public
getsetting(string $name, string $default) : string
Parameters
- $name : string
- $default : string
Return values
string —isValidProtocol()
Validating a protocol.
public
isValidProtocol(mixed $url) : bool
Parameters
- $url : mixed
Return values
bool —pvpListSleepers()
Render a count of sleepers for zone.
public
pvpListSleepers(Environment $env, array<string|int, mixed> $params) : string
Parameters
- $env : Environment
- $params : array<string|int, mixed>
Return values
string —pvpListTable()
Render a PvP table list.
public
pvpListTable(Environment $env, array<string|int, mixed> $params) : string
Parameters
- $env : Environment
- $params : array<string|int, mixed>
Return values
string —secondstonextgameday()
Seconds to next game day.
public
secondstonextgameday() : int
Return values
int —sessionCookieName()
Get cookie name.
public
sessionCookieName() : string
Return values
string —triggerEvent()
Activate a hook.
public
triggerEvent(string $name[, array<string|int, mixed> $data = [] ]) : mixed
Parameters
- $name : string
- $data : array<string|int, mixed> = []
Return values
mixed —varDump()
Dump var and return a string.
public
varDump(mixed $var) : string
Parameters
- $var : mixed