[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.5 (0.6.3.5)

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
RankColorsInChat	8
RankColorsInWorldNames	9
RankPrefixesInChat	10
RankPrefixesInList	11
ShowConnectionMessages	12
ShowJoinedWorldMessages	13
SystemMessageColor	14
HelpColor	15
SayColor	16
AnnouncementColor	17
PrivateMessageColor	18
MeColor	19
WarningColor	20
AnnouncementInterval	21
DefaultBuildRank	22
MapPath	23
VerifyNames	24
MaxConnectionsPerIP	25
AllowUnverifiedLAN	26
PatrolledRank	27
AntispamMessageCount	28
AntispamInterval	29
AntispamMuteDuration	30
AntispamMaxWarnings	31
PaidPlayersOnly	32
RequireBanReason	33
RequireKickReason	34
RequireRankChangeReason	35
AnnounceKickAndBanReasons	36
AnnounceRankChanges	37
AnnounceRankChangeReasons	38
BlockDBEnabled	39
BlockDBAutoEnable	40
BlockDBAutoEnableRank	41
SaveInterval	42
BackupOnStartup	43
BackupOnJoin	44
BackupOnlyWhenChanged	45
DefaultBackupInterval	46
MaxBackups	47
MaxBackupSize	48
BackupDataOnStartup	49
LogMode	50
MaxLogs	51
IRCBotEnabled	52
IRCBotNick	53
IRCBotNetwork	54
IRCBotPort	55
IRCBotChannels	56
IRCBotForwardFromServer	57
IRCBotForwardFromIRC	58
IRCBotAnnounceServerJoins	59
IRCBotAnnounceIRCJoins	60
IRCBotAnnounceServerEvents	61
IRCRegisteredNick	62
IRCNickServ	63
IRCNickServMessage	64
IRCMessageColor	65
IRCUseColor	66
IRCStripMinecraftColors	67
IRCAllowMinecraftEmotes	68
IRCDelay	69
IRCThreads	70
SubmitCrashReports	71
UpdaterMode	72
RunBeforeUpdate	73
RunAfterUpdate	74
BackupBeforeUpdate	75
RelayAllBlockUpdates	76
NoPartialPositionUpdates	77
ProcessPriority	78
BlockUpdateThrottling	79
TickInterval	80
LowLatencyMode	81
MaxUndo	82
MaxUndoStates	83
ConsoleName	84
AutoRankEnabled	85
HeartbeatEnabled	86
WoMEnableEnvExtensions	87
IP	88
BandwidthUseMode	89
RestartInterval	90
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