KickCommand Interface Reference

Inheritance diagram for KickCommand:

Public Member Functions
override string	GetKeyword ()
	Command's name without the '#' prefix.
override bool	IsServerSide ()
	True if the command should be passed to the server. False for only client-side execution.
override int	RequiredRCONPermission ()
	Required permission (ERCONPermissions) to run RCON execution.
override int	RequiredChatPermission ()
	Required permission (EPlayerRole) to run chat execution.
override ref ScrServerCmdResult	OnChatServerExecution (array< string > argv, int playerId)
	The main chat execution that is executed on the server (if IsServerSide is true)
override ref ScrServerCmdResult	OnChatClientExecution (array< string > argv, int playerId)
	The first chat execution stage (always on the client side).
override ref ScrServerCmdResult	OnRCONExecution (array< string > argv)
	Server-side rcon command execution.
override ref ScrServerCmdResult	OnUpdate ()
	Update PENDING request.
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
ScrServerCmdResult	KickPlayer (array< string > argv, int playerId=0)
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()

override string KickCommand.GetKeyword

(

)

Command's name without the '#' prefix.

Implements ScrServerCommand.

IsServerSide()

override bool KickCommand.IsServerSide

(

)

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

Implements ScrServerCommand.

KickPlayer()

ScrServerCmdResult KickCommand.KickPlayer ( array< string >  argv, int  playerId = 0  )

protected

OnChatClientExecution()

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

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

Implements ScrServerCommand.

OnChatServerExecution()

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

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

Implements ScrServerCommand.

OnRCONExecution()

override ref ScrServerCmdResult KickCommand.OnRCONExecution

(

array< string >

argv

)

Server-side rcon command execution.

Implements ScrServerCommand.

OnUpdate()

override ref ScrServerCmdResult KickCommand.OnUpdate

(

)

Update PENDING request.

Implements ScrServerCommand.

RequiredChatPermission()

override int KickCommand.RequiredChatPermission

(

)

Required permission (EPlayerRole) to run chat execution.

Implements ScrServerCommand.

RequiredRCONPermission()

override int KickCommand.RequiredRCONPermission

(

)

Required permission (ERCONPermissions) to run RCON execution.

Implements ScrServerCommand.

---

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

• Game/Network/ServerCommands/BanCommands.c