Replace obsolete EntityWhitelist IsValid usages (#28465)

* Replace obsolete whitelist is valid with whitelist system

* Consistency

* Fix logic

* Bork

* I figured out how to get whitelists on the client lol

* test fail

* woops

* HELP ME FUNCTIONS

* Fix errors

* simplify

---------

Co-authored-by: plykiya <plykiya@protonmail.com>
This commit is contained in:
Plykiya
2024-06-01 20:10:24 -07:00
committed by GitHub
parent dce68e48e8
commit d6ba166d3b
31 changed files with 186 additions and 56 deletions

View File

@@ -60,6 +60,90 @@ public sealed class EntityWhitelistSystem : EntitySystem
return list.RequireAll;
}
/// The following are a list of "helper functions" that are basically the same as each other
/// to help make code that uses EntityWhitelist a bit more readable because at the moment
/// it is quite clunky having to write out component.Whitelist == null ? true : _whitelist.IsValid(component.Whitelist, uid)
/// several times in a row and makes comparisons easier to read
/// <summary>
/// Helper function to determine if Whitelist is not null and entity is on list
/// </summary>
public bool IsWhitelistPass(EntityWhitelist? whitelist, EntityUid uid)
{
if (whitelist == null)
return false;
return IsValid(whitelist, uid);
}
/// <summary>
/// Helper function to determine if Whitelist is not null and entity is not on the list
/// </summary>
public bool IsWhitelistFail(EntityWhitelist? whitelist, EntityUid uid)
{
if (whitelist == null)
return false;
return !IsValid(whitelist, uid);
}
/// <summary>
/// Helper function to determine if Whitelist is either null or the entity is on the list
/// </summary>
public bool IsWhitelistPassOrNull(EntityWhitelist? whitelist, EntityUid uid)
{
if (whitelist == null)
return true;
return IsValid(whitelist, uid);
}
/// <summary>
/// Helper function to determine if Whitelist is either null or the entity is not on the list
/// </summary>
public bool IsWhitelistFailOrNull(EntityWhitelist? whitelist, EntityUid uid)
{
if (whitelist == null)
return true;
return !IsValid(whitelist, uid);
}
/// <summary>
/// Helper function to determine if Blacklist is not null and entity is on list
/// Duplicate of equivalent Whitelist function
/// </summary>
public bool IsBlacklistPass(EntityWhitelist? blacklist, EntityUid uid)
{
return IsWhitelistPass(blacklist, uid);
}
/// <summary>
/// Helper function to determine if Blacklist is not null and entity is not on the list
/// Duplicate of equivalent Whitelist function
/// </summary>
public bool IsBlacklistFail(EntityWhitelist? blacklist, EntityUid uid)
{
return IsWhitelistFail(blacklist, uid);
}
/// <summary>
/// Helper function to determine if Blacklist is either null or the entity is on the list
/// Duplicate of equivalent Whitelist function
/// </summary>
public bool IsBlacklistPassOrNull(EntityWhitelist? blacklist, EntityUid uid)
{
return IsWhitelistPassOrNull(blacklist, uid);
}
/// <summary>
/// Helper function to determine if Blacklist is either null or the entity is not on the list
/// Duplicate of equivalent Whitelist function
/// </summary>
public bool IsBlacklistFailOrNull(EntityWhitelist? blacklist, EntityUid uid)
{
return IsWhitelistFailOrNull(blacklist, uid);
}
private void EnsureRegistrations(EntityWhitelist list)
{