Global

Methods

parseLogString(string){Object}

utils/parseLogString.js, line 7

Parses the log strings returned from ShowAdminLog into objects.

Name	Type	Description
string	string

Returns:

Type	Description
Object

asyncsafeRcon(promise, fallback){Promise.<(T|null)>}

utils/safeRcon.js, line 9

Safely resolves an RCON promise without throwing.

Name	Type	Default	Description
promise	PromiseLike.<T>
fallback	T | null	null	optional

Returns:

Type	Description
Promise.<(T|null)>

xor(buffer, xorKey){Buffer}

utils/xor.js, line 7

Applies an XOR cipher to a buffer using the provided key.

Name	Type	Description
buffer	Buffer	The input buffer.
xorKey	Buffer	The XOR key.

Returns:

Type	Description
Buffer	The transformed buffer.

Type Definitions

AdminUserRecordObject

Properties:

Name	Type	Description
userId	string
group	string
comment	string

BanRecordObject

Properties:

Name	Type	Description
userId	string
userName	string
timeOfBanning	string
durationHours	number
banReason	string
adminName	string

MapRotationEntryObject

Properties:

Name	Type	Description
name	string
gameMode	string
timeOfDay	string
id	string
position	number

MapSequenceEntryObject

Properties:

Name	Type	Description
name	string
gameMode	string
timeOfDay	string
id	string	File path of the map
position	number

PlayerPositionObject

Properties:

Name	Type	Description
x	number
y	number
z	number

PlayerScoreDataObject

Properties:

Name	Type	Description
combat	number
offense	number
defense	number
support	number

PlayerStatsObject

Properties:

Name	Type	Description
deaths	number
infantryKills	number
vehicleKills	number
teamKills	number
vehiclesDestroyed	number

RCONCommandInformationObject

Properties:

Name	Type	Description
name	string
text	string
description	string
dialogueParameters	Array.<RconCommandDialogueParameter>

RconCommandDialogueParameterObject

Properties:

Name	Type	Description
type	string
name	string
id	string
displayMember	string
valueMember	string

RequestCacheItemObject

Properties:

Name	Type	Description
resolve	function	The promise resolve function.
reject	function	The promise reject function.
requestMessage	RequestMessage	The instantiated request message.
encrypted	boolean	Whether the message was sent encrypted.

RequestCacheItemObject

Properties:

Name	Type	Description
resolve	function	The promise resolve function.
requestMessage	RequestMessage	The original request message.
encrypted	boolean	Whether the request was encrypted.

ServerConfigurationObject

Properties:

Name	Type	Description
serverName	string
buildNumber	string
buildRevision	string
supportedPlatforms	Array.<string>
passwordProtected	boolean

SessionObject

Properties:

Name	Type	Description
serverName	string
mapName	string
mapId	string
gameMode	string
remainingMatchTime	number
matchTime	number
alliedFaction	number
axisFaction	number
alliedScore	number
axisScore	number
playerCount	number
alliedPlayerCount	number
axisPlayerCount	number
maxPlayerCount	number
queueCount	number
maxQueueCount	number
vipQueueCount	number
maxVipQueueCount	number

VIPPlayerObject

Properties:

Name	Type	Description
id	string
comment	string