From 2d4539831515a8d0233762d38bd869d7fac5f997 Mon Sep 17 00:00:00 2001 From: Lucas Nicodemus Date: Sat, 21 Jan 2012 23:17:15 -0700 Subject: [PATCH] Added XML comments for TileEdit for use in the upcoming Doxygen documented documentation release --- TShockAPI/GetDataHandlers.cs | 25 +++++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-) diff --git a/TShockAPI/GetDataHandlers.cs b/TShockAPI/GetDataHandlers.cs index 3d5690c4..4cbec43d 100644 --- a/TShockAPI/GetDataHandlers.cs +++ b/TShockAPI/GetDataHandlers.cs @@ -52,22 +52,35 @@ namespace TShockAPI public static int[] WhitelistBuffMaxTime; #region Events - [DisplayName("TileEditEventArgs"), Description("Args")] + /// + /// Used when a TileEdit event is called. + /// public class TileEditEventArgs : HandledEventArgs { - [Description("Tile X")] + /// + /// The tile coordinate on the X plane + /// public int X { get; set; } - [Description("Tile Y")] + + /// + /// The tile coordinate on the Y plane + /// public int Y { get; set; } - [Description("Tile Type")] + + /// + /// The Tile ID being edited. + /// public byte Type { get; set; } - [Description("Edit Type (KillTile = 0, PlaceTile = 1, KillWall = 2, PlaceWall = 3, KillTileNoItem = 4, PlaceWire = 5, KillWire = 6)")] + /// + /// The EditType. + /// (KillTile = 0, PlaceTile = 1, KillWall = 2, PlaceWall = 3, KillTileNoItem = 4, PlaceWire = 5, KillWire = 6) + /// public byte EditType { get; set; } } + /// /// TileEdit - called when a tile is placed or destroyed /// - [Description("Called when a tile is placed or destroyed")] public static HandlerList TileEdit; private static bool OnTileEdit(int x, int y, byte type, byte editType) {