Package net.citizensnpcs.api.trait.trait

Class PlayerFilter

java.lang.Object

net.citizensnpcs.api.trait.Trait

net.citizensnpcs.api.trait.trait.PlayerFilter

All Implemented Interfaces:

Runnable, Listener

public class PlayerFilter
extends Trait

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PlayerFilter.Mode

Field Summary

Fields inherited from class net.citizensnpcs.api.trait.Trait

npc

Constructor Summary

Constructors

Constructor	Description
PlayerFilter()
PlayerFilter(BiConsumer<Player,Entity> hideFunction, BiConsumer<Player,Entity> viewFunction)

Method Summary

Modifier and Type	Method	Description
void	addChildNPC(NPC npc)
void	addGroup(String group)	Manages NPC hiding using the given permissions group
void	addPermission(String permission)	Manages NPC hiding using the given permission
void	addPlayer(UUID uuid)	Manages NPC hiding from the provided UUID
boolean	affectsGroup(String group)
boolean	affectsPlayer(UUID uuid)
void	clear()	Clears all set UUID filters.
double	getApplyRange()
Set<String>	getGroups()	Implementation detail: may change in the future.
Set<String>	getPermissions()	Implementation detail: may change in the future.
Set<UUID>	getPlayerUUIDs()	Implementation detail: may change in the future.
boolean	isAllowlist()
boolean	isDenylist()
boolean	isHidden(Player player)	Whether the NPC should be hidden from the given Player
void	onDespawn()	Called just before the attached NPC is despawned.
boolean	onSeenByPlayer(Player player)	For internal use.
void	recalculate()	Explicit recalculation of which Players should be viewing the NPC.
void	removeGroup(String group)	Unhides the given permissions group
void	removePermission(String permission)	Unhides the given permission
void	removePlayer(UUID uuid)	Unhides the given Player UUID
void	run()	Called every tick if overridden.
void	setAllowlist()
void	setApplyRange(double range)	Sets the range in blocks where the filter applies.
void	setDenylist()	Implementation detail: may change in the future.
void	setPlayerFilter(Function<Player,Boolean> filter)	Sets the filter function, which returns true if the NPC should be hidden from the given Player.
void	setPlayers(Set<UUID> players)	Implementation detail: may change in the future.

Methods inherited from class net.citizensnpcs.api.trait.Trait

getName, getNPC, isRunImplemented, linkToNPC, load, onAttach, onCopy, onDespawn, onPreSpawn, onRemove, onRemove, onSpawn, save

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PlayerFilter

public PlayerFilter()

PlayerFilter

public PlayerFilter(BiConsumer<Player,Entity> hideFunction,
 BiConsumer<Player,Entity> viewFunction)

Method Details

addChildNPC

public void addChildNPC(NPC npc)

addGroup

public void addGroup(String group)

Manages NPC hiding using the given permissions group

addPermission

public void addPermission(String permission)

Manages NPC hiding using the given permission

addPlayer

public void addPlayer(UUID uuid)

Manages NPC hiding from the provided UUID

Parameters:

uuid -

affectsGroup

public boolean affectsGroup(String group)

affectsPlayer

public boolean affectsPlayer(UUID uuid)

clear

public void clear()

Clears all set UUID filters.

getApplyRange

public double getApplyRange()

getGroups

public Set<String> getGroups()

Implementation detail: may change in the future.

getPermissions

public Set<String> getPermissions()

Implementation detail: may change in the future.

getPlayerUUIDs

public Set<UUID> getPlayerUUIDs()

Implementation detail: may change in the future.

isAllowlist

public boolean isAllowlist()

isDenylist

public boolean isDenylist()

isHidden

public boolean isHidden(Player player)

Whether the NPC should be hidden from the given Player

onDespawn

public void onDespawn()

Description copied from class: Trait

Called just before the attached NPC is despawned. NPC.getEntity() will be non-null.

Overrides:

onDespawn in class Trait

onSeenByPlayer

public boolean onSeenByPlayer(Player player)

For internal use. Method signature may be changed at any time.

recalculate

public void recalculate()

Explicit recalculation of which Players should be viewing the NPC. Sends hide packets for players that should no longer view the NPC.

removeGroup

public void removeGroup(String group)

Unhides the given permissions group

removePermission

public void removePermission(String permission)

Unhides the given permission

removePlayer

public void removePlayer(UUID uuid)

Unhides the given Player UUID

run

public void run()

Description copied from class: Trait

Called every tick if overridden.

Specified by:

run in interface Runnable

Overrides:

run in class Trait

setAllowlist

public void setAllowlist()

setApplyRange

public void setApplyRange(double range)

Sets the range in blocks where the filter applies. For example, if the range is 25 blocks and the Player is more than 25 blocks away, the filter is ignored and the Player will not be hidden.

Parameters:

range - The new range

setDenylist

public void setDenylist()

Implementation detail: may change in the future.

setPlayerFilter

public void setPlayerFilter(Function<Player,Boolean> filter)

Sets the filter function, which returns true if the NPC should be hidden from the given Player.

setPlayers

public void setPlayers(Set<UUID> players)

Implementation detail: may change in the future.