C# Класс SharpMod.Player

Наследование: Entity
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
Ban ( string message, int minutes ) : void

Issue the server commands to ban a player by ip.

ExecuteCommand ( string command ) : void

Executes a supplied command on the client side of the player.

Find ( string target ) : Player
FindByAuthId ( string authId ) : Player

Finds an active Player by authid.

FindByName ( string name ) : Player

Finds an active Player by name

FindByUserId ( int id ) : Player
FindByUserId ( string id ) : Player
GetInfoKeyValue ( string key ) : string

Gets a specific value for a key from the infokeybuffer

GetPlayer ( IntPtr entity ) : Player

Gets a Player according to the entity pointer. Needed most of the time for internal engine calls, since the entity pointer is used a lot.

GetUserID ( Player player ) : int
GiveItem ( string itemname ) : Entity
Kick ( string message ) : void

Issue the server command to kick this player.

PrintCenter ( string text ) : void

Prints some text to the Player central screen

PrintChat ( string text ) : void

Prints some text to the players text in one color.

PrintConsole ( string text ) : void

Prints some text to the Players Console.

RegisterCommand ( string str, ClientCommandDelegate handler ) : void
ReloadAllPrivileges ( ) : void
ReloadPrivileges ( ) : void
SetInfoKeyValue ( string key, string val ) : void

Sets some specific InfoKeyValue according to a key.

StripUserWeapons ( ) : void
ToString ( ) : string

Returns a string representation of the player class

UpdateUserInfo ( ) : void
UpdateUserInfo ( string infoString ) : void

Защищенные методы

Метод Описание
OnAssignPrivileges ( AssignPrivilegesEventArgs args ) : void
OnAuthorize ( AuthorizeEventArgs args ) : void
OnCommand ( CommandEventArgs args ) : void
OnConnect ( ConnectEventArgs args ) : void
OnDisconnect ( DisconnectEventArgs args ) : void
OnPlayerAssignPrivileges ( AssignPrivilegesEventArgs args ) : void
OnPlayerAuthorize ( AuthorizeEventArgs args ) : void
OnPlayerClientDisconnect ( DisconnectEventArgs args ) : void
OnPlayerCommand ( CommandEventArgs args ) : void
OnPlayerConnect ( ConnectEventArgs args ) : void
OnPlayerPutInServer ( PutInServerEventArgs args ) : void
OnPutInServer ( PutInServerEventArgs args ) : void

Приватные методы

Метод Описание
OnAssignPrivileges ( Player player, Privileges privileges ) : void
OnAuthorize ( Player player ) : void
OnCommand ( IntPtr entity ) : void
OnConnect ( IntPtr entity, string name, string address, string reject_reason ) : bool
OnDisconnect ( IntPtr entity ) : void
OnPutInServer ( IntPtr entity ) : void
Player ( IntPtr entity ) : System

Constructor for internal building of Players

Release ( ) : void

Releases the event handlers

ResolvedBans ( BanInfo information ) : void
ResolvedPrivileges ( PlayerInfo pi, Privileges priv ) : void

Описание методов

Ban() публичный Метод

Issue the server commands to ban a player by ip.
public Ban ( string message, int minutes ) : void
message string /// A reason to kick/ban ///
minutes int /// The amount of minutes to ban a player by ip ///
Результат void

ExecuteCommand() публичный Метод

Executes a supplied command on the client side of the player.
public ExecuteCommand ( string command ) : void
command string /// A command as a string which must end with ; ///
Результат void

Find() публичный статический Метод

public static Find ( string target ) : Player
target string
Результат Player

FindByAuthId() публичный статический Метод

Finds an active Player by authid.
public static FindByAuthId ( string authId ) : Player
authId string /// AuthId to search by ///
Результат Player

FindByName() публичный статический Метод

Finds an active Player by name
public static FindByName ( string name ) : Player
name string /// Name to search by ///
Результат Player

FindByUserId() публичный статический Метод

public static FindByUserId ( int id ) : Player
id int
Результат Player

FindByUserId() публичный статический Метод

public static FindByUserId ( string id ) : Player
id string
Результат Player

GetInfoKeyValue() публичный Метод

