LocalSession (worldedit-core 7.2.0 API)

java.lang.Object
- com.sk89q.worldedit.LocalSession

public class LocalSession
extends java.lang.Object

Stores session information.

Field Summary

Fields
Modifier and Type Field and Description

static int MAX_HISTORY_SIZE

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.

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

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
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(Actor actor)` Construct a new edit session.
`void`	`describeCUI(Actor actor)` Describe the selection to the CUI actor.
`java.util.Calendar`	`detectDate(java.lang.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(ItemType 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.
`java.util.List<Countable<BlockState>>`	`getLastDistribution()` Get the last block distribution stored in this session.
`java.lang.String`	`getLastScript()` Get the last script used.
`Mask`	`getMask()` Get the mask.
`java.lang.String`	`getNavWandItem()` Get the preferred navigation wand item for this user, or `null` to use the default.
`BlockVector3`	`getPlacementPosition(Actor actor)` Get the position use for commands that take a center point (i.e.
`RegionSelector`	`getRegionSelector(World world)` Get the region selector for defining the selection.
`EditSession.ReorderMode`	`getReorderMode()` Gets the reorder mode of the session.
`Region`	`getSelection(World world)` Get the selection region.
`World`	`getSelectionWorld()` Get the selection world.
`SideEffectSet`	`getSideEffectSet()` Gets the side effect applier of this session.
`Snapshot`	`getSnapshot()` Get the legacy snapshot that has been selected.
`Snapshot`	`getSnapshotExperimental()` Get the snapshot that has been selected.
`BlockTool`	`getSuperPickaxe()` Get the assigned block tool.
`int`	`getTimeout()` Get the maximum time allowed for certain executions to run before cancelling them, such as expressions.
`java.time.ZoneId`	`getTimeZone()` Get the session's timezone.
`Tool`	`getTool(ItemType item)` Get the tool assigned to the item.
`java.lang.String`	`getWandItem()` Get the preferred wand item for this user, or `null` to use the default.
`World`	`getWorldOverride()`
`void`	`handleCUIInitializationMessage(java.lang.String text, Actor actor)` Handle a CUI initialization message.
`boolean`	`hasCUISupport()` Gets the status of CUI support.
`boolean`	`hasFastMode()` Deprecated.
`boolean`	`hasSuperPickAxe()` Checks whether the super pick axe is enabled.
`boolean`	`hasWorldOverride()`
`boolean`	`isDirty()` Get whether this session is "dirty" and has changes that needs to be committed.
`boolean`	`isPlaceAtPos1()`
`boolean`	`isSelectionDefined(World world)` Returns true if the region is fully defined for the specified world.
`boolean`	`isTickingWatchdog()`
`boolean`	`isToolControlEnabled()` Deprecated. The wand is now a tool that can be bound/unbound.
`boolean`	`isTracingActions()`
`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, Actor actor)` 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)` Deprecated.
`void`	`setLastDistribution(java.util.List<Countable<BlockState>> dist)` Store a block distribution in this session.
`void`	`setLastScript(java.lang.String lastScript)` Set the last script used.
`void`	`setMask(Mask mask)` Set a mask.
`void`	`setPlaceAtPos1(boolean placeAtPos1)`
`void`	`setRegionSelector(World world, RegionSelector selector)` Set the region selector.
`void`	`setReorderMode(EditSession.ReorderMode reorderMode)` Sets the reorder mode of the session.
`void`	`setSideEffectSet(SideEffectSet sideEffectSet)` Sets the side effect applier for this session.
`void`	`setSnapshot(Snapshot snapshot)` Select a legacy snapshot.
`void`	`setSnapshotExperimental(Snapshot snapshotExperimental)` Select a snapshot.
`void`	`setSuperPickaxe(BlockTool tool)` Set the super pick axe tool.
`void`	`setTickingWatchdog(boolean tickingWatchdog)`
`void`	`setTimeout(int timeout)` Set the maximum number of blocks that can be changed.
`void`	`setTimezone(java.time.ZoneId timezone)` Set the session's timezone.
`void`	`setTool(ItemType item, Tool tool)` Set the tool.
`void`	`setToolControl(boolean toolControl)` Deprecated. The wand is now a tool that can be bound/unbound.
`void`	`setTracingActions(boolean tracingActions)`
`void`	`setUseInventory(boolean useInventory)` Set the state of inventory usage.
`void`	`setUseServerCUI(boolean useServerCUI)`
`void`	`setWorldOverride(World worldOverride)`
`boolean`	`shouldUseServerCUI()`
`void`	`tellVersion(Actor actor)` Tell the player the WorldEdit version.
`boolean`	`togglePlacementPosition()` Toggle placement position.
`boolean`	`toggleSuperPickAxe()` Toggle the super pick axe.
`EditSession`	`undo(BlockBag newBlockBag, Actor actor)` Performs an undo.
`void`	`updateServerCUI(Actor actor)` Update server-side WorldEdit CUI.

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 java.time.ZoneId getTimeZone()
```
    Get the session's timezone.
    
    Returns:
    
    the timezone
  - setTimezone
```
public void setTimezone(java.time.ZoneId 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,
                        Actor actor)
```
    Performs an undo.
    
    Parameters:
    
    newBlockBag - a new block bag
    
    actor - the actor
    
    Returns:
    
    whether anything was undone
  - redo
```
public EditSession redo(@Nullable
                        BlockBag newBlockBag,
                        Actor actor)
```
    Performs a redo.
    
    Parameters:
    
    newBlockBag - a new block bag
    
    actor - the actor
    
    Returns:
    
    whether anything was redone
  - hasWorldOverride
```
public boolean hasWorldOverride()
```
  - getWorldOverride
```
@Nullable
public World getWorldOverride()
```
  - setWorldOverride
```
public void setWorldOverride(@Nullable
                             World worldOverride)
```
  - isTickingWatchdog
```
public boolean isTickingWatchdog()
```
  - setTickingWatchdog
```
public void setTickingWatchdog(boolean tickingWatchdog)
```
  - isTracingActions
```
public boolean isTracingActions()
```
  - setTracingActions
```
public void setTracingActions(boolean tracingActions)
```
  - 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
```
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
  - setRegionSelector
```
public void setRegionSelector(World world,
                              RegionSelector selector)
```
    Set the region selector.
    
    Parameters:
    
    world - the world
    
    selector - the selector
  - 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
  - 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
```
@Deprecated
public boolean isToolControlEnabled()
```
    Deprecated. The wand is now a tool that can be bound/unbound.
    
    Check if tool control is enabled.
    
    Returns:
    
    true always - see deprecation notice
  - setToolControl
```
@Deprecated
public void setToolControl(boolean toolControl)
```
    Deprecated. The wand is now a tool that can be bound/unbound.
    
    Set if tool control is enabled.
    
    Parameters:
    
    toolControl - unused - see deprecation notice
  - 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
  - getTimeout
```
public int getTimeout()
```
    Get the maximum time allowed for certain executions to run before cancelling them, such as expressions.
    
    Returns:
    
    timeout time, in milliseconds
  - setTimeout
```
public void setTimeout(int timeout)
```
    Set the maximum number of blocks that can be changed.
    
    Parameters:
    
    timeout - the time, in milliseconds, to limit certain executions to, or -1 to disable
  - 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 BlockVector3 getPlacementPosition(Actor actor)
                                  throws IncompleteRegionException
```
    Get the position use for commands that take a center point (i.e. //forestgen, etc.).
    
    Parameters:
    
    actor - the actor
    
    Returns:
    
    the position to use
    
    Throws:
    
    IncompleteRegionException - thrown if a region is not fully selected
  - setPlaceAtPos1
```
public void setPlaceAtPos1(boolean placeAtPos1)
```
  - isPlaceAtPos1
```
public boolean isPlaceAtPos1()
```
  - 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 legacy snapshot that has been selected.
    
    Returns:
    
    the legacy snapshot
  - setSnapshot
```
public void setSnapshot(@Nullable
                        Snapshot snapshot)
```
    Select a legacy snapshot.
    
    Parameters:
    
    snapshot - a legacy snapshot
  - getSnapshotExperimental
```
@Nullable
public Snapshot getSnapshotExperimental()
```
    Get the snapshot that has been selected.
    
    Returns:
    
    the snapshot
  - setSnapshotExperimental
```
public void setSnapshotExperimental(@Nullable
                                    Snapshot snapshotExperimental)
```
    Select a snapshot.
    
    Parameters:
    
    snapshotExperimental - 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(ItemType item)
```
    Get the tool assigned to the item.
    
    Parameters:
    
    item - the item type
    
    Returns:
    
    the tool, which may be null
  - getBrushTool
```
public BrushTool getBrushTool(ItemType 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
    
    Returns:
    
    the tool, or null
    
    Throws:
    
    InvalidToolBindException - if the item can't be bound to that item
  - setTool
```
public void setTool(ItemType item,
                    @Nullable
                    Tool tool)
             throws InvalidToolBindException
```
    Set the tool.
    
    Parameters:
    
    item - the item type
    
    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 java.lang.String getLastScript()
```
    Get the last script used.
    
    Returns:
    
    the last script's name
  - setLastScript
```
public void setLastScript(@Nullable
                          java.lang.String lastScript)
```
    Set the last script used.
    
    Parameters:
    
    lastScript - the last script's name
  - tellVersion
```
public void tellVersion(Actor actor)
```
    Tell the player the WorldEdit version.
    
    Parameters:
    
    actor - the actor
  - shouldUseServerCUI
```
public boolean shouldUseServerCUI()
```
  - setUseServerCUI
```
public void setUseServerCUI(boolean useServerCUI)
```
  - updateServerCUI
```
public void updateServerCUI(Actor actor)
```
    Update server-side WorldEdit CUI.
    
    Parameters:
    
    actor - 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(java.lang.String text,
                                           Actor actor)
```
    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 java.util.Calendar detectDate(java.lang.String input)
```
    Detect date from a user's input.
    
    Parameters:
    
    input - the input to parse
    
    Returns:
    
    a date
  - createEditSession
```
public EditSession createEditSession(Actor actor)
```
    Construct a new edit session.
    
    Parameters:
    
    actor - the actor
    
    Returns:
    
    an edit session
  - getSideEffectSet
```
public SideEffectSet getSideEffectSet()
```
    Gets the side effect applier of this session.
    
    Returns:
    
    the side effect applier
  - setSideEffectSet
```
public void setSideEffectSet(SideEffectSet sideEffectSet)
```
    Sets the side effect applier for this session.
    
    Parameters:
    
    sideEffectSet - the side effect applier
  - hasFastMode
```
@Deprecated
public boolean hasFastMode()
```
    Deprecated.
    
    Checks if the session has fast mode enabled.
    
    Returns:
    
    true if fast mode is enabled
  - setFastMode
```
@Deprecated
public void setFastMode(boolean fastMode)
```
    Deprecated.
    
    Set fast mode.
    
    Parameters:
    
    fastMode - true if fast mode is enabled
  - getReorderMode
```
public EditSession.ReorderMode getReorderMode()
```
    Gets the reorder mode of the session.
    
    Returns:
    
    The reorder mode
  - setReorderMode
```
public void setReorderMode(EditSession.ReorderMode reorderMode)
```
    Sets the reorder mode of the session.
    
    Parameters:
    
    reorderMode - The reorder mode
  - 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
  - getWandItem
```
public java.lang.String getWandItem()
```
    Get the preferred wand item for this user, or null to use the default.
    
    Returns:
    
    item id of wand item, or null
  - getNavWandItem
```
public java.lang.String getNavWandItem()
```
    Get the preferred navigation wand item for this user, or null to use the default.
    
    Returns:
    
    item id of nav wand item, or null
  - getLastDistribution
```
public java.util.List<Countable<BlockState>> getLastDistribution()
```
    Get the last block distribution stored in this session.
    
    Returns:
    
    block distribution or null
  - setLastDistribution
```
public void setLastDistribution(java.util.List<Countable<BlockState>> dist)
```
    Store a block distribution in this session.

Class LocalSession

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAX_HISTORY_SIZE

Constructor Detail

LocalSession

LocalSession

Method Detail

setConfiguration

postLoad

isDirty

compareAndResetDirty

getTimeZone

setTimezone

clearHistory

remember

undo

redo

hasWorldOverride

getWorldOverride

setWorldOverride

isTickingWatchdog

setTickingWatchdog

isTracingActions

setTracingActions

getDefaultRegionSelector

setDefaultRegionSelector

getRegionSelector

setRegionSelector

isSelectionDefined

getSelection

getSelectionWorld

getClipboard

setClipboard

isToolControlEnabled

setToolControl

getBlockChangeLimit

setBlockChangeLimit

getTimeout

setTimeout

hasSuperPickAxe

enableSuperPickAxe

disableSuperPickAxe

toggleSuperPickAxe

getPlacementPosition

setPlaceAtPos1

isPlaceAtPos1

togglePlacementPosition

getBlockBag

getSnapshot

setSnapshot

getSnapshotExperimental

setSnapshotExperimental

getSuperPickaxe

setSuperPickaxe

getTool

getBrushTool

setTool

isUsingInventory

setUseInventory

getLastScript

setLastScript

tellVersion

shouldUseServerCUI

setUseServerCUI

updateServerCUI

dispatchCUIEvent

dispatchCUISetup

dispatchCUISelection

describeCUI

handleCUIInitializationMessage

hasCUISupport

setCUISupport

getCUIVersion

setCUIVersion

detectDate

createEditSession