com.sk89q.worldedit

Class LocalSession

java.lang.Object

com.sk89q.worldedit.LocalSession

public class LocalSession
extends Object

An instance of this represents the WorldEdit session of a user. A session stores history and settings. Sessions are not tied particularly to any player and can be shuffled between players, saved, and loaded.

Author:

sk89q

Field Summary

Fields

Modifier and Type	Field and Description
static int	EXPIRATION_GRACE
static int	MAX_HISTORY_SIZE

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	clearHistory() Clear history.
EditSession	createEditSession(LocalPlayer player) Construct a new edit session.
void	describeCUI(LocalPlayer player)
Calendar	detectDate(String input) Detect date from a user's input.
void	disableSuperPickAxe() Disable super pick axe.
void	dispatchCUIEvent(LocalPlayer player, CUIEvent event) Dispatch a CUI event but only if the player has CUI support.
void	dispatchCUISelection(LocalPlayer player) Send the selection information.
void	dispatchCUISetup(LocalPlayer player) Dispatch the initial setup CUI messages.
void	enableSuperPickAxe() Enable super pick axe.
BlockBag	getBlockBag(LocalPlayer 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.
CuboidClipboard	getClipboard() Gets the clipboard.
int	getCUIVersion() Gets the client's CUI protocol version
String	getLastScript() Get the last script used.
Mask	getMask() Get the mask.
Vector	getPlacementPosition(LocalPlayer player) Get the placement position.
Region	getRegion() Deprecated.
RegionSelector	getRegionSelector() Deprecated.
RegionSelector	getRegionSelector(LocalWorld world) Get the region selector for defining the selection.
Region	getSelection(LocalWorld world) Get the selection region.
LocalWorld	getSelectionWorld() Get the selection world.
Snapshot	getSnapshot() Get the snapshot that has been selected.
BlockTool	getSuperPickaxe()
TimeZone	getTimeZone() Get the session's timezone.
Tool	getTool(int item) Get the tool assigned to the item.
void	handleCUIInitializationMessage(String text)
boolean	hasCUISupport() Gets the status of CUI support.
boolean	hasExpired() Returns whether this session has expired.
boolean	hasFastMode() Checks if the session has fast mode enabled.
boolean	hasSuperPickAxe() Checks whether the super pick axe is enabled.
boolean	isRegionDefined() Deprecated.
boolean	isSelectionDefined(LocalWorld 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.
EditSession	redo(BlockBag newBlockBag, LocalPlayer 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(CuboidClipboard clipboard) Sets the clipboard.
void	setCUISupport(boolean support) Sets the status of CUI support.
void	setCUIVersion(int CUIVersion) Sets the client's CUI protocol version
void	setFastMode(boolean fastMode) Set fast mode.
void	setLastScript(String lastScript) Set the last script used.
void	setMask(Mask mask) Set a mask.
void	setRegionSelector(LocalWorld world, RegionSelector selector) Set the region selector.
void	setSnapshot(Snapshot snapshot) Select a snapshot.
void	setSuperPickaxe(BlockTool tool) Set the super pickaxe 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(LocalPlayer 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.
void	update() Update the last update time for calculating expiration.

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 int MAX_HISTORY_SIZE

EXPIRATION_GRACE

public static int EXPIRATION_GRACE

Constructor Detail

LocalSession

public LocalSession(LocalConfiguration config)

Construct the object.

Parameters:

config -

Method Detail

getTimeZone

public TimeZone getTimeZone()

Get the session's timezone.

Returns:

setTimezone

public void setTimezone(TimeZone timezone)

Set the session's timezone.

Parameters:

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 -

undo

public EditSession undo(BlockBag newBlockBag,
               LocalPlayer player)

Performs an undo.

Parameters:

newBlockBag -

player -

Returns:

whether anything was undone

redo

public EditSession redo(BlockBag newBlockBag,
               LocalPlayer player)

Performs a redo

Parameters:

newBlockBag -

player -

Returns:

whether anything was redone

getRegionSelector

public RegionSelector getRegionSelector(LocalWorld 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 -

Returns:

position

getRegionSelector

@Deprecated
public RegionSelector getRegionSelector()

Deprecated.

Get the region selector. This won't check worlds so make sure that this region selector isn't used blindly.

Returns:

position

setRegionSelector

public void setRegionSelector(LocalWorld world,
                     RegionSelector selector)

Set the region selector.

Parameters:

world -

selector -

isRegionDefined

@Deprecated
public boolean isRegionDefined()

Deprecated.

Returns true if the region is fully defined.

Returns:

isSelectionDefined

public boolean isSelectionDefined(LocalWorld world)

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

Parameters:

world -

Returns:

getRegion

@Deprecated
public Region getRegion()
                 throws IncompleteRegionException

Deprecated.

Use getSelection().

Returns:

region

Throws:

IncompleteRegionException

getSelection

public Region getSelection(LocalWorld 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 -

Returns:

region

Throws:

IncompleteRegionException

getSelectionWorld

public LocalWorld getSelectionWorld()

Get the selection world.

Returns:

getClipboard

public CuboidClipboard getClipboard()
                             throws EmptyClipboardException

Gets the clipboard.

Returns:

clipboard, may be null

Throws:

EmptyClipboardException

setClipboard

public void setClipboard(CuboidClipboard clipboard)

Sets the clipboard.

Parameters:

clipboard -

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 -

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 -

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:

status

getPlacementPosition

public Vector getPlacementPosition(LocalPlayer player)
                            throws IncompleteRegionException

Get the placement position.

Parameters:

player -

Returns:

position

Throws:

IncompleteRegionException

togglePlacementPosition

public boolean togglePlacementPosition()

Toggle placement position.

Returns:

getBlockBag

public BlockBag getBlockBag(LocalPlayer player)

Get a block bag for a player.

Parameters:

player -

Returns:

getSnapshot

public Snapshot getSnapshot()

Get the snapshot that has been selected.

Returns:

the snapshot

setSnapshot

public void setSnapshot(Snapshot snapshot)

Select a snapshot.

Parameters:

snapshot -

getSuperPickaxe

public BlockTool getSuperPickaxe()

Returns:

the superPickaxeMode

setSuperPickaxe

public void setSuperPickaxe(BlockTool tool)

Set the super pickaxe tool.

Parameters:

tool -

getTool

public Tool getTool(int item)

Get the tool assigned to the item.

Parameters:

item -

Returns:

the tool

getBrushTool

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 -

Returns:

the tool

Throws:

InvalidToolBindException

setTool

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

Set the tool.

Parameters:

item -

tool - the tool to set

Throws:

InvalidToolBindException

isUsingInventory

public boolean isUsingInventory()

Returns whether inventory usage is enabled for this session.

Returns:

the useInventory

setUseInventory

public void setUseInventory(boolean useInventory)

Set the state of inventory usage.

Parameters:

useInventory - the useInventory to set

getLastScript

public String getLastScript()

Get the last script used.

Returns:

the lastScript

setLastScript

public void setLastScript(String lastScript)

Set the last script used.

Parameters:

lastScript - the lastScript to set

tellVersion

public void tellVersion(LocalPlayer player)

Tell the player the WorldEdit version.

Parameters:

player -

dispatchCUIEvent

public void dispatchCUIEvent(LocalPlayer player,
                    CUIEvent event)

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

Parameters:

player -

event -

dispatchCUISetup

public void dispatchCUISetup(LocalPlayer player)

Dispatch the initial setup CUI messages.

Parameters:

player -

dispatchCUISelection

public void dispatchCUISelection(LocalPlayer player)

Send the selection information.

Parameters:

player -

describeCUI

public void describeCUI(LocalPlayer player)

handleCUIInitializationMessage

public void handleCUIInitializationMessage(String text)

hasCUISupport

public boolean hasCUISupport()

Gets the status of CUI support.

Returns:

setCUISupport

public void setCUISupport(boolean support)

Sets the status of CUI support.

Parameters:

support -

getCUIVersion

public int getCUIVersion()

Gets the client's CUI protocol version

Returns:

setCUIVersion

public void setCUIVersion(int CUIVersion)

Sets the client's CUI protocol version

Parameters:

CUIVersion -

detectDate

public Calendar detectDate(String input)

Detect date from a user's input.

Parameters:

input -

Returns:

update

public void update()

Update the last update time for calculating expiration.

hasExpired

public boolean hasExpired()

Returns whether this session has expired.

Returns:

createEditSession

public EditSession createEditSession(LocalPlayer player)

Construct a new edit session.

Parameters:

player -

Returns:

hasFastMode

public boolean hasFastMode()

Checks if the session has fast mode enabled.

Returns:

setFastMode

public void setFastMode(boolean fastMode)

Set fast mode.

Parameters:

fastMode -

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