Got a question that the wiki doesn't answer? Ask on the forum (preferred), or join us on IRC.

BeastNode

CommandHelper/Staged/Builtin Object Info

From EngineHub.org Wiki
Jump to: navigation, search


This page describes the built in objects.

ArrayAccess

Parent types: Sizeable, mixed

An ArrayAccess object is one that can be accessed with brackets ([]).

Since: 3.3.1

BadEntityException

Parent types: ArrayAccess, Exception, Sizeable, Throwable, mixed

Thrown if an entity is looked up by id, but doesn't exist.

Since: 3.3.1

BadEntityTypeException

Parent types: ArrayAccess, Exception, Sizeable, Throwable, mixed

Thrown if an entity has the wrong type.

Since: 3.3.1

BindException

Parent types: ArrayAccess, Exception, Sizeable, Throwable, mixed

This exception is thrown if an error occurs when trying to bind() an event, or if a event framework related error occurs.

Since: 3.3.1

ByteArrayReadOnlyException

Parent types: ArrayAccess, Exception, ReadOnlyException, Sizeable, Throwable, mixed

An exception which is thrown if the array copied from a byte array is attempted to be written to.

Since: 3.3.1

ByteBackingArray

Parent types: ArrayAccess, Sizeable, array, mixed

A read-only subclass of array, which is used to make reading byte arrays more efficient.

Since: 3.3.1

CastException

Parent types: ArrayAccess, Exception, Sizeable, Throwable, mixed

This exception is thrown if a value cannot be cast into an appropriate type. Functions that require a numeric value, for instance, would throw this if the string "hi" were passed in.

Since: 3.3.1

ClassType

Parent types: mixed

A ClassType is a value that represents an object type. This includes primitives or other value types.

Since: 3.3.1

EnchantmentException

Parent types: ArrayAccess, Exception, Sizeable, Throwable, mixed

If an enchantment is added to an item that isn't supported, this is thrown.

Since: 3.3.1

Error

Parent types: ArrayAccess, Sizeable, Throwable, mixed

Indicates a serious error occurred. It is not recommended to catch Error directly, but instead catch a specific subtype.

Since: 3.3.1

Exception

Parent types: ArrayAccess, Sizeable, Throwable, mixed

A generic exception. All normal exceptions extend this type.

Since: 3.3.1

FormatException

Parent types: ArrayAccess, Exception, Sizeable, Throwable, mixed

This exception is thrown if a function expected a string to be formatted in a particular way, but it could not interpret the given value.

Since: 3.3.1

IOException

Parent types: ArrayAccess, Exception, Sizeable, Throwable, mixed

This exception is thrown if a file cannot be read or written to.

Since: 3.3.1

IllegalArgumentException

Parent types: ArrayAccess, Exception, Sizeable, Throwable, mixed

Thrown if an argument was illegal in the given context.

Since: 3.3.1

IncludeException

Parent types: ArrayAccess, Exception, Sizeable, Throwable, mixed

This exception is thrown if there is a problem with an include. This is thrown if there is a compile error in the included script.

Since: 3.3.1

IndexOverflowException

Parent types: ArrayAccess, Exception, Sizeable, Throwable, mixed

This exception is thrown if a value is requested from an array that is above the highest index of the array, or a negative number.

Since: 3.3.1

InsufficientArgumentsException

Parent types: ArrayAccess, Exception, Sizeable, Throwable, mixed

Some var arg functions may require at least a certain number of arguments to be passed to the function

Since: 3.3.1

InsufficientPermissionException

Parent types: ArrayAccess, Exception, Sizeable, Throwable, mixed

This exception is thrown if the user running the command does not have permission to run the function

Since: 3.3.1

InvalidPluginException

Parent types: ArrayAccess, Exception, Sizeable, Throwable, mixed

This exception is thrown if a function uses an external plugin, and that plugin is not loaded, or otherwise unusable.

Since: 3.3.1

InvalidProcedureException

Parent types: ArrayAccess, Exception, Sizeable, Throwable, mixed

This exception is thrown if a procedure is used without being defined, or if a procedure name does not follow proper naming conventions.

Since: 3.3.1

InvalidWorldException

Parent types: ArrayAccess, Exception, Sizeable, Throwable, mixed

If a function requests a world, and the world given doesn't exist, this is thrown

Since: 3.3.1

LengthException

Parent types: ArrayAccess, Exception, Sizeable, Throwable, mixed

This exception is thrown if a function expected the length of something to be a particular value, but it was not.

Since: 3.3.1

NotFoundException

Parent types: ArrayAccess, Exception, Sizeable, Throwable, mixed

Thrown if data was not found, but expected.

Since: 3.3.1

NullPointerException

Parent types: ArrayAccess, Exception, Sizeable, Throwable, mixed

If a null is sent, but not expected, this exception is thrown. Additionally, this is thrown if null is dereferenced.

Since: 3.3.1

PlayerOfflineException

