fCraft  0.636
Custom Minecraft Server
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Events
Public Member Functions | Properties | List of all members
fCraft.PlayerOpException Class Reference

Exception that is thrown when a player's action or command could not be completed. More...

Inheritance diagram for fCraft.PlayerOpException:
Inheritance graph
[legend]
Collaboration diagram for fCraft.PlayerOpException:
Collaboration graph
[legend]

Public Member Functions

 PlayerOpException ([NotNull] Player player, PlayerInfo target, PlayerOpExceptionCode errorCode,[NotNull] string message,[NotNull] string messageColored)
 Initialises a new instance of fCraft.PlayerOpException, using the specified information.
 

Properties

Player Player [get, set]
 Player who caused the error.
 
PlayerInfo Target [get, set]
 Target of the command that caused the error.
 
PlayerOpExceptionCode ErrorCode [get, set]
 Error code associated with the error.
 
string MessageColored [get, set]
 Message to display to player, via Minecraft chat. Optionally enhanced with colorcodes.
 

Detailed Description

Exception that is thrown when a player's action or command could not be completed.

Constructor & Destructor Documentation

fCraft.PlayerOpException.PlayerOpException ( [NotNull] Player  player,
PlayerInfo  target,
PlayerOpExceptionCode  errorCode,
[NotNull] string  message,
[NotNull] string  messageColored 
)

Initialises a new instance of fCraft.PlayerOpException, using the specified information.

Parameters
playerThe player executing the command.
targetThe target of the command, null if no target.
errorCodeSpecific error code.
messageMessage to display.
messageColoredMessage to display with colour codes applied.

Property Documentation

PlayerOpExceptionCode fCraft.PlayerOpException.ErrorCode
getset

Error code associated with the error.

string fCraft.PlayerOpException.MessageColored
getset

Message to display to player, via Minecraft chat. Optionally enhanced with colorcodes.

Player fCraft.PlayerOpException.Player
getset

Player who caused the error.

PlayerInfo fCraft.PlayerOpException.Target
getset

Target of the command that caused the error.


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