ScrServerCommand Interface Reference

Inheritance diagram for ScrServerCommand:

Public Member Functions
string	GetKeyword ()
	Command's name without the '#' prefix.
bool	IsServerSide ()
	True if the command should be passed to the server. False for only client-side execution.

Protected Member Functions
ref ScrServerCmdResult	OnUpdate ()
	Update PENDING request.
ref ScrServerCmdResult	OnRCONExecution (array< string > argv)
	Server-side rcon command execution.
int	RequiredRCONPermission ()
	Required permission (ERCONPermissions) to run RCON execution.
ref ScrServerCmdResult	OnChatServerExecution (array< string > argv, int playerId)
	The main chat execution that is executed on the server (if IsServerSide is true)
ref ScrServerCmdResult	OnChatClientExecution (array< string > argv, int playerId)
	The first chat execution stage (always on the client side).
int	RequiredChatPermission ()
	Required permission (EPlayerRole) to run chat execution.

Member Function Documentation

GetKeyword()

string ScrServerCommand.GetKeyword

(

)

Command's name without the '#' prefix.

Implemented in BanCommand, KickCommand, and UploadSaveCommand.

IsServerSide()

bool ScrServerCommand.IsServerSide

(

)

True if the command should be passed to the server. False for only client-side execution.

Implemented in BanCommand, KickCommand, and UploadSaveCommand.

OnChatClientExecution()

ref ScrServerCmdResult ScrServerCommand.OnChatClientExecution ( array< string >  argv, int  playerId  )

protected

The first chat execution stage (always on the client side).

Implemented in BanCommand, KickCommand, and UploadSaveCommand.

OnChatServerExecution()

ref ScrServerCmdResult ScrServerCommand.OnChatServerExecution ( array< string >  argv, int  playerId  )

protected

The main chat execution that is executed on the server (if IsServerSide is true)

Implemented in BanCommand, KickCommand, and UploadSaveCommand.

OnRCONExecution()

ref ScrServerCmdResult ScrServerCommand.OnRCONExecution ( array< string >  argv )

protected

Server-side rcon command execution.

Implemented in BanCommand, and KickCommand.

OnUpdate()

ref ScrServerCmdResult ScrServerCommand.OnUpdate ( )

protected

Update PENDING request.

Implemented in BanCommand, KickCommand, and UploadSaveCommand.

RequiredChatPermission()

int ScrServerCommand.RequiredChatPermission ( )

protected

Required permission (EPlayerRole) to run chat execution.

Implemented in BanCommand, KickCommand, and UploadSaveCommand.

RequiredRCONPermission()

int ScrServerCommand.RequiredRCONPermission ( )

protected

Required permission (ERCONPermissions) to run RCON execution.

Implemented in BanCommand, and KickCommand.

---

The documentation for this interface was generated from the following file:

• Game/generated/ScrServerCommand.c