C# Class TShockAPI.Hooks.PlayerHooks

A collection of events fired by players that can be hooked to.
Mostrar archivo Open project: NyxStudios/TShock

Public Methods

Method Description
OnPlayerChat ( TSPlayer ply, string rawtext, string &tshockText ) : void

Fires the PlayerChat event.

OnPlayerCommand ( TSPlayer player, string cmdName, string cmdText, List args, IEnumerable &commands, string cmdPrefix ) : bool

Fires the PlayerCommand event.

OnPlayerLogout ( TSPlayer ply ) : void

Fires the PlayerLogout event.

OnPlayerPermission ( TSPlayer player, string permission ) : bool

Fires the PlayerPermission event.

OnPlayerPostLogin ( TSPlayer ply ) : void

Fires the PlayerPostLogin event.

OnPlayerPreLogin ( TSPlayer ply, string name, string pass ) : bool

Fires the PlayerPreLogin event.

Method Details

OnPlayerChat() public static method

Fires the PlayerChat event.
public static OnPlayerChat ( TSPlayer ply, string rawtext, string &tshockText ) : void
ply TSPlayer The player firing the event.
rawtext string The raw chat text sent by the player.
tshockText string The chat text after being formatted.
return void

OnPlayerCommand() public static method

Fires the PlayerCommand event.
public static OnPlayerCommand ( TSPlayer player, string cmdName, string cmdText, List args, IEnumerable &commands, string cmdPrefix ) : bool
player TSPlayer The player firing the event.
cmdName string The command name.
cmdText string The raw command text.
args List The command args extracted from the command text.
commands IEnumerable The list of commands.
cmdPrefix string The command specifier used.
return bool

OnPlayerLogout() public static method

Fires the PlayerLogout event.
public static OnPlayerLogout ( TSPlayer ply ) : void
ply TSPlayer The player firing the event.
return void

OnPlayerPermission() public static method

Fires the PlayerPermission event.
public static OnPlayerPermission ( TSPlayer player, string permission ) : bool
player TSPlayer The player firing the event.
permission string
return bool

OnPlayerPostLogin() public static method

Fires the PlayerPostLogin event.
public static OnPlayerPostLogin ( TSPlayer ply ) : void
ply TSPlayer The player firing the event.
return void

OnPlayerPreLogin() public static method

Fires the PlayerPreLogin event.
public static OnPlayerPreLogin ( TSPlayer ply, string name, string pass ) : bool
ply TSPlayer The player firing the event.
name string The user name.
pass string The password.
return bool