diff --git a/TShockAPI/TShock.cs b/TShockAPI/TShock.cs index a31d2190..2f9d00de 100755 --- a/TShockAPI/TShock.cs +++ b/TShockAPI/TShock.cs @@ -1,4 +1,4 @@ -/* +/* TShock, a server mod for Terraria Copyright (C) 2011-2015 Nyx Studios (fka. The TShock Team) @@ -67,30 +67,55 @@ namespace TShockAPI /// LogClear - Determines whether or not the log file should be cleared on initialization. private static bool LogClear; + /// Players - Contains all TSPlayer objects for accessing TSPlayers currently on the server public static TSPlayer[] Players = new TSPlayer[Main.maxPlayers]; + /// Bans - Static reference to the ban manager for accessing bans & related functions. public static BanManager Bans; + /// Warps - Static reference to the warp manager for accessing the warp system. public static WarpManager Warps; + /// Regions - Static reference to the region manager for accessing the region system. public static RegionManager Regions; + /// Backups - Static reference to the backup manager for accessing the backup system. public static BackupManager Backups; + /// Groups - Static reference to the group manager for accessing the group system. public static GroupManager Groups; + /// Users - Static reference to the user manager for accessing the user database system. public static UserManager Users; + /// Itembans - Static reference to the item ban system. public static ItemManager Itembans; + /// ProjectileBans - Static reference to the projectile ban system. public static ProjectileManagager ProjectileBans; + /// TileBans - Static reference to the tile ban system. public static TileManager TileBans; + /// RememberedPos - Static reference to the remembered position manager. public static RememberedPosManager RememberedPos; + /// CharacterDB - Static reference to the SSC character manager. public static CharacterManager CharacterDB; + /// Config - Static reference to the config system, for accessing values set in users' config files. public static ConfigFile Config { get; set; } + /// ServerSideCharacterConfig - Static reference to the server side character config, for accessing values set by users to modify SSC. public static ServerSideConfig ServerSideCharacterConfig; + /// DB - Static reference to the database. public static IDbConnection DB; + /// OverridePort - Determines if TShock should override the server port. public static bool OverridePort; + /// PacketBuffer - Static reference to the packet bufferer system, which buffers packets to clients for better performance. public static PacketBufferer PacketBuffer; + /// Geo - Static reference to the GeoIP system which determines the location of an IP address. public static GeoIPCountry Geo; + /// RestApi - Static reference to the Rest API authentication manager. public static SecureRest RestApi; + /// RestManager - Static reference to the Rest API manager. public static RestManager RestManager; + /// Utils - Static reference to the utilities class, which contains a variety of utility functions. public static Utils Utils = Utils.Instance; + /// StatTracker - Static reference to the stat tracker, which is created immediately when declared. public static StatTracker StatTracker = new StatTracker(); + /// UpdateManager - Static reference to the update checker, which checks for updates and notifies server admins of updates. public static UpdateManager UpdateManager; + /// Log - Static reference to the log system, which outputs to either SQL or a text file, depending on user config. public static ILog Log; + /// instance - Static reference to the TerrariaPlugin instance. public static TerrariaPlugin instance; /// /// Used for implementing REST Tokens prior to the REST system starting up.