me.lucko.helper.utils

Class Players

java.lang.Object

me.lucko.helper.utils.Players

@NonnullByDefault
public final class Players
extends Object

A collection of Player related utilities

Method Summary

Modifier and Type	Method and Description
static Collection<org.bukkit.entity.Player>	all() Gets all players on the server.
static Collection<org.bukkit.OfflinePlayer>	allOffline()
static void	forEach(Consumer<org.bukkit.entity.Player> consumer) Applies a given action to all players on the server
static void	forEachIfPlayer(Iterable<Object> objects, Consumer<org.bukkit.entity.Player> consumer) Applies an action to each object in the iterable, if it is a player.
static void	forEachInRange(org.bukkit.Location center, double radius, Consumer<org.bukkit.entity.Player> consumer) Applies an action to all players within a given radius of a point
static void	forEachOffline(Consumer<org.bukkit.OfflinePlayer> consumer)
static Optional<org.bukkit.entity.Player>	get(String username) Gets a player by username.
static Optional<org.bukkit.entity.Player>	get(UUID uuid) Gets a player by uuid.
static org.bukkit.entity.Player	getNullable(String username) Gets a player by username.
static org.bukkit.entity.Player	getNullable(UUID uuid) Gets a player by uuid.
static Optional<org.bukkit.OfflinePlayer>	getOffline(String username)
static Optional<org.bukkit.OfflinePlayer>	getOffline(UUID uuid)
static org.bukkit.OfflinePlayer	getOfflineNullable(String username)
static org.bukkit.OfflinePlayer	getOfflineNullable(UUID uuid)
static void	msg(org.bukkit.command.CommandSender sender, String... msgs) Messages a sender a set of messages.
static void	playSound(org.bukkit.Location location, org.bukkit.Sound sound)
static void	playSound(org.bukkit.entity.Player player, org.bukkit.Location location, org.bukkit.Sound sound)
static void	playSound(org.bukkit.entity.Player player, org.bukkit.Sound sound)
static void	resetFlySpeed(org.bukkit.entity.Player player)
static void	resetWalkSpeed(org.bukkit.entity.Player player)
static void	sendBlockChange(org.bukkit.entity.Player player, org.bukkit.block.Block block, org.bukkit.Material type)
static void	sendBlockChange(org.bukkit.entity.Player player, org.bukkit.block.Block block, org.bukkit.Material type, int data)
static void	sendBlockChange(org.bukkit.entity.Player player, org.bukkit.Location loc, org.bukkit.Material type)
static void	sendBlockChange(org.bukkit.entity.Player player, org.bukkit.Location loc, org.bukkit.Material type, int data)
static void	spawnEffect(org.bukkit.Location location, org.bukkit.Effect effect)
static void	spawnEffect(org.bukkit.Location location, org.bukkit.Effect effect, int amount)
static void	spawnEffect(org.bukkit.entity.Player player, org.bukkit.Location location, org.bukkit.Effect effect)
static void	spawnEffect(org.bukkit.entity.Player player, org.bukkit.Location location, org.bukkit.Effect effect, int amount)
static void	spawnParticle(org.bukkit.Location location, org.bukkit.Particle particle)
static void	spawnParticle(org.bukkit.Location location, org.bukkit.Particle particle, int amount)
static void	spawnParticle(org.bukkit.entity.Player player, org.bukkit.Location location, org.bukkit.Particle particle)
static void	spawnParticle(org.bukkit.entity.Player player, org.bukkit.Location location, org.bukkit.Particle particle, int amount)
static void	spawnParticleOffset(org.bukkit.Location location, org.bukkit.Particle particle, double offset)
static void	spawnParticleOffset(org.bukkit.Location location, org.bukkit.Particle particle, int amount, double offset)
static void	spawnParticleOffset(org.bukkit.entity.Player player, org.bukkit.Location location, org.bukkit.Particle particle, double offset)
static void	spawnParticleOffset(org.bukkit.entity.Player player, org.bukkit.Location location, org.bukkit.Particle particle, int amount, double offset)
static Stream<org.bukkit.entity.Player>	stream() Gets a stream of all players on the server.
static Stream<org.bukkit.entity.Player>	streamInRange(org.bukkit.Location center, double radius) Gets a stream of all players within a given radius of a point
static Stream<org.bukkit.OfflinePlayer>	streamOffline()

Methods inherited from class java.lang.Object

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

Method Detail

getNullable

@Nullable
public static org.bukkit.entity.Player getNullable(UUID uuid)

Gets a player by uuid.

Parameters:

uuid - the uuid

Returns:

a player, or null

get

public static Optional<org.bukkit.entity.Player> get(UUID uuid)

Gets a player by uuid.

Parameters:

uuid - the uuid

Returns:

an optional player

getNullable

@Nullable
public static org.bukkit.entity.Player getNullable(String username)

Gets a player by username.

Parameters:

username - the players username

Returns:

the player, or null

get

public static Optional<org.bukkit.entity.Player> get(String username)

Gets a player by username.

Parameters:

username - the players username

Returns:

an optional player

all

public static Collection<org.bukkit.entity.Player> all()

Gets all players on the server.

