TAMEOperation

java.lang.Object
- java.lang.Enum<TAMEOperation>
- - com.tameif.tame.TAMEOperation

All Implemented Interfaces:

OperationType, TAMEConstants
```
public enum TAMEOperation
extends java.lang.Enum<TAMEOperation>
implements OperationType, TAMEConstants
```
The set of operations. Values in arguments are popped in reverse order on call, if arguments are taken. NOTE: THESE MUST BE DECLARED IN FULL CAPS TO ENSURE PARSING INTEGRITY!

Author:

Matthew Tropiano

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ADDCUE` Adds a cue to the response.
`ADDOBJECTNAME` Adds an object name to an object.
`ADDOBJECTTAG` Adds an object tag to an object.
`ADDOBJECTTAGTOALLIN` Adds an object tag to every object in a container-type.
`ARITHMETICFUNC` [INTERNAL] Arithmetic function.
`ASBOOLEAN` Casts a value to boolean.
`ASFLOAT` Casts a value to float.
`ASINT` Casts a value to integer.
`ASLIST` Casts a value to a list with one element.
`ASSTRING` Casts a value to string.
`BREAK` [INTERNAL] Throws a BREAK interrupt.
`BROWSE` Calls the appropriate "onBrowse" blocks on objects in an object container.
`BROWSETAGGED` Calls the appropriate "onBrowse" blocks on objects in an object container that have the provided tag.
`CALLELEMENTFUNCTION` [INTERNAL] Calls an element function.
`CALLFUNCTION` [INTERNAL] Calls a function.
`CEILING` Gets the arithmetic ceiling of a number.
`CLAMP` Returns the clamping of a number in an inclusive interval.
`CLEARELEMENTVALUE` [INTERNAL] Clears a variable from object member.
`CLEARVALUE` [INTERNAL] Clears a variable from blocklocal or object member.
`CONTINUE` [INTERNAL] Throws a CONTINUE interrupt.
`COS` Returns cosine of a number.
`CURRENTPLAYERIS` Checks if the current player is the one provided.
`CURRENTROOMIS` Checks if the current room is the one provided.
`E` Returns Euler's number in this implementation.
`ELEMENTHASANCESTOR` Returns true if the first element has the second element in its lineage.
`EMPTY` Gets if a a value is "empty." POP is the value.
`END` [INTERNAL] Throws an END interrupt.
`FINISH` [INTERNAL] Throws a FINISH interrupt.
`FIX` Fixed rounding: rounds a number to the nearest place after/before the decimal point.
`FLOOR` Gets the arithmetic floor of a number.
`FOR` [INTERNAL] FOR block.
`FRANDOM` Returns a random number from 0.0 (inclusive) to 1.0 (exclusive).
`FUNCTIONRETURN` [INTERNAL] Return from function.
`GIVEOBJECT` Adds an object to an object container.
`GRANDOM` Returns a Gaussian-distribution random number using a provided mean and standard deviation.
`HASOBJECT` Checks if an object is owned by an object container.
`HEADER` Pushes the value of a header value of the TAME module.
`IDENTITY` Pushes the identity of an element onto the stack.
`IF` [INTERNAL] If block.
`IRANDOM` Returns a random number from 0 to input-1.
`ISREGEX` Tests if a string is a valid RegEx.
`LENGTH` Gets the length of a value.
`LISTADD` Adds a value to the end of the list.
`LISTADDAT` Adds a value to an index in the list, shifting contents.
`LISTCONCAT` Concatenates two lists and creates a new list.
`LISTCONTAINS` Searches for the existence of a value in the list, starting from the beginning.
`LISTINDEX` Gets the index of a value in the list, starting from the beginning.
`LISTNEW` Makes a new list with a specific length.
`LISTREMOVE` Removes a value from the list, if the value is found in it, shifting contents.
`LISTREMOVEAT` Removes a value from the list by index, shifting contents.
`MAX` Returns the maximum of two numbers.
`MIN` Returns the minimum of two numbers.
`MOVEOBJECTSWITHTAG` Moves objects with a specific tag from a container and puts them in another.
`NOCURRENTPLAYER` Checks if there is no current player.
`NOCURRENTROOM` Checks if there is no current room.
`NOOP` Does nothing.
`OBJECTCOUNT` Counts the objects in a container.
`OBJECTHASNAME` Checks if an object has a specific name.
`OBJECTHASNOOWNER` Checks if an object has no owner.
`OBJECTHASTAG` Checks if an object has a specific tag.
`PAUSE` Adds a PAUSE cue to the response.
`PI` Returns PI in this implementation.
`PLAYERCANACCESSOBJECT` Checks if a player can access a particular item.
`PLAYERHASROOMINSTACK` Checks if a player has a room in its room stack.
`POP` [INTERNAL] Pops a value off the stack.
`POPELEMENTVALUE` [INTERNAL] Sets a variable on a object.
`POPLISTVALUE` [INTERNAL] Sets an index in a list-valued variable on a object.
`POPLOCALVALUE` [INTERNAL] Pops a value into a local variable.
`POPROOM` Pops a room off of the room stack (for the current player).
`POPVALUE` [INTERNAL] Pops a value into a variable in the topmost context in the execution, or the locals if defined.
`PUSHELEMENTVALUE` [INTERNAL] Resolves value of a variable on an object and pushes the value.
`PUSHINITLIST` [INTERNAL] Pushes a new list, initialized with values.
`PUSHLISTVALUE` [INTERNAL] Pushes a list-valued variable from the topmost context.
`PUSHNEWLIST` [INTERNAL] Pushes a new empty list.
`PUSHROOM` Pushes a room onto the room stack (for the current player).
`PUSHTHIS` [INTERNAL] Pushes the element connected to the current context.
`PUSHVALUE` [INTERNAL] Pushes a value or variable from the topmost context.
`QUEUEACTION` [INTERNAL] Enqueues a general action to perform after the current one finishes.
`QUEUEACTIONFOROBJECTSIN` [INTERNAL] Enqueues a transitive action to perform after the current one finishes for each object.
`QUEUEACTIONFORTAGGEDOBJECTSIN` [INTERNAL] Enqueues a transitive action to perform after the current one finishes for each object.
`QUEUEACTIONOBJECT` [INTERNAL] Enqueues a transitive action to perform after the current one finishes.
`QUEUEACTIONOBJECT2` [INTERNAL] Enqueues a ditransitive action to perform after the current one finishes.
`QUEUEACTIONSTRING` [INTERNAL] Enqueues an open/modal action to perform after the current one finishes.
`QUIT` [INTERNAL] Adds a QUIT cue to the response and throws a QUIT interrupt.
`REGEXCONTAINS` Tests if a string contains a pattern matched by a RegEx.
`REGEXFIND` Tests if a string contains a pattern matched by a RegEx.
`REGEXFINDLAST` Tests if a string contains the last pattern matched by a RegEx.
`REGEXGET` Gets the first matching substring in a string that matches a RegEx.
`REGEXGETALL` Gets all matching substrings in a string that matches a RegEx.
`REGEXGETLAST` Gets the last matching substring in a string that matches a RegEx.
`REGEXMATCHES` Gets if a whole string matches a RegEx.
`REGEXREPLACE` Replaces each occurrence of a RegEx match with a string expression.
`REGEXSPLIT` Splits a string into many via a RegEx.
`REMOVEOBJECT` Removes an object from its owner, whatever it is.
`REMOVEOBJECTNAME` Removes an object name from an object.
`REMOVEOBJECTTAG` Removes an object tag from an object.
`REMOVEOBJECTTAGFROMALLIN` Removes an object tag from every object in a container-type.
`ROUND` Rounds a number to the nearest number.
`SETPLAYER` Sets the current player.
`SETROOM` Sets the current room and clears the stack (for the current player).
`SIN` Returns sine of a number.
`SQRT` Gets the square root of a number.
`STRCHAR` Gets a single character from a string.
`STRCONCAT` Concatenates two strings together.
`STRCONTAINS` Returns if a character sequence exists in a given string.
`STRENDSWITH` Gets if a string ends with a particular sequence of characters.
`STRINDEX` Returns the index of where a character sequence starts in a string.
`STRJOIN` Returns a string that is the result of joining a list of strings together with a string in between each element.
`STRLASTINDEX` Returns the last possible index of where a character sequence starts in a string.
`STRLOWER` Gets a string converted to lowercase.
`STRPARAM` Replaces parts of a string with "{X}" with objects in a list.
`STRREPLACE` Replaces the first occurrence of a string with another.
`STRREPLACEALL` Replaces every occurrence of a string with another.
`STRREPLACELAST` Replaces the last occurrence of a string with another.
`STRSPLIT` Returns a string split into a list of strings using a string for matching the delimitation.
`STRSTARTSWITH` Gets if a string starts with a particular sequence of characters.
`STRTRIM` Gets a string trimmed of whitespace at both ends.
`STRUPPER` Gets a string converted to uppercase.
`SUBSTRING` Gets a substring from a larger one.
`SWAPROOM` Pops a room off of the room stack and pushes a new one (for the current player).
`TAN` Returns tangent of a number.
`TEXT` Adds a TEXT cue to the response.
`TEXTF` Adds a TEXTF cue to the response.
`TEXTFLN` Adds a TEXTF cue to the response with a newline appended to it.
`TEXTLN` Adds a TEXT cue to the response with a newline appended to it.
`TIME` Returns the current UTC time in milliseconds since the epoch.
`TIMEFORMAT` Formats a date/time as a string.
`WAIT` Adds a WAIT cue to the response.
`WHILE` [INTERNAL] WHILE block.

Field Summary

Fields
Modifier and Type Field and Description

static TAMEOperation[] VALUES
Array to get around multiple allocations.
- Fields inherited from interface com.tameif.tame.TAMEConstants
  CUE_ERROR, CUE_FATAL, CUE_PAUSE, CUE_QUIT, CUE_TEXT, CUE_TEXTF, CUE_TRACE, CUE_WAIT, DEFAULT_FUNCTION_DEPTH, DEFAULT_RUNAWAY_THRESHOLD, HEADER_AUTHOR, HEADER_COUNTRY, HEADER_EMAIL, HEADER_LANGUAGE, HEADER_TAME_FUNCDEPTH_MAX, HEADER_TAME_RUNAWAY_MAX, HEADER_TITLE, HEADER_TWITTER, HEADER_VERSION, HEADER_WEBSITE, IDENTITY_ARCHETYPE_CONTAINER, IDENTITY_CURRENT_PLAYER, IDENTITY_CURRENT_ROOM, IDENTITY_CURRENT_WORLD, RETURN_VARIABLE

Fields
Modifier and Type	Field and Description
`static TAMEOperation[]`	`VALUES` Array to get around multiple allocations.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`doOperation(TAMERequest request, TAMEResponse response, ValueSet blockLocal, Operation operation)` Performs the operation.
`void`	`execute(TAMERequest request, TAMEResponse response, ValueSet blockLocal, Operation operation)` Increments the runaway operation counter and calls the operation.
`ArgumentType[]`	`getArgumentTypes()` Returns the argument types that this operation expects.
`java.lang.String`	`getGrouping()` Gets the grouping name for this operation (for documentation sorting).
`ArgumentType`	`getReturnType()` Returns the return types that this operation return.
`boolean`	`isInternal()` Is this an internal operation type? Internal operations are not exposed to the parser.
`static TAMEOperation`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static TAMEOperation[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - ADDCUE
```
public static final TAMEOperation ADDCUE
```
    Adds a cue to the response. First POP is the value to print. Second POP is the cue name. Returns nothing.
  - ADDOBJECTNAME
```
public static final TAMEOperation ADDOBJECTNAME
```
    Adds an object name to an object. Changes nothing if it has the name already. First POP is name. Second POP is object. Returns nothing.
  - ADDOBJECTTAG
```
public static final TAMEOperation ADDOBJECTTAG
```
    Adds an object tag to an object. Changes nothing if it has the tag already. First POP is tag. Second POP is object. Returns nothing.
  - ADDOBJECTTAGTOALLIN
```
public static final TAMEOperation ADDOBJECTTAGTOALLIN
```
    Adds an object tag to every object in a container-type. First POP is tag name. Second POP is container-type. Returns nothing.
  - ARITHMETICFUNC
```
public static final TAMEOperation ARITHMETICFUNC
```
    [INTERNAL] Arithmetic function. Operand0 is an integer that describes the operation. Pops a varying amount of values off the stack depending on the function. Pushes result.
  - ASBOOLEAN
```
public static final TAMEOperation ASBOOLEAN
```
    Casts a value to boolean. POP is the value to convert. Returns value as boolean.
  - ASFLOAT
```
public static final TAMEOperation ASFLOAT
```
    Casts a value to float. POP is the value to convert. Returns value as float.
  - ASINT
```
public static final TAMEOperation ASINT
```
    Casts a value to integer. POP is the value to convert. Returns value as integer.
  - ASLIST
```
public static final TAMEOperation ASLIST
```
    Casts a value to a list with one element. POP is the value to convert. Returns value as string.
  - ASSTRING
```
public static final TAMEOperation ASSTRING
```
    Casts a value to string. POP is the value to convert. Returns value as string.
  - BREAK
```
public static final TAMEOperation BREAK
```
    [INTERNAL] Throws a BREAK interrupt. Is keyword. Returns nothing.
  - BROWSE
```
public static final TAMEOperation BROWSE
```
    Calls the appropriate "onBrowse" blocks on objects in an object container. POP is object container. Returns nothing.
  - BROWSETAGGED
```
public static final TAMEOperation BROWSETAGGED
```
    Calls the appropriate "onBrowse" blocks on objects in an object container that have the provided tag. First POP is tag name. Second POP is object container. Returns nothing.
  - CALLELEMENTFUNCTION
```
public static final TAMEOperation CALLELEMENTFUNCTION
```
    [INTERNAL] Calls an element function. Operand0 is the element. Operand1 is the function name. Pops a varying amount of values off the stack depending on the function. Pushes result. Returns nothing.
  - CALLFUNCTION
```
public static final TAMEOperation CALLFUNCTION
```
    [INTERNAL] Calls a function. Operand0 is the function name. Pops a varying amount of values off the stack depending on the function. Pushes result. Returns nothing.
  - CEILING
```
public static final TAMEOperation CEILING
```
    Gets the arithmetic ceiling of a number. POP is the number. Returns float.
  - CLAMP
```
public static final TAMEOperation CLAMP
```
    Returns the clamping of a number in an inclusive interval. First POP is the interval end. Second POP is the interval start. Third POP is the value. Returns float.
  - CLEARELEMENTVALUE
```
public static final TAMEOperation CLEARELEMENTVALUE
```
    [INTERNAL] Clears a variable from object member. Operand0 is the element. Operand1 is the variable. Returns nothing.
  - CLEARVALUE
```
public static final TAMEOperation CLEARVALUE
```
    [INTERNAL] Clears a variable from blocklocal or object member. Operand0 is the variable. Returns nothing.
  - CONTINUE
```
public static final TAMEOperation CONTINUE
```
    [INTERNAL] Throws a CONTINUE interrupt. Is keyword. Returns nothing.
  - COS
```
public static final TAMEOperation COS
```
    Returns cosine of a number. Degrees are in radians. POP is the number. Returns float.
  - CURRENTPLAYERIS
```
public static final TAMEOperation CURRENTPLAYERIS
```
    Checks if the current player is the one provided. POP is the player. Returns boolean.
  - CURRENTROOMIS
```
public static final TAMEOperation CURRENTROOMIS
```
    Checks if the current room is the one provided. POP is the room. Returns boolean.
  - E
```
public static final TAMEOperation E
```
    Returns Euler's number in this implementation. POPs nothing. Returns float.
  - ELEMENTHASANCESTOR
```
public static final TAMEOperation ELEMENTHASANCESTOR
```
    Returns true if the first element has the second element in its lineage. First POP is parent to test. Second POP is the source element. Returns nothing.
  - EMPTY
```
public static final TAMEOperation EMPTY
```
    Gets if a a value is "empty." POP is the value. Returns boolean.
  - END
```
public static final TAMEOperation END
```
    [INTERNAL] Throws an END interrupt. Is keyword. Returns nothing.
  - FINISH
```
public static final TAMEOperation FINISH
```
    [INTERNAL] Throws a FINISH interrupt. Is keyword. Returns nothing.
  - FIX
```
public static final TAMEOperation FIX
```
    Fixed rounding: rounds a number to the nearest place after/before the decimal point. POP is the number. Returns float.
  - FLOOR
```
public static final TAMEOperation FLOOR
```
    Gets the arithmetic floor of a number. POP is the number. Returns float.
  - FOR
```
public static final TAMEOperation FOR
```
    [INTERNAL] FOR block. Has an init block called once, a conditional block that is called and then the success block if POP is true, and another block for the next step. Returns nothing.
  - FRANDOM
```
public static final TAMEOperation FRANDOM
```
    Returns a random number from 0.0 (inclusive) to 1.0 (exclusive). POPs nothing. Returns float.
  - FUNCTIONRETURN
```
public static final TAMEOperation FUNCTIONRETURN
```
    [INTERNAL] Return from function. Sets RETURN value on blocklocal from POP and then throws an END interrupt.
  - GIVEOBJECT
```
public static final TAMEOperation GIVEOBJECT
```
    Adds an object to an object container. First POP is object. Second POP is object container element. Returns nothing.
  - GRANDOM
```
public static final TAMEOperation GRANDOM
```
    Returns a Gaussian-distribution random number using a provided mean and standard deviation. First POP is standard deviation. Second POP is the mean. Returns float.
  - HASOBJECT
```
public static final TAMEOperation HASOBJECT
```
    Checks if an object is owned by an object container. First POP is object. Second POP is object container type. Returns boolean.
  - HEADER
```
public static final TAMEOperation HEADER
```
    Pushes the value of a header value of the TAME module. Returns string, always, regardless of how it is defined, and as it as defined without alteration.
  - IDENTITY
```
public static final TAMEOperation IDENTITY
```
    Pushes the identity of an element onto the stack. POP is the element. Returns string.
  - IF
```
public static final TAMEOperation IF
```
    [INTERNAL] If block. Has a conditional block that is called and then the success block if POP is true, or if false and the fail block exists, call the fail block. Returns nothing.
  - IRANDOM
```
public static final TAMEOperation IRANDOM
```
    Returns a random number from 0 to input-1. If input < 0, the result is -IRANDOM(+input) POP is the interval end. Returns integer or float, depending on input.
  - ISREGEX
```
public static final TAMEOperation ISREGEX
```
    Tests if a string is a valid RegEx. POP is the string. Returns boolean.
  - LENGTH
```
public static final TAMEOperation LENGTH
```
    Gets the length of a value. POP is the value. Returns integer.
  - LISTADD
```
public static final TAMEOperation LISTADD
```
    Adds a value to the end of the list. First POP is the value to add. Second POP is the list. Returns boolean.
  - LISTADDAT
```
public static final TAMEOperation LISTADDAT
```
    Adds a value to an index in the list, shifting contents. First POP is the target index. Second POP is the value to add. Third POP is the list. Returns boolean.
  - LISTCONCAT
```
public static final TAMEOperation LISTCONCAT
```
    Concatenates two lists and creates a new list. First POP is the value/list to append. Second POP is the source list. Returns the value removed.
  - LISTCONTAINS
```
public static final TAMEOperation LISTCONTAINS
```
    Searches for the existence of a value in the list, starting from the beginning. First POP is the value to search for. Second POP is the list. Returns boolean.
  - LISTINDEX
```
public static final TAMEOperation LISTINDEX
```
    Gets the index of a value in the list, starting from the beginning. First POP is the value to search for. Second POP is the list. Returns integer.
  - LISTNEW
```
public static final TAMEOperation LISTNEW
```
    Makes a new list with a specific length. POP is the initial capacity. Returns a list.
  - LISTREMOVE
```
public static final TAMEOperation LISTREMOVE
```
    Removes a value from the list, if the value is found in it, shifting contents. First POP is the value to add. Second POP is the list. Returns boolean.
  - LISTREMOVEAT
```
public static final TAMEOperation LISTREMOVEAT
```
    Removes a value from the list by index, shifting contents. First POP is the index. Second POP is the list. Returns the value removed.
  - MAX
```
public static final TAMEOperation MAX
```
    Returns the maximum of two numbers. First POP is the second number. Second POP is the first number. Returns type of "winner."
  - MIN
```
public static final TAMEOperation MIN
```
    Returns the minimum of two numbers. First POP is the second number. Second POP is the first number. Returns type of "winner."
  - MOVEOBJECTSWITHTAG
```
public static final TAMEOperation MOVEOBJECTSWITHTAG
```
    Moves objects with a specific tag from a container and puts them in another. First POP is tag name. Second POP is destination object container. Third POP is source object container. Returns nothing.
  - NOCURRENTPLAYER
```
public static final TAMEOperation NOCURRENTPLAYER
```
    Checks if there is no current player. POPs nothing. Returns boolean.
  - NOCURRENTROOM
```
public static final TAMEOperation NOCURRENTROOM
```
    Checks if there is no current room. POPs nothing. Returns boolean.
  - NOOP
```
public static final TAMEOperation NOOP
```
    Does nothing. Returns nothing.
  - OBJECTCOUNT
```
public static final TAMEOperation OBJECTCOUNT
```
    Counts the objects in a container. POP is object-container type. Returns integer.
  - OBJECTHASNAME
```
public static final TAMEOperation OBJECTHASNAME
```
    Checks if an object has a specific name. First POP is name. Second POP is object. Returns boolean.
  - OBJECTHASNOOWNER
```
public static final TAMEOperation OBJECTHASNOOWNER
```
    Checks if an object has no owner. True if so. POP is object. Returns boolean.
  - OBJECTHASTAG
```
public static final TAMEOperation OBJECTHASTAG
```
    Checks if an object has a specific tag. First POP is tag. Second POP is object. Returns boolean.
  - PAUSE
```
public static final TAMEOperation PAUSE
```
    Adds a PAUSE cue to the response. POP is the value to print. Returns nothing.
  - PI
```
public static final TAMEOperation PI
```
    Returns PI in this implementation. POPs nothing. Returns float.
  - PLAYERCANACCESSOBJECT
```
public static final TAMEOperation PLAYERCANACCESSOBJECT
```
    Checks if a player can access a particular item. First POP is the object. Second POP is the player. Returns boolean.
  - PLAYERHASROOMINSTACK
```
public static final TAMEOperation PLAYERHASROOMINSTACK
```
    Checks if a player has a room in its room stack. Returns true if current room or in the room stack. First POP is the room. Second POP is the player. Returns boolean.
  - POP
```
public static final TAMEOperation POP
```
    [INTERNAL] Pops a value off the stack. Returns nothing.
  - POPELEMENTVALUE
```
public static final TAMEOperation POPELEMENTVALUE
```
    [INTERNAL] Sets a variable on a object. Operand0 is the object. Operand1 is the variable. POP is the value.
  - POPLISTVALUE
```
public static final TAMEOperation POPLISTVALUE
```
    [INTERNAL] Sets an index in a list-valued variable on a object. First POP is the value. Second POP is the index. Third POP is the list.
  - POPLOCALVALUE
```
public static final TAMEOperation POPLOCALVALUE
```
    [INTERNAL] Pops a value into a local variable. Operand0 is the variable. POP is the value.
  - POPROOM
```
public static final TAMEOperation POPROOM
```
    Pops a room off of the room stack (for the current player). POPs nothing. Returns nothing.
  - POPVALUE
```
public static final TAMEOperation POPVALUE
```
    [INTERNAL] Pops a value into a variable in the topmost context in the execution, or the locals if defined. Operand0 is the variable. POP is the value.
  - PUSHELEMENTVALUE
```
public static final TAMEOperation PUSHELEMENTVALUE
```
    [INTERNAL] Resolves value of a variable on an object and pushes the value. Operand0 is the element. Operand1 is the variable. Pushes the resolved value.
  - PUSHINITLIST
```
public static final TAMEOperation PUSHINITLIST
```
    [INTERNAL] Pushes a new list, initialized with values. First POP is length, then POPs [length] values and fills backwards. Pushes a new list.
  - PUSHLISTVALUE
```
public static final TAMEOperation PUSHLISTVALUE
```
    [INTERNAL] Pushes a list-valued variable from the topmost context. First POP is the index. Second POP is the list. Pushes the value. If variable, it is resolved before the push.
  - PUSHNEWLIST
```
public static final TAMEOperation PUSHNEWLIST
```
    [INTERNAL] Pushes a new empty list. Pops nothing. Pushes a new list.
  - PUSHROOM
```
public static final TAMEOperation PUSHROOM
```
    Pushes a room onto the room stack (for the current player). POP is the new room. Returns nothing.
  - PUSHTHIS
```
public static final TAMEOperation PUSHTHIS
```
    [INTERNAL] Pushes the element connected to the current context. Returns nothing.
  - PUSHVALUE
```
public static final TAMEOperation PUSHVALUE
```
    [INTERNAL] Pushes a value or variable from the topmost context. Operand0 is the variable or value. Pushes the value. If variable, it is resolved before the push.
  - QUEUEACTION
```
public static final TAMEOperation QUEUEACTION
```
    [INTERNAL] Enqueues a general action to perform after the current one finishes. POP is the action. Returns nothing.
  - QUEUEACTIONFOROBJECTSIN
```
public static final TAMEOperation QUEUEACTIONFOROBJECTSIN
```
    [INTERNAL] Enqueues a transitive action to perform after the current one finishes for each object. First POP is the object-container. Second POP is the action. Returns nothing.
  - QUEUEACTIONFORTAGGEDOBJECTSIN
```
public static final TAMEOperation QUEUEACTIONFORTAGGEDOBJECTSIN
```
    [INTERNAL] Enqueues a transitive action to perform after the current one finishes for each object. First POP is the tag name. Second POP is the object-container. Third POP is the action. Returns nothing.
  - QUEUEACTIONOBJECT
```
public static final TAMEOperation QUEUEACTIONOBJECT
```
    [INTERNAL] Enqueues a transitive action to perform after the current one finishes. First POP is the object. Second POP is the action. Returns nothing.
  - QUEUEACTIONOBJECT2
```
public static final TAMEOperation QUEUEACTIONOBJECT2
```
    [INTERNAL] Enqueues a ditransitive action to perform after the current one finishes. First POP is the second object. Second POP is the object. Third POP is the action. Returns nothing.
  - QUEUEACTIONSTRING
```
public static final TAMEOperation QUEUEACTIONSTRING
```
    [INTERNAL] Enqueues an open/modal action to perform after the current one finishes. First POP is the modal or open target. Second POP is the action. Returns nothing.
  - QUIT
```
public static final TAMEOperation QUIT
```
    [INTERNAL] Adds a QUIT cue to the response and throws a QUIT interrupt. Is keyword. Returns nothing.
  - REGEXCONTAINS
```
public static final TAMEOperation REGEXCONTAINS
```
    Tests if a string contains a pattern matched by a RegEx. First POP is the string to search. Second POP is the RegEx String. Returns boolean.
  - REGEXFIND
```
public static final TAMEOperation REGEXFIND
```
    Tests if a string contains a pattern matched by a RegEx. First POP is the string to search. Second POP is the RegEx String. Returns integer.
  - REGEXFINDLAST
```
public static final TAMEOperation REGEXFINDLAST
```
    Tests if a string contains the last pattern matched by a RegEx. First POP is the string to search. Second POP is the RegEx String. Returns integer.
  - REGEXGET
```
public static final TAMEOperation REGEXGET
```
    Gets the first matching substring in a string that matches a RegEx. First POP is the string to search. Second POP is the RegEx String. Returns string or boolean.
  - REGEXGETALL
```
public static final TAMEOperation REGEXGETALL
```
    Gets all matching substrings in a string that matches a RegEx. First POP is the string to search. Second POP is the RegEx String. Returns list.
  - REGEXGETLAST
```
public static final TAMEOperation REGEXGETLAST
```
    Gets the last matching substring in a string that matches a RegEx. First POP is the string to search. Second POP is the RegEx String. Returns string or boolean.
  - REGEXMATCHES
```
public static final TAMEOperation REGEXMATCHES
```
    Gets if a whole string matches a RegEx. First POP is the string to search. Second POP is the RegEx String. Returns boolean.
  - REGEXREPLACE
```
public static final TAMEOperation REGEXREPLACE
```
    Replaces each occurrence of a RegEx match with a string expression. First POP is the string to search. Second POP is the replacement. Third POP is the RegEx String. Returns list.
  - REGEXSPLIT
```
public static final TAMEOperation REGEXSPLIT
```
    Splits a string into many via a RegEx. First POP is the string to split. Second POP is the RegEx String. Returns list.
  - REMOVEOBJECT
```
public static final TAMEOperation REMOVEOBJECT
```
    Removes an object from its owner, whatever it is. POP is object. Returns nothing.
  - REMOVEOBJECTNAME
```
public static final TAMEOperation REMOVEOBJECTNAME
```
    Removes an object name from an object. Does nothing if it doesn't have the name. First POP is name. Second POP is object. Returns nothing.
  - REMOVEOBJECTTAG
```
public static final TAMEOperation REMOVEOBJECTTAG
```
    Removes an object tag from an object. Does nothing if it doesn't have the tag. First POP is tag. Second POP is object. Returns nothing.
  - REMOVEOBJECTTAGFROMALLIN
```
public static final TAMEOperation REMOVEOBJECTTAGFROMALLIN
```
    Removes an object tag from every object in a container-type. First POP is tag name. Second POP is container-type. Returns nothing.
  - ROUND
```
public static final TAMEOperation ROUND
```
    Rounds a number to the nearest number. POP is the number. Returns float.
  - SETPLAYER
```
public static final TAMEOperation SETPLAYER
```
    Sets the current player. Calls unfocus on previous player, then focus on next player. POP is the player. Returns nothing.
  - SETROOM
```
public static final TAMEOperation SETROOM
```
    Sets the current room and clears the stack (for the current player). POP is the new room. Returns nothing.
  - SIN
```
public static final TAMEOperation SIN
```
    Returns sine of a number. Degrees are in radians. POP is the number. Returns float.
  - SQRT
```
public static final TAMEOperation SQRT
```
    Gets the square root of a number. POP is the number. Returns float.
  - STRCHAR
```
public static final TAMEOperation STRCHAR
```
    Gets a single character from a string. First POP is the index. Second POP is the string. Returns string or empty string if index is out of range.
  - STRCONCAT
```
public static final TAMEOperation STRCONCAT
```
    Concatenates two strings together. POP is the second value, cast to a string. POP is the first value, cast to a string. Returns integer.
  - STRCONTAINS
```
public static final TAMEOperation STRCONTAINS
```
    Returns if a character sequence exists in a given string. True if so. First POP is what to search for. Second POP is the string. Returns boolean.
  - STRENDSWITH
```
public static final TAMEOperation STRENDSWITH
```
    Gets if a string ends with a particular sequence of characters. True if so. First POP is the sequence to match. Second POP is the string. Returns boolean.
  - STRINDEX
```
public static final TAMEOperation STRINDEX
```
    Returns the index of where a character sequence starts in a string. -1 is not found. First POP is what to search for. Second POP is the string. Returns integer.
  - STRJOIN
```
public static final TAMEOperation STRJOIN
```
    Returns a string that is the result of joining a list of strings together with a string in between each element. First POP is the string to put in between tokens. Second POP is the list of values to treat as strings. Returns a single string.
  - STRLASTINDEX
```
public static final TAMEOperation STRLASTINDEX
```
    Returns the last possible index of where a character sequence starts in a string. -1 is not found. First POP is what to search for. Second POP is the string. Returns integer.
  - STRLOWER
```
public static final TAMEOperation STRLOWER
```
    Gets a string converted to lowercase. POP is the string. Returns string.
  - STRPARAM
```
public static final TAMEOperation STRPARAM
```
    Replaces parts of a string with "{X}" with objects in a list. X is a list index. The second parameter is treated as a one-entry list if it isn't a list. First POP is the list. Second POP is the string. Returns string.
  - STRREPLACE
```
public static final TAMEOperation STRREPLACE
```
    Replaces the first occurrence of a string with another. First POP is the string to replace with. Second POP is the replacement sequence. Third POP is the string to do replacing in. Returns string.
  - STRREPLACEALL
```
public static final TAMEOperation STRREPLACEALL
```
    Replaces every occurrence of a string with another. First POP is the string to replace with. Second POP is the replacement sequence. Third POP is the string to do replacing in. Returns string.
  - STRREPLACELAST
```
public static final TAMEOperation STRREPLACELAST
```
    Replaces the last occurrence of a string with another. First POP is the string to replace with. Second POP is the replacement sequence. Third POP is the string to do replacing in. Returns string.
  - STRSPLIT
```
public static final TAMEOperation STRSPLIT
```
    Returns a string split into a list of strings using a string for matching the delimitation. First POP is the regular expression. Second POP is the string. Returns a list.
  - STRSTARTSWITH
```
public static final TAMEOperation STRSTARTSWITH
```
    Gets if a string starts with a particular sequence of characters. True if so. First POP is the sequence to match. Second POP is the string. Returns boolean.
  - STRTRIM
```
public static final TAMEOperation STRTRIM
```
    Gets a string trimmed of whitespace at both ends. POP is the string. Returns string.
  - STRUPPER
```
public static final TAMEOperation STRUPPER
```
    Gets a string converted to uppercase. POP is the string. Returns string.
  - SUBSTRING
```
public static final TAMEOperation SUBSTRING
```
    Gets a substring from a larger one. First POP is the ending index, exclusive. Second POP is the starting index, inclusive. Third POP is the string to divide. Returns string.
  - SWAPROOM
```
public static final TAMEOperation SWAPROOM
```
    Pops a room off of the room stack and pushes a new one (for the current player). POP is the new room. Returns nothing.
  - TAN
```
public static final TAMEOperation TAN
```
    Returns tangent of a number. Degrees are in radians. POP is the number. Returns float.
  - TEXT
```
public static final TAMEOperation TEXT
```
    Adds a TEXT cue to the response. POP is the value to print. Returns nothing.
  - TEXTF
```
public static final TAMEOperation TEXTF
```
    Adds a TEXTF cue to the response. POP is the value to print. Returns nothing.
  - TEXTFLN
```
public static final TAMEOperation TEXTFLN
```
    Adds a TEXTF cue to the response with a newline appended to it. POP is the value to print. Returns nothing.
  - TEXTLN
```
public static final TAMEOperation TEXTLN
```
    Adds a TEXT cue to the response with a newline appended to it. POP is the value to print. Returns nothing.
  - TIME
```
public static final TAMEOperation TIME
```
    Returns the current UTC time in milliseconds since the epoch. POPs nothing. Returns integer.
  - TIMEFORMAT
```
public static final TAMEOperation TIMEFORMAT
```
    Formats a date/time as a string. Assumes inputs are integers and millisecond time. First POP is formatting string. Second POP is date value. Returns string.
  - WAIT
```
public static final TAMEOperation WAIT
```
    Adds a WAIT cue to the response. POP is the amount to wait for (read as integer). Returns nothing.
  - WHILE
```
public static final TAMEOperation WHILE
```
    [INTERNAL] WHILE block. Has a conditional block that is called and then the success block if POP is true. Returns nothing.
- Field Detail
  - VALUES
```
public static final TAMEOperation[] VALUES
```
    Array to get around multiple allocations.
- Method Detail
  - values
```
public static TAMEOperation[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (TAMEOperation c : TAMEOperation.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static TAMEOperation valueOf(java.lang.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:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - isInternal
```
public boolean isInternal()
```
    Description copied from interface: OperationType
    
    Is this an internal operation type? Internal operations are not exposed to the parser.
    
    Specified by:
    
    isInternal in interface OperationType
    
    Returns:
    
    true if so, false if not.
  - getReturnType
```
public ArgumentType getReturnType()
```
    Description copied from interface: OperationType
    
    Returns the return types that this operation return.
    
    Specified by:
    
    getReturnType in interface OperationType
    
    Returns:
    
    the return type, or null for no return.
  - getArgumentTypes
```
public ArgumentType[] getArgumentTypes()
```
    Description copied from interface: OperationType
    
    Returns the argument types that this operation expects.
    
    Specified by:
    
    getArgumentTypes in interface OperationType
    
    Returns:
    
    the argument types.
  - doOperation
```
protected void doOperation(TAMERequest request,
                           TAMEResponse response,
                           ValueSet blockLocal,
                           Operation operation)
                    throws TAMEInterrupt
```
    Performs the operation.
    
    Parameters:
    
    request - the TAMERequest context.
    
    response - the TAMEResponse object.
    
    blockLocal - the local variables on the block call.
    
    operation - the operation origin.
    
    Throws:
    
    TAMEInterrupt - if an interrupt occurs.
  - getGrouping
```
public java.lang.String getGrouping()
```
    Gets the grouping name for this operation (for documentation sorting).
    
    Returns:
    
    the grouping name.
  - execute
```
public final void execute(TAMERequest request,
                          TAMEResponse response,
                          ValueSet blockLocal,
                          Operation operation)
                   throws TAMEInterrupt
```
    Increments the runaway operation counter and calls the operation.
    
    Specified by:
    
    execute in interface OperationType
    
    Parameters:
    
    request - the request object.
    
    response - the response object.
    
    blockLocal - the local variables on the block call.
    
    operation - the operation object.
    
    Throws:
    
    TAMEInterrupt - if an interrupt occurs.

Enum TAMEOperation

Enum Constant Summary

Field Summary

Fields inherited from interface com.tameif.tame.TAMEConstants

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ADDCUE

ADDOBJECTNAME

ADDOBJECTTAG

ADDOBJECTTAGTOALLIN

ARITHMETICFUNC

ASBOOLEAN

ASFLOAT

ASINT

ASLIST

ASSTRING

BREAK

BROWSE

BROWSETAGGED

CALLELEMENTFUNCTION

CALLFUNCTION

CEILING

CLAMP

CLEARELEMENTVALUE

CLEARVALUE

CONTINUE

COS

CURRENTPLAYERIS

CURRENTROOMIS

E

ELEMENTHASANCESTOR

EMPTY

END

FINISH

FIX

FLOOR

FOR

FRANDOM

FUNCTIONRETURN

GIVEOBJECT

GRANDOM

HASOBJECT

HEADER

IDENTITY

IF

IRANDOM

ISREGEX

LENGTH

LISTADD

LISTADDAT

LISTCONCAT

LISTCONTAINS

LISTINDEX

LISTNEW

LISTREMOVE

LISTREMOVEAT

MAX

MIN

MOVEOBJECTSWITHTAG

NOCURRENTPLAYER

NOCURRENTROOM

NOOP

OBJECTCOUNT

OBJECTHASNAME

OBJECTHASNOOWNER

OBJECTHASTAG

PAUSE

PI

PLAYERCANACCESSOBJECT

PLAYERHASROOMINSTACK

POP

POPELEMENTVALUE

POPLISTVALUE

POPLOCALVALUE

POPROOM

POPVALUE

PUSHELEMENTVALUE

PUSHINITLIST