themaster1970sf/TShock
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Document some config file methods

Browse source 
I suppose this is really redundant, ...
This commit is contained in:
Lucas Nicodemus 2015-04-22 23:32:01 -06:00
parent 342921b3ed
commit ab3262d971
1 changed files with 31 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

33
TShockAPI/ConfigFile.cs
View file

@ -27,74 +27,103 @@ using Rests;
namespace TShockAPI
{
/// <summary>ConfigFile - The config file class, which contains the configuration for a server that is serialized into JSON and deserialized on load.</summary>
public class ConfigFile
{
/// <summary>InvasionMultiplier - The equation for calculating invasion size = 100 + (multiplier * (number of active players > 200 hp)).</summary>
[Description(
"The equation for calculating invasion size is 100 + (multiplier * (number of active players with greater than 200 health))."
)]
public int InvasionMultiplier = 1;
/// <summary>DefaultMaximumSpawns - The default max spawns per wave.</summary>
[Description("The default maximum mobs that will spawn per wave. Higher means more mobs in that wave.")]
public int DefaultMaximumSpawns = 5;
/// <summary>DefaultSpawnRate - The default spawn rate.</summary>
[Description("The delay between waves. Lower values lead to more mobs.")]
public int DefaultSpawnRate = 600;
/// <summary>ServerPort - The configured server port.</summary>
[Description("The port the server runs on.")]
public int ServerPort = 7777;
/// <summary>EnableWhitelist - boolean if the whitelist functionality should be turned on.</summary>
[Description("Enable or disable the whitelist based on IP addresses in whitelist.txt")]
public bool EnableWhitelist;
/// <summary>InfiniteInvasion - Whether or not infinite invasion mode should be on.</summary>
[Description(
"Enable the ability for invasion size to never decrease. Make sure to run /invade, and note that this adds 2 million+ goblins to the spawn queue for the map."
)]
public bool InfiniteInvasion;
/// <summary>PvPMode - The server PvP mode (normal, always, or disabled).</summary>
[Description("Set the server pvp mode. Valid types are, \"normal\", \"always\", and \"disabled.\"")]
public string PvPMode
= "normal";
public string PvPMode = "normal";
/// <summary>SpawnProtection - Enables the spawn protection system.</summary>
[Description("Prevents tiles from being placed within SpawnProtectionRadius of the default spawn.")]
public bool SpawnProtection = true;
/// <summary>SpawnProtectionRadius - The spawn protection tile radius.</summary>
[Description("Radius from spawn tile for SpawnProtection.")]
public int SpawnProtectionRadius = 10;
/// <summary>MaxSlots - The server's max slots.</summary>
[Description(
"Max slots for the server. If you want people to be kicked with \"Server is full\" set this to how many players you want max and then set Terraria max players to 2 higher."
)]
public int MaxSlots = 8;
/// <summary>RangeChecks - Whether or not the anti-grief system based on range should be enabled.</summary>
[Description("Global protection agent for any block distance based anti-grief check.")]
public bool RangeChecks = true;
/// <summary>DisableBuild - Whether or not building should be enabled.</summary>
[Description("Disables any building; placing of blocks")]
public bool DisableBuild;
/// <summary>SuperAdminChatRGB - The chat color for the superadmin group.</summary>
[Description("#.#.#. = Red/Blue/Green - RGB Colors for the Admin Chat Color. Max value: 255")]
public float[] SuperAdminChatRGB = { 255, 0, 0 };
/// <summary>SuperAdminChatPrefix - The superadmin chat prefix.</summary>
[Description("Super admin group chat prefix")]
public string SuperAdminChatPrefix = "(Admin) ";
/// <summary>SuperAdminChatSuffix - The superadmin chat suffix.</summary>
[Description("Super admin group chat suffix")]
public string SuperAdminChatSuffix = "";
/// <summary>BackupInterval - The backup frequency in minutes.</summary>
[Description(
"Backup frequency in minutes. So, a value of 60 = 60 minutes. Backups are stored in the \\tshock\\backups folder.")]
public int BackupInterval;
/// <summary>BackupKeepFor - Backup max age in minutes.</summary>
[Description("How long backups are kept in minutes. 2880 = 2 days.")]
public int BackupKeepFor = 60;
/// <summary>RememberLeavePos - Whether or not to remember where an IP player was when they left.</summary>
[Description(
"Remembers where a player left off. It works by remembering the IP, NOT the character. \neg. When you try to disconnect, and reconnect to be automatically placed at spawn, you'll be at your last location. Note: Won't save after server restarts."
)]
public bool RememberLeavePos;
/// <summary>HardcoreOnly - Whether or not HardcoreOnly should be enabled.</summary>
[Description("Hardcore players ONLY. This means softcore players cannot join.")]
public bool HardcoreOnly;
/// <summary>MediumcoreOnly - Whether or not MediumCore only players should be enabled.</summary>
[Description("Mediumcore players ONLY. This means softcore players cannot join.")]
public bool MediumcoreOnly;
[Description("Kicks a mediumcore player on death.")]
/// <summary>KickOnMediumcoreDeath - Whether or not to kick mediumcore players on death.</summary>
public bool KickOnMediumcoreDeath;
/// <summary>BanOnMediumcoreDeath - Whether or not to ban mediumcore players on death.</summary>
[Description("Bans a mediumcore player on death.")]
public bool BanOnMediumcoreDeath;