com.sk89q.worldedit

Class EditSessionFactory

java.lang.Object

com.sk89q.worldedit.EditSessionFactory

public class EditSessionFactory
extends Object

Creates new EditSessions. To get an instance of this factory, use WorldEdit.getEditSessionFactory().

It is no longer possible to replace the instance of this in WorldEdit with a custom one. Use EditSessionEvent to override the creation of EditSessions.

Constructor Summary

Constructors

Constructor and Description
EditSessionFactory()

Method Summary

Modifier and Type	Method and Description
EditSession	getEditSession(LocalWorld world, int maxBlocks) Deprecated. We are replacing LocalWorld with World, so use getEditSession(World, int) instead
EditSession	getEditSession(LocalWorld world, int maxBlocks, BlockBag blockBag) Deprecated. We are replacing LocalWorld with World, so use getEditSession(World, int, BlockBag) instead
EditSession	getEditSession(LocalWorld world, int maxBlocks, BlockBag blockBag, LocalPlayer player) Deprecated. We are replacing LocalWorld with World, so use getEditSession(World, int, BlockBag, Player) instead
EditSession	getEditSession(LocalWorld world, int maxBlocks, LocalPlayer player) Deprecated. We are replacing LocalWorld with World, so use getEditSession(World, int, Player) instead
EditSession	getEditSession(World world, int maxBlocks) Construct an edit session with a maximum number of blocks.
EditSession	getEditSession(World world, int maxBlocks, BlockBag blockBag) Construct an edit session with a maximum number of blocks and a block bag.
EditSession	getEditSession(World world, int maxBlocks, BlockBag blockBag, Player player) Construct an edit session with a maximum number of blocks and a block bag.
EditSession	getEditSession(World world, int maxBlocks, Player player) Construct an edit session with a maximum number of blocks.

Methods inherited from class java.lang.Object

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

Constructor Detail

EditSessionFactory

public EditSessionFactory()

Method Detail

getEditSession

public EditSession getEditSession(World world,
                                  int maxBlocks)

Construct an edit session with a maximum number of blocks.

Parameters:

world - the world

maxBlocks - the maximum number of blocks that can be changed, or -1 to use no limit

Returns:

an instance

getEditSession

public EditSession getEditSession(World world,
                                  int maxBlocks,
                                  Player player)

Construct an edit session with a maximum number of blocks.

Parameters:

world - the world

maxBlocks - the maximum number of blocks that can be changed, or -1 to use no limit

player - the player that the EditSession is for

Returns:

an instance

getEditSession

public EditSession getEditSession(World world,
                                  int maxBlocks,
                                  BlockBag blockBag)

Construct an edit session with a maximum number of blocks and a block bag.

Parameters:

world - the world

maxBlocks - the maximum number of blocks that can be changed, or -1 to use no limit

blockBag - an optional BlockBag to use, otherwise null

Returns:

an instance

getEditSession

public EditSession getEditSession(World world,
                                  int maxBlocks,
                                  BlockBag blockBag,
                                  Player player)

Construct an edit session with a maximum number of blocks and a block bag.

Parameters:

world - the world

maxBlocks - the maximum number of blocks that can be changed, or -1 to use no limit

blockBag - an optional BlockBag to use, otherwise null

player - the player that the EditSession is for

Returns:

an instance

getEditSession

@Deprecated
public EditSession getEditSession(LocalWorld world,
                                              int maxBlocks)

Deprecated. We are replacing LocalWorld with World, so use getEditSession(World, int) instead

Construct an edit session.

Parameters:

world - the world

maxBlocks - the maximum number of blocks that can be changed, or -1 to use no limit

Returns:

an instance

getEditSession

@Deprecated
public EditSession getEditSession(LocalWorld world,
                                              int maxBlocks,
                                              LocalPlayer player)

Deprecated. We are replacing LocalWorld with World, so use getEditSession(World, int, Player) instead

Construct an edit session.

Parameters:

world - the world

maxBlocks - the maximum number of blocks that can be changed, or -1 to use no limit

player - the player that the EditSession is for

Returns:

an instance

getEditSession

@Deprecated
public EditSession getEditSession(LocalWorld world,
                                              int maxBlocks,
                                              BlockBag blockBag)

Deprecated. We are replacing LocalWorld with World, so use getEditSession(World, int, BlockBag) instead

Construct an edit session.

Parameters:

world - the world

maxBlocks - the maximum number of blocks that can be changed, or -1 to use no limit

blockBag - an optional BlockBag to use, otherwise null

Returns:

an instance

getEditSession

@Deprecated
public EditSession getEditSession(LocalWorld world,
                                              int maxBlocks,
                                              BlockBag blockBag,
                                              LocalPlayer player)

Deprecated. We are replacing LocalWorld with World, so use getEditSession(World, int, BlockBag, Player) instead

Construct an edit session.

Parameters:

world - the world

maxBlocks - the maximum number of blocks that can be changed, or -1 to use no limit

blockBag - an optional BlockBag to use, otherwise null

player - the player that the EditSession is for

Returns:

an instance