Merge pull request #1457 from deadsurgeon42/general-devel

Hooks for Item/Projectile/Tileban permission checks

TShockAPI/DB/ItemManager.cs

@@ -21,6 +21,7 @@ using System.Collections.Generic;
 using System.Data;
 using System.Linq;
 using MySql.Data.MySqlClient;
+using TShockAPI.Hooks;
 
 namespace TShockAPI.DB
 {
@@ -200,6 +201,9 @@ namespace TShockAPI.DB
 			if (ply.HasPermission(Permissions.usebanneditem))
 				return true;
 
+			if (PlayerHooks.OnPlayerItembanPermission(ply, this))
+				return true;
+
 			var cur = ply.Group;
 			var traversed = new List<Group>();
 			while (cur != null)

TShockAPI/DB/ProjectileManager.cs

@@ -21,6 +21,7 @@ using System.Collections.Generic;
 using System.Data;
 using System.Linq;
 using MySql.Data.MySqlClient;
+using TShockAPI.Hooks;
 
 namespace TShockAPI.DB
 {
@@ -205,6 +206,9 @@ namespace TShockAPI.DB
 			if (ply.HasPermission(Permissions.canusebannedprojectiles))
 				return true;
 
+			if (PlayerHooks.OnPlayerProjbanPermission(ply, this))
+				return true;
+
 			var cur = ply.Group;
 			var traversed = new List<Group>();
 			while (cur != null)

TShockAPI/DB/TileManager.cs

@@ -21,6 +21,7 @@ using System.Collections.Generic;
 using System.Data;
 using System.Linq;
 using MySql.Data.MySqlClient;
+using TShockAPI.Hooks;
 
 namespace TShockAPI.DB
 {
@@ -205,6 +206,9 @@ namespace TShockAPI.DB
 			if (ply.HasPermission(Permissions.canusebannedtiles))
 				return true;
 
+			if (PlayerHooks.OnPlayerTilebanPermission(ply, this))
+				return true;
+
 			var cur = ply.Group;
 			var traversed = new List<Group>();
 			while (cur != null)

TShockAPI/Hooks/PlayerHooks.cs

@@ -18,6 +18,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 using System.Collections.Generic;
 using System.ComponentModel;
+using TShockAPI.DB;
 
 namespace TShockAPI.Hooks
 {
@@ -166,6 +167,87 @@ namespace TShockAPI.Hooks
 		}
 	}
 
+	/// <summary>
+	/// EventArgs used for the <see cref="PlayerHooks.PlayerItembanPermission"/> event.
+	/// </summary>
+	public class PlayerItembanPermissionEventArgs : HandledEventArgs
+	{
+		/// <summary>
+		/// The player who fired the event.
+		/// </summary>
+		public TSPlayer Player { get; set; }
+
+		/// <summary>
+		/// The banned item being checked.
+		/// </summary>
+		public ItemBan BannedItem { get; set; }
+
+		/// <summary>
+		/// Initializes a new instance of the PlayerItembanPermissionEventArgs class.
+		/// </summary>
+		/// <param name="player">The player who fired the event.</param>
+		/// <param name="permission">The permission being checked.</param>
+		public PlayerItembanPermissionEventArgs(TSPlayer player, ItemBan bannedItem)
+		{
+			Player = player;
+			BannedItem = bannedItem;
+		}
+	}
+
+	/// <summary>
+	/// EventArgs used for the <see cref="PlayerHooks.PlayerProjbanPermission"/> event.
+	/// </summary>
+	public class PlayerProjbanPermissionEventArgs : HandledEventArgs
+	{
+		/// <summary>
+		/// The player who fired the event.
+		/// </summary>
+		public TSPlayer Player { get; set; }
+
+		/// <summary>
+		/// The banned projectile being checked.
+		/// </summary>
+		public ProjectileBan BannedProjectile { get; set; }
+
+		/// <summary>
+		/// Initializes a new instance of the PlayerProjbanPermissionEventArgs class.
+		/// </summary>
+		/// <param name="player">The player who fired the event.</param>
+		/// <param name="checkedProjectile">The banned projectile being checked.</param>
+		public PlayerProjbanPermissionEventArgs(TSPlayer player, ProjectileBan checkedProjectile)
+		{
+			Player = player;
+			BannedProjectile = checkedProjectile;
+		}
+	}
+
+	/// <summary>
+	/// EventArgs used for the <see cref="PlayerHooks.PlayerTilebanPermission"/> event.
+	/// </summary>
+	public class PlayerTilebanPermissionEventArgs : HandledEventArgs
+	{
+		/// <summary>
+		/// The player who fired the event.
+		/// </summary>
+		public TSPlayer Player { get; set; }
+
+		/// <summary>
+		/// The banned tile being checked.
+		/// </summary>
+		public TileBan BannedTile { get; set; }
+
+		/// <summary>
+		/// Initializes a new instance of the PlayerTilebanPermissionEventArgs class.
+		/// </summary>
+		/// <param name="player">The player who fired the event.</param>
+		/// <param name="checkedTile">The banned tile being checked.</param>
+		public PlayerTilebanPermissionEventArgs(TSPlayer player, TileBan checkedTile)
+		{
+			Player = player;
+			BannedTile = checkedTile;
+		}
+	}
+
 	/// <summary>
 	/// A collection of events fired by players that can be hooked to.
 	/// </summary>
@@ -232,6 +314,37 @@ namespace TShockAPI.Hooks
 		/// </summary>
 		public static event PlayerPermissionD PlayerPermission;
 
+		/// <summary>
+		/// The delegate of the <see cref="PlayerItembanPermission"/> event.
+		/// </summary>
+		/// <param name="e">The EventArgs for this event.</param>
+		public delegate void PlayerItembanPermissionD(PlayerItembanPermissionEventArgs e);
+		/// <summary>
+		/// Fired by players every time a permission check on banned items involving them occurs.
+		/// </summary>
+		public static event PlayerItembanPermissionD PlayerItembanPermission;
+
+		/// <summary>
+		/// The delegate of the <see cref="PlayerProjbanPermission"/> event.
+		/// </summary>
+		/// <param name="e">The EventArgs for this event.</param>
+		public delegate void PlayerProjbanPermissionD(PlayerProjbanPermissionEventArgs e);
+		/// <summary>
+		/// Fired by players every time a permission check on banned projectiles involving them occurs.
+		/// </summary>
+		public static event PlayerProjbanPermissionD PlayerProjbanPermission;
+
+		/// <summary>
+		/// The delegate of the <see cref="PlayerTilebanPermission"/> event.
+		/// </summary>
+		/// <param name="e">The EventArgs for this event.</param>
+		public delegate void PlayerTilebanPermissionD(PlayerTilebanPermissionEventArgs e);
+		/// <summary>
+		/// Fired by players every time a permission check on banned tiles involving them occurs.
+		/// </summary>
+		public static event PlayerTilebanPermissionD PlayerTilebanPermission;
+
+
 		/// <summary>
 		/// Fires the <see cref="PlayerPostLogin"/> event.
 		/// </summary>
@@ -336,5 +449,50 @@ namespace TShockAPI.Hooks
 			PlayerPermission(args);
 			return args.Handled;
 		}
+
+		/// <summary>
+		/// Fires the <see cref="PlayerItembanPermission"/> event.
+		/// </summary>
+		/// <param name="player">The player firing the event.</param>
+		/// <returns>True if the event has been handled.</returns>
+		public static bool OnPlayerItembanPermission(TSPlayer player, ItemBan bannedItem)
+		{
+			if (PlayerItembanPermission == null)
+				return false;
+
+			var args = new PlayerItembanPermissionEventArgs(player, bannedItem);
+			PlayerItembanPermission(args);
+			return args.Handled;
+		}
+
+		/// <summary>
+		/// Fires the <see cref="PlayerProjbanPermission"/> event.
+		/// </summary>
+		/// <param name="player">The player firing the event.</param>
+		/// <returns>True if the event has been handled.</returns>
+		public static bool OnPlayerProjbanPermission(TSPlayer player, ProjectileBan bannedProj)
+		{
+			if (PlayerProjbanPermission == null)
+				return false;
+
+			var args = new PlayerProjbanPermissionEventArgs(player, bannedProj);
+			PlayerProjbanPermission(args);
+			return args.Handled;
+		}
+
+		/// <summary>
+		/// Fires the <see cref="PlayerTilebanPermission"/> event.
+		/// </summary>
+		/// <param name="player">The player firing the event.</param>
+		/// <returns>True if the event has been handled.</returns>
+		public static bool OnPlayerTilebanPermission(TSPlayer player, TileBan bannedTile)
+		{
+			if (PlayerTilebanPermission == null)
+				return false;
+
+			var args = new PlayerTilebanPermissionEventArgs(player, bannedTile);
+			PlayerTilebanPermission(args);
+			return args.Handled;
+		}
 	}
 }

