[This is preliminary documentation and is subject to change.]

Advanced kick command.

Namespace: fCraft
Assembly: fCraft (in fCraft.dll) Version: 0.6.3.0 (0.6.3.0)

Syntax


	C#

public void Kick(
	Player player,
	string reason,
	LeaveReason context,
	bool announce,
	bool raiseEvents,
	bool recordToPlayerDB
)

Parameters

player: Player
Player who is kicking.

reason: String
Reason for kicking. May be null or blank if allowed by server configuration.

context: LeaveReason
Classification of kick context.

announce: Boolean
Whether the kick should be announced publicly on the server and IRC.

raiseEvents: Boolean
Whether Player.BeingKicked and Player.Kicked events should be raised.

recordToPlayerDB: Boolean
Whether the kick should be counted towards player's record.

See Also

fCraft Namespace