Enum BufferFunctions

java.lang.Object

java.lang.Enum<BufferFunctions>

com.blackrook.rookscript.functions.common.BufferFunctions

All Implemented Interfaces:

ScriptFunctionType, Serializable, Comparable<BufferFunctions>

public enum BufferFunctions
extends Enum<BufferFunctions>
implements ScriptFunctionType

RookScript buffer functions.

Author:

Matthew Tropiano

Nested Class Summary

Nested classes/interfaces inherited from interface ScriptFunctionType

ScriptFunctionType.Usage

Enum Constant Summary

Enum Constants

Enum Constant	Description
BUFFILL
BUFGETBYTE
BUFGETDOUBLE
BUFGETFLOAT
BUFGETINT
BUFGETLONG
BUFGETORDER
BUFGETPOS
BUFGETSHORT
BUFGETSTR
BUFGETUINT
BUFGETUSHORT
BUFNEW
BUFPUTBYTE
BUFPUTDOUBLE
BUFPUTFLOAT
BUFPUTINT
BUFPUTLONG
BUFPUTSHORT
BUFPUTSTR
BUFPUTUINT
BUFPUTUSHORT
BUFREAD
BUFSETORDER
BUFSETPOS
BUFSETSIZE
BUFSLICE
BUFSTR
BUFUNWRAP
BUFWRAP
ISBUFFER

Method Summary

Modifier and Type	Method	Description
static final ScriptFunctionResolver	createResolver()
abstract boolean	execute(ScriptInstance scriptInstance, ScriptValue returnValue)	Executes this function.
int	getParameterCount()
ScriptFunctionType.Usage	getUsage()
protected abstract ScriptFunctionType.Usage	usage()
static BufferFunctions	valueOf(String name)	Returns the enum constant of this type with the specified name.
static BufferFunctions[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ScriptFunctionType

name

Enum Constant Details

ISBUFFER

public static final BufferFunctions ISBUFFER

Since:

1.17.0

BUFNEW

public static final BufferFunctions BUFNEW

BUFSETSIZE

public static final BufferFunctions BUFSETSIZE

BUFWRAP

public static final BufferFunctions BUFWRAP

BUFUNWRAP

public static final BufferFunctions BUFUNWRAP

BUFSLICE

public static final BufferFunctions BUFSLICE

BUFSETPOS

public static final BufferFunctions BUFSETPOS

BUFGETPOS

public static final BufferFunctions BUFGETPOS

BUFSETORDER

public static final BufferFunctions BUFSETORDER

BUFGETORDER

public static final BufferFunctions BUFGETORDER

BUFREAD

public static final BufferFunctions BUFREAD

BUFFILL

public static final BufferFunctions BUFFILL

BUFPUTBYTE

public static final BufferFunctions BUFPUTBYTE

BUFGETBYTE

public static final BufferFunctions BUFGETBYTE

BUFPUTSHORT

public static final BufferFunctions BUFPUTSHORT

BUFGETSHORT

public static final BufferFunctions BUFGETSHORT

BUFPUTUSHORT

public static final BufferFunctions BUFPUTUSHORT

BUFGETUSHORT

public static final BufferFunctions BUFGETUSHORT

BUFPUTINT

public static final BufferFunctions BUFPUTINT

BUFGETINT

public static final BufferFunctions BUFGETINT

BUFPUTUINT

public static final BufferFunctions BUFPUTUINT

BUFGETUINT

public static final BufferFunctions BUFGETUINT

BUFPUTFLOAT

public static final BufferFunctions BUFPUTFLOAT

BUFGETFLOAT

public static final BufferFunctions BUFGETFLOAT

BUFPUTLONG

public static final BufferFunctions BUFPUTLONG

BUFGETLONG

public static final BufferFunctions BUFGETLONG

BUFPUTDOUBLE

public static final BufferFunctions BUFPUTDOUBLE

BUFGETDOUBLE

public static final BufferFunctions BUFGETDOUBLE

BUFPUTSTR

public static final BufferFunctions BUFPUTSTR

BUFGETSTR

public static final BufferFunctions BUFGETSTR

BUFSTR

public static final BufferFunctions BUFSTR

Method Details

values

public static BufferFunctions[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BufferFunctions valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

createResolver

public static final ScriptFunctionResolver createResolver()

Returns:

a function resolver that handles all of the functions in this enum.

getParameterCount

public int getParameterCount()

Specified by:

getParameterCount in interface ScriptFunctionType

Returns:

the total amount of parameters this takes.

getUsage

public ScriptFunctionType.Usage getUsage()

Specified by:

getUsage in interface ScriptFunctionType

Returns:

this function's usage instructions.

execute

public abstract boolean execute(ScriptInstance scriptInstance,
 ScriptValue returnValue)

Description copied from interface: ScriptFunctionType

Executes this function. The value in returnValue is automatically pushed onto the stack after the call. If a Throwable is thrown from this call, it is wrapped in a ScriptExecutionException. ScriptExecutionExceptions are thrown as-is.

Specified by:

execute in interface ScriptFunctionType

Parameters:

scriptInstance - the originating script instance.

returnValue - the value pushed to the stack on return.

Returns:

if false, this halts script execution, else if true, continue.

usage

protected abstract ScriptFunctionType.Usage usage()