TShockAPI/TSPlayer.cs

@@ -1253,6 +1253,38 @@ namespace TShockAPI
 			else
 				return Group.HasPermission(permission);
 		}
+
+		/// <summary>
+		/// Checks to see if a player has permission to use the specific banned item.
+		/// Fires the <see cref="PlayerHooks.OnPlayerItembanPermission"/> hook which may be handled to override item ban permission checks.
+		/// </summary>
+		/// <param name="bannedItem">The <see cref="ItemBan" /> to check.</param>
+		/// <returns>True if the player has permission to use the banned item.</returns>
+		public bool HasPermission(ItemBan bannedItem)
+		{
+			return TShock.Itembans.ItemIsBanned(bannedItem.Name, this);
+		}
+
+		/// <summary>
+		/// Checks to see if a player has permission to use the specific banned projectile.
+		/// Fires the <see cref="PlayerHooks.OnPlayerProjbanPermission"/> hook which may be handled to override projectile ban permission checks.
+		/// </summary>
+		/// <param name="bannedProj">The <see cref="ProjectileBan" /> to check.</param>
+		/// <returns>True if the player has permission to use the banned projectile.</returns>
+		public bool HasPermission(ProjectileBan bannedProj)
+		{
+			return TShock.ProjectileBans.ProjectileIsBanned(bannedProj.ID, this);
+		}
+		/// <summary>
+		/// Checks to see if a player has permission to use the specific banned tile.
+		/// Fires the <see cref="PlayerHooks.OnPlayerTilebanPermission"/> hook which may be handled to override tile ban permission checks.
+		/// </summary>
+		/// <param name="bannedTile">The <see cref="TileBan" /> to check.</param>
+		/// <returns>True if the player has permission to use the banned tile.</returns>
+		public bool HasPermission(TileBan bannedTile)
+		{
+			return TShock.TileBans.TileIsBanned(bannedTile.ID, this);
+		}
 	}
 
 	public class TSRestPlayer : TSPlayer