From 79802cd9e06f54fdfa5e278462754aaa05f04bac Mon Sep 17 00:00:00 2001 From: Lucas Nicodemus Date: Sun, 10 Dec 2017 08:54:32 -0700 Subject: [PATCH] Comment more things in Bouncer --- TShockAPI/Bouncer.cs | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/TShockAPI/Bouncer.cs b/TShockAPI/Bouncer.cs index 6fc7f640..d1810c38 100644 --- a/TShockAPI/Bouncer.cs +++ b/TShockAPI/Bouncer.cs @@ -50,6 +50,9 @@ namespace TShockAPI GetDataHandlers.TileEdit.Register(OnTileEdit); } + /// Bouncer's KillMe hook stops crash exploits from out of bounds values. + /// The object that triggered the event. + /// The packet arguments that the event has. internal void OnKillMe(object sender, GetDataHandlers.KillMeEventArgs args) { short dmg = args.Damage; @@ -81,6 +84,9 @@ namespace TShockAPI } } + /// Bouncer's projectile trigger hook stops world damaging projectiles from destroying the world. + /// The object that triggered the event. + /// The packet arguments that the event has. internal void OnNewProjectile(object sender, GetDataHandlers.NewProjectileEventArgs args) { short ident = args.Identity; @@ -187,6 +193,9 @@ namespace TShockAPI } } + /// Bouncer's PlaceObject hook reverts malicious tile placement. + /// The object that triggered the event. + /// The packet arguments that the event has. internal void OnPlaceObject(object sender, GetDataHandlers.PlaceObjectEventArgs args) { short x = args.X; @@ -315,6 +324,9 @@ namespace TShockAPI } } + /// Bouncer's TileEdit hook is used to revert malicious tile changes. + /// The object that triggered the event. + /// The packet arguments that the event has. internal void OnTileEdit(object sender, GetDataHandlers.TileEditEventArgs args) { EditAction action = args.Action; @@ -681,9 +693,9 @@ namespace TShockAPI } } - /// The handler for the HealOther events in Bouncer - /// sender - /// args + /// Bouncer's HealOther handler prevents gross misuse of HealOther packets by hackers. + /// The object that triggered the event. + /// The packet arguments that the event has. internal void OnHealOtherPlayer(object sender, GetDataHandlers.HealOtherPlayerEventArgs args) { short amount = args.Amount; @@ -723,9 +735,9 @@ namespace TShockAPI return; } - /// The handler for SendTileSquare events in Bouncer - /// sender - /// args + /// Bouncer's SendTileSquare hook halts large scope world destruction. + /// The object that triggered the event. + /// The packet arguments that the event has. internal void OnSendTileSquare(object sender, GetDataHandlers.SendTileSquareEventArgs args) { short size = args.Size;