com.sk89q.worldedit

Class LocalSession

java.lang.Object

com.sk89q.worldedit.LocalSession

public class LocalSession
extends Object

Stores session information.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_HISTORY_SIZE

Constructor Summary

Constructors

Constructor and Description
LocalSession() Construct the object.
LocalSession(LocalConfiguration config) Construct the object.

Method Summary

Modifier and Type	Method and Description
void	clearHistory() Clear history.
boolean	compareAndResetDirty() Get whether this session is "dirty" and has changes that needs to be committed, and reset it to false.
EditSession	createEditSession(LocalPlayer player) Deprecated. use createEditSession(Player)
EditSession	createEditSession(Player player) Construct a new edit session.
void	describeCUI(Actor actor) Describe the selection to the CUI actor.
Calendar	detectDate(String input) Detect date from a user's input.
void	disableSuperPickAxe() Disable super pick axe.
void	dispatchCUIEvent(Actor actor, CUIEvent event) Dispatch a CUI event but only if the actor has CUI support.
void	dispatchCUISelection(Actor actor) Send the selection information.
void	dispatchCUISetup(Actor actor) Dispatch the initial setup CUI messages.
void	enableSuperPickAxe() Enable super pick axe.
BlockBag	getBlockBag(Player player) Get a block bag for a player.
int	getBlockChangeLimit() Get the maximum number of blocks that can be changed in an edit session.
BrushTool	getBrushTool(int item) Get the brush tool assigned to the item.
ClipboardHolder	getClipboard() Gets the clipboard.
int	getCUIVersion() Gets the client's CUI protocol version
RegionSelectorType	getDefaultRegionSelector() Get the default region selector.
String	getLastScript() Get the last script used.
Mask	getMask() Get the mask.
Vector	getPlacementPosition(Player player) Get the position use for commands that take a center point (i.e.
Region	getRegion() Deprecated. use getSelection(World)
RegionSelector	getRegionSelector() Deprecated. use getRegionSelector(World)
RegionSelector	getRegionSelector(LocalWorld world) Deprecated. Use getRegionSelector(World)
RegionSelector	getRegionSelector(World world) Get the region selector for defining the selection.
Region	getSelection(LocalWorld world) Deprecated. use getSelection(World)
Region	getSelection(World world) Get the selection region.
World	getSelectionWorld() Get the selection world.
Snapshot	getSnapshot() Get the snapshot that has been selected.
BlockTool	getSuperPickaxe() Get the assigned block tool.
TimeZone	getTimeZone() Get the session's timezone.
Tool	getTool(int item) Get the tool assigned to the item.
void	handleCUIInitializationMessage(String text) Handle a CUI initialization message.
boolean	hasCUISupport() Gets the status of CUI support.
boolean	hasFastMode() Checks if the session has fast mode enabled.
boolean	hasSuperPickAxe() Checks whether the super pick axe is enabled.
boolean	isDirty() Get whether this session is "dirty" and has changes that needs to be committed.
boolean	isRegionDefined() Deprecated.
boolean	isSelectionDefined(LocalWorld world) Deprecated. use isSelectionDefined(World)
boolean	isSelectionDefined(World world) Returns true if the region is fully defined for the specified world.
boolean	isToolControlEnabled() See if tool control is enabled.
boolean	isUsingInventory() Returns whether inventory usage is enabled for this session.
void	postLoad() Called on post load of the session from persistent storage.
EditSession	redo(BlockBag newBlockBag, LocalPlayer player) Performs a redo
EditSession	redo(BlockBag newBlockBag, Player player) Performs a redo
void	remember(EditSession editSession) Remember an edit session for the undo history.
void	setBlockChangeLimit(int maxBlocksChanged) Set the maximum number of blocks that can be changed.
void	setClipboard(ClipboardHolder clipboard) Sets the clipboard.
void	setConfiguration(LocalConfiguration config) Set the configuration.
void	setCUISupport(boolean support) Sets the status of CUI support.
void	setCUIVersion(int cuiVersion) Sets the client's CUI protocol version
void	setDefaultRegionSelector(RegionSelectorType defaultSelector) Set the default region selector.
void	setFastMode(boolean fastMode) Set fast mode.
void	setLastScript(String lastScript) Set the last script used.
void	setMask(Mask mask) Set a mask.
void	setMask(Mask mask) Set a mask.
void	setRegionSelector(LocalWorld world, RegionSelector selector) Deprecated. use setRegionSelector(World, RegionSelector)
void	setRegionSelector(World world, RegionSelector selector) Set the region selector.
void	setSnapshot(Snapshot snapshot) Select a snapshot.
void	setSuperPickaxe(BlockTool tool) Set the super pick axe tool.
void	setTimezone(TimeZone timezone) Set the session's timezone.
void	setTool(int item, Tool tool) Set the tool.
void	setToolControl(boolean toolControl) Change tool control setting.
void	setUseInventory(boolean useInventory) Set the state of inventory usage.
void	tellVersion(Actor player) Tell the player the WorldEdit version.
boolean	togglePlacementPosition() Toggle placement position.
boolean	toggleSuperPickAxe() Toggle the super pick axe.
EditSession	undo(BlockBag newBlockBag, LocalPlayer player) Performs an undo.
EditSession	undo(BlockBag newBlockBag, Player player) Performs an undo.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_HISTORY_SIZE

public static transient int MAX_HISTORY_SIZE

Constructor Detail

LocalSession

public LocalSession()

Construct the object.

setConfiguration(LocalConfiguration) should be called later with configuration.

LocalSession

public LocalSession(@Nullable
                    LocalConfiguration config)

Construct the object.

Parameters:

config - the configuration

Method Detail

setConfiguration

public void setConfiguration(LocalConfiguration config)

Set the configuration.

Parameters:

config - the configuration

postLoad

public void postLoad()

Called on post load of the session from persistent storage.

isDirty

public boolean isDirty()

Get whether this session is "dirty" and has changes that needs to be committed.

Returns:

true if dirty

compareAndResetDirty

public boolean compareAndResetDirty()

Get whether this session is "dirty" and has changes that needs to be committed, and reset it to false.

Returns:

true if the dirty value was true

getTimeZone

public TimeZone getTimeZone()

Get the session's timezone.

Returns:

the timezone

setTimezone

public void setTimezone(TimeZone timezone)

Set the session's timezone.

Parameters:

timezone - the user's timezone

clearHistory

public void clearHistory()

Clear history.

remember

public void remember(EditSession editSession)

Remember an edit session for the undo history. If the history maximum size is reached, old edit sessions will be discarded.

Parameters:

editSession - the edit session

undo

public EditSession undo(@Nullable
                        BlockBag newBlockBag,
                        LocalPlayer player)

Performs an undo.

Parameters:

newBlockBag - a new block bag

player - the player

Returns:

whether anything was undone

undo

public EditSession undo(@Nullable
                        BlockBag newBlockBag,
                        Player player)

Performs an undo.

Parameters:

newBlockBag - a new block bag

player - the player

Returns:

whether anything was undone

redo

public EditSession redo(@Nullable
                        BlockBag newBlockBag,
                        LocalPlayer player)

Performs a redo

Parameters:

newBlockBag - a new block bag

player - the player

Returns:

whether anything was redone

redo

public EditSession redo(@Nullable
                        BlockBag newBlockBag,
                        Player player)

Performs a redo

Parameters:

newBlockBag - a new block bag

player - the player

Returns:

whether anything was redone

getDefaultRegionSelector

public RegionSelectorType getDefaultRegionSelector()

Get the default region selector.

Returns:

the default region selector

setDefaultRegionSelector

public void setDefaultRegionSelector(RegionSelectorType defaultSelector)

Set the default region selector.

Parameters:

defaultSelector - the default region selector

getRegionSelector

@Deprecated
public RegionSelector getRegionSelector(LocalWorld world)

Deprecated. Use getRegionSelector(World)

getRegionSelector

public RegionSelector getRegionSelector(World world)

Get the region selector for defining the selection. If the selection was defined for a different world, the old selection will be discarded.

Parameters:

world - the world

Returns:

position the position

getRegionSelector

@Deprecated
public RegionSelector getRegionSelector()

Deprecated. use getRegionSelector(World)

setRegionSelector

@Deprecated
public void setRegionSelector(LocalWorld world,
                                          RegionSelector selector)

Deprecated. use setRegionSelector(World, RegionSelector)

setRegionSelector

public void setRegionSelector(World world,
                              RegionSelector selector)

Set the region selector.

Parameters:

world - the world

selector - the selector

isRegionDefined

@Deprecated
public boolean isRegionDefined()

Deprecated.

Returns true if the region is fully defined.

Returns:

true if a region selection is defined

isSelectionDefined

@Deprecated
public boolean isSelectionDefined(LocalWorld world)

Deprecated. use isSelectionDefined(World)

isSelectionDefined

public boolean isSelectionDefined(World world)

Returns true if the region is fully defined for the specified world.

Parameters:

world - the world

Returns:

true if a region selection is defined

getRegion

@Deprecated
public Region getRegion()
                             throws IncompleteRegionException

Deprecated. use getSelection(World)

Throws:

IncompleteRegionException

getSelection

@Deprecated
public Region getSelection(LocalWorld world)
                                throws IncompleteRegionException

Deprecated. use getSelection(World)

Throws:

IncompleteRegionException

getSelection

public Region getSelection(World world)
                    throws IncompleteRegionException

Get the selection region. If you change the region, you should call learnRegionChanges(). If the selection is defined in a different world, the IncompleteRegionException exception will be thrown.

Parameters:

world - the world

Returns:

a region

Throws:

IncompleteRegionException - if no region is selected

getSelectionWorld

public World getSelectionWorld()

Get the selection world.

Returns:

the the world of the selection

getClipboard

public ClipboardHolder getClipboard()
                             throws EmptyClipboardException

Gets the clipboard.

Returns:

clipboard

Throws:

EmptyClipboardException - thrown if no clipboard is set

setClipboard

public void setClipboard(@Nullable
                         ClipboardHolder clipboard)

Sets the clipboard.

Pass null to clear the clipboard.

Parameters:

clipboard - the clipboard, or null if the clipboard is to be cleared

isToolControlEnabled

public boolean isToolControlEnabled()

See if tool control is enabled.

Returns:

true if enabled

setToolControl

public void setToolControl(boolean toolControl)

Change tool control setting.

Parameters:

toolControl - true to enable tool control

getBlockChangeLimit

public int getBlockChangeLimit()

Get the maximum number of blocks that can be changed in an edit session.

Returns:

block change limit

setBlockChangeLimit

public void setBlockChangeLimit(int maxBlocksChanged)

Set the maximum number of blocks that can be changed.

Parameters:

maxBlocksChanged - the maximum number of blocks changed

hasSuperPickAxe

public boolean hasSuperPickAxe()

Checks whether the super pick axe is enabled.

Returns:

status

enableSuperPickAxe

public void enableSuperPickAxe()

Enable super pick axe.

disableSuperPickAxe

public void disableSuperPickAxe()

Disable super pick axe.

toggleSuperPickAxe

public boolean toggleSuperPickAxe()

Toggle the super pick axe.

Returns:

whether the super pick axe is now enabled

getPlacementPosition

public Vector getPlacementPosition(Player player)
                            throws IncompleteRegionException

Get the position use for commands that take a center point (i.e. //forestgen, etc.).

Parameters:

player - the player

Returns:

the position to use

Throws:

IncompleteRegionException - thrown if a region is not fully selected

togglePlacementPosition

public boolean togglePlacementPosition()

Toggle placement position.

Returns:

whether "place at position 1" is now enabled

getBlockBag

@Nullable
public BlockBag getBlockBag(Player player)

Get a block bag for a player.

Parameters:

player - the player to get the block bag for

Returns:

a block bag

getSnapshot

@Nullable
public Snapshot getSnapshot()

Get the snapshot that has been selected.

Returns:

the snapshot

setSnapshot

public void setSnapshot(@Nullable
                        Snapshot snapshot)

Select a snapshot.

Parameters:

snapshot - a snapshot

getSuperPickaxe

public BlockTool getSuperPickaxe()

Get the assigned block tool.

Returns:

the super pickaxe tool mode

setSuperPickaxe

public void setSuperPickaxe(BlockTool tool)

Set the super pick axe tool.

Parameters:

tool - the tool to set

getTool

@Nullable
public Tool getTool(int item)

Get the tool assigned to the item.

Parameters:

item - the item type ID

Returns:

the tool, which may be null

getBrushTool

@Nullable
public BrushTool getBrushTool(int item)
                                 throws InvalidToolBindException

Get the brush tool assigned to the item. If there is no tool assigned or the tool is not assigned, the slot will be replaced with the brush tool.

Parameters:

item - the item type ID

Returns:

the tool, or null

Throws:

InvalidToolBindException - if the item can't be bound to that item

setTool

public void setTool(int item,
                    @Nullable
                    Tool tool)
             throws InvalidToolBindException

Set the tool.

Parameters:

item - the item type ID

tool - the tool to set, which can be null

Throws:

InvalidToolBindException - if the item can't be bound to that item

isUsingInventory

public boolean isUsingInventory()

Returns whether inventory usage is enabled for this session.

Returns:

if inventory is being used

setUseInventory

public void setUseInventory(boolean useInventory)

Set the state of inventory usage.

Parameters:

useInventory - if inventory is to be used

getLastScript

@Nullable
public String getLastScript()

Get the last script used.

Returns:

the last script's name

setLastScript

public void setLastScript(@Nullable
                          String lastScript)

Set the last script used.

Parameters:

lastScript - the last script's name

tellVersion

public void tellVersion(Actor player)

Tell the player the WorldEdit version.

Parameters:

player - the player

dispatchCUIEvent

public void dispatchCUIEvent(Actor actor,
                             CUIEvent event)

Dispatch a CUI event but only if the actor has CUI support.

Parameters:

actor - the actor

event - the event

dispatchCUISetup

public void dispatchCUISetup(Actor actor)

Dispatch the initial setup CUI messages.

Parameters:

actor - the actor

dispatchCUISelection

public void dispatchCUISelection(Actor actor)

Send the selection information.

Parameters:

actor - the actor

describeCUI

public void describeCUI(Actor actor)

Describe the selection to the CUI actor.

Parameters:

actor - the actor

handleCUIInitializationMessage

public void handleCUIInitializationMessage(String text)

Handle a CUI initialization message.

Parameters:

text - the message

hasCUISupport

public boolean hasCUISupport()

Gets the status of CUI support.

Returns:

true if CUI is enabled

setCUISupport

public void setCUISupport(boolean support)

Sets the status of CUI support.

Parameters:

support - true if CUI is enabled

getCUIVersion

public int getCUIVersion()

Gets the client's CUI protocol version

Returns:

the CUI version

setCUIVersion

public void setCUIVersion(int cuiVersion)

Sets the client's CUI protocol version

Parameters:

cuiVersion - the CUI version

detectDate

@Nullable
public Calendar detectDate(String input)

Detect date from a user's input.

Parameters:

input - the input to parse

Returns:

a date

createEditSession

@Deprecated
public EditSession createEditSession(LocalPlayer player)

Deprecated. use createEditSession(Player)

createEditSession

public EditSession createEditSession(Player player)

Construct a new edit session.

Parameters:

player - the player

Returns:

an edit session

hasFastMode

public boolean hasFastMode()

Checks if the session has fast mode enabled.

Returns:

true if fast mode is enabled

setFastMode

public void setFastMode(boolean fastMode)

Set fast mode.

Parameters:

fastMode - true if fast mode is enabled

getMask

public Mask getMask()

Get the mask.

Returns:

mask, may be null

setMask

public void setMask(Mask mask)

Set a mask.

Parameters:

mask - mask or null

setMask

public void setMask(Mask mask)

Set a mask.

Parameters:

mask - mask or null