com.github.lazoyoung.craftgames.api.module

Interface PlayerModule

public PlayerModule

Constructor Detail

PlayerModule

public PlayerModule()

Method Detail

getLivingPlayers

@NotNull
java.util.List<org.bukkit.entity.Player> getLivingPlayers()

getDeadPlayers

@NotNull
java.util.List<org.bukkit.entity.Player> getDeadPlayers()

getPlayersInside

@Deprecated
void getPlayersInside(@NotNull
                                   java.lang.String areaTag,
                                   @NotNull
                                   java.util.function.Consumer<java.util.List> callback)

Deprecated.

Inspect which Players are inside the area.

Parameters:

areaTag - Name of the coordinate tag which designates the area.

callback - Callback function that will accept the result(List of players inside) once the process is completed.

See Also:

Player

getPlayersInside

void getPlayersInside(@NotNull
                      CoordTag areaTag,
                      @NotNull
                      java.util.function.Consumer<java.util.List> callback)

Inspect which Players are inside the area.

Parameters:

areaTag - Coordinate tag which designates the area.

callback - Callback function that will accept the result(List of players inside) once the process is completed.

See Also:

Player

isOnline

boolean isOnline(@NotNull
                 org.bukkit.entity.Player player)

Check if player is playing this game.

See Also:

player

eliminate

void eliminate(@NotNull
               org.bukkit.entity.Player player)

Eliminate a player out of game, consequently switching the player to spectator mode.

See Also:

player

disguiseAsPlayer

void disguiseAsPlayer(@NotNull
                      org.bukkit.entity.Player player,
                      @NotNull
                      java.lang.String skinName,
                      boolean selfVisible)

Disguise a player to another Player.

This effectively changes the player's skin.

Parameters:

player - Player who are going to disguise.

skinName - Account name of the new skin's owner.

selfVisible - If true, disguise is visible in self perspective.

Throws:

DependencyNotFound - is thrown if LibsDisguises is not installed.

See Also:

player

disguiseAsMob

void disguiseAsMob(@NotNull
                   org.bukkit.entity.Player player,
                   @NotNull
                   org.bukkit.entity.EntityType type,
                   boolean isAdult,
                   boolean selfVisible)

Disguise a player to a Mob.

Parameters:

player - Player who are going to disguise.

type - Type of this Mob.

isAdult - Whether this Mob is an adult or a baby.

selfVisible - If true, disguise is visible in self perspective.

Throws:

DependencyNotFound - is thrown if LibsDisguises is not installed.

See Also:

player

disguiseAsBlock

void disguiseAsBlock(@NotNull
                     org.bukkit.entity.Player player,
                     @NotNull
                     org.bukkit.Material material,
                     boolean selfVisible)

Disguise a player to a FallingBlock.

Parameters:

player - Player who are going to disguise.

material - Type of this block.

selfVisible - If true, disguise is visible in self perspective.

Throws:

DependencyNotFound - is thrown if LibsDisguises is not installed.

See Also:

player

disguiseAsCustomPreset

void disguiseAsCustomPreset(@NotNull
                            org.bukkit.entity.Player player,
                            @NotNull
                            java.lang.String name,
                            boolean selfVisible)

Disguise a player to a custom saved preset.

Custom disguise can be saved via /savedisguise name (disguise_data)

Parameters:

player - Player who are going to disguise.

name - Name of the custom preset.

selfVisible - If true, disguise is visible in self perspective.

Throws:

DependencyNotFound - is thrown if LibsDisguises is not installed.

See Also:

player, name

undisguise

void undisguise(@NotNull
                org.bukkit.entity.Player player)

Stop disguise of this player.

Parameters:

player - Player who are going to stop disguise.

Throws:

DependencyNotFound - is thrown if LibsDisguises is not installed.

See Also:

player

setSpawnpoint

@Deprecated
void setSpawnpoint(@NotNull
                                PlayerType type,
                                @NotNull
                                java.lang.String spawnTag)

Deprecated.

Set spawnpoint for the players associated in certain enum PlayerType.

For team-based spawnpoint, see TeamModule.setSpawnpoint.

Parameters:

type - enum PlayerType indicating whose spawnpoint it is.

spawnTag - Name of the coordinate tag which captures spawnpoints.

Throws:

IllegalArgumentException - is thrown if spawnTag is not in this game.

See Also:

enum PlayerType, TeamModule.setSpawnpoint

setSpawnpoint

void setSpawnpoint(@NotNull
                   PlayerType type,
                   @NotNull
                   CoordTag tag)

Set spawnpoint for the players associated in certain enum PlayerType.

For team-based spawnpoint, see TeamModule.setSpawnpoint.

Parameters:

type - enum PlayerType indicating whose spawnpoint it is.

tag - Coordinate tag which designates spawnpoint(s).

Throws:

IllegalArgumentException - is raised if tag mode is neither TagMode.SPAWN nor TagMode.AREA.

See Also:

enum PlayerType, TeamModule.setSpawnpoint

overrideSpawnpoint

@Deprecated
void overrideSpawnpoint(@NotNull
                                     org.bukkit.entity.Player player,
                                     @NotNull
                                     java.lang.String tagName,
                                     int index)

Deprecated.

Set new spawnpoint for individual player.

Default spawnpoint becomes ineffective for that player.

Parameters:

player - The target player.

tagName - Name of the coordinate tag indicating spawnpoint.

index - (Optional) The capture index of that coordinate tag.This is randomly chosen if you to pass null.

See Also:

player

overrideSpawnpoint

void overrideSpawnpoint(@NotNull
                        org.bukkit.entity.Player player,
                        @NotNull
                        CoordTag tag,
                        int index)

Set new spawnpoint for individual player.

Default spawnpoint becomes ineffective for that player.

Parameters:

player - The target player.

tag - Coordinate tag indicating spawnpoint.

index - (Optional) The capture index of that coordinate tag.This is randomly chosen if you to pass null.

Throws:

IllegalArgumentException - is raised if tag mode is neither TagMode.SPAWN nor TagMode.AREA.

See Also:

player

overrideSpawnpoint

void overrideSpawnpoint(@NotNull
                        org.bukkit.entity.Player player,
                        @NotNull
                        org.bukkit.Location location)

Set new spawnpoint for individual player.

Default spawnpoint becomes ineffective for that player.

Parameters:

player - The target player.

location - Location of new spawnpoint.

See Also:

player

resetSpawnpoint

void resetSpawnpoint(@NotNull
                     org.bukkit.entity.Player player)

Reset individual spawnpoint back to default one.

In other words, it discards the spawnpoint previously set for the player via overrideSpawnpoint.

Parameters:

player - The target player.

See Also:

overrideSpawnpoint