Gets a specific value for a key from the infokeybuffer
public GetInfoKeyValue ( string key ) : string
key string /// The key name ///
Результат string

GetPlayer() публичный статический Метод

Gets a Player according to the entity pointer. Needed most of the time for internal engine calls, since the entity pointer is used a lot.
public static GetPlayer ( IntPtr entity ) : Player
entity System.IntPtr /// A pointer to the entity class ///
Результат Player

GetUserID() публичный статический Метод

public static GetUserID ( Player player ) : int
player Player
Результат int

GiveItem() публичный Метод

public GiveItem ( string itemname ) : Entity
itemname string
Результат Entity

Kick() публичный Метод

Issue the server command to kick this player.
public Kick ( string message ) : void
message string /// A reason for kicking ///
Результат void

OnAssignPrivileges() защищенный статический Метод

protected static OnAssignPrivileges ( AssignPrivilegesEventArgs args ) : void
args AssignPrivilegesEventArgs
Результат void

OnAuthorize() защищенный статический Метод

protected static OnAuthorize ( AuthorizeEventArgs args ) : void
args AuthorizeEventArgs
Результат void

OnCommand() защищенный статический Метод

protected static OnCommand ( CommandEventArgs args ) : void
args CommandEventArgs
Результат void

OnConnect() защищенный статический Метод

protected static OnConnect ( ConnectEventArgs args ) : void
args ConnectEventArgs
Результат void

OnDisconnect() защищенный статический Метод

protected static OnDisconnect ( DisconnectEventArgs args ) : void
args DisconnectEventArgs
Результат void

OnPlayerAssignPrivileges() защищенный Метод

protected OnPlayerAssignPrivileges ( AssignPrivilegesEventArgs args ) : void
args AssignPrivilegesEventArgs
Результат void

OnPlayerAuthorize() защищенный Метод

protected OnPlayerAuthorize ( AuthorizeEventArgs args ) : void
args AuthorizeEventArgs
Результат void

OnPlayerClientDisconnect() защищенный Метод

protected OnPlayerClientDisconnect ( DisconnectEventArgs args ) : void
args DisconnectEventArgs
Результат void

OnPlayerCommand() защищенный Метод

protected OnPlayerCommand ( CommandEventArgs args ) : void
args CommandEventArgs
Результат void

OnPlayerConnect() защищенный Метод

protected OnPlayerConnect ( ConnectEventArgs args ) : void
args ConnectEventArgs
Результат void

OnPlayerPutInServer() защищенный Метод

protected OnPlayerPutInServer ( PutInServerEventArgs args ) : void
args PutInServerEventArgs
Результат void

OnPutInServer() защищенный статический Метод

protected static OnPutInServer ( PutInServerEventArgs args ) : void
args PutInServerEventArgs
Результат void

PrintCenter() публичный Метод

Prints some text to the Player central screen
public PrintCenter ( string text ) : void
text string /// Text to print ///
Результат void

PrintChat() публичный Метод

Prints some text to the players text in one color.
public PrintChat ( string text ) : void
text string /// Text to print ///
Результат void

PrintConsole() публичный Метод

Prints some text to the Players Console.
public PrintConsole ( string text ) : void
text string /// Text to print ///
Результат void

RegisterCommand() публичный статический Метод

public static RegisterCommand ( string str, ClientCommandDelegate handler ) : void
str string
handler ClientCommandDelegate
Результат void

ReloadAllPrivileges() публичный статический Метод

public static ReloadAllPrivileges ( ) : void
Результат void

ReloadPrivileges() публичный Метод

public ReloadPrivileges ( ) : void
Результат void

SetInfoKeyValue() публичный Метод

Sets some specific InfoKeyValue according to a key.
public SetInfoKeyValue ( string key, string val ) : void
key string /// The key ///
val string /// The value which has to be set to the key ///
Результат void

StripUserWeapons() публичный Метод

public StripUserWeapons ( ) : void
Результат void

ToString() публичный Метод

Returns a string representation of the player class
public ToString ( ) : string
Результат string

UpdateUserInfo() публичный Метод

public UpdateUserInfo ( ) : void
Результат void

UpdateUserInfo() публичный Метод

public UpdateUserInfo ( string infoString ) : void
infoString string
Результат void