BanCommand Interface Reference

Inheritance diagram for BanCommand:

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.

Static Public Attributes
const static int	BAN_LIST_ITEMS_PER_PAGE_CHAT = 10
const static int	BAN_LIST_ITEMS_PER_PAGE_RCON = 25

Protected Member Functions
ScrServerCmdResult	CreateBan (array< string > argv, int playerId)
ScrServerCmdResult	RemoveBan (array< string > argv, int playerId)
ScrServerCmdResult	ListBans (array< string > argv, int playerId)
ScrServerCmdResult	ListBansResult ()
ScrServerCmdResult	ListBansResultFiltered ()
ScrServerCmdResult	HandleCommand (array< string > argv, int playerId=0)
SCR_EPlayerIdType	GetPlayerIdType (string id)
int	GetPlayerIdFromName (string name)
array< string >	TryParsePlayerNameWithSpaces (array< string > argv, int playerNameStartId)
ScrServerCmdResult	HandleSuccessfulResult ()
ScrServerCmdResult	HandleFailure ()

Protected Attributes
ref StateBackendCallback	m_Callback
ref BanListPageParams	m_Params
BanServiceApi	m_BanApi
SCR_EBanSubcommandArg	m_eSubcommandArg
int	m_iBanPlayerId
int	m_iDuration
int	m_iPage
string	m_sBanReason = ""
string	m_sPlayerName = ""

Member Function Documentation

CreateBan()

ScrServerCmdResult BanCommand.CreateBan ( array< string > argv, int playerId )

protected

GetKeyword()

override string BanCommand.GetKeyword

(

)

Command's name without the '#' prefix.

Implements ScrServerCommand.

GetPlayerIdFromName()

int BanCommand.GetPlayerIdFromName ( string name )

protected

GetPlayerIdType()

SCR_EPlayerIdType BanCommand.GetPlayerIdType ( string id )

protected

HandleCommand()

ScrServerCmdResult BanCommand.HandleCommand ( array< string > argv, int playerId = 0 )

protected

HandleFailure()

ScrServerCmdResult BanCommand.HandleFailure ( )

protected

HandleSuccessfulResult()

ScrServerCmdResult BanCommand.HandleSuccessfulResult ( )

protected

IsServerSide()

override bool BanCommand.IsServerSide

(

)

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

Implements ScrServerCommand.

ListBans()

ScrServerCmdResult BanCommand.ListBans ( array< string > argv, int playerId )

protected

ListBansResult()

ScrServerCmdResult BanCommand.ListBansResult ( )

protected

ListBansResultFiltered()

ScrServerCmdResult BanCommand.ListBansResultFiltered ( )

protected

OnChatClientExecution()

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

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

Implements ScrServerCommand.

OnChatServerExecution()

override ref ScrServerCmdResult BanCommand.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 BanCommand.OnRCONExecution

(

array< string >

argv

)

Server-side rcon command execution.

Implements ScrServerCommand.

OnUpdate()

override ref ScrServerCmdResult BanCommand.OnUpdate

(

)

Update PENDING request.

Implements ScrServerCommand.

RemoveBan()

ScrServerCmdResult BanCommand.RemoveBan ( array< string > argv, int playerId )

protected

RequiredChatPermission()

override int BanCommand.RequiredChatPermission

(

)

Required permission (EPlayerRole) to run chat execution.

Implements ScrServerCommand.

RequiredRCONPermission()

override int BanCommand.RequiredRCONPermission

(

)

Required permission (ERCONPermissions) to run RCON execution.

Implements ScrServerCommand.

TryParsePlayerNameWithSpaces()

array< string > BanCommand.TryParsePlayerNameWithSpaces ( array< string > argv, int playerNameStartId )

protected

Member Data Documentation

BAN_LIST_ITEMS_PER_PAGE_CHAT

const static int BanCommand.BAN_LIST_ITEMS_PER_PAGE_CHAT = 10

static

BAN_LIST_ITEMS_PER_PAGE_RCON

const static int BanCommand.BAN_LIST_ITEMS_PER_PAGE_RCON = 25

static

m_BanApi

BanServiceApi BanCommand.m_BanApi

protected

m_Callback

ref StateBackendCallback BanCommand.m_Callback

protected

m_eSubcommandArg

SCR_EBanSubcommandArg BanCommand.m_eSubcommandArg

protected

m_iBanPlayerId

int BanCommand.m_iBanPlayerId

protected

m_iDuration

int BanCommand.m_iDuration

protected

m_iPage

int BanCommand.m_iPage

protected

m_Params

ref BanListPageParams BanCommand.m_Params

protected

m_sBanReason

string BanCommand.m_sBanReason = ""

protected

m_sPlayerName

string BanCommand.m_sPlayerName = ""

protected

---

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

• Game/Network/ServerCommands/BanCommands.c