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

Fix most of the stupid comments in Bouncer

Browse source
This commit is contained in:
Lucas Nicodemus 2017-12-06 17:02:23 -07:00
parent f065e99a0e
commit 9ba0907dc0
2 changed files with 14 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

8
TShockAPI/Bouncer.cs
View file

@ -39,10 +39,10 @@ using TShockAPI.Net;
namespace TShockAPI namespace TShockAPI
{ {
/// <summary>Bouncer - The TShock anti-hack and build guardian system</summary> /// <summary>Bouncer is the TShock anti-hack and build guardian system</summary>
public class Bouncer public class Bouncer
{ {
/// <summary>Bouncer - Constructor call initializes Bouncer & related functionality.</summary> /// <summary>Constructor call initializes Bouncer & related functionality.</summary>
/// <returns>A new Bouncer.</returns> /// <returns>A new Bouncer.</returns>
public Bouncer(TerrariaPlugin pluginInstance) public Bouncer(TerrariaPlugin pluginInstance)
{ {
@ -52,7 +52,7 @@ namespace TShockAPI
GetDataHandlers.HealOtherPlayer.Register(OnHealOtherPlayer); GetDataHandlers.HealOtherPlayer.Register(OnHealOtherPlayer);
} }
/// <summary>OnHealOtherPlayer - The handler for the HealOther events in Bouncer</summary> /// <summary>The handler for the HealOther events in Bouncer</summary>
/// <param name="sender">sender</param> /// <param name="sender">sender</param>
/// <param name="args">args</param> /// <param name="args">args</param>
internal void OnHealOtherPlayer(object sender, GetDataHandlers.HealOtherPlayerEventArgs args) internal void OnHealOtherPlayer(object sender, GetDataHandlers.HealOtherPlayerEventArgs args)
@ -91,7 +91,7 @@ namespace TShockAPI
return; return;
} }
/// <summary>OnSendTileSquare - The handler for SendTileSquare events in Bouncer</summary> /// <summary>The handler for SendTileSquare events in Bouncer</summary>
/// <param name="sender">sender</param> /// <param name="sender">sender</param>
/// <param name="args">args</param> /// <param name="args">args</param>
internal void OnSendTileSquare(object sender, GetDataHandlers.SendTileSquareEventArgs args) internal void OnSendTileSquare(object sender, GetDataHandlers.SendTileSquareEventArgs args)

20
TShockAPI/GetDataHandlers.cs
View file

@ -532,26 +532,26 @@ namespace TShockAPI
return false; return false;
} }
/// <summary>HandledEventArgs - The event args object for the HealOtherPlayer event</summary> /// <summary>The event args object for the HealOtherPlayer event</summary>
public class HealOtherPlayerEventArgs : HandledEventArgs public class HealOtherPlayerEventArgs : HandledEventArgs
{ {
/// <summary>Player - The TSPlayer object that caused the event</summary> /// <summary>The TSPlayer object that caused the event</summary>
public TSPlayer Player { get; set; } public TSPlayer Player { get; set; }
/// <summary>TargetPlayerIndex - The Terraria player index of the target player</summary> /// <summary>The Terraria player index of the target player</summary>
public byte TargetPlayerIndex { get; set; } public byte TargetPlayerIndex { get; set; }
/// <summary>Amount - The amount to heal by</summary> /// <summary>The amount to heal by</summary>
public short Amount { get; set; } public short Amount { get; set; }
} }
/// <summary>HealOtherPlayer - When a player heals another player</summary> /// <summary>When a player heals another player</summary>
public static HandlerList<HealOtherPlayerEventArgs> HealOtherPlayer; public static HandlerList<HealOtherPlayerEventArgs> HealOtherPlayer;
/// <summary>OnHealOtherPlayer - Fires the HealOtherPlayer event</summary> /// <summary>Fires the HealOtherPlayer event</summary>
/// <param name="player">player - The TSPlayer that started the event</param> /// <param name="player">The TSPlayer that started the event</param>
/// <param name="targetPlayerIndex">targetPlayerIndex - The Terraria player index that the event targets</param> /// <param name="targetPlayerIndex">The Terraria player index that the event targets</param>
/// <param name="amount">amount - The amount to heal</param> /// <param name="amount">The amount to heal</param>
/// <returns>bool</returns> /// <returns>bool</returns>
private static bool OnHealOtherPlayer(TSPlayer player, byte targetPlayerIndex, short amount) private static bool OnHealOtherPlayer(TSPlayer player, byte targetPlayerIndex, short amount)
{ {
@ -596,7 +596,7 @@ namespace TShockAPI
public int TileY { get; set; } public int TileY { get; set; }
} }
/// <summary> /// <summary>
/// SendTileSquare - When the player sends a tile square /// When the player sends a tile square
/// </summary> /// </summary>
public static HandlerList<SendTileSquareEventArgs> SendTileSquare; public static HandlerList<SendTileSquareEventArgs> SendTileSquare;