Class Clansuite\Capture\ServerInfo

`final`

Represents detailed information about a game server, including status, players, and configuration.

Located at Capture/ServerInfo.php

Methods


					
	public

__construct(
	null|string $address = null,
	null|int $queryport = null,
	bool $online = false,
	null|string $gamename = null,
	null|string $gameversion = null,
	null|string $servertitle = null,
	null|string $mapname = null,
	null|string $gametype = null,
	int $numplayers = 0,
	int $maxplayers = 0,
	array<mixed> $rules = [],
	array<mixed> $players = [],
	array<mixed> $channels = [],
	null|string $errstr = null,
	?bool $password = null,
	?string $name = null,
	?string $map = null,
	?int $players_current = null,
	?int $players_max = null,
	?string $version = null,
	?string $motd = null,
)

Initializes server information with the provided data.

Parameters

`$address`	Server IP address
`$queryport`	Query port number
`$online`	Whether the server is online
`$gamename`	Name of the game
`$gameversion`	Game version
`$servertitle`	Server title
`$mapname`	Current map name
`$gametype`	Game type/mode
`$numplayers`	Current number of players
`$maxplayers`	Maximum number of players
`$rules`	Server rules/configuration
`$players`	List of players
`$channels`	Voice channels (for applicable games)
`$errstr`	Error message if query failed


					
	public

toArray(): array<mixed>

Converts the server information to an associative array.

Returns

Server info as key-value pairs

Properties
`public`	`null\|string`	`$address` Server IP address Server IP address	#
`public`	`null\|int`	`$queryport` Query port number Query port number	#
`public`	`bool`	`$online` Whether the server is online Whether the server is online	#
`public`	`null\|string`	`$gamename` Name of the game Name of the game	#
`public`	`null\|string`	`$gameversion` Game version Game version	#
`public`	`null\|string`	`$servertitle` Server title Server title	#
`public`	`null\|string`	`$mapname` Current map name Current map name	#
`public`	`null\|string`	`$gametype` Game type/mode Game type/mode	#
`public`	`int`	`$numplayers` Current number of players Current number of players	#
`public`	`int`	`$maxplayers` Maximum number of players Maximum number of players	#
`public`	`array<mixed>`	`$rules` Server rules/configuration Server rules/configuration	#
`public`	`array<mixed>`	`$players` List of players List of players	#
`public`	`array<mixed>`	`$channels` Voice channels (for applicable games) Voice channels (for applicable games)	#
`public`	`null\|string`	`$errstr` Error message if query failed Error message if query failed	#
`public`	`?bool`	`$password`	#
`public`	`?string`	`$name`	#
`public`	`?string`	`$map`	#
`public`	`?int`	`$players_current`	#
`public`	`?int`	`$players_max`	#
`public`	`?string`	`$version`	#
`public`	`?string`	`$motd`	#

Namespaces

Classes

Exceptions

Functions

Class Clansuite\Capture\ServerInfo

Parameters

Returns