Provides data for Player.BeingKicked event. Cancelable. More...

Inheritance diagram for fCraft.Events.PlayerBeingKickedEventArgs:

Collaboration diagram for fCraft.Events.PlayerBeingKickedEventArgs:

Properties
Player	Player `[get, set]`
	Player who is being kicked (target).

Player	Kicker `[get, set]`
	Player who is kicking.

string	Reason `[get, set]`
	Given kick reason. May be null. Can be changed.

bool	Announce `[get, set]`
	Whether the kick should be announced in-game and on IRC. Can be changed.

bool	RecordToPlayerDB `[get, set]`
	Whether kick should be added to the target's record. Can be changed.

LeaveReason	Context `[get, set]`
	Circumstances that resulted in a kick (e.g. Kick, Ban, BanIP, IdleKick, etc).

bool	Cancel `[get, set]`

Properties inherited from fCraft.Events.IPlayerEvent
Player	Player `[get]`
	Player who initiated or is affected by the event.

Properties inherited from fCraft.ICancelableEvent
bool	Cancel `[get, set]`
	Set to "true" to cancel the event.

Detailed Description

Provides data for Player.BeingKicked event. Cancelable.

Property Documentation

bool fCraft.Events.PlayerBeingKickedEventArgs.Announce

getset

Whether the kick should be announced in-game and on IRC. Can be changed.

bool fCraft.Events.PlayerBeingKickedEventArgs.Cancel

getset

LeaveReason fCraft.Events.PlayerBeingKickedEventArgs.Context

getset

Circumstances that resulted in a kick (e.g. Kick, Ban, BanIP, IdleKick, etc).

Player fCraft.Events.PlayerBeingKickedEventArgs.Kicker

getset

Player who is kicking.

Player fCraft.Events.PlayerBeingKickedEventArgs.Player

getset

Player who is being kicked (target).

string fCraft.Events.PlayerBeingKickedEventArgs.Reason

getset

Given kick reason. May be null. Can be changed.

bool fCraft.Events.PlayerBeingKickedEventArgs.RecordToPlayerDB

getset

Whether kick should be added to the target's record. Can be changed.

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