Parent types: ArrayAccess, Exception, Sizeable, Throwable, mixed

This exception is thrown if a function expected an online player, but that player was offline, or the command is being run from somewhere not in game, and the function was trying to use the current player.

Since: 3.3.1

PluginChannelException

Parent types: ArrayAccess, Exception, Sizeable, Throwable, mixed

Thrown if trying to register a plugin channel that is already registered, or unregister one that isn't registered.

Since: 3.3.1

PluginInternalException

Parent types: ArrayAccess, Exception, Sizeable, Throwable, mixed

This exception is thrown when a plugin is loaded, but a call to the plugin failed, usually for some reason specific to the plugin. Check the error message for more details about this error.

Since: 3.3.1

RangeException

Parent types: ArrayAccess, Exception, Sizeable, Throwable, mixed

This exception is thrown if a function expected a numeric value to be in a particular range, and it wasn't

Since: 3.3.1

ReadOnlyException

Parent types: ArrayAccess, Exception, Sizeable, Throwable, mixed

Thrown if a field was read only, but a write operation was attempted.

Since: 3.3.1

SQLException

Parent types: ArrayAccess, Exception, Sizeable, Throwable, mixed

Thrown if an SQL related exception occurs.

Since: 3.3.1

ScoreboardException

Parent types: ArrayAccess, Exception, Sizeable, Throwable, mixed

Thrown if a scoreboard error occurs, such as attempting to create a team or objective with a name that is already in use, or trying to access one that doesn't exist.

Since: 3.3.1

SecurityException

Parent types: ArrayAccess, Exception, Sizeable, Throwable, mixed

This exception is thrown if a script tries to read or write to a location of the filesystem that is not allowed.

Since: 3.3.1

ShellException

Parent types: ArrayAccess, Exception, Sizeable, Throwable, mixed

Thrown if a shell exception occurs.

Since: 3.3.1

Sizeable

Any object that can report a size should implement this.

Since: 3.3.1

StackOverflowError

Parent types: ArrayAccess, Error, Sizeable, Throwable, mixed

Thrown if a stack overflow error happens. This can occur if a function recurses too deeply.

Since: 3.3.1

Throwable

Parent types: ArrayAccess, Sizeable, mixed

All throwable types must extend this method. Otherwise, they will not be allowed to be thrown by the in script system.

Since: 3.3.1

UnageableMobException

Parent types: ArrayAccess, Exception, Sizeable, Throwable, mixed

If an age function is called on an unageable mob, this exception is thrown.

Since: 3.3.1

UntameableMobException

Parent types: ArrayAccess, Exception, Sizeable, Throwable, mixed

If an untameable mob is attempted to be tamed, this exception is thrown

Since: 3.3.1

array

Parent types: ArrayAccess, Sizeable, mixed

An array is a data type, which contains any number of other values.

Since: 3.0.1

boolean

Parent types: mixed, primitive

A boolean represents a true or false value.

Since: 3.0.1

byte_array

Parent types: ArrayAccess, Sizeable, array, mixed

A byte_array represents low level byte data.

Since: 3.3.1

closure

Parent types: mixed

A closure is a data type that contains executable code. This is similar to a procedure, but the value is first class, and can be stored in variables, and executed.

Since: 3.3.1

double

Parent types: mixed, number, primitive

A double is a floating point value, such as PI, 3.1415. Integral values can also be stored in a double, though they are represented differently, both internally and when displayed.

Since: 3.0.1

iclosure

Parent types: closure, mixed

An iclosure is an isolated scope closure. This is more efficient than a regular closure, but it doesn't allow for access of variables outside of the scope of the closure, other than values passed in.

Since: 3.3.1

int

Parent types: mixed, number, primitive

An integer is a discreet numerical value. All positive and negative counting numbers, as well as 0.

Since: 3.0.1

mixed

All values ultimately extend from mixed.

Since: 3.0.1

mutable_primitive

Parent types: ArrayAccess, Sizeable, array, mixed

A mutible primitive is a special data type that allows you to store primitives by reference, instead of value.

Since: 3.3.1

null

Parent types: mixed

null is a default value. All values can be null.

Since: 3.0.1

number

Parent types: mixed, primitive

A number is any double or integer number.

Since: 3.0.1

primitive

Parent types: mixed

A primitive is any non-object and non-array data type. All primitives are pass by value.

Since: 3.0.1

resource

Parent types: mixed

A resource is a value that represents an underlying native object. The object cannot be accessed directly.

Since: 3.3.1

slice

Parent types: ArrayAccess, Sizeable, array, mixed

A slice is a value that represents a numeric range, either in the positive direction, or negative.

Since: 3.3.1

string

Parent types: ArrayAccess, Sizeable, mixed, primitive

A string is a value that contains character data. The character encoding is stored with the string as well.

Since: 3.0.1

void

Parent types: mixed

void isn't a datatype per se, but represents a lack of a datatype. Void values can't be assigned to variables, or otherwise used.

Since: 3.0.1




Navigation menu