Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

[detail level 12345]

fCraft
AutoRank
AutoRankManager
Condition	Base class for all AutoRank conditions.
ConditionIntRange	Class for checking ranges of countable PlayerInfo fields (see ConditionField enum).
ConditionRankChangeType	Checks what caused player's last rank change (see RankChangeType enum).
ConditionPreviousRank	Checks what rank the player held previously.
ConditionSet	Base class for condition sets/combinations.
ConditionAND	Logical AND - true if ALL conditions are true.
ConditionNAND	Logical AND - true if NOT ALL of the conditions are true.
ConditionOR	Logical AND - true if ANY of the conditions are true.
ConditionNOR	Logical AND - true if NONE of the conditions are true.
Criterion
Drawing
CheckeredBrushFactory	Constructs CheckeredBrush.
CheckeredBrush	Brush that alternates between two block types, in a checkered pattern.
CloudyBrushFactory	Constructs CloudyBrush.
CloudyBrush	Brush that uses 3D perlin noise to create "cloudy" patterns.
NormalBrushFactory	Constructs NormalBrush.
NormalBrush	Brush that creates a solid, single-block fill.
RainbowBrush	Brush that creates a diagonal rainbow pattern, using Red, Orange, Yellow, Green, Aqua, Blue, and Violet blocks.
RandomBrushFactory	Constructs RandomBrush.
RandomBrush	Brush that creates a random pattern, with individually adjustable probabilities for each blocktype.
ReplaceBrushFactory	Constructs ReplaceBrush.
ReplaceBrush	Brush that replaces all blocks of given type(s) with a replacement blocktype.
ReplaceBrushBrushFactory	Constructs ReplaceBrushBrush.
ReplaceBrushBrush	Brush that replaces all blocks of the given type with output of a brush.
ReplaceNotBrushFactory	Constructs ReplaceNotBrush.
ReplaceNotBrush	Brush that replaces all blocks EXCEPT those of given type(s) with a replacement blocktype.
BrushManager	Indexes available brushes. Provides /Brush command, a way to register new brushes, a way to look up existing brushes by name.
CopyState	Represents a set of copied blocks, including metadata. Created by /Copy and /Cut commands.
DrawOperation	Abstract class representing a drawing operation.
BlockDBDrawOperation	Draw operation that applies changes from a given BlockDBEntry array.
CuboidDrawOperation	Draw operation that creates a simple cuboid.
CuboidHollowDrawOperation	Draw operation that creates a hollow cuboid, optionally filling the center.
CuboidWireframeDrawOperation	Draw operation that creates a wireframe cuboid, optionally filling sides and center.
CutDrawOperation	Draw operation that handles /Cut command. Copies everything into currently-selected copy slot as soon as Begin() is called, then gradually fills the area.
EllipsoidDrawOperation	Draw operation that creates a filled ellipsoid.
EllipsoidHollowDrawOperation	Draw operation that creates a hollow ellipsoid, or an ellipsoid filled differently on inside and outside. The "shell" of the ellipsoid is always 1 block wide.
Fill2DDrawOperation	Draw operation that performs a 2D flood fill. Uses player's position to determine plane of filling.
LineDrawOperation	Draw operation that creates a simple line, 1 block thick.
PasteDrawOperation	Draw operation that handles aligned (two-mark) pasting for /PasteX and /PasteNotX commands. Also used internally by /Paste and /PasteNot.
QuickPasteDrawOperation	Draw operation that handles non-aligned (single-mark) pasting for /Paste and /PasteNot. Preserves original orientation of the CopyState.
SphereDrawOperation	Draw operation that creates a solid sphere.
SphereHollowDrawOperation	Draw operation that creates a hollow sphere, or a sphere filled differently on inside and outside. The "shell" of the sphere is always 1 block wide.
TorusDrawOperation	Draw operation that creates a horizontal torus.
TriangleDrawOperation	Draw operation that creates a filled triangle, 1 block thick, using three given coordinates as vertices.
TriangleWireframeDrawOperation	Draw operation that creates an outline of a triangle, using three given coordinates as vertices.
UndoDrawOperation	Draw operation that handles /Undo and /Redo commands. Applies changes stored in a given UndoState object.
DrawOpWithBrush	A self-contained DrawOperation that prodivides its own brush. Purpose of this class is mostly to take care of the boilerplate code.
IBrushFactory	Class that desribes a type of brush in general, and allows creating new brushes with /Brush. One instance of IBrushFactory for each type of brush is kept by the BrushManager.
IBrush	Class that describes a configured brush, and allows creating instances for specific DrawOperations. Configuration-free brush types may combine IBrushFactory and IBrushType into one class.
IBrushInstance	Class that describes an individual instance of a configured brush. Each brush instance will only be used for one DrawOperation, so it can store state. Stateless brush types may combine IBrush and IBrushInstance into one class.
UndoState	Object used to store
UndoBlock	Stores state of a block at a particular coordinate, used by UndoState.
Events
CommandRegisteredEventArgs	Provides data for CommandManager.CommandRegistered event. Immutable.
CommandRegistringEventArgs	Provides data for CommandManager.CommandRegistering event. Cancelable.
CommandCalledEventArgs	Provides data for CommandManager.CommandCalled event. Immutable.
CommandCallingEventArgs	Provides data for CommandManager.CommandCalling event. Cancelable.
DrawOperationEventArgs
DrawOperationBeginningEventArgs
HeartbeatSendingEventArgs	Provides data for Heartbeat.Sending event. Cancelable. HeartbeatData may be modified, Uri and GetSercerUri may be changed.
HeartbeatSentEventArgs	Provides data for Heartbeat.Sent event. Immutable.
UriChangedEventArgs	Provides data for Heartbeat.UriChanged event. Immutable.
IPBanEventArgs	Provides data for IPBanList.AddedIPBan and RemovedIPBan events. Immutable.
IPBanCancelableEventArgs	Provides data for IPBanList.AddingIPBan and RemovingIPBan events. Cancelable.
ChatSendingEventArgs	Provides data for Chat.Sending event. Cancelable. FormattedMessage and recipientList properties may be changed.
ChatSentEventArgs	Provides data for Chat.Sent event. Immutable.
IPlayerEvent	An EventArgs for an event that directly relates to a particular player.
PlayerEventArgs	Provides basic data for player-related events.
SessionConnectingEventArgs	Provides data for Server.SessionConnecting event. Cancelable.
SessionDisconnectedEventArgs	Provides data for Server.SessionDisconnected event. Immutable.
PlayerConnectingEventArgs	Provides data for Player.Connecting event. Cancelable.
PlayerConnectedEventArgs	Provides data for Player.Connected event. StartingWorld property may be changed. Make sure to check IsFake property.
PlayerMovingEventArgs	Provides data for Player.Moving event. Cancelable.
PlayerMovedEventArgs	Provides data for Player.Moved event. Immutable.
PlayerClickingEventArgs	Provides data for Player.Clicking event. Cancelable. Coords, Block, and Action properties may be changed.
PlayerClickedEventArgs	Provides data for Player.Clicked event. Immutable.
PlayerPlacingBlockEventArgs	Provides data for Player.PlacingBlock event. Result may be overridden.
PlayerPlacedBlockEventArgs	Provides data for Player.PlacedBlock event. Immutable.
PlayerBeingKickedEventArgs	Provides data for Player.BeingKicked event. Cancelable.
PlayerKickedEventArgs	Provides data for Player.Kicked event. Immutable.
PlayerDisconnectedEventArgs	Provides data for Player.Disconnected event. Immutable. Make sure to check IsFake property.
PlayerJoiningWorldEventArgs	Provides data for Player.JoiningWorld event. Cancelable. Allows overriding the text that is shown on connection screen.
PlayerJoinedWorldEventArgs	Provides data for Player.JoinedWorld event. Immutable.
PlayerHideChangedEventArgs	Provides data for Player.HideChanged event. Immutable.
IPlayerInfoEvent	An EventArgs for an event that directly related to a particular PlayerInfo.
PlayerInfoBeingCreatedEventArgs	Provides data for PlayerInfo.BeingCreated event. Cancelable. Allows changing StartingRank.
PlayerInfoCreatedEventArgs	Provides data for PlayerInfo.Created event. Immutable.
PlayerInfoRankChangingEventArgs	Provides data for PlayerInfo.RankChanging event. Cancelable.
PlayerInfoRankChangedEventArgs	Provides data for PlayerInfo.RankChanged event. Immutable.
PlayerInfoBanChangingEventArgs	Provides data for PlayerInfo.BanChanging event. Cancelable. Reason and Announce properties may be changed.
PlayerInfoBanChangedEventArgs	Provides data for PlayerInfo.BanChanged event. Immutable.
PlayerInfoFrozenChangingEventArgs	Provides data for PlayerInfo.FrozenChanging event. Cancelable. Announce property may be changed.
PlayerInfoFrozenChangedEventArgs	Provides data for PlayerInfo.FrozenChanged event. Immutable.
PlayerInfoMuteChangingEventArgs	Provides data for PlayerInfo.MuteChanging event. Cancelable. Duration and Announce properties may be changed.
PlayerInfoMuteChangedEventArgs	Provides data for PlayerInfo.MuteChanged event. Immutable.
ConfigKeyChangingEventArgs	Provides data for Config.KeyChanging event. Allows modification of the value. Cancelable.
ConfigKeyChangedEventArgs	Provides data for Config.keyChanged event. Immutable.
LogEventArgs	Provides data for Logger.Logged event. Immutable.
CrashedEventArgs	Provides for Logger.Crashed event. Crash reporting can be canceled.
ShutdownEventArgs
SearchingForPlayerEventArgs
CheckingForUpdatesEventArgs	Provides data for Updater.CheckingForUpdates event. Allows changing the URL. Cancelable.
CheckedForUpdatesEventArgs	Provides data for Updater.CheckedForUpdates event. Immutable.
ForesterBlockPlacingEventArgs
IWorldEvent	An EventArgs for an event that directly relates to a particular world.
MainWorldChangedEventArgs	Provides data for WorldManager.MainWorldChanged event. Immutable.
MainWorldChangingEventArgs	Provides data for WorldManager.MainWorldChanging event. Cancelable.
SearchingForWorldEventArgs	Provides data for WorldManager.SearchingForWorld event. Allows changing the results.
WorldCreatingEventArgs	Provides data for WorldManager.WorldCreating event. Allows renaming. Cancelable.
WorldCreatedEventArgs	Provides data for WorldManager.WorldCreated event. Immutable.
GUI
AboutWindow
IsoCat	Isometric map renderer. Creates a bitmap of the map. Every IsoCat instance is single-use.
IsoCatResult
MapConversion
IMapConverter	A map converter (either importer, exporter, or both).
IMapImporter	IMapConverter that provides functionality for identifying and saving maps from files.
IMapExporter	IMapConverter that provides functionality for saving maps to files.
MapD3	D3 map conversion implementation, for converting D3 map format into fCraft's default map format.
MapDat	.Dat map conversion implementation, for converting .Dat map format into fCraft's default map format.
MapFCMv2	fCraft map format converter, for obsolete format version #2 (2010).
MapFCMv3	fCraft map format converter, for format version #3 (2011). Soon to be obsoleted by FCMv4.
MapFormatException	Exception that is thrown when problems arise during map saving or loading. May be caused by map file's incorrect format or structure.
NoMapConverterFoundException	Exception that is thrown when no importer or exporter could be found for the given map format, or a map format could not be identified at all.
MapIndev	NBT map conversion implementation, for converting NBT map format into fCraft's default map format.
MapJTE	JTE map conversion implementation, for converting JTE map format into fCraft's default map format.
MapMCSharp	MCSharp map conversion implementation, for converting MCSharp map format into fCraft's default map format.
MapMinerCPP	MinerCPP/LuaCraft map conversion implementation, for converting MinerCPP/LuaCraft map format into fCraft's default map format.
MapMyne	Myne map conversion implementation, for converting Myne map format into fCraft's default map format.
MapOpticraft	Opticraft map conversion implementation, for converting Opticraft map format into fCraft's default map format.
MapRaw	D3 map conversion implementation, for converting D3 map format into fCraft's default map format.
MapUtility	Utilities used to handle different map formats, including loading, parsing, and saving.
MyneMetaFile	INI parser used by MapMyne.
NBTag
NBTEnumerator
NBTList
NBTCompound
BuildingCommands	Commands for placing specific blocks (solid, water, grass), and switching block placement modes (paint, bind).
ChatCommands
CommandDescriptor	Describes a chat command. Defines properties, permission requirements, and usage information. Specifies a handler method.
CommandManager	Static class that allows registration and parsing of all text commands.
CommandRegistrationException	Exception that is thrown when an attempt to register a command has failed.
CommandReader	A text scanner that aids parsing chat commands and their arguments. Breaks up a message into tokens at spaces. Treats quoted strings as whole tokens.
InfoCommands	Contains commands that don't do anything besides displaying some information or text. Includes several chat commands.
MaintenanceCommands	Several yet-undocumented commands, mostly related to AutoRank.
ModerationCommands	Most commands for server moderation - kick, ban, rank change, etc - are here.
WorldCommands	Contains commands related to world management.
ZoneCommands	Contains commands related to zone management.
Heartbeat	Static class responsible for sending heartbeats.
HeartbeatData	Contains data that's sent to heartbeat servers.
IPBanInfo	IP ban record.
IPBanList	Handles the addition, lookup, and removal of IP bans.
IRC	IRC control class.
IRCCommands	Provides methods for constructing IRC command messages.
IRCMessage	Represents a parsed incoming IRC message.
LineWrapper	Intelligent line-wrapper for Minecraft protocol. Splits long messages into 64-character chunks of ASCII. Maintains colors between lines. Wraps at word boundaries and hyphens. Removes invalid characters and color sequences. Supports optional line prefixes for second and consequent lines. This class is implemented as IEnumerable of Packets, so it's usable with foreach() and Linq.
Packet	Packet struct, just a wrapper for a byte array.
PacketReader
PacketWriter
Player	Represents a connection to a Minecraft client. Handles low-level interactions (e.g. networking).
Chat	Helper class for handling player-generated chat.
ChatTimer	Provides a way to create and manage publicly-announced countdowns. Long timers announce once an hour (e.g. "7h left"). During the last hour, timer announces more often: every 10 minutes, then every minute, then every 10 seconds, and finally every second - until the timer is up.
ChatTimerEventArgs	Provides data for ChatTimer.Started and ChatTimer.Stopped events. Immutable.
PlayerListSorter
PlayerDB	Persistent database of player information.
PlayerEnumerable	Contains a set of utilities that simplify working with sets of players. All the utilities are implemented as extension methods, and it is recommended that you invoke them as extension methods.
PlayerInfo	Object representing persistent state ("record") of a player, online or offline. There is exactly one PlayerInfo object for each known Minecraft account. All data is stored in the PlayerDB.
PlayerInfoComparer	Sorts PlayerInfo objects by relevance. Orders players by online/offline state first, then by rank, then by time-since-last-seen. Hidden players are listed with the offline players.
PlayerOpException	Exception that is thrown when a player's action or command could not be completed.
Position	Struct representing a position AND orientation in 3D space. Used to represent players' positions in Minecraft world. Stores X/Y/Z as signed shorts, and R/L as unsigned bytes (8 bytes total). Use Vector3I if you just need X/Y/Z coordinates without orientation. Note that, as a struct, Positions are COPIED when assigned or passed as an argument.
Rank	Rank of a player. Ranks are arranged in a linear hierarchy. One instance of a Rank object should be shared by players of the same rank. Rank objects are comparable - you can use comparison operators or CompareTo.
RankDefinitionException	Exception that is thrown when parsing a rank definition has failed.
RankManager	Manages all the ranks on a server. Controlls what ranks are avaliable and in what order they exist in.
SecurityController	Controller for setting and checking per-rank permissions and per-player exceptions. Used by World.AccessSecurity, World.BuildSecurity, and Zone.
PlayerExceptions	List of included and excluded players.
Config	Static class that handles loading/saving configuration, contains config defaults, and various configuration-related utilities.
ConfigKeyAttribute	Describes attributes and metadata of a configuration key.
StringKeyAttribute
Logger	Central logging class. Logs to file, relays messages to the frontend, submits crash reports.
Scheduler	A general-purpose task scheduler.
SchedulerTask	A task to be executed by the Scheduler. Stores timing information and state.
Server	Core of an fCraft server. Manages startup/shutdown, online player sessions, global events and scheduled tasks.
ShutdownParams	Describes the circumstances of server shutdown.
BoundingBox	Defines a 3D bounding box, in integer cartesian coordinates. Coordinates are always inclusive, so note that even a bounding box with coinciding vertices is a 1x1x1 cube, and has non-zero volume and non-zero dimensions.
BufferUtil	Provides utility methods for working with byte arrays and pointers.
Color	Static class with definitions of Minecraft color codes, parsers, converters, and utilities.
ConcurrentQueue< T >	A lightweight queue implementation with lock-free/concurrent operations.
DateTimeUtil	Provides utility functions for working with DateTime and TimeSpan.
EnumerableUtil	Provides methods JoinToString/JoinToClassyString methods for merging lists and enumerations into strings.
EnumUtil	Provides TryParse method, for parsing enumerations.
ICancelableEvent	An EventArgs for an event that can be cancelled.
INotifiesOnChange	Simple interface for objects to notify of changes in their serializable state. This event is used to trigger saving things like Zone- and MetadataCollection. sender should be set for EventHandler, and e should be set to EventArgs.Empty
FormatUtil
IClassy	Provides a way for printing an object's name beautified with Minecraft color codes. It was "classy" in a sense that it was colored based on "class" (rank) of a player/world/zone.
IPAddressUtil	Provides utility methods for working with IP addresses and ranges.
LogRecorder	A simple way to temporarily hook into fCraft's Logger. Make sure to dispose this class when you are done recording. The easiest way to ensure that is with a using(){...} block.
MetadataEntry< TValue >	A string metadata entry.
MetadataCollection< TValue >	A collection of metadata entries, addressable by pairs of string group/key names. Group names, key names, and values may not be null.
MonoCompat	Class dedicated to solving Mono compatibility issues
Noise	Class for generating and filtering 2D and 3D noise, extensively used by MapGenerator and Cloudy brush.
Paths	Contains fCraft path settings, and some filesystem-related utilities.
PerlinNoise3D	Implementation of 3D Perlin Noise after Ken Perlin's reference implementation.
RWLSExtension
ReadLockHelper
UpgradeableReadLockHelper
WriteLockHelper
Trie< T >	Specialized data structure for partial-matching of large sparse sets of words. Used as a searchable index of players for PlayerDB.
TrieKeyCollection
TrieKeySubset
TrieSubset	A subset of trie's key/value pairs that start with a certain prefix.
TrieValueCollection
TrieValueSubset
Updater	Checks for updates, and keeps track of current version/revision.
UpdaterResult	Result of an update check.
ReleaseInfo	Used to describe a particular release version of fCraft. Includes date released, version
Vector3F	Floating-point (single precision) 3D vector.
Vector3I	Integer 3D vector.
BlockDB	Database of block changes. Each BlockDB object is associated with a world. Provides controls for storage/retention, and methods to look up data.
IBlockDBQueryProcessor	Class used to process results of traversing the BlockDB.
BlockDBEntry	Struct representing a single block change. You may safely cast byte* pointers directly to BlockDBEntry* and vice versa.
BlockUpdate	Structure representing a pending update to the map's block array. Contains information about the block coordinates, type, and change's origin.
Forester	Vegetation generator for MapGenerator.
ForesterArgs
Map	Represents a map file (associated with a world or not). Maps can be created blank (using Map constructor), generated terrain (using MapGenerator), or loaded from file (using fCraft.MapConversion.MapUtility).
MapGenerator	Provides functionality for generating map files.
MapGeneratorArgs	Contains parameters for advanced map generation.
World	World instance. Manages the player list, manages access/build security, stores metadata.
WorldManager	Manages the world list. Handles loading/unloading, renaming, map changes, and more.
WorldOpException	Exception that is thrown when an invalid operation is attempted on a world.
Zone	A bounding box selection that is designated as a sub area within a world. Zones can have restriction just like worlds on access, and block modification.
ZoneCollection	A collection of zones within a map.
fCraftGUI
Properties
JetBrains
Annotations
LocalizationRequiredAttribute	Indicates that marked element should be localized or not.
StringFormatMethodAttribute	Indicates that marked method builds string by format pattern and (optional) arguments. Parameter, which contains format string, should be given in constructor. The format string should be in string.Format(IFormatProvider,string,object[]) -like form
InvokerParameterNameAttribute	Indicates that the function argument should be string literal and match one of the parameters of the caller function. For example, ArgumentNullException has such parameter.
NotifyPropertyChangedInvocatorAttribute	Indicates that the function is used to notify class type property value is changed.
CanBeNullAttribute	Indicates that the value of marked element could be null sometimes, so the check for null is necessary before its usage
NotNullAttribute	Indicates that the value of marked element could never be null
ContractAnnotationAttribute	Describes dependency between method input and output
CannotApplyEqualityOperatorAttribute	Indicates that the value of marked type (or its derivatives) cannot be compared using '==' or '!=' operators. There is only exception to compare with null, it is permitted
BaseTypeRequiredAttribute	When applied to target attribute, specifies a requirement for any type which is marked with target attribute to implement or inherit specific type or types
UsedImplicitlyAttribute	Indicates that the marked symbol is used implicitly (e.g. via reflection, in external library), so this symbol will not be marked as unused (as well as by other usage inspections)
MeansImplicitUseAttribute	Should be used on attributes and causes ReSharper to not mark symbols marked with such attributes as unused (as well as by other usage inspections)
PublicAPIAttribute	This attribute is intended to mark publicly available API which should not be removed and so is treated as used.
InstantHandleAttribute	Tells code analysis engine if the parameter is completely handled when the invoked method is on stack. If the parameter is delegate, indicates that delegate is executed while the method is executed. If the parameter is enumerable, indicates that it is enumerated while the method is executed.
PureAttribute	Indicates that method doesn't contain observable side effects.
Mono
Options
StringCoda
OptionValueCollection
OptionContext
Option
ArgumentSource
ResponseFileSource
OptionException
OptionSet
System
IO
Compression
ZipStorer	Unique class for compression/decompression file. Represents a Zip file.
ZipFileEntry	Represents an entry in Zip file directory.