[This is preliminary documentation and is subject to change.]
Provides data for Player.BeingKicked event. Cancellable.
Namespace: fCraft.EventsAssembly: fCraft (in fCraft.dll) Version: 0.6.3.0 (0.6.3.0)
Syntax
| C# |
public sealed class PlayerBeingKickedEventArgs : EventArgs, IPlayerEvent, ICancelableEvent
Members
| All Members | Properties | Methods |
| Member | Description | |
|---|---|---|
| Announce | Whether the kick should be announced in-game and on IRC. Can be changed. | |
| Cancel | ||
| Context | Circumstances that resulted in a kick (e.g. Kick, Ban, BanIP, IdleKick, etc). | |
| Equals(Object) | (Inherited from Object.) | |
| Finalize()()()() |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) | |
| GetHashCode()()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) | |
| GetType()()()() |
Gets the Type of the current instance.
(Inherited from Object.) | |
| Kicker | Player who is kicking. | |
| MemberwiseClone()()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) | |
| Player | Player who is being kicked (target). | |
| Reason | Given kick reason. May be null. Can be changed. | |
| RecordToPlayerDB | Whether kick should be added to the target's record. Can be changed. | |
| ToString()()()() | (Inherited from Object.) |