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

Enumeration of available configuration keys. See comments at the top of Config.cs for a history of changes.

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

Syntax


	C#

public enum ConfigKey

Members

Member	Value	Description
ServerName	0
MOTD	1
MaxPlayers	2
MaxPlayersPerWorld	3
DefaultRank	4
IsPublic	5
Port	6
UploadBandwidth	7
HeartbeatToWoMDirect	8
WoMDirectDescription	9
WoMDirectFlags	10
RankColorsInChat	11
RankColorsInWorldNames	12
RankPrefixesInChat	13
RankPrefixesInList	14
ShowConnectionMessages	15
ShowJoinedWorldMessages	16
SystemMessageColor	17
HelpColor	18
SayColor	19
AnnouncementColor	20
PrivateMessageColor	21
MeColor	22
WarningColor	23
AnnouncementInterval	24
DefaultBuildRank	25
MapPath	26
VerifyNames	27
MaxConnectionsPerIP	28
AllowUnverifiedLAN	29
PatrolledRank	30
AntispamMessageCount	31
AntispamInterval	32
AntispamMuteDuration	33
AntispamMaxWarnings	34
PaidPlayersOnly	35
RequireBanReason	36
RequireKickReason	37
RequireRankChangeReason	38
AnnounceKickAndBanReasons	39
AnnounceRankChanges	40
AnnounceRankChangeReasons	41
BlockDBEnabled	42
BlockDBAutoEnable	43
BlockDBAutoEnableRank	44
SaveInterval	45
BackupOnStartup	46
BackupOnJoin	47
BackupOnlyWhenChanged	48
DefaultBackupInterval	49
MaxBackups	50
MaxBackupSize	51
BackupDataOnStartup	52
LogMode	53
MaxLogs	54
IRCBotEnabled	55
IRCBotNick	56
IRCBotNetwork	57
IRCBotPort	58
IRCBotChannels	59
IRCBotForwardFromServer	60
IRCBotForwardFromIRC	61
IRCBotAnnounceServerJoins	62
IRCBotAnnounceIRCJoins	63
IRCBotAnnounceServerEvents	64
IRCRegisteredNick	65
IRCNickServ	66
IRCNickServMessage	67
IRCMessageColor	68
IRCUseColor	69
IRCStripMinecraftColors	70
IRCDelay	71
IRCThreads	72
SubmitCrashReports	73
UpdaterMode	74
RunBeforeUpdate	75
RunAfterUpdate	76
BackupBeforeUpdate	77
RelayAllBlockUpdates	78
NoPartialPositionUpdates	79
ProcessPriority	80
BlockUpdateThrottling	81
TickInterval	82
LowLatencyMode	83
MaxUndo	84
MaxUndoStates	85
ConsoleName	86
AutoRankEnabled	87
HeartbeatEnabled	88
WoMEnableEnvExtensions	89
IP	90
BandwidthUseMode	91
RestartInterval	92
IsDefault		Checks whether given ConfigKey still has its default value.
GetDefault		Provides the default value for a given ConfigKey.
IsBlank		Checks whether any value has been set for a given key.
GetString		Returns raw value for the given key.
GetInt		Attempts to parse given key's value as an integer. Throws a FormatException on failure.
TryGetInt		Attempts to parse a given key's value as an integer.
GetEnum		Attempts to parse a given key's value as an enumeration. An ArgumentException is thrown if value could not be parsed. Note the parsing is done in a case-insensitive way.
Enabled		Attempts to parse given key's value as a boolean. Throws a FormatException on failure.
TryGetBool		Attempts to parse a given key's value as a boolean.
GetValueType		Returns the expected Type of the key's value, as specified in key metadata.
GetMetadata		Returns the metadata container (ConfigKeyAttribute object) for a given key.
GetSection		Returns the ConfigSection that a given key is associated with.
GetDescription		Returns the description text for a given config key.
ResetValue		Resets key value to its default setting.
SetValue		Sets value of a given config key. Note that this method may throw exceptions if the given value is not acceptable. Use Config.TrySetValue() if you'd like to suppress exceptions in favor of a boolean return value.
TrySetValue		Attempts to set the value of a given config key. Check the return value to make sure that the given value was acceptable.

Syntax

Members

See Also