Package com.blackrook.rookscript.functions

Enum Class MathFunctions

java.lang.Object

java.lang.Enum<MathFunctions>

com.blackrook.rookscript.functions.MathFunctions

All Implemented Interfaces:

ScriptFunctionType, Serializable, Comparable<MathFunctions>, java.lang.constant.Constable

public enum MathFunctions
extends Enum<MathFunctions>
implements ScriptFunctionType

Script common functions for mathematic functions.

Author:

Matthew Tropiano

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface com.blackrook.rookscript.lang.ScriptFunctionType

ScriptFunctionType.Usage

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACOS
ASIN
ATAN
CEILING
CLAMP
COLOR
COLORF
COS
DEG2RAD
E
FIX
FLOOR
LERP
LOG10
LOGE
MAX
MIN
PARSEINT
PI
POW
RAD2DEG
ROUND
SIN
SQRT
TAN
WRAP

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 MathFunctions	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MathFunctions[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.blackrook.rookscript.lang.ScriptFunctionType

name

Enum Constant Details

MIN

public static final MathFunctions MIN

MAX

public static final MathFunctions MAX

POW

public static final MathFunctions POW

ROUND

public static final MathFunctions ROUND

FLOOR

public static final MathFunctions FLOOR

CEILING

public static final MathFunctions CEILING

FIX

public static final MathFunctions FIX

E

public static final MathFunctions E

LOGE

public static final MathFunctions LOGE

LOG10

public static final MathFunctions LOG10

SQRT

public static final MathFunctions SQRT

PI

public static final MathFunctions PI

DEG2RAD

public static final MathFunctions DEG2RAD

RAD2DEG

public static final MathFunctions RAD2DEG

SIN

public static final MathFunctions SIN

COS

public static final MathFunctions COS

TAN

public static final MathFunctions TAN

ASIN

public static final MathFunctions ASIN

ACOS

public static final MathFunctions ACOS

ATAN

public static final MathFunctions ATAN

CLAMP

public static final MathFunctions CLAMP

WRAP

public static final MathFunctions WRAP

LERP

public static final MathFunctions LERP

PARSEINT

public static final MathFunctions PARSEINT

COLOR

public static final MathFunctions COLOR

COLORF

public static final MathFunctions COLORF

Method Details

values

public static MathFunctions[] values()

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

Returns:

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

valueOf

public static MathFunctions valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class 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()