RCON

Summary

Methods

Method	Returns
SendCommand(command: string)	string{}
SendCommand(command: string, args: string{})	string{}
RegisterCommand(command: string, flags: RemoteCommandFlag, callback: callable)	int
RegisterCommand(command: string, flags: RemoteCommandFlag, context: any, callback: callable)	int
DeregisterCommand(handle: int)	void
GetServerGuid()	Guid | nil
TriggerEvent(event: string)	void
TriggerEvent(event: string, args: string{})	void

Methods

SendCommand

SendCommand(command: string): string{}

Parameters

Name	Type	Description
command	string

Returns

Type	Description
string{}

SendCommand

SendCommand(command: string, args: string{}): string{}

Parameters

Name	Type	Description
command	string
args	string{}

Returns

Type	Description
string{}

RegisterCommand

RegisterCommand(command: string, flags: RemoteCommandFlag, callback: callable): int

Parameters

Name	Type	Description
command	string
flags	RemoteCommandFlag
callback	callable	A callback in the form function(command: string, args: string{}, loggedIn: bool): string{}.

Returns

Type	Description
int

RegisterCommand

RegisterCommand(command: string, flags: RemoteCommandFlag, context: any, callback: callable): int

Parameters

Name	Type	Description
command	string
flags	RemoteCommandFlag
context	any	A context value to pass to the callback.
callback	callable	A callback in the form function(context: any, command: string, args: string{}, loggedIn: bool): string{}.

Returns

Type	Description
int

DeregisterCommand

DeregisterCommand(handle: int)

Parameters

Name	Type	Description
handle	int

GetServerGuid

GetServerGuid(): Guid | nil

Returns

Type	Description
Guid | nil

TriggerEvent

TriggerEvent(event: string)

Parameters

Name	Type	Description
event	string

TriggerEvent

TriggerEvent(event: string, args: string{})

Parameters

Name	Type	Description
event	string
args	string{}