com.sk89q.worldedit.scripting

Class CraftScriptContext

java.lang.Object

com.sk89q.worldedit.scripting.CraftScriptEnvironment

com.sk89q.worldedit.scripting.CraftScriptContext

public class CraftScriptContext
extends CraftScriptEnvironment

The context given to scripts.

Field Summary

Fields inherited from class com.sk89q.worldedit.scripting.CraftScriptEnvironment

config, controller, player, server, session

Constructor Summary

Constructors

Constructor and Description
CraftScriptContext(WorldEdit controller, Platform server, LocalConfiguration config, LocalSession session, Player player, String[] args)

Method Summary

Modifier and Type	Method and Description
void	checkArgs(int min, int max, String usage) Checks to make sure that there are enough but not too many arguments.
void	error(String message) Print an error message to the user.
BaseBlock	getBlock(String id) Get a block.
BaseBlock	getBlock(String input, boolean allAllowed) Get an item ID from an item name or an item ID number.
Set<Integer>	getBlockIDs(String list, boolean allBlocksAllowed) Get a list of blocks as a set.
Pattern	getBlockPattern(String list) Get a list of blocks as a set.
LocalConfiguration	getConfiguration() Get the configuration for WorldEdit.
List<EditSession>	getEditSessions() Get a list of edit sessions that have been created.
Player	getPlayer() Get the player.
File	getSafeFile(String folder, String filename) Deprecated.
File	getSafeOpenFile(String folder, String filename, String defaultExt, String... exts) Gets the path to a file for opening.
File	getSafeSaveFile(String folder, String filename, String defaultExt, String... exts) Gets the path to a file for saving.
LocalSession	getSession() Get the player's session.
void	print(String message) Print a regular message to the user.
void	printRaw(String message) Print an raw message to the user.
EditSession	remember() Get an edit session.

Methods inherited from class java.lang.Object

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

Constructor Detail

CraftScriptContext

public CraftScriptContext(WorldEdit controller,
                          Platform server,
                          LocalConfiguration config,
                          LocalSession session,
                          Player player,
                          String[] args)

Method Detail

remember

public EditSession remember()

Get an edit session. Every subsequent call returns a new edit session. Usually you only need to use one edit session.

Returns:

an edit session

getPlayer

public Player getPlayer()

Get the player.

Returns:

the calling player

getSession

public LocalSession getSession()

Get the player's session.

Returns:

a session

getConfiguration

public LocalConfiguration getConfiguration()

Get the configuration for WorldEdit.

Returns:

the configuration

getEditSessions

public List<EditSession> getEditSessions()

Get a list of edit sessions that have been created.

Returns:

a list of created EditSessions

print

public void print(String message)

Print a regular message to the user.

Parameters:

message - a message

error

public void error(String message)

Print an error message to the user.

Parameters:

message - a message

printRaw

public void printRaw(String message)

Print an raw message to the user.

Parameters:

message - a message

checkArgs

public void checkArgs(int min,
                      int max,
                      String usage)
               throws InsufficientArgumentsException

Checks to make sure that there are enough but not too many arguments.

Parameters:

min - a number of arguments

max - -1 for no maximum

usage - usage string

Throws:

InsufficientArgumentsException

getBlock

public BaseBlock getBlock(String input,
                          boolean allAllowed)
                   throws WorldEditException

Get an item ID from an item name or an item ID number.

Parameters:

input - input to parse

allAllowed - true to ignore blacklists

Returns:

a block

Throws:

UnknownItemException

DisallowedItemException

WorldEditException

getBlock

public BaseBlock getBlock(String id)
                   throws WorldEditException

Get a block.

Parameters:

id - the type Id

Returns:

a block

Throws:

UnknownItemException

DisallowedItemException

WorldEditException

getBlockPattern

public Pattern getBlockPattern(String list)
                        throws WorldEditException

Get a list of blocks as a set. This returns a Pattern.

Parameters:

list - the input

Returns:

pattern

Throws:

UnknownItemException

DisallowedItemException

WorldEditException

getBlockIDs

public Set<Integer> getBlockIDs(String list,
                                boolean allBlocksAllowed)
                         throws WorldEditException

Get a list of blocks as a set.

Parameters:

list - a list

allBlocksAllowed - true if all blocks are allowed

Returns:

set

Throws:

UnknownItemException

DisallowedItemException

WorldEditException

getSafeFile

@Deprecated
public File getSafeFile(String folder,
                                    String filename)
                             throws FilenameException

Deprecated.

Gets the path to a file. This method will check to see if the filename has valid characters and has an extension. It also prevents directory traversal exploits by checking the root directory and the file directory. On success, a java.io.File object will be returned.

Use this method if you need to read a file from a directory.

Parameters:

folder - sub-directory to look in

filename - filename (user-submitted)

Returns:

a file

Throws:

FilenameException

getSafeOpenFile

public File getSafeOpenFile(String folder,
                            String filename,
                            String defaultExt,
                            String... exts)
                     throws FilenameException

Gets the path to a file for opening. This method will check to see if the filename has valid characters and has an extension. It also prevents directory traversal exploits by checking the root directory and the file directory. On success, a java.io.File object will be returned.

Use this method if you need to read a file from a directory.

Parameters:

folder - sub-directory to look in

filename - filename (user-submitted)

defaultExt - default extension to append if there is none

exts - list of extensions for file open dialog, null for no filter

Returns:

a file

Throws:

FilenameException

getSafeSaveFile

public File getSafeSaveFile(String folder,
                            String filename,
                            String defaultExt,
                            String... exts)
                     throws FilenameException

Gets the path to a file for saving. This method will check to see if the filename has valid characters and has an extension. It also prevents directory traversal exploits by checking the root directory and the file directory. On success, a java.io.File object will be returned.

Use this method if you need to read a file from a directory.

Parameters:

folder - sub-directory to look in

filename - filename (user-submitted)

defaultExt - default extension to append if there is none

exts - list of extensions for file save dialog, null for no filter

Returns:

a file

Throws:

FilenameException