Package de.erethon.dungeonsxl.api.player

Interface EditPlayer

All Superinterfaces:

GlobalPlayer, InstancePlayer, de.erethon.commons.player.PlayerWrapper

public interface EditPlayer
extends InstancePlayer

Represents a player in an edit instance.

All players in an edit world have one wrapper object that is an instance of EditPlayer.

Author:

Daniel Saukel

Method Summary

Modifier and Type	Method	Description
void	escape()	Makes the player leave the edit world without saving the progress.
String[]	getCopiedLines()	Returns the lines of a sign the player has copied with a stick tool in an array with the length of four.
EditWorld	getEditWorld()	Returns the EditWorld the player is editing.
default void	leave()	Makes the player leave his group and dungeon.
void	leave(boolean unloadIfEmpty)	Makes the player leave his group and dungeon.
void	setCopiedLines(String[] copiedLines)	Sets the memorized sign lines.

Methods inherited from interface de.erethon.dungeonsxl.api.player.GlobalPlayer

checkRequirements, getGroup, getRewardItems, hasPermission, hasRewardItemsLeft, isInBreakMode, isInChatSpyMode, isInGroupChat, reset, reset, sendMessage, setInBreakMode, setInChatSpyMode, setInGroupChat, setRewardItems

Methods inherited from interface de.erethon.dungeonsxl.api.player.InstancePlayer

getInstanceWorld, getWorld

Methods inherited from interface de.erethon.commons.player.PlayerWrapper

getName, getPlayer, getUniqueId

Method Details

getEditWorld

EditWorld getEditWorld()

Returns the EditWorld the player is editing.

Returns:

the EditWorld the player is editing

getCopiedLines

String[] getCopiedLines()

Returns the lines of a sign the player has copied with a stick tool in an array with the length of four.

Returns:

the lines of a sign the player has copied with a stick tool in an array with the length of four

setCopiedLines

void setCopiedLines(String[] copiedLines)

Sets the memorized sign lines.

Parameters:

copiedLines - the lines

leave

default void leave()

Makes the player leave his group and dungeon.

This unloads the world if there are no editors left after this player leaves.

Specified by:

leave in interface InstancePlayer

leave

void leave(boolean unloadIfEmpty)

Makes the player leave his group and dungeon.

Parameters:

unloadIfEmpty - whether the world is to be unloaded if, after this player leaves, no editors are left

escape

void escape()

Makes the player leave the edit world without saving the progress.