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

Change enum names for clarity

Browse source
This commit is contained in:
Ruby Rose 2017-07-12 08:47:27 +03:00
parent 3764527d3d
commit 685d9964f0
5 changed files with 38 additions and 38 deletions
Download patch file Download diff file Expand all files Collapse all files

52
TShockAPI/Hooks/PlayerHooks.cs
View file

@ -156,9 +156,9 @@ namespace TShockAPI.Hooks
public string Permission { get; set; }
/// <summary>
/// <see cref="PermissionResult"/> of the hook.
/// <see cref="PermissionHookResult"/> of the hook.
/// </summary>
public PermissionResult Result { get; set; }
public PermissionHookResult Result { get; set; }
/// <summary>
/// Initializes a new instance of the PlayerPermissionEventArgs class.
@ -169,7 +169,7 @@ namespace TShockAPI.Hooks
{
Player = player;
Permission = permission;
Result = PermissionResult.Inconclusive;
Result = PermissionHookResult.Unhandled;
}
}
@ -189,9 +189,9 @@ namespace TShockAPI.Hooks
public ItemBan BannedItem { get; set; }
/// <summary>
/// <see cref="PermissionResult"/> of the hook.
/// <see cref="PermissionHookResult"/> of the hook.
/// </summary>
public PermissionResult Result { get; set; }
public PermissionHookResult Result { get; set; }
/// <summary>
/// Initializes a new instance of the PlayerItembanPermissionEventArgs class.
@ -202,7 +202,7 @@ namespace TShockAPI.Hooks
{
Player = player;
BannedItem = bannedItem;
Result = PermissionResult.Inconclusive;
Result = PermissionHookResult.Unhandled;
}
}
@ -222,9 +222,9 @@ namespace TShockAPI.Hooks
public ProjectileBan BannedProjectile { get; set; }
/// <summary>
/// <see cref="PermissionResult"/> of the hook.
/// <see cref="PermissionHookResult"/> of the hook.
/// </summary>
public PermissionResult Result { get; set; }
public PermissionHookResult Result { get; set; }
/// <summary>
/// Initializes a new instance of the PlayerProjbanPermissionEventArgs class.
@ -235,7 +235,7 @@ namespace TShockAPI.Hooks
{
Player = player;
BannedProjectile = checkedProjectile;
Result = PermissionResult.Inconclusive;
Result = PermissionHookResult.Unhandled;
}
}
@ -255,9 +255,9 @@ namespace TShockAPI.Hooks
public TileBan BannedTile { get; set; }
/// <summary>
/// <see cref="PermissionResult"/> of the hook.
/// <see cref="PermissionHookResult"/> of the hook.
/// </summary>
public PermissionResult Result { get; set; }
public PermissionHookResult Result { get; set; }
/// <summary>
/// Initializes a new instance of the PlayerTilebanPermissionEventArgs class.
@ -268,7 +268,7 @@ namespace TShockAPI.Hooks
{
Player = player;
BannedTile = checkedTile;
Result = PermissionResult.Inconclusive;
Result = PermissionHookResult.Unhandled;
}
}
@ -463,11 +463,11 @@ namespace TShockAPI.Hooks
/// Fires the <see cref="PlayerPermission"/> event.
/// </summary>
/// <param name="player">The player firing the event.</param>
/// <returns>Event result if the event has been handled, otherwise <see cref="PermissionResult.Inconclusive"/>.</returns>
public static PermissionResult OnPlayerPermission(TSPlayer player, string permission)
/// <returns>Event result if the event has been handled, otherwise <see cref="PermissionHookResult.Unhandled"/>.</returns>
public static PermissionHookResult OnPlayerPermission(TSPlayer player, string permission)
{
if (PlayerPermission == null)
return PermissionResult.Inconclusive;
return PermissionHookResult.Unhandled;
var args = new PlayerPermissionEventArgs(player, permission);
PlayerPermission(args);
@ -479,11 +479,11 @@ namespace TShockAPI.Hooks
/// Fires the <see cref="PlayerItembanPermission"/> event.
/// </summary>
/// <param name="player">The player firing the event.</param>
/// <returns>Event result if the event has been handled, otherwise <see cref="PermissionResult.Inconclusive"/>.</returns>
public static PermissionResult OnPlayerItembanPermission(TSPlayer player, ItemBan bannedItem)
/// <returns>Event result if the event has been handled, otherwise <see cref="PermissionHookResult.Unhandled"/>.</returns>
public static PermissionHookResult OnPlayerItembanPermission(TSPlayer player, ItemBan bannedItem)
{
if (PlayerItembanPermission == null)
return PermissionResult.Inconclusive;
return PermissionHookResult.Unhandled;
var args = new PlayerItembanPermissionEventArgs(player, bannedItem);
PlayerItembanPermission(args);
@ -495,11 +495,11 @@ namespace TShockAPI.Hooks
/// Fires the <see cref="PlayerProjbanPermission"/> event.
/// </summary>
/// <param name="player">The player firing the event.</param>
/// <returns>Event result if the event has been handled, otherwise <see cref="PermissionResult.Inconclusive"/>.</returns>
public static PermissionResult OnPlayerProjbanPermission(TSPlayer player, ProjectileBan bannedProj)
/// <returns>Event result if the event has been handled, otherwise <see cref="PermissionHookResult.Unhandled"/>.</returns>
public static PermissionHookResult OnPlayerProjbanPermission(TSPlayer player, ProjectileBan bannedProj)
{
if (PlayerProjbanPermission == null)
return PermissionResult.Inconclusive;
return PermissionHookResult.Unhandled;
var args = new PlayerProjbanPermissionEventArgs(player, bannedProj);
PlayerProjbanPermission(args);
@ -511,11 +511,11 @@ namespace TShockAPI.Hooks
/// Fires the <see cref="PlayerTilebanPermission"/> event.
/// </summary>
/// <param name="player">The player firing the event.</param>
/// <returns>Event result if the event has been handled, otherwise <see cref="PermissionResult.Inconclusive"/>.</returns>
public static PermissionResult OnPlayerTilebanPermission(TSPlayer player, TileBan bannedTile)
/// <returns>Event result if the event has been handled, otherwise <see cref="PermissionHookResult.Unhandled"/>.</returns>
public static PermissionHookResult OnPlayerTilebanPermission(TSPlayer player, TileBan bannedTile)
{
if (PlayerTilebanPermission == null)
return PermissionResult.Inconclusive;
return PermissionHookResult.Unhandled;
var args = new PlayerTilebanPermissionEventArgs(player, bannedTile);
PlayerTilebanPermission(args);
@ -528,10 +528,10 @@ namespace TShockAPI.Hooks
/// <summary>
/// Defines the possible outcomes of <see cref="PlayerHooks.PlayerPermission"/> handlers.
/// </summary>
public enum PermissionResult
public enum PermissionHookResult
{
/// <summary>Hook doesn't return a result on the permission check.</summary>
Inconclusive,
Unhandled,
/// <summary>Permission is explicitly denied by a hook.</summary>
Denied,
/// <summary>Permission is explicitly granted by a hook.</summary>