Returns:

all players on the server

stream

public static Stream<org.bukkit.entity.Player> stream()

Gets a stream of all players on the server.

Returns:

a stream of all players on the server

forEach

public static void forEach(Consumer<org.bukkit.entity.Player> consumer)

Applies a given action to all players on the server

Parameters:

consumer - the action to apply

forEachIfPlayer

public static void forEachIfPlayer(Iterable<Object> objects,
                                   Consumer<org.bukkit.entity.Player> consumer)

Applies an action to each object in the iterable, if it is a player.

Parameters:

objects - the objects to iterate

consumer - the action to apply

streamInRange

public static Stream<org.bukkit.entity.Player> streamInRange(org.bukkit.Location center,
                                                             double radius)

Gets a stream of all players within a given radius of a point

Parameters:

center - the point

radius - the radius

Returns:

a stream of players

forEachInRange

public static void forEachInRange(org.bukkit.Location center,
                                  double radius,
                                  Consumer<org.bukkit.entity.Player> consumer)

Applies an action to all players within a given radius of a point

Parameters:

center - the point

radius - the radius

consumer - the action to apply

msg

public static void msg(org.bukkit.command.CommandSender sender,
                       String... msgs)

Messages a sender a set of messages.

Parameters:

sender - the sender

msgs - the messages to send

getOfflineNullable

@Nullable
public static org.bukkit.OfflinePlayer getOfflineNullable(UUID uuid)

getOffline

public static Optional<org.bukkit.OfflinePlayer> getOffline(UUID uuid)

getOfflineNullable

@Nullable
public static org.bukkit.OfflinePlayer getOfflineNullable(String username)

getOffline

public static Optional<org.bukkit.OfflinePlayer> getOffline(String username)

allOffline

public static Collection<org.bukkit.OfflinePlayer> allOffline()

streamOffline

public static Stream<org.bukkit.OfflinePlayer> streamOffline()

forEachOffline

public static void forEachOffline(Consumer<org.bukkit.OfflinePlayer> consumer)

playSound

public static void playSound(org.bukkit.entity.Player player,
                             org.bukkit.Sound sound)

playSound

public static void playSound(org.bukkit.entity.Player player,
                             org.bukkit.Location location,
                             org.bukkit.Sound sound)

playSound

public static void playSound(org.bukkit.Location location,
                             org.bukkit.Sound sound)

sendBlockChange

public static void sendBlockChange(org.bukkit.entity.Player player,
                                   org.bukkit.Location loc,
                                   org.bukkit.Material type,
                                   int data)

sendBlockChange

public static void sendBlockChange(org.bukkit.entity.Player player,
                                   org.bukkit.block.Block block,
                                   org.bukkit.Material type,
                                   int data)

sendBlockChange

public static void sendBlockChange(org.bukkit.entity.Player player,
                                   org.bukkit.Location loc,
                                   org.bukkit.Material type)

sendBlockChange

public static void sendBlockChange(org.bukkit.entity.Player player,
                                   org.bukkit.block.Block block,
                                   org.bukkit.Material type)

spawnParticle

public static void spawnParticle(org.bukkit.entity.Player player,
                                 org.bukkit.Location location,
                                 org.bukkit.Particle particle)

spawnParticle

public static void spawnParticle(org.bukkit.Location location,
                                 org.bukkit.Particle particle)

spawnParticle

public static void spawnParticle(org.bukkit.entity.Player player,
                                 org.bukkit.Location location,
                                 org.bukkit.Particle particle,
                                 int amount)

spawnParticle

public static void spawnParticle(org.bukkit.Location location,
                                 org.bukkit.Particle particle,
                                 int amount)

spawnParticleOffset

public static void spawnParticleOffset(org.bukkit.entity.Player player,
                                       org.bukkit.Location location,
                                       org.bukkit.Particle particle,
                                       double offset)

spawnParticleOffset

public static void spawnParticleOffset(org.bukkit.Location location,
                                       org.bukkit.Particle particle,
                                       double offset)

spawnParticleOffset

public static void spawnParticleOffset(org.bukkit.entity.Player player,
                                       org.bukkit.Location location,
                                       org.bukkit.Particle particle,
                                       int amount,
                                       double offset)

spawnParticleOffset

public static void spawnParticleOffset(org.bukkit.Location location,
                                       org.bukkit.Particle particle,
                                       int amount,
                                       double offset)

spawnEffect

public static void spawnEffect(org.bukkit.entity.Player player,
                               org.bukkit.Location location,
                               org.bukkit.Effect effect)

spawnEffect

public static void spawnEffect(org.bukkit.Location location,
                               org.bukkit.Effect effect)

spawnEffect

public static void spawnEffect(org.bukkit.entity.Player player,
                               org.bukkit.Location location,
                               org.bukkit.Effect effect,
                               int amount)

spawnEffect

public static void spawnEffect(org.bukkit.Location location,
                               org.bukkit.Effect effect,
                               int amount)

resetWalkSpeed

public static void resetWalkSpeed(org.bukkit.entity.Player player)

resetFlySpeed

public static void resetFlySpeed(org.bukkit.entity.Player player)