com.elikill58.negativity.universal.playerModifications

Interface PlayerModifications

public interface PlayerModifications

An extension used to indicate server-side modifications of a player. These modifications are not Forge or Fabric mods the player might have installed but whatever server-sided modding (of any nature) can do to change the behaviour/capacities of a player (think of the fly mode added by Essentials.)

Such modifications might trigger false positives, this is why this class exists.

See Also:

PlayerModificationsManager, PlayerModificationsProvider

Method Summary

Modifier and Type	Method and Description
default boolean	canFly(Player player) Indicates whether the given player is permitted to fly.
default String	getDisplayname()
default boolean	isProtected(Player player, Entity damager) Indicates whether the given player can be damaged by the given entity.
default boolean	isSpeedUnlocked(Player player) Indicates whether the given player can move as fast as they want.
default boolean	shouldIgnoreMovementChecks(Player player) Indicates whether the given player's movements should not be checked

Method Detail

getDisplayname

default String getDisplayname()

isProtected

default boolean isProtected(Player player,
                            Entity damager)

Indicates whether the given player can be damaged by the given entity.

Implementors might need to use more context, like the player location, to determine if they are in a region of a world that protects them for example.

Parameters:

player - the player to check if is protected

damager - the entity that try to damage player

Returns:

true if should be protected

See Also:

PlayerModificationsManager.isProtected(Player, Entity)

canFly

default boolean canFly(Player player)

Indicates whether the given player is permitted to fly.

Parameters:

player - the player which is looking for fly

Returns:

true if the player can fly

See Also:

PlayerModificationsManager.canFly(Player)

isSpeedUnlocked

default boolean isSpeedUnlocked(Player player)

Indicates whether the given player can move as fast as they want.

Parameters:

player - the player which is looking for speed

Returns:

true if the player can speed

See Also:

PlayerModificationsManager.isSpeedUnlocked(Player)

shouldIgnoreMovementChecks

default boolean shouldIgnoreMovementChecks(Player player)

Indicates whether the given player's movements should not be checked

Parameters:

player - the player which can have ignore movement

Returns:

true if movement of this player should be ignored

See Also:

PlayerModificationsManager.shouldIgnoreMovementChecks(Player)