API - MethodScript

You are viewing an older version of the site. Click here to view the latest version of this page. (This may be a dead link, if so, try the root page of the docs here.)

ArrayHandling
BasicLogic
BossBar
BukkitMetadata
ByteArrays
Clipboard
Cmdline
Commands
Compiler
ControlFlow
Crypto
DataHandling
DataTransformations
Debug
Easings
Echoes
Enchantments
EntityManagement
Environment
EventBinding
Exceptions
ExecutionQueue
ExtensionMeta
FileHandling
InventoryManagement
ItemMeta
Marquee
Math
MatrixHandling
Meta
Minecraft
MobManagement
OAuth
OS
ObjectManagement
Performance
Permissions
Persistence
PlayerManagement
PluginMeta
Recipes
Reflection
Regex
ResourceManager
SQL
Sandbox
Scheduling
Scoreboards
Statistics
StringHandling
TaskHandling
Threading
Trades
Weather
Web
World
XGUI

== ArrayHandling ==

This class contains functions that provide a way to manipulate arrays. To create an array, use the array function. For more detailed information on array usage, see the page on [[Arrays|arrays]]

array1, array2, comparisonClosure | {{object|CastException}}
{{object|IllegalArgumentException}} | Returns an array that is the intersection of the two provided arrays. If either array is associative, it puts the function in associative mode. For normal arrays, the values are compared, and for associative arrays, the keys are compared, but the values are taken from the left array. comparisonMode is only applicable for normal arrays, and defaults to HASH, but determines the mode in which the system decides if two values are equal or not. A closure may be sent instead, which should return true if the two values are considered equals or not. Using the HASH mode is fastest, as this puts the function in an optimizing mode, and it can run at O(n log n). Otherwise, the runtime is O(n**2). The results between HASH and STRICT_EQUALS should almost never be different, and so in that case using STRICT_EQUALS has a lower performance for no gain, but there may be some cases where using the hash code is not desirable. EQUALS is necessary if you wish to disregard typing, so that array(1, 2, 3) and array('1', '2', '3') are considered equal. Duplicate values in the left array are duplicated, but duplicates in the right are not.
([[API/functions/array_intersect#Examples|Examples...]]) | No |- | [[API/functions/array_iterate|array_iterate]]() | array | array, closure | {{object|CastException}} | Iterates across an array, calling the closure for each value of the array. The closure should accept two arguments, the key and the value. This method can be used in some code to increase readability, to increase re-usability, or keep variables created in a loop in an isolated scope. Note that this runs at approximately the same speed as a for loop, which is probably slower than a foreach loop. Any values returned from the closure are silently ignored. Returns a reference to the original array.
([[API/functions/array_iterate#Examples|Examples...]]) | No |- | [[API/functions/array_keys|array_keys]]() | array | array | {{object|CastException}} | Returns the keys in this array as a normal array. If the array passed in is already a normal array, the keys will be 0 -> (array_size(array) - 1)
([[API/functions/array_keys#Examples|Examples...]]) | No |- | [[API/functions/array_last_index|array_last_index]]() | mixed | array, value | {{object|CastException}} | Finds the index in the array where value occurs last. If the value is not found, returns null. That is to say, if the value is contained in an array (even multiple times) the index of the last element is returned.
([[API/functions/array_last_index#Examples|Examples...]]) | No |- | [[API/functions/array_map|array_map]]() | array | array, closure | {{object|CastException}}
{{object|IllegalArgumentException}} | Calls the closure on each element of an array, and returns an array that contains the results.
([[API/functions/array_map#Examples|Examples...]]) | No |- | [[API/functions/array_merge|array_merge]]() | array | array1, array2, [arrayN...] | {{object|InsufficientArgumentsException}}
{{object|CastException}} | Merges the specified arrays from left to right, and returns a new array. If the array merged is associative, it will overwrite the keys from left to right, but if the arrays are normal, the keys are ignored, and values are simply pushed.
([[API/functions/array_merge#Examples|Examples...]]) | No |- | [[API/functions/array_normalize|array_normalize]]() | array | array | {{object|CastException}} | Returns a new normal array, given an associative array. (If the array passed in is not associative, a copy of the array is returned).
([[API/functions/array_normalize#Examples|Examples...]]) | No |- | [[API/functions/array_push|array_push]]() | void | array, value, [value2...] | {{object|CastException}} | Pushes the specified value(s) onto the end of the array. Unlike calling array_set(@array, array_size(@array), @value) on a normal array, the size of the array is increased first. The special operator syntax @array[] = 'value' is also supported, as shorthand for array_push().
([[API/functions/array_push#Examples|Examples...]]) | No |- | [[API/functions/array_push_all|array_push_all]]() | void | array, values | {{object|CastException}} | Pushes all the values of an array individually. If you try to push an array onto array_push, this will give you a two dimensional array, this method pushes the sub values of the values array into the destination array. | No |- | [[API/functions/array_rand|array_rand]]() | array | array, [number, [getKeys]] | {{object|RangeException}}
{{object|CastException}} | Returns a random selection of keys or values from an array. The array may be either normal or associative. Number defaults to 1, and getKey defaults to true. If number is greater than the size of the array, a RangeException is thrown. No value will be returned twice from the array however, one it is "drawn" from the array, it is not placed back in. The order of the elements in the array will also be random, if order is important, use array_sort().
([[API/functions/array_rand#Examples|Examples...]]) | No |- | [[API/functions/array_reduce|array_reduce]]() | mixed | array, closure | {{object|CastException}}
{{object|IllegalArgumentException}} | Reduces an array to a single value. This is useful for, for instance, summing the values of an array. The previously calculated value, then the next value of the array are sent to the closure, which is expected to return a value, based on the two values, which will be sent again to the closure as the new calculated value. If the array is empty, null is returned, and if the array has exactly one value in it, only that value is returned. Associative arrays are supported, but the order is based on the key order, which may not be as expected. The keys of the array are ignored.
([[API/functions/array_reduce#Examples|Examples...]]) | No |- | [[API/functions/array_reduce_right|array_reduce_right]]() | mixed | array, closure | {{object|CastException}}
{{object|IllegalArgumentException}} | Reduces an array to a single value. This works in reverse of array_reduce(). This is useful for, for instance, summing the values of an array. The previously calculated value, then the previous value of the array are sent to the closure, which is expected to return a value, based on the two values, which will be sent again to the closure as the new calculated value. If the array is empty, null is returned, and if the array has exactly one value in it, only that value is returned. Associative arrays are supported, but the order is based on the key order, which may not be as expected. The keys of the array are ignored.
([[API/functions/array_reduce_right#Examples|Examples...]]) | No |- | [[API/functions/array_remove|array_remove]]() | mixed | array, index | {{object|RangeException}}
{{object|CastException}}
{{object|PluginInternalException}} | Removes an index from an array. If the array is a normal array, all values' indices are shifted left one. If the array is associative, the index is simply removed. If the index exists, the value removed is returned. If the index doesn't exist, the array remains unchanged, however it'll throw a RangeException for normal arrays (returns null for associative arrays).
([[API/functions/array_remove#Examples|Examples...]]) | No |- | [[API/functions/array_remove_values|array_remove_values]]() | void | array, value | {{object|CastException}} | Removes all instances of value from the specified array. For instance, array_remove_values(array(1, 2, 2, 3), 2) would produce the array(1, 3). Note that it returns void however, so it will simply in place modify the array passed in, much like array_remove.
([[API/functions/array_remove_values#Examples|Examples...]]) | No |- | [[API/functions/array_resize|array_resize]]() | array | array, size, [fill] | {{object|CastException}} | Resizes the given array so that it is at least of size size, filling the blank spaces with fill, or null by default. If the size of the array is already at least size, nothing happens; in other words this function can only be used to increase the size of the array. A reference to the array is returned, for easy chaining.
([[API/functions/array_resize#Examples|Examples...]]) | No |- | [[API/functions/array_reverse|array_reverse]]() | array | array | {{object|CastException}} | Reverses an array in place. However, if the array is associative, throws a CastException, since associative arrays are more like a map. Returns the array for easy chaining.
([[API/functions/array_reverse#Examples|Examples...]]) | No |- | [[API/functions/array_scontains|array_scontains]]() | boolean | array, testValue | {{object|CastException}} | Checks if the array contains a value of the same datatype and value as testValue. For associative arrays, only the values are searched, the keys are ignored. If you need to check for the existence of a particular key, use array_index_exists().
([[API/functions/array_scontains#Examples|Examples...]]) | No |- | [[API/functions/array_set|array_set]]() | mixed | array, index, value | {{object|CastException}}
{{object|IndexOverflowException}} | Sets the value of the array at the specified index. The value that was set is returned, to allow for chaining.
([[API/functions/array_set#Examples|Examples...]]) | No |- | [[API/functions/array_shallow_clone|array_shallow_clone]]() | array | array | {{object|CastException}}
{{object|InsufficientArgumentsException}} | Performs a shallow clone on an array (as opposed to a deep clone). See the examples for more info.
([[API/functions/array_shallow_clone#Examples|Examples...]]) | No |- | [[API/functions/array_size|array_size]]() | int | array | {{object|CastException}} | Returns the size of this array as an integer.
([[API/functions/array_size#Examples|Examples...]]) | No |- | [[API/functions/array_some|array_some]]() | boolean | array, closure | {{object|CastException}} | Returns true if any value in the array meets some test, which the closure should return true or false about. Not all values will necessarily be checked, once a value is determined to pass the check, execution is stopped, and true is returned. The closure will be passed each value in the array, one at a time, and must return a boolean.
([[API/functions/array_some#Examples|Examples...]]) | No |- | [[API/functions/array_sort|array_sort]]() | array | array, [sortType] | {{object|CastException}}
{{object|FormatException}} | Sorts an array in place, and also returns a reference to the array. [[API/functions/array_sort|See more...]]

([[API/functions/array_sort#Examples|Examples...]]) | No |- | [[API/functions/array_sort_async|array_sort_async]]() | void | array, [sortType], closure(array) | {{object|CastException}} | Works like array_sort, but does the sort on another thread, then calls the closure and sends it the sorted array. This is useful if the array is large enough to actually "stall" the server when doing the sort. Sort type should be one of REGULAR, NUMERIC, STRING or STRING_IC | No |- | [[API/functions/array_subset_of|array_subset_of]]() | boolean | array, array | {{object|IllegalArgumentException}} | Returns true if first array is a subset of second array.
([[API/functions/array_subset_of#Examples|Examples...]]) | No |- | [[API/functions/array_subtract|array_subtract]]() | array | array1, array2, [comparisonMode] | {{object|CastException}}
{{object|IllegalArgumentException}} | Returns a new array, which contains all the values in the left array, which are not present in the right array. comparisonMode defaults to HASH, but may also be EQUALS or STRICT_EQUALS. A closure may be sent instead, which should return true if the two values are considered equals or not. [[API/functions/array_subtract|See more...]]
| No |- | [[API/functions/array_unique|array_unique]]() | array | array, [compareTypes] | {{object|CastException}} | Removes all non-unique values from an array. [[API/functions/array_unique|See more...]]

([[API/functions/array_unique#Examples|Examples...]]) | No |- | [[API/functions/cslice|cslice]]() | slice | from, to | {{object|CastException}} | Dynamically creates an array slice, which can be used with array_get (or the [bracket notation]) to get a range of elements. cslice(0, 5) is equivalent to 0..5 directly in code, however with this function you can also do cslice(@var, @var), or other more complex expressions, which are not possible in static code.
([[API/functions/cslice#Examples|Examples...]]) | No |- | [[API/functions/map_implode|map_implode]]() | string | associativeArray, innerGlue, outerGlue | {{object|CastException}} | Implodes an associative array. The innerGlue is used to glue the key to the value, and then the outerGlue is used to glue those elements together. This only works with associative arrays, and will throw CastException if the array passed in isa normal array.
([[API/functions/map_implode#Examples|Examples...]]) | No |- | [[API/functions/range|range]]() | array | start, finish, [increment]

finish | {{object|CastException}} | Returns an array of numbers from start to (finish - 1) skipping increment integers per count. start defaults to 0, and increment defaults to 1. All inputs must be integers. If the input doesn't make sense, it will reasonably degrade, and return an empty array.
([[API/functions/range#Examples|Examples...]]) | No |}

== BasicLogic ==

These functions provide basic logical operations.

number d1, double d2, double epsilon | {{object|CastException}} | When comparing the equality of floating point numbers, it is often impossible to directly compare via == (equals) since two floating point numbers that might be actually semantically equivalent, are represented slightly differently in the computer, thus making them not actually equal, even though they are effectively equal. This function provides an epsilon argument to verify if two numbers are within that degree of difference. A good rule of thumb is to use 5-6 places of precision, but depending on your program's needs, more or less might be required.
([[API/functions/equals_epsilon#Examples|Examples...]]) | No |- | [[API/functions/equals_ic|equals_ic]]() | boolean | val1, val2[, valX...] | {{object|InsufficientArgumentsException}} | Returns true if all the values are equal to each other, while ignoring case.
([[API/functions/equals_ic#Examples|Examples...]]) | No |- | [[API/functions/gt|gt]]() | boolean | var1, var2 | {{object|CastException}} | Returns the result of a greater than operation. Operator syntax is also supported: @a > @b
([[API/functions/gt#Examples|Examples...]]) | No |- | [[API/functions/gte|gte]]() | boolean | var1, var2 | {{object|CastException}} | Returns the result of a greater than or equal to operation. Operator sytnax is also supported: @a >= @b
([[API/functions/gte#Examples|Examples...]]) | No |- | [[API/functions/hash|hash]]() | int | value | | Hashes the value, and returns an int representing that value.
([[API/functions/hash#Examples|Examples...]]) | No |- | [[API/functions/lshift|lshift]]() | int | value, bitsToShift | {{object|CastException}} | Left shifts the value bitsToShift times
([[API/functions/lshift#Examples|Examples...]]) | No |- | [[API/functions/lt|lt]]() | boolean | var1, var2 | {{object|CastException}} | Returns the results of a less than operation. Operator syntax is also supported: @a < @b
([[API/functions/lt#Examples|Examples...]]) | No |- | [[API/functions/lte|lte]]() | boolean | var1, var2 | {{object|CastException}} | Returns the result of a less than or equal to operation. Operator syntax is also supported: @a <= @b
([[API/functions/lte#Examples|Examples...]]) | No |- | [[API/functions/nand|nand]]() | boolean | val1, [val2...] | {{object|CastException}} | Return the equivalent of not(and())
([[API/functions/nand#Examples|Examples...]]) | No |- | [[API/functions/nequals|nequals]]() | boolean | val1, val2 | | Returns true if the two values are NOT equal, or false otherwise. Equivalent to not(equals(val1, val2)). Operator syntax is also supported: @a != @b
([[API/functions/nequals#Examples|Examples...]]) | No |- | [[API/functions/nequals_ic|nequals_ic]]() | boolean | val1, val2 | | Returns true if the two values are NOT equal to each other, while ignoring case.
([[API/functions/nequals_ic#Examples|Examples...]]) | No |- | [[API/functions/nor|nor]]() | boolean | val1, [val2...] | {{object|CastException}} | Returns the equivalent of not(or())
([[API/functions/nor#Examples|Examples...]]) | No |- | [[API/functions/not|not]]() | boolean | var1 | {{object|CastException}} | Returns the boolean value of a logical NOT for this argument. Operator syntax is also supported: !@var
([[API/functions/not#Examples|Examples...]]) | No |- | [[API/functions/or|or]]() | boolean | var1, [var2...] | {{object|CastException}} | Returns the boolean value of a logical OR across all arguments. Uses lazy determination, so once an argument resolves to true, the function returns. Operator syntax is also supported: @a || @b
([[API/functions/or#Examples|Examples...]]) | No |- | [[API/functions/ref_equals|ref_equals]]() | boolean | val1, val2 | | Returns true if and only if the two values are actually the same reference. Primitives that are equal will always be the same reference, this method is only useful for object/array comparisons.
([[API/functions/ref_equals#Examples|Examples...]]) | No |- | [[API/functions/rshift|rshift]]() | int | value, bitsToShift | {{object|CastException}} | Right shifts the value bitsToShift times
([[API/functions/rshift#Examples|Examples...]]) | No |- | [[API/functions/sequals|sequals]]() | boolean | val1, val2 | | Uses a strict equals check, which determines if two values are not only equal, but also the same type. So, while equals('1', 1) returns true, sequals('1', 1) returns false, because the first one is a string, and the second one is an int. More often than not, you want to use plain equals(). In addition, type juggling is explicitly not performed on strings. Thus '2' !== '2.0', despite those being ==. Operator syntax is also supported: @a === @b
([[API/functions/sequals#Examples|Examples...]]) | No |- | [[API/functions/sequals_ic|sequals_ic]]() | boolean | value1, value2 | | Returns true if the values are the same type, as well as equal, according to equals_ic. Generally, equals_ic will suffice, because usually you will be comparing two strings, however, this function may be useful in various other cases, perhaps where the datatypes are unknown, but could be strings.
([[API/functions/sequals_ic#Examples|Examples...]]) | No |- | [[API/functions/snequals|snequals]]() | boolean | val1, val2 | | Equivalent to not(sequals(val1, val2)). Operator syntax is also supported: @a !== @b
([[API/functions/snequals#Examples|Examples...]]) | No |- | [[API/functions/urshift|urshift]]() | int | value, bitsToShift | {{object|CastException}} | Right shifts value bitsToShift times, pushing a 0, making this an unsigned right shift.
([[API/functions/urshift#Examples|Examples...]]) | No |- | [[API/functions/xnor|xnor]]() | boolean | val1, val2 | {{object|CastException}} | Returns the xnor of the two values
([[API/functions/xnor#Examples|Examples...]]) | No |- | [[API/functions/xor|xor]]() | boolean | val1, val2 | {{object|CastException}} | Returns the xor of the two values.
([[API/functions/xor#Examples|Examples...]]) | No |}

== BossBar ==

Functions to create and manage boss bars in Minecraft.

id, percent

id, title | {{object|IllegalArgumentException}}
{{object|CastException}}
{{object|FormatException}}
{{object|NotFoundException}}
{{object|RangeException}} | Updates the state for the specified boss bar. See create_bar() for available option keys and values for the optionsArray. If the second argument is a string, it'll use it to update the title. If it's a double, it'll use it to update the percentage filled (0.0 - 1.0). | Yes |}

== BukkitMetadata ==

This class allows manipulation of bukkit metadata.

object, key, [plugin] | {{object|BadEntityException}}
{{object|CastException}}
{{object|FormatException}}
{{object|InvalidPluginException}}
{{object|LengthException}}
{{object|InvalidWorldException}}
{{object|PlayerOfflineException}} | Returns the metadata values attached to the given object. object can be a location array (it will designate a block), an entityID (it will designate an entity) or a string (it will designate a world). If only the key is given, the object is the current player. The function returns an associative array where the values are keyed by plugin which have registered the metadata with the given key, and the array values the registered metadata values. If the plugin argument is given (a string that represent the plugin name), the function simply returns the value of the metadata registered by the plugin with this key, or null if no metadata is found. --- The Bukkit metadata allow to attach information to entities, blocks and worlds, and allow plugins to exchange these information between them without requiring one to be dependant on each other. The metadata are persistent across server reloads, but not across server restarts. The metadata attached to a player are also persistent between logins.
([[API/functions/get_metadata#Examples|Examples...]]) | Yes |- | [[API/functions/has_metadata|has_metadata]]() | boolean | [object], key

object, key, value, [plugin] | {{object|BadEntityException}}
{{object|CastException}}
{{object|FormatException}}
{{object|InvalidPluginException}}
{{object|LengthException}}
{{object|InvalidWorldException}}
{{object|PlayerOfflineException}} | Registers a metadata value in the given object with the given key. object can be a location array (it will designate a block), an entityID (it will designate an entity) or a string (it will designate a world). If only the key and the value are given, the object is the current player. You can specify the plugin that will own the metadata, 'MethodScript' by default. See get_metadata() for more information about Bukkit metadata. | Yes |}

== ByteArrays ==

This class contains all the methods needed to manipulate a byte array primitive. Since byte arrays would be very inefficient to implement using a normal array, this data type allows for more efficient operations, while still allowing for low level data access. Most data transferred within scripts is higher level, and does not require access to a byte array, however, code that interacts with external processes may require use of these functions to properly manipulate the data. Note that all the methods deal with low level types, so the following definitions apply: a byte is 8 bits, a short is 16 bits, an int is 32 bits, a long is 64 bits. UTF-8 strings are supported directly. The byte array is automatically resized as needed.

== Clipboard ==

Provides functions for managing the system clipboard

== Cmdline ==

This class contains functions that are mostly only useful for command line scripts, but in general may be used by any script. For more information on running MethodScript from the command line, see [[Command_Line_Scripting|this wiki page]].

{| class="sticky" |- ! scope="col" width="8%" | Function Name ! scope="col" width="4%" | Returns ! scope="col" width="16%" | Arguments ! scope="col" width="8%" | Throws ! scope="col" width="62%" | Description ! scope="col" width="2%" | Res |- | [[API/functions/cd|cd]]() | void | [dir] | {{object|IOException}}
{{object|InsufficientPermissionException}} | Changes the current working directory to the path specified, or the user's home directory if omitted. This only works from cmdline mode. | Yes |- | [[API/functions/clear_screen|clear_screen]]() | void | | | Clears the screen. This only works from cmdline mode, nothing happens otherwise. | Yes |- | [[API/functions/exit|exit]]() | void | [int] | | Exits the program. If this is being run from the command line, works by exiting the interpreter, with the specified exit code (defaulting to 0). If this is being run from in-game, works just like die().
([[API/functions/exit#Examples|Examples...]]) | No |- | [[API/functions/get_env|get_env]]() | mixed | [variableName] | | Returns the environment variable specified, if variableName is set. Otherwise, returns an associative array of all the environment variables. | Yes |- | [[API/functions/get_os|get_os]]() | string | | | Returns the name of the current OS. Will be one of WINDOWS, MAC, LINUX, SOLARIS, or UNKNOWN. | Yes |- | [[API/functions/get_terminal_width|get_terminal_width]]() | int | | {{object|InsufficientPermissionException}} | Returns the current width of the terminal, measured in characters. This is useful for determining proper layout for dynamic output. This only works in cmdline mode. | Yes |- | [[API/functions/in_cmdline_mode|in_cmdline_mode]]() | boolean | | | Returns true if the environment is in cmdline mode. False otherwise. | No |- | [[API/functions/ls|ls]]() | array | [directory] | {{object|InsufficientPermissionException}}
{{object|IOException}} | Returns an array of files in the current working directory, including "hidden" files, orif directory is specified, the files in that directory. This is only available in cmdline mode. | Yes |- | [[API/functions/print_err|print_err]]() | void | text | | Writes the text to the system's std err, but does not automatically add a newline at the end. Unlike console(), this does not use anything else to format the output, though in many cases they will behave the same. Unlike other print methods, colors and other formatting characters WILL "bleed" through, so print_err(color(RED) . 'This is red') will also cause the next line to also be red, so if you need to print multiple lines out, you should manually reset the color with print_out(color(RESET)), or use sys_err. | Yes |- | [[API/functions/print_out|print_out]]() | void | text | | Writes the text to the system's std out, but does not automatically add a newline at the end. Unlike console(), this does not use anything else to format the output, though in many cases they will behave the same. Unlike other print methods, colors and other formatting characters WILL "bleed" through, so print_out(color(RED) . 'This is red') will also cause the next line to also be red, so if you need to print multiple lines out, you should manually reset the color with print_out(color(RESET)), or use sys_out.. | Yes |- | [[API/functions/prompt_char|prompt_char]]() | string | prompt | {{object|InsufficientPermissionException}}
{{object|IOException}} | Prompts the user for a single character. They do not need to hit enter first. This only works in cmdline mode. | Yes |- | [[API/functions/prompt_line|prompt_line]]() | string | prompt | {{object|InsufficientPermissionException}}
{{object|IOException}} | Prompts the user for a line. The line typed is returned once the user presses enter. This only works in cmdline mode. | Yes |- | [[API/functions/prompt_pass|prompt_pass]]() | secure_string | prompt, [mask] | {{object|InsufficientPermissionException}}
{{object|IOException}} | Prompts the user for a password. This only works in cmdline mode. If mask is true (default), then the password displays * characters for each password character they type. If mask is false, the field stays blank as they type. What they type is returned once they hit enter. The value returned is a secure_string, so to get the actual password, you must use decrypt_secure_string.
([[API/functions/prompt_pass#Examples|Examples...]]) | Yes |- | [[API/functions/pwd|pwd]]() | string | | {{object|ShellException}} | Returns the path to the current working directory. This is available outside cmdline mode, but is probably only useful for debugging, meta, or informational purposes when not in cmdline interpreter mode, as the current working directory is known simply by knowing what file this is running from. When run from a context where there is no working directory, a ShellException is thrown. | Yes |- | [[API/functions/read_pipe_input|read_pipe_input]]() | mixed | [binary] | {{object|IOException}}
{{object|InsufficientPermissionException}} | Reads the input from a process that is piped to this script. It is assumed that the data piped to the script will come all at once, and it will be returned as a string (or byte_array if binary is true). This can only be used in cmdline mode, and binary defaults to false. If the script isn't started in TTY mode, an IOException is thrown. | Yes |- | [[API/functions/set_cmdline_prompt|set_cmdline_prompt]]() | void | closure | {{object|CastException}}
{{object|InsufficientPermissionException}} | Sets the cmdline prompt. This is only usable or useful in cmdline interpreter mode. The closure should return a string, that string will be used as the prompt. The closure is called each time a prompt needs generating, thereby allowing for dynamic prompts. A boolean is sent to the closure, if true, the shell is in shellMode, meaning the command is interpreted as a shell command. If false, it is in normal mscript mode. | Yes |- | [[API/functions/set_env|set_env]]() | void | variableName, value | | Sets the value of an environment variable. This only changes the environment value in this process, not system-wide. This uses some hackery to work, and may not be 100% reliable in all cases, and shouldn't be relied on heavily. It will always work with get_env, however, so you can rely on that mechanism. The value will always be interpreted as a string, so if you are expecting a particular data type on a call to get_env, you will need to manually cast the variable. Arrays will be toString'd as well, but will be accepted. | Yes |- | [[API/functions/shell|shell]]() | string | command, [options] | {{object|InsufficientPermissionException}}
{{object|ShellException}}
{{object|IOException}}
{{object|IllegalArgumentException}} | Runs a shell command. <code>command</code> can be either a string, or array of string arguments. This works mostly like {{function|shell_adv}} however, it buffers then returns the output for sysout once the process is completed, and throws a ShellException with the exception message set to the syserr output if the process exits with an exit code that isn't the expectedExitCode, which defaults to 0. This is useful for simple commands that return output and don't need very complicated usage, and failures don't need to check the exact error code. If the underlying command throws an IOException, it is passed through. Requires the allow-shell-commands option to be enabled in preferences, or run from command line, otherwise an InsufficientPermissionException is thrown. When the passed command results in an empty shell command, an IllegalArgumentException is thrown. Options is an associative array which expects zero or more of the following options: expectedErrorCode - The expected error code indicating successful command completion. Defaults to 0. workingDir - Sets the working directory for the sub process. By default null, which represents the directory of this script. If the path is relative, it is relative to the directory of this script.
([[API/functions/shell#Examples|Examples...]]) | Yes |- | [[API/functions/shell_adv|shell_adv]]() | void | command, [options] | {{object|InsufficientPermissionException}}
{{object|IOException}}
{{object|IllegalArgumentException}} | Runs a shell command. <code>command</code> can either be a string or an array of string arguments, which are run as an external process. Requires the allow-shell-commands option to be enabled in preferences, or run from command line, otherwise an InsufficientPermissionException is thrown.When the passed command results in an empty shell command, an IllegalArgumentException is thrown. [[API/functions/shell_adv|See more...]]
| Yes |- | [[API/functions/shell_on|shell_on]]() | string | os, command, [options] | {{object|InsufficientPermissionException}}
{{object|ShellException}}
{{object|IOException}}
{{object|FormatException}} | Executes the command if and only if on the given operating system (one of WINDOWS, MAC, LINUX, SOLARIS, or UNKNOWN). If not on the specified OS, this command returns null. The os argument may be a pipe seperated list of OSes, for instance 'MAC|LINUX', which is useful given that both are unix based, and often times the same command will work for both. Otherwise completely equivalent to {{function|shell}}. This is useful, because usually a command is tailored to a specific OS, and simply won't run on other OSes. This allows you to create similar commands across various OSes, and ensure that they only run for the correct OS.
([[API/functions/shell_on#Examples|Examples...]]) | Yes |- | [[API/functions/shell_on_adv|shell_on_adv]]() | void | os, command, [options] | {{object|InsufficientPermissionException}}
{{object|ShellException}}
{{object|IOException}}
{{object|FormatException}} | Executes the command if and only if on the given operating system (one of WINDOWS, MAC, LINUX, SOLARIS, or UNKNOWN). If not on the specified OS, this command does nothing. The os argument may be a pipe seperated list of OSes, for instance 'MAC|LINUX', which is useful given that both are unix based, and often times the same command will work for both. Otherwise completely equivalent to {{function|shell_adv}}. This is useful, because usually a command is tailored to a specific OS, and simply won't run on other OSes. This allows you to create similar commands across various OSes, and ensure that they only run for the correct OS. | Yes |- | [[API/functions/sys_beep|sys_beep]]() | void | | {{object|InsufficientPermissionException}}
{{object|PluginInternalException}} | Emits a system beep, on the system itself, not in game. This is only useful from cmdline. | Yes |- | [[API/functions/sys_err|sys_err]]() | void | text | | Writes the text to the system's std err. Unlike console(), this does not use anything else to format the output, though in many cases they will behave nearly the same. However, colors and other formatting characters will not "bleed" through, so sys_err(color(RED) . 'This is red') will not cause the next line to also be red, so if you need to print multiple lines out, you should manually add \n to create your linebreaks, and only make one call to sys_err.
([[API/functions/sys_err#Examples|Examples...]]) | Yes |- | [[API/functions/sys_out|sys_out]]() | void | text | | Writes the text to the system's std out. Unlike console(), this does not use anything else to format the output, though in many cases they will behave the same. However, colors and other formatting characters will not "bleed" through, so sys_out(color(RED) . 'This is red') will not cause the next line to also be red, so if you need to print multiple lines out, you should manually add \n to create your linebreaks, and only make one call to sys_out.
([[API/functions/sys_out#Examples|Examples...]]) | Yes |- | [[API/functions/sys_properties|sys_properties]]() | mixed | [propertyName] | | If propertyName is set, that single property is returned, or null if that property doesn't exist. If propertyName is not set, an associative array with all the system properties is returned. This mechanism hooks into Java's system property mechanism, and is just a wrapper for that. System properties are more reliable than environmental variables, and so are preferred in cases where they exist. For more information about system properties, see http://docs.oracle.com/javase/tutorial/essential/environment/sysprop.html. In addition, known preferences listed in preferences.ini are also included, starting with the prefix "methodscript.preference."
([[API/functions/sys_properties#Examples|Examples...]]) | Yes |- | [[API/functions/user|user]]() | string | | | Returns the name of the current user. This is retrieved in a platform specific manner, and should be cross compatible in all scripts. Null is returned if this function call is non-sensical in the current platform | No |- | [[API/functions/x_find|x_find]]() | array | regex, [startFrom], [type]

regex, [startFrom], types | {{object|IllegalArgumentException}}
{{object|InsufficientPermissionException}} | Returns a list of absolute paths of files whose name matches the given regex, searching recursively. Only available in cmdline mode. [[API/functions/x_find|See more...]]
| Yes |}

== Commands ==

A series of functions for creating and managing custom commands.

== Compiler ==

Compiler internal functions should be declared here. If you're reading this from anywhere but the source code, there's a bug, because these functions shouldn't be public or used in a script.

{| class="sticky" |- ! scope="col" width="8%" | Function Name ! scope="col" width="4%" | Returns ! scope="col" width="16%" | Arguments ! scope="col" width="8%" | Throws ! scope="col" width="62%" | Description ! scope="col" width="2%" | Res |- class="hiddenFunction" | [[API/functions/__smart_string__|__smart_string__]]() | none | string | | This is a compiler construct, and is not normally used directly. It is created via double quoted strings. | No |- class="hiddenFunction" | [[API/functions/__unsafe_assign__|__unsafe_assign__]]() | ivariable | [type], ivar, mixed | {{object|CastException}} | Accepts an ivariable ivar as a parameter, and puts the specified value mixed in it. Returns the variable that was assigned. Operator syntax is also supported: <code>@a = 5;</code>. Other forms are supported as well, +=, -=, *=, /=, .=, which do multiple operations at once. Array assigns are also supported: @array[5] = 'new value in index 5';
([[API/functions/__unsafe_assign__#Examples|Examples...]]) | No |}

== ControlFlow ==

This class provides various functions to manage control flow.

== Crypto ==

Provides common cryptographic functions. Many functions in this class are aware of and compatible with secure_string (where specified in the function documentation). In these cases, if the argument passed in is a secure_string, it is first decrypted and the underlying string is used rather than the default string value "**secure string**".

== DataHandling ==

This class provides various methods to control script data and program flow.

{| class="sticky" |- ! scope="col" width="8%" | Function Name ! scope="col" width="4%" | Returns ! scope="col" width="16%" | Arguments ! scope="col" width="8%" | Throws ! scope="col" width="62%" | Description ! scope="col" width="2%" | Res |- | [[API/functions/array|array]]() | array | [var1, [var2...]] | | Creates an array of values.
([[API/functions/array#Examples|Examples...]]) | No |- | [[API/functions/assign|assign]]() | ivariable | [type], ivar, mixed | {{object|CastException}} | Accepts an ivariable ivar as a parameter, and puts the specified value mixed in it. Returns the variable that was assigned. Operator syntax is also supported: <code>@a = 5;</code>. Other forms are supported as well, +=, -=, *=, /=, .=, which do multiple operations at once. Array assigns are also supported: @array[5] = 'new value in index 5';
([[API/functions/assign#Examples|Examples...]]) | No |- | [[API/functions/associative_array|associative_array]]() | array | [args...] | | Works exactly like array(), except the array created will be an associative array, even if the array has been created with no elements. This is the only use case where this is necessary, vs using the normal array() function, or in the case where you assign sequential keys anyways, and the same array could have been created using array().
([[API/functions/associative_array#Examples|Examples...]]) | No |- | [[API/functions/boolean|boolean]]() | boolean | item | | Returns a new construct that has been cast to a boolean. The item is cast according to the boolean conversion rules. Since all data types can be cast to a a boolean, this function will never throw an exception.
([[API/functions/boolean#Examples|Examples...]]) | No |- | [[API/functions/closure|closure]]() | closure | [params...], code | | Returns a closure on the provided code. A closure is a datatype that represents some code as code, not the results of some code after it is run. Code placed in a closure can be used as a string, or executed by other functions using the execute() function. If a closure is "to string'd" it will not necessarily look like the original code, but will be functionally equivalent. The current environment is "snapshotted" and stored with the closure, however, this information is only stored in memory, it isn't retained during a serialization operation. Also, the special variable @arguments is automatically created for you, and contains an array of all the arguments passed to the closure, much like procedures. See the wiki article on [[Closures|closures]] for more details and examples.
([[API/functions/closure#Examples|Examples...]]) | Yes |- | [[API/functions/double|double]]() | double | item | {{object|CastException}} | Returns a new construct that has been cast to an double. This function will throw a CastException if is_numeric would return false for this item, but otherwise, it will be cast properly.
([[API/functions/double#Examples|Examples...]]) | No |- | [[API/functions/eval|eval]]() | string | script_string | {{object|CastException}}
{{object|InsufficientPermissionException}} | Executes arbitrary MethodScript. Note that this function is very experimental, and is subject to changing or removal. To globally disable use of eval, set the runtime setting "function.eval.disable" to true, which will cause use of the function to throw an exception. | Yes |- | [[API/functions/execute|execute]]() | mixed | [values...], callable | {{object|CastException}} | Executes the given closure or other Callable. You can also send arguments to the Callable, which it may or may not use, depending on the particular Callable's definition. If the Callable returns a value, then that value will be returned with execute. Otherwise, void is returned. Note that Callables are in general first class language features, which can be invoked with parenthesis, for instance <code>Callable @c = ...; @c();</code> will execute @c, and is the preferred syntax. | Yes |- | [[API/functions/execute_array|execute_array]]() | mixed | valueArray, closure | {{object|CastException}} | Executes the given closure, expanding the value array as individual arguments to the closure. If there are no arguments to be sent to the closure, an empty array can be sent. If the closure returns a value with return(), then that value will be returned with execute. Otherwise, void is returned. | Yes |- | [[API/functions/executeas|executeas]]() | mixed | sender, label, [values...], closure | {{object|CastException}} | Executes the given closure in the context of a given player or ~console. A closure that runs player(), for instance, would return the specified player's name. If null is given, it will execute with the current sender context instead of the closure's. The label argument sets the permission label that this closure will use. If null is given, the closure's label will be used, like with execute(). | Yes |- | [[API/functions/export|export]]() | void | key, value | {{object|IllegalArgumentException}}
{{object|IndexOverflowException}} | Stores a value in the global storage register. An arbitrary value is stored with the given key, and can be retrieved using import. If the value is already stored, it is overwritten. See {{function|import}}. The reference to the value is stored, not a copy of the value, so in the case of arrays, manipulating the contents of the array will manipulate the stored value. An array may be used as a key. It is converted into a string with the array values separated by dots. export() is threadsafe.
([[API/functions/export#Examples|Examples...]]) | Yes |- | [[API/functions/fixed_array|fixed_array]]() | fixed_array | ClassType type, int size, [boolean nullOut] | {{object|RangeException}}
{{object|CastException}} | Creates an array that can hold values of the given type, and is of the given size. The array cannot be resized or retyped later. The array cannot be associative. In general, this isn't meant for normal use, and unless you have specific need for a fixed_size array, array() should be used instead. This is instead meant for writing low level system code. On the other hand, for performance sensitive needs, this may be used instead, though note that most of the API does not accept fixed_arrays (though it does implement ArrayAccess, and so can be used in most read only array based functions), nor will it in the future. This does however map to the underlying system array closely, and so can in particular be used to integrate more directly with the system. fixed_array isn't a particularly flexible type, but it isn't meant to be, it's meant to more directly map to the lower level part of the system. nullOut defaults to true, and in the interpreter is irrelevant, but for native code, if set to true, this loops through the array and sets each value to null (or equivalent for primitive types). This takes additional work, but sets the value to a known state. This can be bypassed if the array is about to be filled from 0 to length, but should otherwise always be set to true. A RangeException is thrown if size is negative, or larger than a 32 bits signed integer. A CastException is thrown when size cannot be cast to an int. | No |- class="hiddenFunction" | [[API/functions/g|g]]() | string | func1, [func2...] | | Groups any number of functions together, and returns void. | No |- | [[API/functions/get_proc|get_proc]]() | Procedure | reference | {{object|IllegalArgumentException}} | Returns a first class reference to the currently in scope procedure. This can be stored in variables and generally passed around, though it cannot be serialized. Keyword usage is preferred, such as <code>proc _asdf;</code> instead of <code>get_proc('_asdf')</code>. Note that this is a special compiler function, and must contain a hardcoded procedure name. | Yes |- | [[API/functions/iclosure|iclosure]]() | iclosure | [params...], code | | Returns a scope isolated closure on the provided code. An iclosure is a datatype that represents some code as code, not the results of some code after it is run. Code placed in an iclosure can be used as a string, or executed by other functions using the execute() function. If a closure is "to string'd" it will not necessarily look like the original code, but will be functionally equivalent. The current environment is "snapshotted" and stored with the closure, however, this information is only stored in memory, it isn't retained during a serialization operation. However, the variable table of the parent scope is not retained, thus making this closure "isolated" from the parent code. The special variable @arguments is automatically created for you, and contains an array of all the arguments passed to the closure, much like procedures. See the wiki article on [[Closures|closures]] for more details and examples.
([[API/functions/iclosure#Examples|Examples...]]) | Yes |- | [[API/functions/import|import]]() | mixed | key, [default] | {{object|IllegalArgumentException}}
{{object|IndexOverflowException}} | This function imports a value from the global value register. It looks for a value stored with the specified key (using the export function), and returns that value. If specified key doesn't exist, it will return either null or the default value if specified. An array may be used as a key. It is converted into a string with the array values separated by dots. import() is threadsafe.
([[API/functions/import#Examples|Examples...]]) | Yes |- | [[API/functions/include|include]]() | void | path | {{object|IncludeException}}
{{object|IOException}} | Includes external code at the specified path. | No |- | [[API/functions/include_dir|include_dir]]() | nothing | directory, [recursive] | | Works like include, but takes a directory, and includes all files within the directory. Recursive defaults to false, but if true, recurses down into all subdirectories as well. As an implementation note, this function is fully resolved at compile time, thus the inputs must be hardcoded. The directories are scanned at compile time, and replaced with individual includes for each .ms file found. | No |- | [[API/functions/instanceof|instanceof]]() | boolean | value, type | | Checks to see if the value is, extends, or implements the given type. Keyword usage is preferred: <code>@value instanceof int</code>. The opposite operation is <code>@value notinstanceof int</code>. [[API/functions/instanceof|See more...]]

([[API/functions/instanceof#Examples|Examples...]]) | No |- | [[API/functions/integer|integer]]() | integer | item | {{object|CastException}} | Returns a new construct that has been cast to an integer. This function will throw a CastException if is_numeric would return false for this item, but otherwise, it will be cast properly. Data may be lost in this conversion. For instance, 4.5 will be converted to 4, by using integer truncation. You can use is_integral to see if this data loss would occur.
([[API/functions/integer#Examples|Examples...]]) | No |- | [[API/functions/is_array|is_array]]() | boolean | item | | Returns whether or not the item is an array
([[API/functions/is_array#Examples|Examples...]]) | No |- | [[API/functions/is_associative|is_associative]]() | boolean | array | {{object|CastException}} | Returns whether or not the array is associative. If the parameter is not an array, throws a CastException.
([[API/functions/is_associative#Examples|Examples...]]) | No |- | [[API/functions/is_boolean|is_boolean]]() | boolean | item | | Returns whether the given item is of the boolean datatype. Note that all datatypes can be used as booleans, however this function checks the specific datatype of the given item.
([[API/functions/is_boolean#Examples|Examples...]]) | No |- | [[API/functions/is_bytearray|is_bytearray]]() | boolean | item | | Returns whether or not the item is actually a ByteArray datatype.
([[API/functions/is_bytearray#Examples|Examples...]]) | No |- | [[API/functions/is_closure|is_closure]]() | boolean | arg | | Returns true if the argument is a closure (could be executed) or false otherwise
([[API/functions/is_closure#Examples|Examples...]]) | No |- | [[API/functions/is_double|is_double]]() | boolean | item | | Returns whether or not the given item is a double. Note that numeric strings and integers can usually be used as a double, however this function checks the actual datatype of the item. If you just want to see if an item can be used as a number, use is_numeric() instead.
([[API/functions/is_double#Examples|Examples...]]) | No |- | [[API/functions/is_integer|is_integer]]() | boolean | item | | Returns whether or not the given item is an integer. Note that numeric strings can usually be used as integers, however this function checks the actual datatype of the item. If you just want to see if an item can be used as a number, use is_integral() or is_numeric() instead.
([[API/functions/is_integer#Examples|Examples...]]) | No |- | [[API/functions/is_integral|is_integral]]() | boolean | item | {{object|CastException}} | Returns true if the numeric value represented by a given double or numeric string could be cast to an integer without losing data (or if it's an integer). For instance, is_numeric(4.5) would return true, and integer(4.5) would work, however, equals(4.5, integer(4.5)) returns false, because the value was narrowed to 4.
([[API/functions/is_integral#Examples|Examples...]]) | No |- | [[API/functions/is_null|is_null]]() | boolean | item | | Returns whether or not the given item is null.
([[API/functions/is_null#Examples|Examples...]]) | No |- | [[API/functions/is_number|is_number]]() | boolean | item | | Returns whether or not the given item is an integer or a double. Note that numeric strings can usually be used as integers and doubles, however this function checks the actual datatype of the item. If you just want to see if an item can be used as a number, use is_integral() or is_numeric() instead.
([[API/functions/is_number#Examples|Examples...]]) | No |- | [[API/functions/is_numeric|is_numeric]]() | boolean | item | | Returns false if the item would fail if it were used as a numeric value. If it can be parsed or otherwise converted into a numeric value, true is returned.
([[API/functions/is_numeric#Examples|Examples...]]) | No |- | [[API/functions/is_proc|is_proc]]() | boolean | procName | | Returns whether or not the given procName is currently defined, i.e. if calling this proc wouldn't throw an exception. | Yes |- | [[API/functions/is_string|is_string]]() | boolean | item | | Returns whether or not the item is actually a string datatype. If you just care if some data can be used as a string, use is_stringable().
([[API/functions/is_string#Examples|Examples...]]) | No |- | [[API/functions/is_stringable|is_stringable]]() | boolean | item | | Returns whether or not the item is convertable to a string. Everything but arrays can be used as strings.
([[API/functions/is_stringable#Examples|Examples...]]) | No |- class="hiddenFunction" | [[API/functions/mutable_primitive|mutable_primitive]]() | mutable_primitive | [primitive_value] | {{object|FormatException}} | Creates a mutable primitive object, initially setting the value of the object to null, or the specified value. The value must be a primitive value, and cannot be an array or object. [[API/functions/mutable_primitive|See more...]]

([[API/functions/mutable_primitive#Examples|Examples...]]) | No |- | [[API/functions/parse_int|parse_int]]() | int | value, radix | {{object|CastException}}
{{object|RangeException}}
{{object|FormatException}} | Converts a string representation of an integer to a real integer, given the value's radix (base). See {{function|to_radix}} for a more detailed explanation of number theory. Radix must be between 2 and 36, inclusive.
([[API/functions/parse_int#Examples|Examples...]]) | No |- | [[API/functions/proc|proc]]() | void | procName, [params...], procCode | {{object|FormatException}} | Creates a new user defined procedure (also known as "function"), with the given name and parameters, that can be called later in code. The name of the procedure must be a constant and its parameters must be variables. Please see the more detailed documentation on procedures for more information. In general, brace syntax and keyword usage is preferred: proc _myProc(@a, @b){ procCode(@a, @b); } | No |- class="hiddenFunction" | [[API/functions/rclosure|rclosure]]() | closure | [params...], code | | Returns a non-linking closure on the provided code. The same rules apply for closures, except the top level internal code does not check for proper linking at compile time, and instead links at runtime. Lexer errors and some other compile time checks ARE done however, but functions are not optimized or linked. This is used for remote code execution, since the remote platform may have some functionality unavailable on this current platform.
([[API/functions/rclosure#Examples|Examples...]]) | Yes |- | [[API/functions/string|string]]() | string | item | | Creates a new construct that is the "toString" of an item. For arrays, an human readable version is returned; this should not be used directly, as the format is not guaranteed to remain consistent. Booleans return "true" or "false" and null returns "null". Strings (and subclasses of strings) are simply returned as is.
([[API/functions/string#Examples|Examples...]]) | No |- | [[API/functions/to_radix|to_radix]]() | string | value, radix | {{object|CastException}}
{{object|RangeException}}
{{object|FormatException}} | Given an int and a radix, returns a string representation of the integer value in the given base. A common use would be to output a hex or binary representation of a number, for instance. [[API/functions/to_radix|See more...]]

([[API/functions/to_radix#Examples|Examples...]]) | No |- | [[API/functions/typeof|typeof]]() | ClassType | arg | | Returns a ClassType value of the typeof a value. For instance 'array' is returned for typeof(array()). This is a generic replacement for the is_* series of functions.
([[API/functions/typeof#Examples|Examples...]]) | No |}

== DataTransformations ==

This class provides functions that are able to transform data from native objects to their serialized forms, i.e. json, ini, etc.

== Debug ==

Provides methods for viewing data about both CommandHelper and the other plugins in your server. Though not meant to be called by normal scripts, these methods are available everywhere other methods are available. Note that for some of these functions to even work, play-dirty mode must set to on. These are most useful in conjunction with interpreter mode.

== Easings ==

Easing related functions. Easings are based on the easings listed at http://easings.net, with the addition of the LINEAR easing, which just returns x.

== Echoes ==

These functions allow you to echo information to the screen

message, [recipients] | {{object|FormatException}} | Broadcasts a message to all or some players and/or console. If permission is given, only players with that permission and console will see the broadcast. If an array of recipients is given, only online players in the list will see the broadcast. Console will receive the broadcast only when the array contains case-insensitive '~console'. Offline players and duplicate recipients in the list will be ignored. If permission/recipients is null, all players and console will see the broadcast. Throws FormatException when the given recipients array is associative. | Yes |- | [[API/functions/chat|chat]]() | void | string | {{object|PlayerOfflineException}} | Echoes string to the chat, as if the user simply typed something into the chat bar. This function cannot be run from console, a PlayerOfflineException is thrown if attempted. Use broadcast() instead. | Yes |- | [[API/functions/chatas|chatas]]() | void | player, msg | {{object|PlayerOfflineException}}
{{object|LengthException}} | Sends a chat message to the server, as the given player. Otherwise the same as the chat() function | Yes |- | [[API/functions/color|color]]() | string | name | | Returns the color (or style) code modifier for a given value. If the value isn't valid, white is used instead. The list of valid color names is: BLACK, DARK_BLUE, DARK_GREEN, DARK_AQUA, DARK_RED, DARK_PURPLE, GOLD, GRAY, DARK_GRAY, BLUE, GREEN, AQUA, RED, LIGHT_PURPLE, YELLOW, WHITE, RANDOM, BOLD, STRIKETHROUGH, UNDERLINE, ITALIC, or PLAIN_WHITE. Other supported values include the color integers 0-15, the color hex numbers 0-F, and the style values k, l, m, n, o, and r. Additionally, any RGB color can be used in the hex format '#rrggbb' (except in tellraw). [[API/functions/color|See more...]]
| No |- | [[API/functions/colorize|colorize]]() | mixed | text, [symbol] | | Replaces all the colorizable character codes in the string. For instance, colorize('&aText') would be equivalent to (color('a').'Text'). By default, the symbol is '&', but that can be any arbitrary string that you specify. If text is not a string, that value is simply returned. If you need to "escape" a symbol, (that is have a literal symbol followed by a letter that is a valid color) just repeat the symbol twice, for instance '&&c' would return a literal '&c' instead of a red modifier. Additionally, any RGB color can be used in the hex format '&#rrggbb' (except in tellraw). [[API/functions/colorize|See more...]]
| No |- | [[API/functions/console|console]]() | void | message, [prefix] | {{object|CastException}} | Logs a message to the console. If prefix is true, prepends "CommandHelper:" to the message. Default is true. If you wish to set the default value of prefix to false, use set_runtime_setting('function.console.prefix_default', false). | Yes |- | [[API/functions/msg|msg]]() | void | var1, [var2...] | {{object|PlayerOfflineException}} | Echoes a message to the player running the command | No |- | [[API/functions/strip_colors|strip_colors]]() | string | toStrip | | Strips all the color codes from a given string | No |- | [[API/functions/tellraw|tellraw]]() | void | [string selector], array raw | {{object|CastException}}
{{object|FormatException}}
{{object|IOException}} | A thin wrapper around the tellraw command from console context, this simply passes the input to the command. The raw is passed in as an array and json encoded. No validation is done on the input, so the command may fail. Do not use double quotes (smart string) when providing the selector. If not provided, the selector defaults to @a. See {{function|ptellraw}} if you need the @s selector with player context. [[API/functions/tellraw|See more...]]

([[API/functions/tellraw#Examples|Examples...]]) | Yes |- | [[API/functions/title|title]]() | void | [player], title, subtitle, [fadein, stay, fadeout] | {{object|PlayerOfflineException}}
{{object|CastException}}
{{object|RangeException}}
{{object|LengthException}} | Shows a title and/or subtitle to a player. The title and subtitle parameters can be null. The integers fadein, stay, and fadeout define the time in ticks that the title will be displayed. The defaults are 10, 70, and 20 respectively. | Yes |- | [[API/functions/tmsg|tmsg]]() | void | player, msg, [...] | {{object|PlayerOfflineException}}
{{object|InsufficientArgumentsException}}
{{object|LengthException}} | Displays a message on the specified players screen, similar to msg, but targets a specific user. | Yes |}

== Enchantments ==

Provides methods for dealing with enchanted items

player, slot, enchantsArray | {{object|CastException}}
{{object|EnchantmentException}}
{{object|PlayerOfflineException}} | Adds enchantments to an item in the player's inventory. A single enchantment type and level can be specified or an enchantment array may be given. If slot is null, the currently selected slot is used. If an enchantment cannot be applied to the specified item, an EnchantmentException is thrown. The enchantment array must have the enchantment as keys and levels as the values. (eg. array('unbreaking': 1)) The level parameter can be a number or a roman numeral. [[API/functions/enchant_item|See more...]]
| Yes |- | [[API/functions/enchantment_list|enchantment_list]]() | array | | | Returns an informational list of all valid enchantment names. Note that this will simply cover all enchantment types, but may not be a comprehensive list of names that can be accepted, there may be more, however, the list returned here is "comprehensive" and "official". Additionally, this may vary from server type to server type. | No |- | [[API/functions/get_enchant_max|get_enchant_max]]() | int | name | {{object|EnchantmentException}} | Given an enchantment name, returns the max level it can be. If name is not a valid enchantment, an EnchantException is thrown. | No |- | [[API/functions/get_enchants|get_enchants]]() | array | item | {{object|FormatException}}
{{object|CastException}}
{{object|RangeException}}
{{object|NotFoundException}} | Given an item array, returns the enchantments that can be validly added to this item. This may return an empty array. | No |- | [[API/functions/get_item_enchants|get_item_enchants]]() | array | [player], slot | {{object|PlayerOfflineException}}
{{object|CastException}} | Returns an array of arrays of the enchantments and their levels on the given item. For example: array('sharpness': 1, 'unbreaking': 3). | Yes |- | [[API/functions/is_enchantment|is_enchantment]]() | boolean | name | | Returns true if this name is a valid enchantment type. | No |- | [[API/functions/remove_item_enchant|remove_item_enchant]]() | void | [player], slot, type | {{object|CastException}}
{{object|EnchantmentException}}
{{object|PlayerOfflineException}} | Removes an enchantment from an item. The type may be a valid enchantment, or an array of enchantment names. It can also be null, and all enchantments will be removed. If an enchantment is specified, and the item is not enchanted with that, it is simply ignored. | Yes |}

== EntityManagement ==

This class of functions allow entities to be managed.

[locationArray] | {{object|InvalidWorldException}}
{{object|FormatException}}
{{object|CastException}} | Returns an array of IDs for all entities in the given scope. With no args, this will return all entities loaded on the entire server. If the first argument is given and is a location, only entities in the chunk containing that location will be returned, or if it is a world only entities in that world will be returned. If all three arguments are given, only entities in the chunk with those coords will be returned. This can take chunk coords (ints) or location coords (doubles).
([[API/functions/all_entities#Examples|Examples...]]) | Yes |- | [[API/functions/drop_item|drop_item]]() | string | [player/LocationArray], itemArray, [spawnNaturally] | {{object|CastException}}
{{object|FormatException}}
{{object|PlayerOfflineException}}
{{object|InvalidWorldException}} | Drops the specified item stack at the specified player's feet (or at an arbitrary Location, if an array is given), and returns its entity UUID. spawnNaturally takes a boolean, which forces the way the item will be spawned. If true, the item will be dropped with a random velocity. | Yes |- | [[API/functions/entities_in_radius|entities_in_radius]]() | array | locationArray, distance, [type]

locationArray, distance, [arrayTypes] | {{object|CastException}}
{{object|BadEntityException}}
{{object|FormatException}}
{{object|RangeException}} | Returns an array of all entities within the given distance from the location. Set type argument to filter entities to a specific entity type. You can pass an array of types. [[API/functions/entities_in_radius|See more...]]
| Yes |- | [[API/functions/entity_exists|entity_exists]]() | boolean | entityUUID | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Returns true if entity exists, otherwise false. | Yes |- | [[API/functions/entity_fall_distance|entity_fall_distance]]() | double | entityUUID | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Returns the distance the entity has fallen. | Yes |- | [[API/functions/entity_grounded|entity_grounded]]() | boolean | entityUUID | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | returns whether the entity is touching the ground | Yes |- | [[API/functions/entity_in_water|entity_in_water]]() | boolean | entityUUID | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Returns whether an entity is colliding with water. This accounts for waterlogged blocks, bubble columns, and fluid height. It does not account for water cauldrons. | Yes |- | [[API/functions/entity_loc|entity_loc]]() | locationArray | entityUUID | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Returns the location array for this entity, if it exists. This array will be compatible with any function that expects a location.
([[API/functions/entity_loc#Examples|Examples...]]) | Yes |- | [[API/functions/entity_onfire|entity_onfire]]() | int | entityUUID | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Returns the number of seconds until this entity stops being on fire, 0 if it already isn't. | Yes |- | [[API/functions/entity_remove|entity_remove]]() | void | entityUUID | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Removes the specified entity from the world, without any drops or animations. Note: you can't remove players. As a safety measure for working with NPC plugins, it will not work on anything human, even if it is not a player. | Yes |- | [[API/functions/entity_spec|entity_spec]]() | array | entityID | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Returns an associative array containing all the data of the given entity that are too specific to have its own function. [[API/functions/entity_spec|See more...]]
| Yes |- | [[API/functions/entity_type|entity_type]]() | string | entityUUID | {{object|CastException}} | Returns the EntityType of the entity with the specified ID. Returns null if the entity does not exist. | Yes |- | [[API/functions/entity_velocity|entity_velocity]]() | array | entityUUID | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Returns an entity's motion vector represented as an associative array with the the keys x, y, and z. As a convenience, the magnitude is also included.
([[API/functions/entity_velocity#Examples|Examples...]]) | Yes |- | [[API/functions/get_art_at|get_art_at]]() | string | locationArray | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Gets the specified art at the given location. If the item at the specified location isn't a painting, an [[API/functions/get_art_at|See more...]]
| Yes |- | [[API/functions/get_display_entity|get_display_entity]]() | array | entityUUID | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Returns an associative array of display entity data. Array keys are: 'billboard', 'brightness', 'glowcolor', 'height', 'width', 'viewrange', 'shadowradius', 'shadowstrength', 'teleportduration', and 'transformation'. [[API/functions/get_display_entity|See more...]]
| Yes |- | [[API/functions/get_entity_age|get_entity_age]]() | int | entityUUID | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Returns the entity age as an integer, represented by server ticks. | Yes |- | [[API/functions/get_entity_freezing|get_entity_freezing]]() | int | entityUUID | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Returns the number of ticks the entity has been freezing in powdered snow. (MC 1.17+) Counts down by 2 every tick when entity is thawing. | Yes |- | [[API/functions/get_entity_glowing|get_entity_glowing]]() | boolean | entityUUID | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Returns true if the entity is glowing | Yes |- | [[API/functions/get_entity_gravity|get_entity_gravity]]() | boolean | entityUUID | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Returns true if gravity applies to the entity. | Yes |- | [[API/functions/get_entity_invulnerable|get_entity_invulnerable]]() | boolean | entityUUID | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Returns true if the entity cannot be damaged | Yes |- | [[API/functions/get_entity_killer|get_entity_killer]]() | string | entityUUID | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Gets the player killer of a living entity. Can be null. Usually indicates the last player that damaged the entity within the last five seconds. | Yes |- | [[API/functions/get_entity_max_speed|get_entity_max_speed]]() | double | entityUUID | {{object|BadEntityException}}
{{object|BadEntityTypeException}}
{{object|LengthException}} | Returns a max speed for a minecart. | Yes |- | [[API/functions/get_entity_pose|get_entity_pose]]() | string | entityUUID | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Returns the pose of an entity. Poses are desynchronized from entity state, as the pose is set at the end of a tick and can be set to anything by a plugin. [[API/functions/get_entity_pose|See more...]]
| Yes |- | [[API/functions/get_entity_rider|get_entity_rider]]() | string | entityUUID | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Returns the UUID of the given entity's rider, or null if it doesn't have one. If there are multiple riders, only the first is returned. | Yes |- | [[API/functions/get_entity_riders|get_entity_riders]]() | array | entityUUID | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Returns an array of UUIDs for the given entity's riders. | Yes |- | [[API/functions/get_entity_saves_on_unload|get_entity_saves_on_unload]]() | void | entityUUID | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Gets whether the entity will be saved to disk when it is unloaded. | Yes |- | [[API/functions/get_entity_silent|get_entity_silent]]() | boolean | entityUUID | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Returns true if the entity produces sounds | Yes |- | [[API/functions/get_entity_transient_id|get_entity_transient_id]]() | int | uuid | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Given a permanent entity uuid, returns the transient entity id. This should not be stored, as it is reset every restart, and is only useful for dealing with low level packets. | No |- | [[API/functions/get_entity_vehicle|get_entity_vehicle]]() | string | entityUUID | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Returns the UUID of the given entity's vehicle, or null if none exists. | Yes |- | [[API/functions/get_hanging_direction|get_hanging_direction]]() | string | entityUUID | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Returns the direction a hanging entity is facing. | Yes |- | [[API/functions/get_mob_name|get_mob_name]]() | string | entityUUID | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Returns the name of the given mob. | Yes |- | [[API/functions/get_name_visible|get_name_visible]]() | boolean | entityUUID | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Returns whether or not a mob's custom name is always visible. If this is true it will be as visible as player names, otherwise it will only be visible when near the mob. | Yes |- | [[API/functions/get_projectile_bounce|get_projectile_bounce]]() | boolean | entityUUID | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Returns if the given projectile should bounce when it hits something. (deprecated) | Yes |- | [[API/functions/get_projectile_item|get_projectile_item]]() | array | entityUUID | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Returns the displayed item for some projectiles. This can be used on throwable projectiles (snowballs, eggs, exp bottles, enderpearls) as well as large and small fireballs. | Yes |- | [[API/functions/get_projectile_shooter|get_projectile_shooter]]() | mixed | entityUUID | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Returns the shooter of the given projectile, can be null. If the shooter is an entity, that entity's ID will be return, but if it is a block, that block's location will be returned. | Yes |- | [[API/functions/get_scoreboard_tags|get_scoreboard_tags]]() | array | entityUUID | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Returns an array of scoreboard tags for this entity. | Yes |- | [[API/functions/get_transformation_from_matrix|get_transformation_from_matrix]]() | array | array matrix

float f0, float f1, float f2, float f3, float f4, float f5, float f6, float f7, float f8, float f9, float f10, float f11, float f12, float f13, float f14, float f15 | {{object|LengthException}} | Converts a Minecraft transformation matrix into a transformation object. This is the same underlying algorithm that set_display_entity uses when accepting a transformation matrix. | No |- | [[API/functions/has_scoreboard_tag|has_scoreboard_tag]]() | boolean | entityUUID, tag | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Returns whether this entity has a specific tag. | Yes |- | [[API/functions/is_entity_hidden_by_default|is_entity_hidden_by_default]]() | boolean | entityUUID | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Returns whether an entity is hidden by default to clients. (MC 1.19.3+) If true, pshow_entity() must be used before a player's client can see this entity. Unrelated to the invisibility potion effect. | Yes |- | [[API/functions/is_entity_living|is_entity_living]]() | boolean | entityUUID | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Returns true if entity is living, otherwise false. | Yes |- | [[API/functions/is_tameable|is_tameable]]() | boolean | entityUUID | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Returns true or false if the specified entity is tameable | Yes |- | [[API/functions/launch_firework|launch_firework]]() | string | locationArray, [optionsArray] | {{object|FormatException}}
{{object|RangeException}}
{{object|InvalidWorldException}} | Launches a firework rocket. The location array specifies where it is launched from, and the options array is an associative array described below. All parameters in the array are optional, and default to the specified values if not set. The default options being set will make it look like a normal firework, with a white explosion. Returns the firework rocket entity's UUID. [[API/functions/launch_firework|See more...]]
| Yes |- | [[API/functions/play_entity_effect|play_entity_effect]]() | void | entityUUID, effect | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Plays the given visual effect on the entity. Non-applicable effects simply won't happen. Note: the death effect makes the mob invisible to players and immune to melee attacks. When used on players, they are shown the respawn menu, but because they are not actually dead, they can only log out. [[API/functions/play_entity_effect|See more...]]
| Yes |- | [[API/functions/remove_scoreboard_tag|remove_scoreboard_tag]]() | boolean | entityUUID, tag | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Removes a tag from the entity. Returns whether or not it was successful. | Yes |- | [[API/functions/set_art_at|set_art_at]]() | boolean | locationArray, art | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Sets the art at the specified location. If the art doesn't fit, nothing happens, and false is returned. Otherwise, true is returned. [[API/functions/set_art_at|See more...]]
| Yes |- | [[API/functions/set_display_entity|set_display_entity]]() | void | entityUUID, array | {{object|BadEntityException}}
{{object|LengthException}}
{{object|FormatException}}
{{object|IllegalArgumentException}}
{{object|CastException}}
{{object|RangeException}} | Sets the data for a display entity. See {{function|get_display_entity}} for details about the array format. [[API/functions/set_display_entity|See more...]]
| Yes |- | [[API/functions/set_entity_age|set_entity_age]]() | void | entityUUID, int | {{object|CastException}}
{{object|BadEntityException}}
{{object|RangeException}}
{{object|LengthException}} | Sets the age of the entity to the specified int, represented by server ticks. Entity age cannot be less than 1 server tick, | Yes |- | [[API/functions/set_entity_fall_distance|set_entity_fall_distance]]() | void | entityUUID, double | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Sets the distance the entity has fallen. | Yes |- | [[API/functions/set_entity_freezing|set_entity_freezing]]() | void | entityUUID, int | {{object|FormatException}}
{{object|LengthException}}
{{object|BadEntityException}}
{{object|RangeException}} | Sets how many server ticks the entity has been freezing. (MC 1.17+) Must be above zero, and will clamp to the maximum the server allows. | Yes |- | [[API/functions/set_entity_glowing|set_entity_glowing]]() | void | entityUUID, boolean | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | If true, applies glowing effect to the entity | Yes |- | [[API/functions/set_entity_gravity|set_entity_gravity]]() | void | entityUUID, boolean | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Sets whether or not gravity applies to the entity. | Yes |- | [[API/functions/set_entity_hidden_by_default|set_entity_hidden_by_default]]() | void | entityUUID, hidden | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Sets whether an entity's is hidden by default to clients. (MC 1.19.3+) If set to true, pshow_entity() must be used before a player's client can see this entity. Unrelated to the invisibility potion effect. | Yes |- | [[API/functions/set_entity_invulnerable|set_entity_invulnerable]]() | void | entityUUID, boolean | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | If set to true the entity cannot be damaged, except by players in creative mode | Yes |- | [[API/functions/set_entity_killer|set_entity_killer]]() | void | entityUUID, player | {{object|FormatException}}
{{object|LengthException}}
{{object|BadEntityException}} | Sets the player killer of a living entity. (Paper only) Can be set at any time before the entity dies to change kill attribution for the next five seconds or until it's changed again. Can be set to null. | Yes |- | [[API/functions/set_entity_loc|set_entity_loc]]() | boolean | entityUUID, locationArray | {{object|BadEntityException}}
{{object|FormatException}}
{{object|CastException}}
{{object|InvalidWorldException}}
{{object|LengthException}}
{{object|IllegalArgumentException}} | Teleports the entity to the given location and returns whether the action was successful. Note this can set both location and direction. On Paper 1.19.3+ servers, this teleports passengers along with the entity instead of canceling the teleport.
([[API/functions/set_entity_loc#Examples|Examples...]]) | Yes |- | [[API/functions/set_entity_max_speed|set_entity_max_speed]]() | void | entityUUID | {{object|BadEntityException}}
{{object|BadEntityTypeException}}
{{object|CastException}}
{{object|LengthException}} | Sets a max speed for a minecart. | Yes |- | [[API/functions/set_entity_onfire|set_entity_onfire]]() | void | entityUUID, seconds | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Sets the entity on fire for the given number of seconds. Throws a RangeException if seconds is less than 0 or greater than 107374182. | Yes |- | [[API/functions/set_entity_pose|set_entity_pose]]() | void | entityUUID, pose, [fixed] | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Sets an entity's pose. (only Mannequins on Spigot, 1.20.1+ on Paper) The fixed argument is a boolean for whether the pose should stay unless manually changed. (defaults to false) While in most cases you can set any pose to any entity, only certain poses will result in a noticable change for a particular entity type. Poses can affect entity hitboxes but do not otherwise change entity state. See {{function|get_entity_pose}} for a list of poses. | Yes |- | [[API/functions/set_entity_rider|set_entity_rider]]() | boolean | horse, rider | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Sets the way two entities are stacked. Horse and rider are entity ids. If rider is null, horse will eject its current rider, if it has one. If horse is null, rider will leave whatever it is riding. If horse and rider are both valid entities, rider will ride horse. The function returns the success of whatever operation is done. If horse and rider are both null, or otherwise the same, a FormatException is thrown. If a horse already has a rider, this will add the new rider without ejecting the existing one. | Yes |- | [[API/functions/set_entity_rotation|set_entity_rotation]]() | void | entityUUID, yaw, [pitch] | {{object|UnsupportedOperationException}}
{{object|LengthException}} | Sets an entity's yaw and pitch without teleporting or ejecting. Can only be used on players when on Paper 1.19 or above, otherwise will throw an UnsupportedOperationException. | Yes |- | [[API/functions/set_entity_saves_on_unload|set_entity_saves_on_unload]]() | void | entityUUID, boolean | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Sets whether the entity is saved to disk when it is unloaded. By default an entity is saved. Setting this to false disables that. Can be used on players to disable player data saving on quit. | Yes |- | [[API/functions/set_entity_silent|set_entity_silent]]() | void | entityUUID, boolean | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Sets whether or not entity produces sounds | Yes |- | [[API/functions/set_entity_spec|set_entity_spec]]() | void | entityUUID, specArray | {{object|CastException}}
{{object|BadEntityException}}
{{object|IndexOverflowException}}
{{object|IndexOverflowException}}
{{object|RangeException}}
{{object|FormatException}}
{{object|LengthException}}
{{object|InvalidWorldException}} | Sets the data in the specArray to the given entity. The specArray must follow the same format as entity_spec(). See the documentation for that function for info on available options. All indices in the specArray are optional. | Yes |- | [[API/functions/set_entity_velocity|set_entity_velocity]]() | void | entityUUID, array | {{object|FormatException}}
{{object|LengthException}}
{{object|BadEntityException}}
{{object|IllegalArgumentException}} | Sets the velocity of this entity according to the supplied xyz array. All 3 values default to 0, so an empty array will simply stop the entity's motion. Both normal and associative arrays are accepted.
([[API/functions/set_entity_velocity#Examples|Examples...]]) | Yes |- | [[API/functions/set_hanging_direction|set_hanging_direction]]() | void | entityUUID, direction, [force] | {{object|BadEntityException}}
{{object|LengthException}}
{{object|FormatException}}
{{object|IllegalArgumentException}} | Sets the direction a hanging entity is facing. Valid directions are NORTH, SOUTH, EAST, and WEST. UP and DOWN are also valid for item frames. A hanging will not change direction if there's no supporting block in the new position. However, the 'force' parameter can be set to true to override this behavior. While leash hitches are technically hangings, they don't support different directions. | Yes |- | [[API/functions/set_mob_name|set_mob_name]]() | void | entityUUID, name | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Sets the name of the given mob. This automatically truncates if it is more than 64 characters. | Yes |- | [[API/functions/set_name_visible|set_name_visible]]() | void | entityUUID, boolean | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Sets the visibility of a mob's custom name. True means it will be visible from a distance, like a playername. False means it will only be visible when near the mob. | Yes |- | [[API/functions/set_projectile_bounce|set_projectile_bounce]]() | void | entityUUID, boolean | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Sets if the given projectile should bounce when it hits something. (deprecated) | Yes |- | [[API/functions/set_projectile_item|set_projectile_item]]() | void | entityUUID, itemArray | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Sets the displayed item for some projectiles. This can be used on throwable projectiles (snowballs, eggs, exp bottles, enderpearls) as well as large and small fireballs. | Yes |- | [[API/functions/set_projectile_shooter|set_projectile_shooter]]() | void | entityUUID, shooter | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Sets the shooter of the given projectile. This can be an entity UUID, dispenser location array (throws CastException if not a dispenser), or null. | Yes |- | [[API/functions/shoot_projectile|shoot_projectile]]() | string | [entity[, projectile]]

player, projectile, target[, speed] | {{object|BadEntityException}}
{{object|BadEntityTypeException}}
{{object|FormatException}}
{{object|PlayerOfflineException}} | Shoots an entity from the specified location (can be an entity UUID, player name or location array), or the current player if no arguments are passed. If no entity type is specified, it defaults to a fireball. If provide three arguments, with target (entity UUID, player name or location array), entity will shoot to target location. Last, fourth argument, is double and specifies the speed of projectile. Returns the UUID of the entity. | Yes |- | [[API/functions/spawn_entity|spawn_entity]]() | array | entityType, [qty], [location], [closure] | {{object|CastException}}
{{object|FormatException}}
{{object|BadEntityException}}
{{object|InvalidWorldException}}
{{object|PlayerOfflineException}}
{{object|IllegalArgumentException}} | Spawns the specified number of entities of the given type at the given location. Returns an array of entity UUIDs of what is spawned. Qty defaults to 1 and location defaults to the location of the commandsender, if it is a block or player. If the commandsender is console, location must be supplied. [[API/functions/spawn_entity|See more...]]

([[API/functions/spawn_entity#Examples|Examples...]]) | Yes |}

== Environment ==

Allows you to manipulate the environment around the player

locationArray, [world] | {{object|FormatException}}
{{object|CastException}}
{{object|LengthException}}
{{object|InvalidWorldException}}
{{object|NotFoundException}} | Gets a location array for the highest block at a specific x and z column. If a location array is specified, the y coordinate is ignored. | Yes |- | [[API/functions/get_light_at|get_light_at]]() | int | locationArray | {{object|CastException}}
{{object|InvalidWorldException}}
{{object|FormatException}} | Returns the combined light level at a block, taking into account all sources. | No |- | [[API/functions/get_sign_text|get_sign_text]]() | array | locationArray, [side] | {{object|RangeException}}
{{object|FormatException}} | Gets an array of 4 strings of the text on the side of a sign. Side can be FRONT (default) or BACK. (MC 1.20+) If the location given isn't a sign, then a RangeException is thrown. | Yes |- | [[API/functions/get_skull_owner|get_skull_owner]]() | array | locationArray | {{object|RangeException}}
{{object|FormatException}} | Returns the owner name and uuid of the skull at the given location as an array in format: {name: string, uuid: string, texture: string}, or null if the skull does not have an owner. The value at the 'name' key will be an empty string if the server does not know the player's name. The 'texture' value is the Base64 encoded string of the textures property, or null. (Paper only) If no world is provided and the function is executed by a player, the player's world is used. If the block at the given location isn't a skull, a RangeException is thrown. | Yes |- | [[API/functions/get_sky_light_at|get_sky_light_at]]() | int | locationArray | {{object|CastException}}
{{object|InvalidWorldException}}
{{object|FormatException}} | Returns the sky light level for a location. Disregards all block sources of light, where 15 is directly beneath the sky during the day. | No |- | [[API/functions/is_block_lockable|is_block_lockable]]() | boolean | locationArray | {{object|CastException}}
{{object|FormatException}}
{{object|InvalidWorldException}} | Returns whether or not the block is lockable. [[API/functions/is_block_lockable|See more...]]
| Yes |- | [[API/functions/is_block_locked|is_block_locked]]() | boolean | locationArray | {{object|CastException}}
{{object|FormatException}}
{{object|InvalidWorldException}}
{{object|IllegalArgumentException}} | Returns whether or not the block is locked if its lockable. [[API/functions/is_block_locked|See more...]]
| Yes |- | [[API/functions/is_block_powered|is_block_powered]]() | boolean | locationArray, [checkMode] | {{object|CastException}}
{{object|InvalidWorldException}}
{{object|FormatException}} | Returns whether or not a block is being supplied with power.checkMode can be: "BOTH" (Check both direct and indirect power), "DIRECT_ONLY" (Check direct power only) or "INDIRECT_ONLY" (Check indirect power only). CheckMode defaults to "BOTH". | No |- | [[API/functions/is_sign_at|is_sign_at]]() | boolean | locationArray | {{object|FormatException}} | Returns true if the block at this location is a sign. | Yes |- | [[API/functions/is_sign_text_glowing|is_sign_text_glowing]]() | boolean | locationArray, [side] | {{object|FormatException}}
{{object|InvalidWorldException}} | Returns true if the sign side at this location has glowing text. (MC 1.17+) Side can be FRONT (default) or BACK. (MC 1.20+) | Yes |- | [[API/functions/is_sign_waxed|is_sign_waxed]]() | boolean | locationArray | {{object|FormatException}}
{{object|InvalidWorldException}} | Returns whether a sign is waxed and uneditable. (MC 1.20.1+) | Yes |- | [[API/functions/play_named_sound|play_named_sound]]() | void | source, soundArray[, players] | {{object|InvalidWorldException}}
{{object|CastException}}
{{object|FormatException}}
{{object|PlayerOfflineException}} | Plays a sound at the given source. Source can be a location array (or entity UUID on MC 1.19.3+). The soundArray is in an associative array with the keys: 'sound', 'category', 'volume' (float), 'pitch' (float), 'seed' (int; MC 1.20.2+) -- all are optional except sound. Volume, if greater than 1.0 (default), controls the distance players can hear the sound. Pitch has a clamped range of 0.5 - 2.0, where where 1.0 is the middle pitch and default. Seed is an integer that determines which sound variant is played. Players can be a single player or an array of players to play the sound to, if not given, all players can potentially hear it. Sound is a sound path, separated by periods. [[API/functions/play_named_sound|See more...]]
| Yes |- | [[API/functions/play_note|play_note]]() | void | [player], instrument, note, [locationArray] | {{object|CastException}}
{{object|RangeException}}
{{object|FormatException}}
{{object|PlayerOfflineException}} | Plays a note for the given player, at the given note block location. Player defaults to the current player, and location defaults to the player's location. Instrument may be one of: PIANO, BASS_DRUM, SNARE_DRUM, STICKS, BASS_GUITAR, FLUTE, BELL, GUITAR, CHIME, XYLOPHONE, IRON_XYLOPHONE, COW_BELL, DIDGERIDOO, BIT, BANJO, PLING, ZOMBIE, TRUMPET, TRUMPET_EXPOSED, TRUMPET_OXIDIZED, TRUMPET_WEATHERED, SKELETON, CREEPER, DRAGON, WITHER_SKELETON, PIGLIN, or CUSTOM_HEAD, and note is an associative array with 2 values, array(octave: 0, tone: 'F#') where octave is either 0, 1, or 2, and tone is one of the notes G, A, B, C, D, E, or F, optionally suffixed with a pound symbol, which denotes a sharp. (Not all notes can be sharped.) | Yes |- | [[API/functions/play_sound|play_sound]]() | void | source, soundArray[, players] | {{object|InvalidWorldException}}
{{object|CastException}}
{{object|FormatException}}
{{object|PlayerOfflineException}} | Plays a sound at the given source. Source can be a location array (or entity UUID on MC 1.18.1+). The soundArray is in an associative array with the keys: 'sound' 'category', 'volume' (float), 'pitch' (float), 'seed' (int; MC 1.20.2+) -- all are optional except sound. Volume, if greater than 1.0 (default), controls the distance players can hear the sound. Pitch has a clamped range of 0.5 - 2.0, where where 1.0 is the middle pitch and default. Seed is an integer that determines which sound variant is played. Players can be a single player or an array of players to play the sound to, if not given, all players can potentially hear it. [[API/functions/play_sound|See more...]]
| Yes |- | [[API/functions/set_banner_patterns|set_banner_patterns]]() | void | array location, array patterns | {{object|FormatException}} | Overwrites the banner patterns for the standing banner at the given location. Patterns should be an array of associative arrays containing the keys "color" and "shape". [[API/functions/set_banner_patterns|See more...]]
| Yes |- | [[API/functions/set_biome|set_biome]]() | void | x, z, [world], biome

locationArray, biome | {{object|FormatException}}
{{object|CastException}}
{{object|NotFoundException}}
{{object|InvalidWorldException}} | Sets the biome at a block location. Minecraft only provides one quarter precision for three dimensional biomes, so this sets the nearest center of a 4x4x4 region. When not using a location array, the entire column at the x and z coordinates are set. [[API/functions/set_biome|See more...]]
| Yes |- | [[API/functions/set_block|set_block]]() | void | locationArray, blockName, [physics] | {{object|FormatException}}
{{object|CastException}}
{{object|InvalidWorldException}}
{{object|IllegalArgumentException}} | Sets the block at the location. The physics boolean determines whether or not this causes a block update. Defaults to true. | Yes |- | [[API/functions/set_block_command|set_block_command]]() | void | locationArray, [cmd] | {{object|CastException}}
{{object|FormatException}} | Sets a command to a Command Block at the given location.If no command is given or parameter is null, it clears the Command Block. | Yes |- | [[API/functions/set_block_lock|set_block_lock]]() | void | locationArray, string | {{object|CastException}}
{{object|FormatException}}
{{object|InvalidWorldException}}
{{object|IllegalArgumentException}} | Sets the string lock for this block if its lockable. Set an empty string or null to remove lock. [[API/functions/set_block_lock|See more...]]
| Yes |- | [[API/functions/set_blockdata|set_blockdata]]() | void | locationArray, data, [physics] | {{object|FormatException}}
{{object|CastException}}
{{object|InvalidWorldException}}
{{object|NotFoundException}}
{{object|IllegalArgumentException}} | Sets the block at the location from a blockdata object. Blockdata can be an associative array or string format. If an array, a 'block' key must exist with the block material. All the other keys must be a blockstate and its value. The physics boolean determines whether or not this causes a block update. Defaults to true. | Yes |- | [[API/functions/set_blockdata_string|set_blockdata_string]]() | void | locationArray, data, [physics] | {{object|FormatException}}
{{object|CastException}}
{{object|InvalidWorldException}}
{{object|NotFoundException}}
{{object|IllegalArgumentException}} | Sets the block at the location from a blockdata string. Forward compatibility is not ensured. The physics boolean determines whether or not this causes a block update. Defaults to true. | Yes |- | [[API/functions/set_command_block_name|set_command_block_name]]() | void | locationArray, [name] | {{object|CastException}}
{{object|FormatException}} | Sets the name of the Command Block at the given location.If no name is given or name is null, the Command Block's name is reset to @. | Yes |- | [[API/functions/set_decorated_pot_sherds|set_decorated_pot_sherds]]() | void | locationArray, array | {{object|CastException}}
{{object|FormatException}}
{{object|InvalidWorldException}} | Set the sherds on the sides of a decorated pot. Takes an associative array with a key for each side: 'front', 'back', 'left', and 'right'. Each side accepts a sherd material name, or if no decoration is desired on that side, a brick. Throws a FormatException if a side or material is not valid. | Yes |- | [[API/functions/set_end_gateway_age|set_end_gateway_age]]() | void | gatewayLocation, ticks | {{object|CastException}}
{{object|FormatException}}
{{object|InvalidWorldException}} | Sets an end gateway's age in ticks. A magenta beam is emitted from 0 to 200 ticks (10 seconds). Also a purple beam is emitted very 2400 positive ticks (2 minutes). Setting this to a negative number, like math_const('LONG_MIN'), can be used to prevent beams. | Yes |- | [[API/functions/set_end_gateway_exit|set_end_gateway_exit]]() | void | gatewayLocation, exitLocation, [exactTeleport] | {{object|CastException}}
{{object|FormatException}}
{{object|InvalidWorldException}} | Sets an end gateways teleport exit location. The exit location must be null or a location array with the same world as the end gateway. If exactTeleport is set to true, entities will teleport to the exit's exact block location. Otherwise a teleport location will be found near the exit location. | Yes |- | [[API/functions/set_sign_text|set_sign_text]]() | void | locationArray, [side], lineArray

locationArray, line1, [line2, [line3, [line4]]] | {{object|RangeException}}
{{object|FormatException}} | Sets the text on the side of a sign at the given location. Side can be FRONT (default) or BACK. (MC 1.20+) If the block at x,y,z isn't a sign, a RangeException is thrown. If a text line cannot fit on the sign, it'll be cut off. | Yes |- | [[API/functions/set_sign_text_glowing|set_sign_text_glowing]]() | void | locationArray, [side], isGlowing | {{object|RangeException}}
{{object|FormatException}}
{{object|InvalidWorldException}}
{{object|CastException}} | Sets the text on a sign side to be glowing or not. (MC 1.17+) Side can be FRONT (default) or BACK. (MC 1.20+) | Yes |- | [[API/functions/set_sign_waxed|set_sign_waxed]]() | void | locationArray, boolean | {{object|RangeException}}
{{object|FormatException}}
{{object|InvalidWorldException}}
{{object|CastException}} | Sets a sign to be waxed or not. (MC 1.20.1+) If a sign is waxed, it is not editable by players. | Yes |- | [[API/functions/set_skull_owner|set_skull_owner]]() | void | locationArray, owner, [texture] | {{object|RangeException}}
{{object|FormatException}} | Sets the owner of the skull at the given location by name or uuid. Supplying null will clear the skull owner, but due to limitations in Bukkit, clients will only see this change after reloading the block. If owner is not null, the texture value as a Base64 encoded string may be provided. (Paper only) If no world is provided and the function is executed by a player, the player's world is used. If the block at the given location isn't a skull, a RangeException is thrown. | Yes |- | [[API/functions/spawn_particle|spawn_particle]]() | void | location, particle[, players] | {{object|RangeException}}
{{object|CastException}}
{{object|FormatException}}
{{object|PlayerOfflineException}}
{{object|LengthException}} | Spawns particles at the specified location. The players parameter can be one player or an array of players. If none is given, all players within 32 meters will see the particle. The particle parameter can be a particle name or an associative array defining the characteristics of the particle to be spawned. The array requires the particle name under the key "particle". [[API/functions/spawn_particle|See more...]]
| Yes |}

== EventBinding ==

This class of functions provide methods to hook deep into the server's event architecture

parameterArray

parameter, [parameter...] | {{object|BindException}} | Locks the specified event parameter(s), or all of them, if specified with no arguments. Locked parameters become read only for lower priority event handlers. | Yes |- | [[API/functions/modify_event|modify_event]]() | boolean | parameter, value, [throwOnFailure] | {{object|CastException}}
{{object|BindException}} | Modifies the underlying event object, if applicable. The documentation for each event will explain what parameters can be modified, and what their expected values are. [[API/functions/modify_event|See more...]]
| Yes |- class="hiddenFunction" | [[API/functions/trigger|trigger]]() | void | eventName, eventObject, [serverWide] | {{object|CastException}}
{{object|BindException}} | Manually triggers bound events. The event object passed to this function is sent directly as-is to the bound events. Check the documentation for each event to see what is required. No checks will be done on the data here, but it is not recommended to fail to send all parameters required. If serverWide is true, the event is triggered directly in the server, unless it is a CommandHelper specific event, in which case, serverWide is irrelevant. Defaults to false, which means that only CommandHelper code will receive the event. Throws a CastException when eventObject is not an array and not null. Throws a BindException when trigger() is not yet supported by the given event. | Yes |- | [[API/functions/unbind|unbind]]() | void | [eventID] | {{object|BindException}} | Unbinds an event, which causes it to not run anymore. If called from within an event handler, eventID is optional, and defaults to the current event id. | Yes |}

== Exceptions ==

This class contains functions related to Exception handling in MethodScript

{| class="sticky" |- ! scope="col" width="8%" | Function Name ! scope="col" width="4%" | Returns ! scope="col" width="16%" | Arguments ! scope="col" width="8%" | Throws ! scope="col" width="62%" | Description ! scope="col" width="2%" | Res |- class="hiddenFunction" | [[API/functions/complex_try|complex_try]]() | void | tryBlock, [catchVariable, catchBlock]+, [catchBlock] | | | No |- | [[API/functions/get_stack_trace|get_stack_trace]]() | array | | | Returns an array of stack trace elements. This is the same stack trace that would be generated if one were to throw an exception, then catch it.
([[API/functions/get_stack_trace#Examples|Examples...]]) | Yes |- | [[API/functions/set_uncaught_exception_handler|set_uncaught_exception_handler]]() | closure | closure(@ex) | {{object|CastException}} | Sets the uncaught exception handler, returning the currently set one, or null if none has been set yet. If code throws an exception, instead of doing the default (displaying the error to the user/console) it will run your code instead. The exception that was thrown will be passed to the closure, and it is expected that the closure returns either null, true, or false. [[API/functions/set_uncaught_exception_handler|See more...]]

([[API/functions/set_uncaught_exception_handler#Examples|Examples...]]) | Yes |- | [[API/functions/throw|throw]]() | nothing | exceptionType, msg, [causedBy]

exception | {{object|FormatException}} | This function causes an exception to be thrown. The exceptionType may be any valid exception type. [[API/functions/throw|See more...]]
| No |- | [[API/functions/try|try]]() | void | tryCode, [varName, catchCode, [exceptionTypes]]

tryCode, catchCode | {{object|CastException}}
{{object|FormatException}} | This function works similar to a try-catch block in most languages. If the code in tryCode throws an exception, instead of killing the whole script, it stops running, and begins running the catchCode. var should be an ivariable, and it is set to an array containing information about the exception. Consider using try/catch blocks instead of the try function. [[API/functions/try|See more...]]
| No |}

== ExecutionQueue ==

An execution queue is a queue of closures, which are queued up to be run in sequence by the engine. Unlike set_timeout and set_interval, there is no time component, it's simply a queue of operations to execute sequentially. See the [[Execution_Queue|article on the learning trail]] for more information.

== ExtensionMeta ==

Provides the ability for finding out information about installed extensions, including events and functions.

== FileHandling ==

This class contains methods that help manage files on the file system. Most are restricted with the base-dir setting in your preferences.

== InventoryManagement ==

Provides methods for managing inventory related tasks.

{| class="sticky" |- ! scope="col" width="8%" | Function Name ! scope="col" width="4%" | Returns ! scope="col" width="16%" | Arguments ! scope="col" width="8%" | Throws ! scope="col" width="62%" | Description ! scope="col" width="2%" | Res |- | [[API/functions/add_to_inventory|add_to_inventory]]() | int | mixed specifier, array itemArray | {{object|CastException}}
{{object|FormatException}}
{{object|BadEntityException}}
{{object|InvalidWorldException}}
{{object|IllegalArgumentException}}
{{object|NotFoundException}}
{{object|RangeException}} | Add to inventory the specified item. The specifier must be a location array, entity UUID, or virtual inventory id. The items are distributed in the inventory, first filling up slots that have the same item type, up to the max stack size, then fills up empty slots, until either the entire inventory is filled, or the entire amount has been given. If the inventory is full, number of items that were not added is returned, which will be less than or equal to the quantity provided. Otherwise, returns 0.
([[API/functions/add_to_inventory#Examples|Examples...]]) | Yes |- | [[API/functions/clear_pinv|clear_pinv]]() | void | [player] | {{object|PlayerOfflineException}}
{{object|LengthException}}
{{object|NotFoundException}} | Clears a player's entire inventory (including armor). | Yes |- | [[API/functions/close_pinv|close_pinv]]() | void | [player] | {{object|PlayerOfflineException}}
{{object|LengthException}} | Closes the inventory of the current player, or of the specified player. | Yes |- | [[API/functions/create_virtual_inventory|create_virtual_inventory]]() | void | id, [type/size], [title], [inventory] | {{object|RangeException}}
{{object|CastException}}
{{object|FormatException}}
{{object|IllegalArgumentException}} | Creates a virtual inventory and holds it under the specified id. The string id should not be a UUID. If the id is already in use, an IllegalArgumentException will be thrown. You can use this id in other inventory functions to modify the contents, among other things. If a size is specified instead of a type, it is rounded up to the nearest multiple of 9. Size cannot be higher than 54. A title for the top of the inventory may be given, but it will use the default for that that inventory type if null is specified. An optional inventory array may be specified, otherwise the inventory will start empty. Available inventory types: BREWING, CHEST, DISPENSER, DROPPER, ENDER_CHEST, FURNACE, HOPPER, PLAYER, WORKBENCH, ANVIL, SMITHING, SHULKER_BOX, BARREL, BLAST_FURNACE or SMOKER | Yes |- | [[API/functions/delete_virtual_inventory|delete_virtual_inventory]]() | boolean | id | | Deletes a virtual inventory. The inventory will be closed for all viewers. Returns whether or not an inventory with that id existed and was removed. | Yes |- | [[API/functions/get_inventory|get_inventory]]() | array | specifier, [index] | {{object|CastException}}
{{object|RangeException}}
{{object|FormatException}}
{{object|BadEntityException}}
{{object|InvalidWorldException}}
{{object|IllegalArgumentException}} | Gets an array of the specified inventory. If the block or entity can't have an inventory, an IllegalArgumentException is thrown. If the index is specified, only the slot given will be returned. The max index of the array in the array is different for different types of inventories. If there is no item at the slot specified, null is returned. [[API/functions/get_inventory|See more...]]
| Yes |- | [[API/functions/get_inventory_item|get_inventory_item]]() | array | specifier, slot | {{object|FormatException}}
{{object|BadEntityException}}
{{object|InvalidWorldException}}
{{object|CastException}}
{{object|RangeException}}
{{object|IllegalArgumentException}} | If a number is provided, it is assumed to be an entity, and if the entity supports inventories, it will be valid. Otherwise, if a location array is provided, it is assumed to be a block (chest, brewer, etc) and interpreted thusly. Depending on the inventory type, the max index will vary. If the index is too large, a RangeException is thrown, otherwise, the item at that location is returned as an item array, or null, if no item is there. You can determine the inventory type (and thus the max index count) with get_inventory_type(). An itemArray, like the one used by pinv/set_pinv is returned. | Yes |- | [[API/functions/get_inventory_name|get_inventory_name]]() | string | specifier | {{object|BadEntityException}}
{{object|CastException}}
{{object|FormatException}}
{{object|InvalidWorldException}}
{{object|IllegalArgumentException}} | Returns the name of the inventory holder specified. If the block or entity can't have an inventory or a name, an IllegalArgumentException is thrown. If the inventory was not given a title, an empty string is returned. | Yes |- | [[API/functions/get_inventory_size|get_inventory_size]]() | int | specifier | {{object|FormatException}}
{{object|BadEntityException}}
{{object|InvalidWorldException}}
{{object|CastException}}
{{object|IllegalArgumentException}} | Returns the max size of the inventory specified. If the block or entity can't have an inventory, an IllegalArgumentException is thrown. | Yes |- | [[API/functions/get_inventory_type|get_inventory_type]]() | string | specifier | {{object|CastException}}
{{object|FormatException}}
{{object|BadEntityException}}
{{object|InvalidWorldException}}
{{object|IllegalArgumentException}} | Returns the inventory type at the location specified, or of the entity specified. If the entity or location specified is not capable of having an inventory, an IllegalArgumentException is thrown. [[API/functions/get_inventory_type|See more...]]
| Yes |- | [[API/functions/get_inventory_viewers|get_inventory_viewers]]() | array | specifier | {{object|FormatException}}
{{object|BadEntityException}}
{{object|InvalidWorldException}}
{{object|CastException}}
{{object|IllegalArgumentException}} | Gets all players currently viewing this inventory. The specifier can be an entity UUID, block location array, or virtual inventory id. | Yes |- | [[API/functions/get_virtual_inventories|get_virtual_inventories]]() | array | | | Returns an array of virtual inventory ids. | Yes |- | [[API/functions/has_inventory|has_inventory]]() | boolean | specifier | {{object|FormatException}}
{{object|BadEntityException}}
{{object|InvalidWorldException}}
{{object|CastException}}
{{object|RangeException}}
{{object|IllegalArgumentException}} | Returns whether the specified entity or location has an inventory. The specifier can be an entity UUID, location array, or virtual inventory ID. If given the id of a virtual inventory that doesn't exist, false will be returned. | Yes |- | [[API/functions/penchanting|penchanting]]() | void | [player] | {{object|PlayerOfflineException}}
{{object|LengthException}} | Shows an enchanting to the current player, or a specified player. Note that power is defined by how many bookcases are near. | Yes |- | [[API/functions/penderchest|penderchest]]() | array | [player, [index]] | {{object|PlayerOfflineException}}
{{object|LengthException}}
{{object|CastException}}
{{object|RangeException}}
{{object|NotFoundException}} | Gets the inventory for the specified player's enderchest, or the current player if none specified. If the index is specified, only the slot given will be returned. The index of the array in the array is 0 - 26, which corresponds to the slot in the enderchest inventory. If there is no item at the slot specified, null is returned. [[API/functions/penderchest|See more...]]
| Yes |- | [[API/functions/pgive_enderchest_item|pgive_enderchest_item]]() | int | [player], itemArray | {{object|FormatException}}
{{object|CastException}}
{{object|RangeException}}
{{object|PlayerOfflineException}}
{{object|NotFoundException}}
{{object|IllegalArgumentException}}
{{object|LengthException}} | Adds the specified item to a player's enderchest. Unlike {{function|set_penderchest}}, this does not use a specific slot. The items are distributed in the player's inventory, first filling up slots that have the same items, up to the max stack size, then fills up empty slots, until either the entire inventory is filled or the entire amount has been given. If the player's enderchest is full, the number of items that were not added is returned, which will be less than or equal to the quantity provided. Otherwise, returns 0. | Yes |- | [[API/functions/pgive_item|pgive_item]]() | int | [player], itemArray | {{object|CastException}}
{{object|FormatException}}
{{object|PlayerOfflineException}}
{{object|NotFoundException}}
{{object|IllegalArgumentException}}
{{object|LengthException}}
{{object|InsufficientArgumentsException}} | Gives a player the specified item. Unlike set_pinv(), this does not specify a slot. The qty is distributed in the player's inventory, first filling up slots that have the same item type, up to the max stack size, then fills up empty slots, until either the entire inventory is filled, or the entire amount has been given. If the player's inv is full, the number of items that were not added is returned, which will be less than or equal to the quantity provided. Otherwise, returns 0. This function will not touch the player's armor slots however. | Yes |- | [[API/functions/phas_item|phas_item]]() | int | [player], itemArray | {{object|PlayerOfflineException}}
{{object|FormatException}}
{{object|RangeException}}
{{object|CastException}}
{{object|NotFoundException}}
{{object|LengthException}} | Returns the quantity of the specified item that the player is carrying (including armor slots). This counts across all slots in inventory. Recall that 0 is false, and anything else is true, so this can be used to get the total, or just see if they have the item. [[API/functions/phas_item|See more...]]

([[API/functions/phas_item#Examples|Examples...]]) | Yes |- | [[API/functions/pheld_slot|pheld_slot]]() | int | [player] | {{object|PlayerOfflineException}}
{{object|LengthException}}
{{object|FormatException}}
{{object|NotFoundException}} | Returns the selected quickbar slot of the given or executing player. The slot number is in range of [0-8]. | Yes |- | [[API/functions/pinv|pinv]]() | array | [player, [slot]] | {{object|PlayerOfflineException}}
{{object|LengthException}}
{{object|CastException}}
{{object|RangeException}}
{{object|NotFoundException}} | Gets the inventory for a player, or the current player if none specified. If the slot is specified, only the item in the slot given will be returned. The indexes of the array are 0 - 35, 100 - 103, -106, which corresponds to the slots in the player's inventory. To access armor slots, you may also specify the slot index. (100 - 103). The quick bar is 0 - 8. If slot is null, the item in the player's hand is returned, regardless of what slot is selected. If index is -106, the player's off-hand item is returned. If there is no item at the slot specified, null is returned. [[API/functions/pinv|See more...]]
| Yes |- | [[API/functions/pinv_open|pinv_open]]() | void | [playerToShow,] playerInventory | {{object|PlayerOfflineException}}
{{object|LengthException}} | Opens a player's inventory, shown to the player specified's screen. | Yes |- | [[API/functions/pinventory_holder|pinventory_holder]]() | mixed | [player] | {{object|PlayerOfflineException}}
{{object|FormatException}}
{{object|BadEntityException}}
{{object|InvalidWorldException}}
{{object|CastException}}
{{object|LengthException}} | Returns the block location, entity UUID, or virtual id of the inventory the player is currently viewing. If the player is viewing their own inventory or no inventory, the player's UUID is returned. When the inventory is virtual but has no id, it will return null. The returned value can be used in other inventory functions unless it is null. | Yes |- | [[API/functions/pitem_slot|pitem_slot]]() | array | [player], itemArray | {{object|CastException}}
{{object|FormatException}}
{{object|LengthException}}
{{object|PlayerOfflineException}}
{{object|NotFoundException}} | Given an item array, returns the slot numbers that the matching item has at least one item in. [[API/functions/pitem_slot|See more...]]

([[API/functions/pitem_slot#Examples|Examples...]]) | Yes |- | [[API/functions/popen_inventory|popen_inventory]]() | void | [player], specifier | {{object|PlayerOfflineException}}
{{object|FormatException}}
{{object|BadEntityException}}
{{object|InvalidWorldException}}
{{object|CastException}}
{{object|LengthException}}
{{object|IllegalArgumentException}} | Opens an inventory for a player. The specifier must be an entity UUID, location array of a container block, or a virtual inventory id. | Yes |- | [[API/functions/ptake_enderchest_item|ptake_enderchest_item]]() | int | [player], itemArray | {{object|CastException}}
{{object|PlayerOfflineException}}
{{object|LengthException}}
{{object|FormatException}}
{{object|NotFoundException}}
{{object|RangeException}} | Works in reverse of pgive_enderchest_item(), but returns the number of items actually taken, which will be from 0 to qty. [[API/functions/ptake_enderchest_item|See more...]]

([[API/functions/ptake_enderchest_item#Examples|Examples...]]) | Yes |- | [[API/functions/ptake_item|ptake_item]]() | int | [player], itemArray | {{object|CastException}}
{{object|PlayerOfflineException}}
{{object|RangeException}}
{{object|FormatException}}
{{object|NotFoundException}}
{{object|LengthException}} | Works in reverse of pgive_item(), but returns the number of items actually taken, which will be from 0 to qty. [[API/functions/ptake_item|See more...]]

([[API/functions/ptake_item#Examples|Examples...]]) | Yes |- | [[API/functions/pworkbench|pworkbench]]() | void | [player] | {{object|PlayerOfflineException}}
{{object|LengthException}}
{{object|InsufficientArgumentsException}} | Shows a workbench to the current player, or a specified player. | Yes |- | [[API/functions/set_inventory|set_inventory]]() | void | specifier, invArray | {{object|CastException}}
{{object|FormatException}}
{{object|BadEntityException}}
{{object|InvalidWorldException}}
{{object|RangeException}}
{{object|IllegalArgumentException}} | Sets a block or entity inventory to the specified inventory object. The specifier can be an entity UUID, location array, or virtual inventory ID. If the block or entity can't have an inventory, an IllegalArgumentException is thrown. An inventory object invArray is one that matches what is returned by get_inventory(), so set_inventory(123, get_inventory(123)) while pointless, would be a correct call. [[API/functions/set_inventory|See more...]]
| Yes |- | [[API/functions/set_inventory_item|set_inventory_item]]() | void | specifier, index, itemArray | {{object|FormatException}}
{{object|BadEntityException}}
{{object|InvalidWorldException}}
{{object|CastException}}
{{object|RangeException}}
{{object|IllegalArgumentException}} | Sets the specified item in the specified inventory slot. The specifier can be an entity UUID, block location array or virtual inventory id. [[API/functions/set_inventory_item|See more...]]
| Yes |- | [[API/functions/set_penderchest|set_penderchest]]() | void | [player], invArray | {{object|PlayerOfflineException}}
{{object|CastException}}
{{object|FormatException}}
{{object|LengthException}} | Sets a player's enderchest's inventory to the specified inventory object. An inventory object is one that matches what is returned by penderchest(), so set_penderchest(penderchest()), while pointless, would be a correct call. [[API/functions/set_penderchest|See more...]]
| Yes |- | [[API/functions/set_pheld_slot|set_pheld_slot]]() | void | [player], slotNumber | {{object|RangeException}}
{{object|PlayerOfflineException}}
{{object|FormatException}}
{{object|NotFoundException}}
{{object|LengthException}} | Sets the selected quickbar slot of the given or executing player to the given slot. The slot number is in range of [0-8]. | Yes |- | [[API/functions/set_pinv|set_pinv]]() | void | [player, [slot]], array | {{object|PlayerOfflineException}}
{{object|CastException}}
{{object|FormatException}}
{{object|LengthException}} | Sets a player's inventory to the specified inventory array. An inventory array is one that matches what is returned by {{function|pinv}}, so set_pinv(pinv()), while pointless, would be a correct call (though some item meta may not yet be supported). If a slot is specified as the second argument, only that slot is set with the given item array. [[API/functions/set_pinv|See more...]]
| Yes |- | [[API/functions/show_enderchest|show_enderchest]]() | void | [player [, player]] | {{object|PlayerOfflineException}}
{{object|LengthException}} | Shows the enderchest of either the current player or the specified player if given. If a second player is specified, shows the second player the contents of the first player's enderchest. | Yes |- | [[API/functions/take_from_inventory|take_from_inventory]]() | int | specifier, itemArray

specifier, itemID, qty | {{object|CastException}}
{{object|FormatException}}
{{object|BadEntityException}}
{{object|InvalidWorldException}}
{{object|RangeException}}
{{object|NotFoundException}}
{{object|IllegalArgumentException}} | Works in reverse of add_to_inventory(), but returns the number of items actually taken, which will be from 0 to qty. Target must be a location array or entity UUID. [[API/functions/take_from_inventory|See more...]]

([[API/functions/take_from_inventory#Examples|Examples...]]) | Yes |}

== ItemMeta ==

These functions manipulate an item's meta data. The items are modified in a player's inventory.

== Marquee ==

This class provides methods for making a text "marquee", like a stock ticker. Because this is a threading operation, and could be potentially resource intensive, the heavy lifting has been implemented natively.

== Math ==

Provides mathematical functions to scripts

min/max, [max] | {{object|RangeException}}
{{object|CastException}} | Returns a random number from 0 to max or min to max, depending on usage. Max is exclusive. Min must be less than max. This will return an integer. If no arguments are given, a random double from 0.0 to 1.0 (exclusive) will be returned.
([[API/functions/rand#Examples|Examples...]]) | No |- | [[API/functions/round|round]]() | double | number, [precision] | {{object|CastException}}
{{object|RangeException}} | Unlike floor and ceil, rounds the number to the nearest double that is equal to an integer. Precision defaults to 0, but if set to 1 or more, rounds decimal places. For instance, round(2.29, 1) would return 2.3. If precision is < 0, a RangeException is thrown.
([[API/functions/round#Examples|Examples...]]) | No |- | [[API/functions/round15|round15]]() | double | value | {{object|CastException}} | Rounds value to the 15th place. This is useful when doing math using approximations. For instance, sin(math_const('PI')) returns 1.2246467991473532E-16, but sin of pi is actually 0. This happens because pi cannot be accurately represented on a computer, it is an approximation. Using round15, you can round to the next nearest value, which often time should give a more useful answer to display. For instance, round15(sin(math_const('PI'))) is 0. This functionality is not provided by default in methods like sin(), because it technically makes the result less accurate, given the inputs. In general, you should only use this function just before displaying the value to the user. Internally, you should keep the value returned by the input functions.
([[API/functions/round15#Examples|Examples...]]) | No |- | [[API/functions/sin|sin]]() | double | number | {{object|CastException}} | Returns the sin of the number | No |- | [[API/functions/sinh|sinh]]() | double | number | {{object|CastException}} | Returns the hyperbolic sine of the number | No |- | [[API/functions/sqrt|sqrt]]() | number | number | {{object|RangeException}}
{{object|CastException}} | Returns the square root of a number. Note that this is mathematically equivalent to pow(number, .5). Imaginary numbers are not supported, so number must be positive. | No |- | [[API/functions/subtract|subtract]]() | mixed | var1, [var2...] | {{object|CastException}} | Subtracts the arguments from left to right, and returns either a double or an integer. Operator syntax is also supported: @a - @b
([[API/functions/subtract#Examples|Examples...]]) | No |- | [[API/functions/tan|tan]]() | double | number | {{object|CastException}} | Returns the tan of the number | No |- | [[API/functions/tanh|tanh]]() | double | number | {{object|CastException}} | Returns the hyperbolic tangent of the number | No |- | [[API/functions/to_degrees|to_degrees]]() | double | number | {{object|CastException}} | Converts the number to degrees (which is assumed to have been in radians) | No |- | [[API/functions/to_radians|to_radians]]() | double | number | {{object|CastException}} | Converts the number to radians (which is assumed to have been in degrees) | No |}

== MatrixHandling ==

Contains functions related to matrices. The general format of a matrix object is either a Real2dMatrix object, or an array of two parameters, dimensions, and data. Dimensions is an array of dimensions, indicating the size of each dimension. The data parameter contains the actual matrix data, stored in row-major order. Currently, only 2 dimensional arrays of real numbers are supported. Dimension sizes must be 32 bit integers. The data array contains doubles, and the size of this array must be equal to the dimension values multiplied together. Matrix operations done via a Real2dMatrix object will be faster than equivalent operations directly on an array. If you have a flat array, use matrix_create() to convert it into a matrix object.

array left, Real2dMatrix

array right | {{object|IllegalArgumentException}}
{{object|CastException}} | Adds the right matrix to the left. The underlying left matrix object is modified in place if it is a Real2dMatrix, but a reference is always returned. | No |- | [[API/functions/matrix_can_add|matrix_can_add]]() | boolean | Real2dMatrix

array left, Real2dMatrix

array right | {{object|CastException}} | Returns true if the two matrices can be added (or subtracted). That is, are the dimensions of both matrices equal. | No |- | [[API/functions/matrix_can_multiply|matrix_can_multiply]]() | boolean | Real2dMatrix

array left, Real2dMatrix

array right | {{object|CastException}} | Returns true if matrix multiplication would succed for the two matrices. That is, true if the column count of the left matrix matches the row count of the right matrix | No |- | [[API/functions/matrix_clone|matrix_clone]]() | Real2dMatrix | Real2dMatrix matrix | {{object|CastException}} | Clones the matrix. This clone is a deep copy, fully independent from the source matrix. | No |- | [[API/functions/matrix_create|matrix_create]]() | Real2dMatrix | array matrixObject

array matrix, int rows, int columns | {{object|CastException}}
{{object|RangeException}} | Creates a Real2dMatrix object from a flat array of doubles. The matrix may instead be null, and a matrix of all zeros will be created with the specified row and column count. If an array is passed in, the length of the array must be equal to rows * columns, or a RangeException is thrown. Alternatively, if the underlying array is a matrix object (an associative array with a dimensions and data property) it is converted to a Real2dMatrix object. | No |- | [[API/functions/matrix_determinant|matrix_determinant]]() | double | Real2dMatrix

array matrix | {{object|CastException}}
{{object|RangeException}} | Returns the determinant of the matrix, that is, the product of the main diagonal, minus the product of the other diagonal. This throws a RangeException if the matrix is not square. | No |- | [[API/functions/matrix_equals|matrix_equals]]() | boolean | Real2dMatrix

array left, Real2dMatrix

array right, double tolerance | {{object|CastException}} | Returns true if the two matrices are equal to each other, within the given tolerance. | No |- | [[API/functions/matrix_format|matrix_format]]() | string | Real2dMatrix

array matrix, string format = '%.3f' | {{object|CastException}} | Returns a human readable representation of the matrix, formatting the numbers according to the format, by default '%.3f'. See sprintf for full formatting rules.
([[API/functions/matrix_format#Examples|Examples...]]) | No |- | [[API/functions/matrix_get_column|matrix_get_column]]() | array | Real2dArray

array matrix, int column | {{object|CastException}}
{{object|RangeException}} | Gets the specified zero indexed column of the matrix, as an array. A RangeException is thrown if the specified value exceeds the | No |- | [[API/functions/matrix_identity|matrix_identity]]() | Real2dMatrix | int size | {{object|CastException}} | Returns a new identity matrix of the given size. The size value is a single dimension, the other dimension will be the same size, as all identity matrices are square. | No |- | [[API/functions/matrix_is_square|matrix_is_square]]() | boolean | Real2dMatrix

array matrix | {{object|CastException}} | Returns true if the matrix is square, that is the row and column count are the same. | No |- | [[API/functions/matrix_multiply|matrix_multiply]]() | Real2dMatrix | Real2dMatrix

array left, Real2dMatrix

array right | {{object|IllegalArgumentException}}
{{object|CastException}} | Performs matrix multiplication between this matrix and the specified matrix. A new matrix is returned. The column count of the left matrix must match the row count of the right matrix, or a IllegalArgumentException is thrown. | No |- | [[API/functions/matrix_norm|matrix_norm]]() | double | Real2dMatrix

array matrix | {{object|CastException}} | Returns the Frobinius norm of the matrix, that is, the square root of the sum of the squares of all elements. | No |- | [[API/functions/matrix_scalar_multiply|matrix_scalar_multiply]]() | void | Real2dMatrix

array matrix, double scalar | {{object|CastException}} | Does scalar multiplication on the matrix. The underlying left matrix object is modified in place if it is a Real2dMatrix, but a reference is always returned. | No |- | [[API/functions/matrix_submatrix|matrix_submatrix]]() | Real2dMatrix | Real2dMatrix

array matrix, int row, int column | {{object|RangeException}}
{{object|CastException}} | Creates a submatrix by deleting the given row and column. A new matrix is returned. If either row or column are negative, only the other will be deleted. If both are negative, or either is greater than the dimensions of the matrix, a range exception is thrown. | No |- | [[API/functions/matrix_subtract|matrix_subtract]]() | void | Real2dMatrix

array left, Real2dMatrix

array right | {{object|IllegalArgumentException}}
{{object|CastException}} | Subtracts the right matrix from the left. The underlying left matrix object is modified in place if it is a Real2dMatrix, but a reference is always returned. | No |- | [[API/functions/matrix_to_array|matrix_to_array]]() | array | Real2dMatrix matrix | {{object|CastException}} | Converts a Real2dMatrix object into an array. Note that matrices implement ArrayAccess, so this step is not generally necessary just to access elements of the matrix. The returned array will have two keys, dimensions, and data. Dimensions will be a length 2 array of integers, containing the row and column count, and data is a flat array containing the doubles. | No |- | [[API/functions/matrix_trace|matrix_trace]]() | double | Real2dMatrix

array matrix | {{object|CastException}}
{{object|RangeException}} | Returns the trace of the matrix, that is, the sum of the values on the diagonal. This throws a RangeException if the matrix is not square. | No |- | [[API/functions/matrix_transpose|matrix_transpose]]() | Real2dMatrix | array

Real2dMatrix matrix | {{object|CastException}} | Transposes a matrix. Transposing a matrix inverts the matrix about the diagonal, changing the length of dimensions (if they are different). The underlying matrix object is modified in place if it is a Real2dMatrix, but a reference is always returned. | No |}

== Meta ==

These functions provide a way to run other commands, and otherwise interact with the system in a meta way.

== Minecraft ==

These functions provide a hook into game functionality.

== MobManagement ==

These functions manage specifically living entities. If the entity specified is not living, a BadEntityTypeException will be thrown.

entityUUID, attribute, id | {{object|CastException}}
{{object|LengthException}}
{{object|FormatException}}
{{object|BadEntityTypeException}}
{{object|BadEntityException}} | Removes an attribute modifier from an entity. Can provide either a modifier array or just the attribute and namespaced id of the modifier. | Yes |- | [[API/functions/reset_entity_attribute_base|reset_entity_attribute_base]]() | void | entityUUID, attribute | {{object|CastException}}
{{object|LengthException}}
{{object|FormatException}}
{{object|BadEntityTypeException}}
{{object|BadEntityException}} | Resets the base attribute value to the default for this entity. [[API/functions/reset_entity_attribute_base|See more...]]
| Yes |- | [[API/functions/set_can_pickup_items|set_can_pickup_items]]() | void | entityUUID, boolean | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Sets a living entity's ability to pick up items. | Yes |- | [[API/functions/set_entity_ai|set_entity_ai]]() | void | entityUUID, boolean | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | enables or disables the entity AI. | Yes |- | [[API/functions/set_entity_air|set_entity_air]]() | void | entityUUID, int | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Sets the amount of air the specified living entity has remaining. | Yes |- | [[API/functions/set_entity_attribute_base|set_entity_attribute_base]]() | void | entityUUID, attribute, value | {{object|CastException}}
{{object|LengthException}}
{{object|FormatException}}
{{object|BadEntityTypeException}}
{{object|BadEntityException}} | Sets the base value for the entity attribute. Accepts a double as the value. [[API/functions/set_entity_attribute_base|See more...]]
| Yes |- | [[API/functions/set_entity_breedable|set_entity_breedable]]() | void | entityUUID, boolean | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Set an entity to be breedable. | Yes |- | [[API/functions/set_entity_gliding|set_entity_gliding]]() | void | entityUUID, boolean | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | If possible, makes the entity glide. | Yes |- | [[API/functions/set_entity_health|set_entity_health]]() | void | entityUUID, healthPercent | {{object|CastException}}
{{object|BadEntityException}}
{{object|RangeException}}
{{object|LengthException}} | Sets the specified entity's health as a percentage, where 0 kills it and 100 gives it full health. An exception is thrown if the entity by that UUID doesn't exist or isn't a LivingEntity. | Yes |- | [[API/functions/set_entity_immunity_ticks|set_entity_immunity_ticks]]() | void | entityUUID, int | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Sets the number of immunity ticks a living entity has remaining. | Yes |- | [[API/functions/set_entity_max_air|set_entity_max_air]]() | void | entityUUID, int | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Sets the maximum amount of air the specified living entity can have. | Yes |- | [[API/functions/set_entity_persistence|set_entity_persistence]]() | void | entityUUID, boolean | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Sets whether a living entity will despawn when players are far enough away. | Yes |- | [[API/functions/set_equipment_droprates|set_equipment_droprates]]() | void | entityUUID, array | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Sets the drop chances for each equipment slot on a mob, but does not work on players. Passing null instead of an array will automatically set all rates to 0.0, which will cause nothing to drop. A rate of 1.0 will guarantee a drop if the entity is killed by a player. A rate above 1.0 will guarantee a drop by any cause. Non-mobs, like players and armor stands, cannot have their drop-rates modified. | Yes |- | [[API/functions/set_leashholder|set_leashholder]]() | void | entityUUID, holderUUID | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | The first argument is the entity to be held on a leash, and must be a mob or a boat. The second is the holder of the leash and can be many types of entities, notably a leash hitch. Certain entity types may be excluded from being leashed depending on the Minecraft version. Boats are only supported on Paper 1.21.3+ and Spigot 1.21.10+. | Yes |- | [[API/functions/set_max_health|set_max_health]]() | void | entityUUID, double | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Sets the max health of a living entity, players included. This value is persistent, and will not reset even after server restarts.
([[API/functions/set_max_health#Examples|Examples...]]) | Yes |- | [[API/functions/set_mob_age|set_mob_age]]() | void | entityUUID, int[, lockAge] | {{object|UnageableMobException}}
{{object|CastException}}
{{object|BadEntityException}}
{{object|LengthException}} | sets the age of the mob to the specified int, and locks it at that age if lockAge is true, but by default it will not. Throws a UnageableMobException if the mob does not age naturally. | Yes |- | [[API/functions/set_mob_collidable|set_mob_collidable]]() | void | entityUUID, boolean | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Sets whether or not other entities will collide with this mob. | Yes |- | [[API/functions/set_mob_effect|set_mob_effect]]() | boolean | entityUUID, potionEffect, [strength], [seconds], [ambient], [particles] | {{object|LengthException}}
{{object|FormatException}}
{{object|BadEntityException}}
{{object|RangeException}} | Adds one, or modifies an existing, potion effect on a mob. The potionEffect can be SLOWNESS, INVISIBILITY, SLOW_FALLING, BAD_OMEN, WEAKNESS, DOLPHINS_GRACE, INSTANT_DAMAGE, BREATH_OF_THE_NAUTILUS, MINING_FATIGUE, TRIAL_OMEN, SPEED, WITHER, LUCK, FIRE_RESISTANCE, WIND_CHARGED, WATER_BREATHING, GLOWING, OOZING, ABSORPTION, HUNGER, BAD_LUCK, HERO_OF_THE_VILLAGE, REGENERATION, INFESTED, WEAVING, STRENGTH, BLINDNESS, LEVITATION, CONDUIT_POWER, RAID_OMEN, JUMP_BOOST, POISON, NAUSEA, RESISTANCE, HEALTH_BOOST, DARKNESS, NIGHT_VISION, INSTANT_HEALTH, HASTE, or SATURATION. It also accepts an integer corresponding to the effect id listed on the Minecraft wiki. Strength is an integer representing the power level of the effect, starting at 0. Seconds defaults to 30.0. To remove an effect, set the seconds to 0. If seconds is greater than 107374182 a RangeException is thrown. Negative seconds makes the effect infinite. (or max in versions prior to 1.19.4) Ambient takes a boolean of whether the particles should be more transparent. Particles takes a boolean of whether the particles should be visible at all. The function returns whether or not the effect was modified. | Yes |- | [[API/functions/set_mob_equipment|set_mob_equipment]]() | void | entityUUID, array | {{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Takes an associative array with keys representing equipment slots and values of item arrays. The equipment slots are: weapon, off_hand, helmet, chestplate, leggings, boots, body (MC 1.20.6+), and saddle (MC 1.21.5+). This works on mobs, players, mannequins, and armor stands. While you may set any slot for any of these entities, some slots are not used by some entities. Setting unused slots is not officially supported behavior, so your results may vary.
([[API/functions/set_mob_equipment#Examples|Examples...]]) | Yes |- | [[API/functions/set_mob_love_ticks|set_mob_love_ticks]]() | void | entityUUID, int | {{object|BadEntityTypeException}}
{{object|CastException}}
{{object|BadEntityException}}
{{object|LengthException}} | Sets the number of ticks that this mob will be in love mode. | Yes |- | [[API/functions/set_mob_owner|set_mob_owner]]() | void | entityUUID, player | {{object|UntameableMobException}}
{{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Sets the tameable mob to the specified player. The player argument supports offline players, so it should be a UUID or an exact player name. Setting the player to null will untame the mob. | Yes |- | [[API/functions/set_mob_target|set_mob_target]]() | void | entityUUID, entityUUID | {{object|BadEntityException}}
{{object|LengthException}} | The first is the entity that is targeting, the second is the target. It can also be set to null to clear the current target. Not all mobs can have their target set. | Yes |}

== OAuth ==

This class provides methods for interfacing with OAuth providers.

== OS ==

Contains various methods for interacting with the Operating System. Some of the functions deal with OS specific mechanisms.

== ObjectManagement ==

Provides functions for creating and using objects. None of these methods should normally be used, all of them provide easier to use compiler support.

{| class="sticky" |- ! scope="col" width="8%" | Function Name ! scope="col" width="4%" | Returns ! scope="col" width="16%" | Arguments ! scope="col" width="8%" | Throws ! scope="col" width="62%" | Description ! scope="col" width="2%" | Res |- class="hiddenFunction" | [[API/functions/define_object|define_object]]() | void | AccessModifier accessModifier, array objectModifiers, ObjectType objectType, string objectName, array superclasses, array interfaces, ? enumList, map elementList, array annotations, ClassType containingClass, string classComment, array genericParameters | {{object|ClassDefinitionError}} | Defines a new object. Not meant for normal use. | Yes |- class="hiddenFunction" | [[API/functions/new_object|new_object]]() | T | ClassType type, params... | | Constructs a new object of the specified type. The type must be hardcoded. | No |}

== Performance ==

This class provides functions for hooking into CommandHelper's powerful Performance measuring. To use the functions, you must have allow-profiling option set to true in your preferences file.

== Permissions ==

Provides access to the server's underlying permissions system. Permissions functionality is only as good as the management system in place, however, and so not all functions may be supported on a given system.

== Persistence ==

Allows scripts to store data from execution to execution. See the guide on [[Persistence_Network|persistence]] for more information. In all the functions, you may send multiple arguments for the key, which will automatically be concatenated with a period (the namespace separator). No magic happens here, you can put periods yourself, or combine manually namespaced values or automatically namespaced values with no side effects. All the functions in the Persistence API are threadsafe (though not necessarily process safe).

== PlayerManagement ==

This class of functions allow players to be managed. Functions that accept an online player's name will also accept their UUID.

yaw, pitch

player, F

player, yaw, pitch

player

<none> | {{object|PlayerOfflineException}}
{{object|RangeException}}
{{object|CastException}}
{{object|NotFoundException}} | Gets or sets the direction the player is facing. [[API/functions/pfacing|See more...]]
| Yes |- | [[API/functions/pfirst_played|pfirst_played]]() | int | [player] | | Returns the unix time stamp, in milliseconds, that this player first logged onto this server, or 0 if they never have. The player argument can be a UUID or a name. But if given a name, it must be exact.
([[API/functions/pfirst_played#Examples|Examples...]]) | Yes |- | [[API/functions/pflying|pflying]]() | boolean | [player] | {{object|PlayerOfflineException}}
{{object|LengthException}} | Gets the flying state for the player. | Yes |- | [[API/functions/pfood|pfood]]() | int | [player] | {{object|PlayerOfflineException}} | Returns the player's current food level. | Yes |- | [[API/functions/pforce_respawn|pforce_respawn]]() | void | [player] | {{object|PlayerOfflineException}}
{{object|LengthException}} | Forces a player to respawn immediately if they're currently dead. | Yes |- | [[API/functions/pget_time|pget_time]]() | int | [player] | {{object|PlayerOfflineException}} | Returns the time of the specified player, as an integer in ticks from 0 to 23999. As of MC 26.1 non-overworld dimensions do not have a world clock and will return 0 unless modified for this player. | Yes |- | [[API/functions/pgive_recipe|pgive_recipe]]() | int | [player], recipeKey(s) | {{object|PlayerOfflineException}}
{{object|LengthException}}
{{object|FormatException}} | Adds one or more recipes to a player's recipe book. Can take a single recipe key or an array of keys. Returns how many recipes were newly discovered. | Yes |- | [[API/functions/pgroup|pgroup]]() | array | [playerName] | {{object|PlayerOfflineException}} | Returns an array of the groups a player is in. If playerName is omitted, the current player is used. This relies on "group.groupname" permission nodes in your permissions plugin. Otherwise an extension is required to get the groups from the plugin. | Yes |- | [[API/functions/phas_flight|phas_flight]]() | boolean | [player] | {{object|PlayerOfflineException}} | Returns whether or not the player has the ability to fly. | Yes |- | [[API/functions/phas_played|phas_played]]() | boolean | player | | Returns whether the given player has ever been on this server. The player argument can be a UUID or a name. But if given a name, it must be exact.
([[API/functions/phas_played#Examples|Examples...]]) | Yes |- | [[API/functions/phas_recipe|phas_recipe]]() | boolean | [player], recipeKey | {{object|PlayerOfflineException}}
{{object|LengthException}}
{{object|FormatException}} | Gets whether a player has a recipe in their recipe book. | Yes |- | [[API/functions/phas_storm|phas_storm]]() | boolean | [player] | {{object|PlayerOfflineException}} | Returns true if the given player is experiencing a storm, as set by set_pstorm(). (ignores world weather) | Yes |- | [[API/functions/phealth|phealth]]() | double | [player] | {{object|LengthException}}
{{object|PlayerOfflineException}} | Gets the player's health. | Yes |- | [[API/functions/phide_entity|phide_entity]]() | void | [player], entityUUID | {{object|PlayerOfflineException}}
{{object|LengthException}}
{{object|BadEntityException}} | Sets an entity to no longer be seen or tracked by the player's client. Resets to default on player rejoin. (MC 1.18+) | Yes |- | [[API/functions/phunger|phunger]]() | int | [player] | {{object|PlayerOfflineException}} | Returns the player's hunger level. | Yes |- | [[API/functions/pinfo|pinfo]]() | mixed | [player], [value] | {{object|PlayerOfflineException}}
{{object|RangeException}}
{{object|CastException}}
{{object|NotFoundException}} | Returns various information about the player specified, or the current player if no argument was given. [[API/functions/pinfo|See more...]]
| Yes |- | [[API/functions/pisop|pisop]]() | boolean | [player] | {{object|PlayerOfflineException}} | Returns whether or not the player is op. | Yes |- | [[API/functions/pkick|pkick]]() | void | [playerName], [message] | {{object|PlayerOfflineException}} | Kicks the specified player with an optional message. If no message is specified, "You have been kicked" is used. If no player is specified, the current player is used with the default message. | Yes |- | [[API/functions/pkill|pkill]]() | void | [playerName] | {{object|PlayerOfflineException}} | Kills the specified player, or the current player if a name is omitted. | Yes |- | [[API/functions/plast_known_name|plast_known_name]]() | string | uuid | {{object|LengthException}} | Returns the name for this player the last time they were on the server. Return null if the player has never been on the server. This is not guaranteed to be their current player name. This is read directly from the player data file for offline players. | Yes |- | [[API/functions/plast_played|plast_played]]() | int | [player] | | Returns the unix time stamp, in milliseconds, that this player was last seen on this server, or 0 if they never were. The player argument can be a UUID or a name. But if given a name, it must be exact.
([[API/functions/plast_played#Examples|Examples...]]) | Yes |- | [[API/functions/player|player]]() | string | [playerName]

[uuid] | {{object|PlayerOfflineException}} | Returns a player's name. If a string is specified, it will attempt to find a complete match for a partial name. If no string is specified, the current player is returned. UUIDs are also accepted for this and other functions that apply to online players. If the command is being run from the console, then the string '~console' is returned. If the command came from a CommandBlock, the block's name prefixed with # is returned. If the command is coming from elsewhere, returns a string chosen by the sender of this command (or null). Note that most functions won't support console or block names (they'll throw a PlayerOfflineException), but you can use this to determine where a command is being run from. | No |- | [[API/functions/players_in_radius|players_in_radius]]() | array | [locationArray], distance | {{object|CastException}}
{{object|FormatException}}
{{object|PlayerOfflineException}}
{{object|NotFoundException}} | Returns an array of all the players within the given radius. | Yes |- | [[API/functions/plevel|plevel]]() | int | [player] | {{object|CastException}}
{{object|PlayerOfflineException}} | Gets the player's level. | Yes |- | [[API/functions/ploc|ploc]]() | array | [playerName] | {{object|PlayerOfflineException}}
{{object|NotFoundException}} | Returns a location array of the coordinates of the player specified, or the player running the command if no player is specified. Note that unlike entity_loc() the y coordinate will be for the block the player is standing on, which is one meter lower. The array returned also includes the player's world, yaw and pitch. | Yes |- | [[API/functions/plocale|plocale]]() | string | [player] | {{object|PlayerOfflineException}} | Gets the player's locale. | Yes |- | [[API/functions/pmode|pmode]]() | string | [player] | {{object|PlayerOfflineException}}
{{object|NotFoundException}} | Returns the player's game mode. It will be one of SURVIVAL, CREATIVE, ADVENTURE, or SPECTATOR. | Yes |- | [[API/functions/ponfire|ponfire]]() | int | [player] | {{object|PlayerOfflineException}} | Returns the number of ticks remaining that this player will be on fire for. If the player is not on fire, 0 is returned, which evaluates as false. | Yes |- | [[API/functions/ponline|ponline]]() | boolean | player | | Returns whether or not the specified player is online. Note that the name must match exactly, but it will not throw a PlayerOfflineException if the player is not online, or if the player doesn't even exist. | Yes |- | [[API/functions/preset_time|preset_time]]() | void | [player] | {{object|InvalidWorldException}}
{{object|PlayerOfflineException}} | Resets the visible time for the player to the time of the world. | Yes |- | [[API/functions/psaturation|psaturation]]() | double | [player] | {{object|RangeException}}
{{object|PlayerOfflineException}} | Returns the player's food saturation level. | Yes |- | [[API/functions/psend_block_change|psend_block_change]]() | void | [player], locationArray, block | {{object|FormatException}}
{{object|PlayerOfflineException}} | Changes a block temporarily for the specified player. This can be used to "fake" blocks for a player. These illusory blocks will disappear when the client updates them, most often by clicking on them or reloading the chunks. Sending null will reset the block to its existing state in the world. A block type or blockdata format is supported. (see set_blockdata_string()) | Yes |- | [[API/functions/psend_block_damage|psend_block_damage]]() | void | [player], locationArray, progress, [entity] | {{object|CastException}}
{{object|FormatException}}
{{object|InvalidWorldException}}
{{object|LengthException}}
{{object|PlayerOfflineException}}
{{object|RangeException}} | Sends the player fake block damage progress. Progress is a percentage from 0.0 to 1.0, with 0.0 clearing any block damage. Alternatively you can specify the discrete damage state as an integer from 0 to 10. If a source entity UUID is specified, it will be as if that entity is damaging the block, otherwise the player will be used. If given null, damage will disregard source entity. If that entity damages a different block, the previous block's damage will be cleared. If unchanged, the damage will clear on its own after 20 seconds. On versions prior to Spigot 1.19.4 or Paper 1.19.2, the source entity will always be the player this block damage is being sent to. | Yes |- | [[API/functions/psend_equipment|psend_equipment]]() | void | [player], entityUUID, equipmentArray | {{object|PlayerOfflineException}}
{{object|LengthException}}
{{object|BadEntityException}}
{{object|FormatException}} | Changes a living entity's equipment only for the specified player. (MC 1.18+) Equipment array can be null to make all equipment not visible. Otherwise equipment array must be an associative array where the keys are equipment slots and the values are item arrays or null. The equipment slots are: weapon, off_hand, helmet, chestplate, leggings, boots, body (MC 1.20.6+), and saddle (MC 1.21.5+). | Yes |- | [[API/functions/psend_sign_text|psend_sign_text]]() | void | [player], locationArray, 1, 2, 3, 4

[player], locationArray, array | {{object|FormatException}}
{{object|PlayerOfflineException}}
{{object|CastException}} | Changes a sign's text only for the specified player. This will not change the sign in the world. If a normal array is used it cannot have more than 4 elements. If a line is null, the existing line will still be displayed. An associative array of sign data may be sent instead. This is the same as sign item meta, and can include the keys: 'signtext', 'color', 'glowing' (MC 1.17.1+), 'backtext' (MC 1.20.1+), 'backcolor' (MC 1.20.1+), and 'backglowing' (MC 1.20.1+). | Yes |- | [[API/functions/pshow_entity|pshow_entity]]() | void | [player], entityUUID | {{object|PlayerOfflineException}}
{{object|LengthException}}
{{object|BadEntityException}} | Sets an entity to be sent to the player's client again. (MC 1.18+) | Yes |- | [[API/functions/psneaking|psneaking]]() | boolean | [player] | {{object|LengthException}}
{{object|PlayerOfflineException}} | Returns whether or not the player is sneaking. | Yes |- | [[API/functions/pspectator_target|pspectator_target]]() | string | [player] | {{object|PlayerOfflineException}}
{{object|IllegalArgumentException}} | Gets the entity UUID that a spectator is viewing. If the player isn't spectating from an entity, null is returned. If the player isn't in spectator mode, an IllegalArgumentException is thrown. | Yes |- | [[API/functions/psprinting|psprinting]]() | boolean | [player] | {{object|PlayerOfflineException}}
{{object|LengthException}} | Gets if a player is sprinting or not. | Yes |- | [[API/functions/pstatistic|pstatistic]]() | int | [player], statistic, [type] | {{object|IllegalArgumentException}}
{{object|PlayerOfflineException}} | Returns the specified statistic for the player. Some statistics require a block, item or entity type. An IllegalArgumentException will be thrown if the statistic is invalid, or if the type is invalid for that statistic. The player argument is required before the type argument is. [[API/functions/pstatistic|See more...]]
| Yes |- | [[API/functions/ptarget_space|ptarget_space]]() | array | [player] | {{object|PlayerOfflineException}}
{{object|RangeException}} | Returns a location array of the space that the player is currently looking at. This is the space where if they placed a block (and were close enough), it would end up going. | Yes |- | [[API/functions/ptellraw|ptellraw]]() | void | [string selector], array raw | {{object|CastException}}
{{object|FormatException}}
{{object|IOException}}
{{object|PlayerOfflineException}} | A thin wrapper around the tellraw command from player context, this simply passes the input to the command. The raw is passed in as a normal (possibly associative) array, and json encoded. No validation is done on the input, so the command may fail. If not provided, the selector defaults to @s. Do not use double quotes (smart string) when providing the selector. See {{function|tellraw}} if you don't need the @s selector with player context. [[API/functions/ptellraw|See more...]]

([[API/functions/ptellraw#Examples|Examples...]]) | Yes |- | [[API/functions/ptexp|ptexp]]() | int | [player] | {{object|CastException}}
{{object|PlayerOfflineException}} | Gets the total experience of a player. | Yes |- | [[API/functions/puuid|puuid]]() | string | [player], [dashless] | {{object|PlayerOfflineException}}
{{object|NotFoundException}} | Returns the UUID of the current player or the specified player. If dashless is set to true, the returned UUID format will not have any dashes. This will attempt to find an offline player, but if that also fails, a PlayerOfflineException will be thrown. [[API/functions/puuid|See more...]]
| No |- | [[API/functions/pvehicle|pvehicle]]() | string | [player] | {{object|PlayerOfflineException}} | Returns the UUID of the vehicle which the player is riding, or null if player is not riding a vehicle. | Yes |- | [[API/functions/pvehicle_leave|pvehicle_leave]]() | boolean | [player] | {{object|PlayerOfflineException}} | Forces a player to leave their vehicle. This returns false if the player is not riding a vehicle. | Yes |- | [[API/functions/pvelocity|pvelocity]]() | array | [player] | {{object|PlayerOfflineException}}
{{object|NotFoundException}} | Returns an associative array that represents the player's velocity. The array contains the following items: magnitude, x, y, z. These represent a 3 dimensional Vector. The important part is x, y, z, however, the magnitude is provided for you as a convenience. (It should equal sqrt(x ** 2 + y ** 2 + z ** 2)) | Yes |- | [[API/functions/pwhitelisted|pwhitelisted]]() | boolean | player | | Returns whether or not this player is whitelisted. This will work with offline players, but the name must be exact. [[API/functions/pwhitelisted|See more...]]
| Yes |- | [[API/functions/pworld|pworld]]() | string | [playerName] | {{object|PlayerOfflineException}} | Gets the world of the player specified, or the current player if playerName isn't specified. | Yes |- | [[API/functions/raw_pcan_see|raw_pcan_see]]() | boolean | [player], otherPlayer | {{object|PlayerOfflineException}}
{{object|LengthException}} | Returns whether this player can see another player or not. Hidden players are sometimes called vanished players. | Yes |- | [[API/functions/raw_set_pvanish|raw_set_pvanish]]() | void | [player], isVanished, otherPlayer | {{object|PlayerOfflineException}}
{{object|LengthException}} | Sets the visibility of this player to another player. If isVanished is true, the player's model and tablist name will not be visible to the other player. | Yes |- | [[API/functions/reset_display_name|reset_display_name]]() | void | [playerName] | {{object|PlayerOfflineException}} | Resets a player's display name to their real name. If playerName isn't specified, defaults to the player running the command.
([[API/functions/reset_display_name#Examples|Examples...]]) | Yes |- | [[API/functions/save_players|save_players]]() | void | | {{object|CastException}} | Saves current players to disk. | Yes |- | [[API/functions/set_compass_target|set_compass_target]]() | array | [player], locationArray | {{object|PlayerOfflineException}}
{{object|FormatException}} | Sets the player's compass target, and returns the old location. | Yes |- | [[API/functions/set_display_name|set_display_name]]() | void | [playerName], newDisplayName | {{object|PlayerOfflineException}} | Sets a player's display name. If the first name isn't provided, it sets the display name of the player running the command. See reset_display_name() also. All player functions expect the player's real name, not their display name.
([[API/functions/set_display_name#Examples|Examples...]]) | Yes |- | [[API/functions/set_list_name|set_list_name]]() | void | [player], [listName] | {{object|PlayerOfflineException}}
{{object|LengthException}} | Sets the player's list name. Colors are supported and setting the name to null resets it. | Yes |- | [[API/functions/set_pbanned|set_pbanned]]() | void | player, isBanned, [reason], [source] | {{object|NotFoundException}} | Sets the ban flag for the specified player. This will work with offline players, but the name must be exact. When banning, a reason message may be provided that the player will see when attempting to login. An optional source may also be provided that indicates who or what banned the player. At this time, this function only works with the vanilla ban system. If you use a third party ban system, you should instead run the command for that plugin instead. [[API/functions/set_pbanned|See more...]]
| Yes |- | [[API/functions/set_pbed_location|set_pbed_location]]() | void | [player], locationArray, [forced]

[player], x, y, z, [forced] | {{object|CastException}}
{{object|LengthException}}
{{object|PlayerOfflineException}}
{{object|FormatException}}
{{object|NullPointerException}} | Sets the respawn location of a player. If player is omitted, the current player is used. The specified location should be the block below the respawn location. If forced is false, it will respawn the player next to that location only if a bed found is found there. (forced defaults to true) | Yes |- | [[API/functions/set_pborder|set_pborder]]() | void | player, paramArray | {{object|PlayerOfflineException}}
{{object|CastException}}
{{object|FormatException}}
{{object|RangeException}}
{{object|InvalidWorldException}} | Creates or updates a player's virtual world border. (MC 1.18.2+) In addition to the keys returned by pborder(), you can also specify 'seconds'. This is the time in which the border will move from the previous width to the new 'width'. If give null instead of an array, this resets the player's visible world border to the one of the world that they're in. | Yes |- | [[API/functions/set_pcooldown|set_pcooldown]]() | int | [player], material, cooldown | {{object|LengthException}}
{{object|FormatException}}
{{object|PlayerOfflineException}}
{{object|RangeException}}
{{object|CastException}} | Sets the player's cooldown time for the specified item type. The cooldown must be a positive integer representing server ticks. | Yes |- | [[API/functions/set_peffect|set_peffect]]() | boolean | player, potionEffect, [strength], [seconds], [ambient], [particles], [icon] | {{object|PlayerOfflineException}}
{{object|CastException}}
{{object|RangeException}} | Adds one, or modifies an existing, potion effect on a mob. The potionEffect can be SLOWNESS, INVISIBILITY, SLOW_FALLING, BAD_OMEN, WEAKNESS, DOLPHINS_GRACE, INSTANT_DAMAGE, BREATH_OF_THE_NAUTILUS, MINING_FATIGUE, TRIAL_OMEN, SPEED, WITHER, LUCK, FIRE_RESISTANCE, WIND_CHARGED, WATER_BREATHING, GLOWING, OOZING, ABSORPTION, HUNGER, BAD_LUCK, HERO_OF_THE_VILLAGE, REGENERATION, INFESTED, WEAVING, STRENGTH, BLINDNESS, LEVITATION, CONDUIT_POWER, RAID_OMEN, JUMP_BOOST, POISON, NAUSEA, RESISTANCE, HEALTH_BOOST, DARKNESS, NIGHT_VISION, INSTANT_HEALTH, HASTE, or SATURATION. It also accepts an integer corresponding to the effect id listed on the Minecraft wiki. Strength is an integer representing the power level of the effect, starting at 0. Seconds defaults to 30.0. To remove an effect, set the seconds to 0. If seconds is greater than 107374182 a RangeException is thrown. Negative seconds makes the effect infinite. (or max in versions prior to 1.19.4) Ambient takes a boolean of whether the particles should be more transparent. Particles takes a boolean of whether the particles should be visible at all. Icon argument takes a boolean of whether the effect icon should be displayed. The function returns whether or not the effect was modified.
([[API/functions/set_peffect#Examples|Examples...]]) | Yes |- | [[API/functions/set_pexp|set_pexp]]() | void | [player], xp | {{object|CastException}}
{{object|PlayerOfflineException}}
{{object|RangeException}} | Sets the experience of a player within the current level, as a percentage, from 0 to 100. 100 will sometimes reset the experience to zero and add a level to the player. | Yes |- | [[API/functions/set_pflight|set_pflight]]() | void | [player], flight | {{object|PlayerOfflineException}} | Sets whether or not this player is allowed to fly. | Yes |- | [[API/functions/set_pflying|set_pflying]]() | void | [player], flying | {{object|PlayerOfflineException}}
{{object|IllegalArgumentException}} | Sets the flying state for the player.Requires player to have the ability to fly, which is set with set_pflight(). | Yes |- | [[API/functions/set_pflyspeed|set_pflyspeed]]() | void | [player], speed | {{object|PlayerOfflineException}}
{{object|RangeException}}
{{object|CastException}} | Sets a player's fly speed. The speed must be between -1.0 and 1.0. The default player fly speed is 0.1. | Yes |- | [[API/functions/set_pfood|set_pfood]]() | void | [player], level | {{object|PlayerOfflineException}}
{{object|CastException}} | Sets the player's food level. This is an integer from 0-? | Yes |- | [[API/functions/set_phealth|set_phealth]]() | void | [player], health | {{object|CastException}}
{{object|RangeException}}
{{object|PlayerOfflineException}} | Sets the player's health. Health should be a double between 0 and their max health, which is 20.0 by default. | Yes |- | [[API/functions/set_phunger|set_phunger]]() | void | [player], hunger | {{object|RangeException}}
{{object|PlayerOfflineException}}
{{object|CastException}} | Sets a player's hunger level, where 0 is empty and 20 is full. | Yes |- | [[API/functions/set_player_sleeping_ignored|set_player_sleeping_ignored]]() | void | [player], boolean | {{object|PlayerOfflineException}}
{{object|InsufficientArgumentsException}}
{{object|CastException}} | Sets whether <player> is ignored when counting sleepers to skip night. | No |- | [[API/functions/set_plevel|set_plevel]]() | void | [player], level | {{object|CastException}}
{{object|PlayerOfflineException}} | Sets the level of a player. | Yes |- | [[API/functions/set_plist_footer|set_plist_footer]]() | void | [player], footer | {{object|LengthException}}
{{object|PlayerOfflineException}} | Sets the player list footer for a player. This is the text that appears below the player list that appears when hitting the tab key. Colors and new lines are accepted. Only the given player (or current player if none is given) will see these changes. | Yes |- | [[API/functions/set_plist_header|set_plist_header]]() | void | [player], header | {{object|LengthException}}
{{object|PlayerOfflineException}} | Sets the player list header for a player. This is the text that appears above the player list that appears when hitting the tab key. Colors and new lines are accepted. Only the given player (or current player if none is given) will see these changes. | Yes |- | [[API/functions/set_ploc|set_ploc]]() | boolean | [player], locationArray

[player], x, y, z | {{object|CastException}}
{{object|LengthException}}
{{object|PlayerOfflineException}}
{{object|FormatException}}
{{object|InvalidWorldException}}
{{object|IllegalArgumentException}} | Sets the location of the player to the specified coordinates. If the coordinates are not valid, or the player was otherwise prevented from teleporting, false is returned, otherwise true. On Paper 1.19.3+, passengers do not automatically prevent teleports. If player is omitted, the current player is used. Important: unlike {{function|set_entity_loc}}, 1.0 is automatically added to the y coordinate. | Yes |- | [[API/functions/set_pmode|set_pmode]]() | void | [player], mode | {{object|PlayerOfflineException}}
{{object|FormatException}} | Sets the player's game mode. Mode must be one of: SURVIVAL, CREATIVE, ADVENTURE, or SPECTATOR | Yes |- | [[API/functions/set_ponfire|set_ponfire]]() | void | [player], ticks | {{object|PlayerOfflineException}}
{{object|CastException}} | Sets the player on fire for the specified number of ticks. If a boolean is given for ticks, false is 0, and true is 20. | Yes |- | [[API/functions/set_psaturation|set_psaturation]]() | void | [player], saturation | {{object|RangeException}}
{{object|PlayerOfflineException}}
{{object|CastException}} | Set's the player's food saturation level. If this is above 0.0 and the player's health is below max, the player will experience fast health regeneration. | Yes |- | [[API/functions/set_pspectator_target|set_pspectator_target]]() | void | [player], entity | {{object|PlayerOfflineException}}
{{object|IllegalArgumentException}}
{{object|BadEntityException}} | Sets the entity for the player to spectate. If set to null, the spectator will stop following an entity. If the player is not in spectator mode an IllegalArgumentException is thrown. | Yes |- | [[API/functions/set_pstatistic|set_pstatistic]]() | void | [player], statistic, [type], amount | {{object|RangeException}}
{{object|PlayerOfflineException}}
{{object|CastException}}
{{object|IllegalArgumentException}} | Sets the specified statistic for the player. Some statistics require a block, item or entity type. An IllegalArgumentException will be thrown if the statistic is invalid, or if the type is invalid for that statistic. The player argument is required before the type argument is. [[API/functions/set_pstatistic|See more...]]
| Yes |- | [[API/functions/set_pstorm|set_pstorm]]() | void | [player], downFall | {{object|PlayerOfflineException}} | Sets the weather for the given player only. If downFall is true, the player will experience a storm. If downFall is null, it will reset the player's visible weather to that which the player's world is experiencing. | Yes |- | [[API/functions/set_ptexp|set_ptexp]]() | void | [player], exp | {{object|CastException}}
{{object|PlayerOfflineException}}
{{object|RangeException}} | Sets the total experience of a player. | Yes |- | [[API/functions/set_ptime|set_ptime]]() | void | [player], time, [relative] | {{object|PlayerOfflineException}}
{{object|FormatException}} | Sets the time of a given player. Relative defaults to false, but if true, the time will be an offset and the player's time will still progress. Otherwise it will be locked and should be a number from 0 to 24000, else it is modulo scaled. Alternatively, common time notation (9:30pm, 4:00 am) is acceptable, and convenient english mappings also exist:<ul><li>afternoon = 8000</li><li>dawn = 22500</li><li>day = 2000</li><li>dusk = 13500</li><li>earlymorning = 20000</li><li>evening = 12000</li><li>midday = 6000</li><li>midnight = 18000</li><li>morning = 0</li><li>night = 14000</li><li>noon = 6000</li><li>sunrise = 23000</li><li>sunset = 13000</li></ul> | Yes |- | [[API/functions/set_pvelocity|set_pvelocity]]() | boolean | [player], vector

[player], x, y, z | {{object|CastException}}
{{object|PlayerOfflineException}}
{{object|FormatException}}
{{object|IllegalArgumentException}} | Sets a player's velocity. vector must be an associative array with x, y, and z keys defined (if magnitude is set, it is ignored). If the vector's magnitude is greater than 10, the command is cancelled, because the server won't allow the player to move faster than that. A warning is issued, and false is returned if this happens, otherwise, true is returned. | Yes |- | [[API/functions/set_pwalkspeed|set_pwalkspeed]]() | void | [player], speed | {{object|PlayerOfflineException}}
{{object|RangeException}}
{{object|CastException}} | Sets a player's walk speed. The speed must be between -1.0 and 1.0. The default player walk speed is 0.2. | Yes |- | [[API/functions/set_pwhitelisted|set_pwhitelisted]]() | void | player, isWhitelisted | {{object|NotFoundException}} | Sets the whitelist flag of the specified player. This will work with offline players, but the name must be exact. [[API/functions/set_pwhitelisted|See more...]]
| Yes |- | [[API/functions/stop_named_sound|stop_named_sound]]() | void | player, sound, [category] | {{object|InvalidWorldException}}
{{object|LengthException}}
{{object|FormatException}}
{{object|PlayerOfflineException}} | Stops the specified sound for the given player. | Yes |- | [[API/functions/stop_sound|stop_sound]]() | void | player, sound, [category] | {{object|InvalidWorldException}}
{{object|LengthException}}
{{object|FormatException}}
{{object|PlayerOfflineException}} | Stops the specified sound for a player. | Yes |- | [[API/functions/stop_sound_category|stop_sound_category]]() | void | player, category | {{object|LengthException}}
{{object|FormatException}}
{{object|PlayerOfflineException}} | Stops all sounds in a category for a player. (MC 1.19+) | Yes |}

== PluginMeta ==

This class contains the functions use to communicate with other plugins and the server in general.

== Recipes ==

This class of functions allows recipes to be managed.

== Reflection ==

This class of functions allows scripts to hook deep into the interpreter itself, and get meta information about the operations of a script. This is useful for debugging, testing, and ultra dynamic scripting. See the [[Reflection|guide to reflection]] on the wiki for more details. In order to make the most of these functions, you should familiarize yourself with the general workings of the language. These functions explore extremely advanced concepts, and should normally not be used; especially if you are not familiar with the language.

element, docField | {{object|FormatException}} | Returns the documentation for an element. There are 4 things that an element might have, and one of these should be passed as the docField argument: type, return, args, description. A valid element is either the name of an ivariable, or a function/proc. For instance, reflect_docs('reflect_docs', 'description') would return what you are reading right now. User defined variables and procs may not have any documentation, in which case null is returned. If the specified argument cannot be found, a FormatException is thrown. If no arguments are passed in, it returns the documentation for reflect_docs, that is, what you're reading right now.
([[API/functions/reflect_docs#Examples|Examples...]]) | Yes |- | [[API/functions/reflect_pull|reflect_pull]]() | mixed | param, [args, ...] | {{object|FormatException}}
{{object|IOException}} | Returns information about the runtime in a usable format. Depending on the information returned, it may be usable directly, or it may be more of a referential format. [[API/functions/reflect_pull|See more...]]
| Yes |- | [[API/functions/reflect_type|reflect_type]]() | array | type | {{object|CastException}} | Returns information about the given ClassType. [[API/functions/reflect_type|See more...]]

([[API/functions/reflect_type#Examples|Examples...]]) | Yes |- | [[API/functions/reflect_value_source|reflect_value_source]]() | string | persistenceKey | | Returns the source file that this key will store a value to in the Persistence Network. For instance, in your persistence.ini file, if you have the entry "storage.test.**=json:///path/to/file.json", then reflect_value_source('storage.test.testing') would return 'json:///path/to/file.json'. This is useful for debugging, as it will definitively trace back the source/destination of a value. Note that unlike get and store_value, the "storage" prefix is required, if you're searching for values that are stored using these functions. | Yes |}

== Regex ==

This class provides regular expression functions. For more details, please see the page on [[Regex|regular expressions]]. Note that all the functions are just passthroughs to the Java regex mechanism. If you need to set a flag on the regex, where the api calls for a pattern, instead send array('pattern', 'flags') where flags is any of i, m, or s. Alternatively, using the embedded flag system that Java provides is also valid.

== ResourceManager ==

This class contains functions for resource management. This entire class of functions WILL be deprecated at some point in the future, so don't rely too heavily on it.

== SQL ==

This class of functions provides methods for accessing various SQL servers.

== Sandbox ==

This class is for functions that are experimental. They don't actually get added to the documentation, and are subject to removal at any point in time, nor are they likely to have good documentation.

== Scheduling ==

This class contains methods for dealing with time and server scheduling.

== Scoreboards ==

A class of functions for manipulating the server scoreboard.

objectiveName, displayname, [scoreboard] | {{object|FormatException}}
{{object|LengthException}}
{{object|ScoreboardException}} | Sets the display name and/or slot of the given objective. If arg 2 is not an array, it is assumed to be the displayname, otherwise arg 2 should be an array with keys 'displayname' and/or 'slot', affecting their respective properties. A null displayname resets it to the actual name, and a null slot removes it from all displays. Slot can be one of: BELOW_NAME, PLAYER_LIST, SIDEBAR, SIDEBAR_TEAM_BLACK, SIDEBAR_TEAM_DARK_BLUE, SIDEBAR_TEAM_DARK_GREEN, SIDEBAR_TEAM_DARK_AQUA, SIDEBAR_TEAM_DARK_RED, SIDEBAR_TEAM_DARK_PURPLE, SIDEBAR_TEAM_GOLD, SIDEBAR_TEAM_GRAY, SIDEBAR_TEAM_DARK_GRAY, SIDEBAR_TEAM_BLUE, SIDEBAR_TEAM_GREEN, SIDEBAR_TEAM_AQUA, SIDEBAR_TEAM_RED, SIDEBAR_TEAM_LIGHT_PURPLE, SIDEBAR_TEAM_YELLOW, or SIDEBAR_TEAM_WHITE [[API/functions/set_objective_display|See more...]]
| Yes |- | [[API/functions/set_pscore|set_pscore]]() | void | objectiveName, name, int, [scoreboard] | {{object|LengthException}}
{{object|ScoreboardException}} | Sets the player's score for the given objective. The name can be anything, not just player names. A LengthException is thrown if it's too long.Scoreboard defaults to 'main' if not given. | Yes |- | [[API/functions/set_pscoreboard|set_pscoreboard]]() | void | player, [scoreboard] | {{object|PlayerOfflineException}}
{{object|ScoreboardException}} | Sets the scoreboard to be used by a player. The scoreboard argument is the id of a registered scoreboard. Scoreboard defaults to 'main' if not given. | Yes |- | [[API/functions/set_team_display|set_team_display]]() | void | teamName, array, [scoreboard]

teamName, displayname, [scoreboard] | {{object|LengthException}}
{{object|ScoreboardException}}
{{object|IllegalArgumentException}} | Sets the display name, color, prefix, and/or suffix of the given team. If arg 2 is not an array, it is assumed to be the displayname, otherwise arg 2 should be an array with keys 'displayname', 'color', 'prefix', and/or 'suffix', affecting their respective properties. A null displayname resets it to the actual name, and a null prefix or suffix removes it from all displays. Color can be one of BLACK, DARK_BLUE, DARK_GREEN, DARK_AQUA, DARK_RED, DARK_PURPLE, GOLD, GRAY, DARK_GRAY, BLUE, GREEN, AQUA, RED, LIGHT_PURPLE, YELLOW, WHITE, RANDOM, BOLD, STRIKETHROUGH, UNDERLINE, ITALIC or PLAIN_WHITE. [[API/functions/set_team_display|See more...]]
| Yes |- | [[API/functions/set_team_options|set_team_options]]() | void | teamName, array, [scoreboard] | {{object|ScoreboardException}}
{{object|FormatException}} | Sets various options about the team from an array. The keys 'friendlyfire' and 'friendlyinvisibles' must be booleans. The keys 'collisionrule', 'nametagvisibility', and 'deathmessagevisibility' must be one of ALWAYS, FOR_OTHER_TEAMS, FOR_OWN_TEAM, or NEVER.Scoreboard defaults to 'main' if not given. | Yes |- | [[API/functions/team_add_player|team_add_player]]() | void | teamName, entry, [scoreboard] | {{object|ScoreboardException}} | Adds a player (or entity UUID) to a team, given the team exists. It will be removed from any other team on the same scoreboard. Scoreboard defaults to 'main' if not given. | Yes |- | [[API/functions/team_remove_player|team_remove_player]]() | boolean | teamname, entry, [scoreboard] | {{object|ScoreboardException}} | Attempts to remove a player (or entity UUID) from a team, and returns true if successful, for false if it was not part of the team.Scoreboard defaults to 'main' if not given. | Yes |}

== Statistics ==

Provides a set of functions that deal with statistical analysis of numbers.

number input... | {{object|CastException}}
{{object|IndexOverflowException}} | Returns the average (also known as the arithmetic mean) across all the numbers in the set. The input may be an array of numbers, or individual numbers as arguments. The average of a set of numbers is the result of adding all the numbers in the set, and dividing it by the number of values in the set. If an empty array is provided, a IndexOverflowException is thrown.
([[API/functions/average#Examples|Examples...]]) | No |- | [[API/functions/median|median]]() | number | array

number input... | {{object|CastException}}
{{object|IndexOverflowException}} | Returns the median across all the numbers in the set. The input may be an array of numbers, or individual numbers as arguments. The median is the number that is in the center of set, once the values in the set are ordered from least to greatest. That is, in the set [1, 2, 3], 2 is the median. If there is an even number of value in the set, the middle two values are averaged, and that value is returned. If an empty array is provided, a IndexOverflowException is thrown.
([[API/functions/median#Examples|Examples...]]) | No |- | [[API/functions/mode|mode]]() | array | array

number input... | {{object|CastException}}
{{object|IndexOverflowException}} | Returns the mode across all the numbers in the set. The input may be an array of numbers, or individual numbers as arguments. The mode of a set of numbers is the values that occur most in the set. This function supports bimodal (and generally n-modal sets), as well as fully unique sets, by returning an array. If the set is fully unique, i.e. [1, 2, 3], then the original set will be returned all values occur once). If there are more than one modes, i.e. [1, 1, 2, 3, 3], then an array of both 1 and 3 will be returned. The values will not necessarily be returned in any particular order. If an empty array is provided, a IndexOverflowException is thrown.
([[API/functions/mode#Examples|Examples...]]) | No |- | [[API/functions/percentile|percentile]]() | number | number percentile, array

number percentile, number input... | {{object|CastException}}
{{object|IndexOverflowException}}
{{object|RangeException}} | Returns the nth-percentile across all the numbers in the set. The input may be an array of numbers, or individual numbers as arguments. A percentile is a measure indicating the value below which a given percentage of observations in a group of observations falls. For example, the 20th percentile is the value (or score) below which 20% of the observations may be found. If an empty array is provided, a IndexOverflowException is thrown. If the percentile is not within the range of 0 or 1, a RangeException is thrown.
([[API/functions/percentile#Examples|Examples...]]) | No |- | [[API/functions/sum|sum]]() | number | array

number input... | {{object|CastException}}
{{object|IndexOverflowException}} | Returns the sum across all the numbers in the set. The input may be an array of numbers, or individual numbers as arguments. The sum is the result of adding all the numbers in the set together. If an empty array is provided, a IndexOverflowException is thrown.
([[API/functions/sum#Examples|Examples...]]) | No |}

== StringHandling ==

These class provides functions that allow strings to be manipulated

locale, formatString, array(parameters...) | {{object|FormatException}}
{{object|InsufficientArgumentsException}}
{{object|CastException}} | Returns a string formatted to the given formatString specification, using the parameters passed in. Locale should be a string in format, for instance, en_US, nl_NL, no_NO... Which locales are available depends on your system. Use null to use the system's locale. The formatString should be formatted according to [http://docs.oracle.com/javase/6/docs/api/java/util/Formatter.html#syntax this standard], with the caveat that the parameter types are automatically cast to the appropriate type, if possible. Calendar/time specifiers, (t and T) expect an integer which represents unix time, but are otherwise valid. All format specifiers in the documentation are valid.
([[API/functions/lsprintf#Examples|Examples...]]) | No |- | [[API/functions/parse_args|parse_args]]() | array | string, [useAdvanced] | | Parses string into an array, where string is a space seperated list of arguments. Handy for turning $ into a usable array of items with which to script against. Extra spaces are ignored, so you would never get an empty string as an input. useAdvanced defaults to false, but if true, uses a basic argument parser that supports quotes for allowing arguments with spaces.
([[API/functions/parse_args#Examples|Examples...]]) | No |- | [[API/functions/replace|replace]]() | string | subject, search, replacement | | Replaces all instances of 'search' with 'replacement' in 'subject'
([[API/functions/replace#Examples|Examples...]]) | No |- | [[API/functions/sconcat|sconcat]]() | string | var1, [var2...] | | Concatenates any number of arguments together, but puts a space between elements
([[API/functions/sconcat#Examples|Examples...]]) | No |- | [[API/functions/secure_string|secure_string]]() | secure_string | charArray

string | {{object|FormatException}} | Constructs a secure_string from a given char array or string. [[API/functions/secure_string|See more...]]

([[API/functions/secure_string#Examples|Examples...]]) | No |- | [[API/functions/split|split]]() | array | split, string, [limit] | {{object|CastException}} | Splits a string into parts, using the split as the index. Though it can be used in every single case you would use reg_split, this does not use regex, and therefore can take a literal split expression instead of needing an escaped regex, and *may* perform better than the regex versions, as it uses an optimized tokenizer split, instead of Java regex. Limit defaults to infinity, but if set, only that number of splits will occur.
([[API/functions/split#Examples|Examples...]]) | No |- | [[API/functions/sprintf|sprintf]]() | string | formatString, parameters...

formatString, array(parameters...) | {{object|FormatException}}
{{object|InsufficientArgumentsException}}
{{object|CastException}} | Returns a string formatted to the given formatString specification, using the parameters passed in. The formatString should be formatted according to [http://docs.oracle.com/javase/6/docs/api/java/util/Formatter.html#syntax this standard], with the caveat that the parameter types are automatically cast to the appropriate type, if possible. Calendar/time specifiers, (t and T) expect an integer which represents unix time, but are otherwise valid. All format specifiers in the documentation are valid. This works the same as lsprintf with the locale set to "DEFAULT".
([[API/functions/sprintf#Examples|Examples...]]) | No |- | [[API/functions/string_append|string_append]]() | void | Resource, toAppend... | {{object|CastException}} | Appends any number of values to the underlying string builder. This is much more efficient than doing normal concatenation with a string when building a string in a loop. The underlying resource may be converted to a string via a cast, string(@res).
([[API/functions/string_append#Examples|Examples...]]) | Yes |- | [[API/functions/string_compare|string_compare]]() | int | string s1, string s2 | | Compares two strings lexicographically. The comparison is based on the Unicode value of each character in the strings. Returns 0 if s1 is equal to s2, a negative value if s1 is lexographically less than s2, and a positive value if s1 is lexigraphically greater than s2. The magnitude of non-zero return values is the difference between the char values at the first index at which a different char was found in both strings. If all chars match but the strings differ in length, then the magnitude is this difference.
([[API/functions/string_compare#Examples|Examples...]]) | No |- | [[API/functions/string_compare_ic|string_compare_ic]]() | int | string s1, string s2 | | Compares two strings lexicographically ignoring casing. The comparison is based on the Unicode value of each character in the strings. Returns 0 if s1 is equal to s2, a negative value if s1 is lexographically less than s2, and a positive value if s1 is lexigraphically greater than s2. The magnitude of non-zero return values is the difference between the char values at the first index at which a different char was found in both strings. If all chars match but the strings differ in length, then the magnitude is this difference.
([[API/functions/string_compare_ic#Examples|Examples...]]) | No |- | [[API/functions/string_contains|string_contains]]() | boolean | haystack, needle | {{object|NullPointerException}} | Returns true if the string needle is found anywhere within the string haystack. This is functionally equivalent to string_position(@haystack, @needle) != -1, but is generally clearer.
([[API/functions/string_contains#Examples|Examples...]]) | No |- | [[API/functions/string_contains_ic|string_contains_ic]]() | boolean | haystack, needle | {{object|NullPointerException}}
{{object|FormatException}} | Returns true if the string needle is found anywhere within the string haystack (while ignoring case). This is functionally equivalent to string_position(to_lower(@haystack), to_lower(@needle)) != -1, but is generally clearer. | No |- | [[API/functions/string_ends_with|string_ends_with]]() | boolean | teststring, keyword | {{object|NullPointerException}} | Determines if the provided teststring ends with the provided keyword. Note that this will cast both arguments to strings. This means that the boolean true will match the string 'true' or the integer 1 will match the string '1'. If an empty string is provided for the keyword, it will always return true.
([[API/functions/string_ends_with#Examples|Examples...]]) | No |- | [[API/functions/string_from_bytes|string_from_bytes]]() | string | byte_array, [encoding] | {{object|CastException}}
{{object|FormatException}} | Returns a new string, given the byte array encoding provided. The encoding defaults to UTF-8, but may be specified. A FormatException is thrown if the encoding type is invalid. | No |- | [[API/functions/string_get_bytes|string_get_bytes]]() | byte_array | string, [encoding] | {{object|CastException}}
{{object|FormatException}} | Returns this string as a byte_array, encoded using the specified encoding, or UTF-8 if no encoding is specified. Valid encodings are the encoding types that java supports. If the encoding is invalid, a FormatException is thrown. | No |- | [[API/functions/string_multiply|string_multiply]]() | string | string, times | {{object|RangeException}}
{{object|CastException}} | Multiplies a string the given number of times. For instance, string_multiply('a', 3) returns 'aaa'. If the string is empty, an empty string is returned. If the string is null, null is returned. If times is 0, an empty string is returned. All other string values are multiplied accordingly. Providing a value less than 0 for times results in a RangeException. When the maximum string size of 2147483647 characters would be exceeded, a RangeException is thrown.
([[API/functions/string_multiply#Examples|Examples...]]) | No |- | [[API/functions/string_position|string_position]]() | int | haystack, needle | {{object|NullPointerException}} | Finds the numeric position of the first occurrence of needle in haystack. haystack is the string to search in, and needle is the string to search with. Returns the position of the needle (starting with 0) or -1 if the string is not found at all.
([[API/functions/string_position#Examples|Examples...]]) | No |- | [[API/functions/string_starts_with|string_starts_with]]() | boolean | teststring, keyword | {{object|NullPointerException}} | Determines if the provided teststring starts with the provided keyword. This could be used to find the prefix of a line, for instance. Note that this will cast both arguments to strings. This means that the boolean true will match the string 'true' or the integer 1 will match the string '1'. If an empty string is provided for the keyword, it will always return true.
([[API/functions/string_starts_with#Examples|Examples...]]) | No |- | [[API/functions/substr|substr]]() | string | str, begin, [end] | {{object|RangeException}}
{{object|CastException}} | Returns a substring of the given string str, starting from index begin, to index end, or the end of the string, if no index is given. If either begin or end are out of bounds of the string, an exception is thrown. substr('hamburger', 4, 8) returns "urge", substr('smiles', 1, 5) returns "mile", and substr('lightning', 5) returns "ning". See also length().
([[API/functions/substr#Examples|Examples...]]) | No |- | [[API/functions/to_lower|to_lower]]() | string | str | {{object|FormatException}} | Returns an all lower case version of str
([[API/functions/to_lower#Examples|Examples...]]) | No |- | [[API/functions/to_upper|to_upper]]() | string | str | {{object|FormatException}} | Returns an all caps version of str
([[API/functions/to_upper#Examples|Examples...]]) | No |- | [[API/functions/trim|trim]]() | string | s | | Returns the string s with leading and trailing whitespace cut off
([[API/functions/trim#Examples|Examples...]]) | No |- | [[API/functions/triml|triml]]() | string | s | | Returns the string s with leading whitespace cut off
([[API/functions/triml#Examples|Examples...]]) | No |- | [[API/functions/trimr|trimr]]() | string | s | | Returns the string s with trailing whitespace cut off
([[API/functions/trimr#Examples|Examples...]]) | No |- | [[API/functions/unicode_from_char|unicode_from_char]]() | int | character | {{object|CastException}}
{{object|RangeException}} | Returns the unicode code point for a given character. The character is a string, but it should only be 1 code point character (which may be length(@character) == 2).
([[API/functions/unicode_from_char#Examples|Examples...]]) | No |- | [[API/functions/uuid|uuid]]() | string | type, arg | {{object|CastException}} | Returns a UUID (also known as a GUID). Different types of UUIDs can be generated, by default, if no parameters are provided, a random uuid is returned (version 4). For full details on what exactly a uuid is, and what the different versions are, see https://en.wikipedia.org/wiki/Universally_unique_identifier. The arg varies depending on the type, some types do not require an argument, in which case, this parameter will be ignored. <code>type</code> may be one of: - RANDOM - Returns a random UUID. This type takes 0 arguments. - NIL - Returns the nil UUID, that is 00000000-0000-0000-0000-000000000000. This type takes 0 arguments.
([[API/functions/uuid#Examples|Examples...]]) | No |}

== TaskHandling ==

This class is used to manage various tasks throughout MethodScript. It is a task manager of sorts.

{| class="sticky" |- ! scope="col" width="8%" | Function Name ! scope="col" width="4%" | Returns ! scope="col" width="16%" | Arguments ! scope="col" width="8%" | Throws ! scope="col" width="62%" | Description ! scope="col" width="2%" | Res |- class="hiddenFunction" | [[API/functions/tm_get_tasks|tm_get_tasks]]() | array | | | Returns an array of currently running tasks. [[API/functions/tm_get_tasks|See more...]]
| Yes |- class="hiddenFunction" | [[API/functions/tm_kill_task|tm_kill_task]]() | void | taskType, id | {{object|CastException}} | Attempts to kill the specified task. The taskType and id will be listed with the task in the task manager. If the task is already finished, doesn't exist, or already in the process of finishing, nothing happens. | Yes |}

== Threading ==

This experimental and private API is subject to removal, or incompatible changes, and should not be yet heavily relied on in normal development.

== Trades ==

Functions related to the management of trades and merchants. A trade is a special kind of recipe accessed through the merchant interface. A merchant is a provider of trades, which may or may not be attached to a Villager or Wandering Trader.

== Weather ==

Provides functions to control the weather

x, y, z, [safe] | {{object|CastException}}
{{object|LengthException}}
{{object|InvalidWorldException}}
{{object|FormatException}} | Makes lightning strike at the x y z coordinates specified in the array or arguments. Safe defaults to false, but if true, lightning striking a player will not hurt them. Returns the UUID of the lightning bolt entity. | Yes |- | [[API/functions/set_thunder|set_thunder]]() | void | boolean, [world], [int] | {{object|InvalidWorldException}}
{{object|CastException}} | Sets whether or not the weather can have thunder. The third argument can specify how long the thunder should last in server ticks. | Yes |- | [[API/functions/storm|storm]]() | void | isStorming, [world], [int] | {{object|CastException}}
{{object|FormatException}}
{{object|InvalidWorldException}} | Creates a (rain) storm if isStorming is true, stops a storm if isStorming is false. The second argument can be a world name or the duration in ticks of the given weather setting. The third argument allows specifying both a world and a duration. The second param is required to be the world if the function is run from console. | Yes |}

== Web ==

Contains various methods to make HTTP requests.

url, settings | {{object|FormatException}} | Makes an HTTP request to the given url. [[API/functions/http_request|See more...]]

([[API/functions/http_request#Examples|Examples...]]) | Yes |- | [[API/functions/url_decode|url_decode]]() | string | param | | Decodes a previously url encoded string.
([[API/functions/url_decode#Examples|Examples...]]) | No |- | [[API/functions/url_encode|url_encode]]() | string | param | | URL Encodes the parameter given. This escapes all special characters per the x-www-form-urlencoded format.
([[API/functions/url_encode#Examples|Examples...]]) | No |}

== World ==

Provides functions for manipulating a world

locationArray, [world] | {{object|CastException}}
{{object|FormatException}}
{{object|InvalidWorldException}} | Returns if the chunk is a slime spawning chunk. The current player's world is used if one is not provided. | Yes |- | [[API/functions/load_chunk|load_chunk]]() | void | [world], x, z

[world], locationArray | {{object|CastException}}
{{object|FormatException}}
{{object|InvalidWorldException}} | Loads a chunk for a world using the x and z coordinates. The current player's world is used if one isn't provided. | Yes |- | [[API/functions/location_shift|location_shift]]() | array | origin, target, [distance], [clamp]

origin, direction, [distance] | {{object|InvalidWorldException}}
{{object|FormatException}} | Returns a location array that is the specified distance from the origin location along a vector. [[API/functions/location_shift|See more...]]

([[API/functions/location_shift#Examples|Examples...]]) | Yes |- class="hiddenFunction" | [[API/functions/refresh_chunk|refresh_chunk]]() | void | [world], x, z

[world], locationArray | {{object|CastException}}
{{object|FormatException}}
{{object|InvalidWorldException}} | This is not guaranteed to work reliably! Resends the chunk data to all clients, using the specified world or current player's world. | Yes |- | [[API/functions/regen_chunk|regen_chunk]]() | boolean | x, z, [world]

locationArray, [world] | {{object|CastException}}
{{object|FormatException}}
{{object|InvalidWorldException}} | Regenerate the chunk for a world. The current player's world is used if one is not provided. Beware that this is destructive! Any data in this chunk will be lost! Returns true if the operation was successful. This function is deprecated. Results will vary per platform and may not work at all. | Yes |- | [[API/functions/save_world|save_world]]() | void | world_name | {{object|InvalidWorldException}} | Saves the specified world. | Yes |- | [[API/functions/set_chunk_force_loaded|set_chunk_force_loaded]]() | void | [world], x, z, forced

locationArray, forced | {{object|CastException}}
{{object|FormatException}}
{{object|InvalidWorldException}} | Sets a chunk to be persistently loaded. | Yes |- | [[API/functions/set_difficulty|set_difficulty]]() | void | [world], difficulty | {{object|InvalidWorldException}}
{{object|FormatException}} | Sets the difficulty of the world with the given name, or all worlds if the name is not given. The difficulty can be PEACEFUL, EASY, NORMAL, or HARD. | Yes |- | [[API/functions/set_gamerule|set_gamerule]]() | boolean | [world], gameRule, value | {{object|InvalidWorldException}}
{{object|FormatException}}
{{object|CastException}} | Sets the value of the gamerule for the specified world. If world is not given the value is set for all worlds. Returns true if successful. [[API/functions/set_gamerule|See more...]]
| Yes |- | [[API/functions/set_keep_spawn_loaded|set_keep_spawn_loaded]]() | void | world, boolean | {{object|InvalidWorldException}} | Sets whether or not the spawn chunks in the given world should stay loaded. Spawn chunks are never kept loaded starting from MC 1.21.9. | Yes |- | [[API/functions/set_pvp|set_pvp]]() | void | [world], boolean | {{object|InvalidWorldException}} | Sets if PVP is allowed in the world with the given name, or all worlds if the name is not given. (uses gamerule in 1.21.9+) | Yes |- | [[API/functions/set_spawn|set_spawn]]() | void | [world], locationArray

[world], x, y, z | {{object|InvalidWorldException}}
{{object|CastException}}
{{object|FormatException}} | Sets the spawn of the world. Note that in some cases a plugin may override the spawn. | Yes |- | [[API/functions/set_world_autosave|set_world_autosave]]() | void | [world_name], newState | | Updates the world's auto-save state. If no world is specified, set the option for all worlds. | Yes |- | [[API/functions/set_world_border|set_world_border]]() | void | world_name, paramArray | {{object|CastException}}
{{object|FormatException}}
{{object|InvalidWorldException}}
{{object|RangeException}} | Updates the world's border with the given values. In addition to the keys returned by get_world_border(), you can also specify the "seconds". This is time in which the border will move from the previous width to the new "width". | Yes |- | [[API/functions/set_world_day|set_world_day]]() | void | [world], day | {{object|InvalidWorldException}} | Set the current day number of a given world. As of MC 26.1 some dimensions may not have a world clock. (e.g. nether) | Yes |- | [[API/functions/set_world_time|set_world_time]]() | void | [world], time | {{object|InvalidWorldException}}
{{object|FormatException}} | Sets the time of a given world. As of MC 26.1 some dimensions may not have a world clock. (e.g. nether) The time should be a number in ticks from 0 to 23999. If not, it is modulo scaled. Common time notation (9:30pm, 4:00 am) is also accepted, and convenient english mappings also exist: [[API/functions/set_world_time|See more...]]
| Yes |- | [[API/functions/spawn_falling_block|spawn_falling_block]]() | string | locationArray, blockName, [vectorArray] | {{object|FormatException}} | Spawns a falling block entity of the specified block type at the specified location, applying the vector array as a velocity if given. Values for the vector array are doubles, and 1.0 seems to imply about 3 times walking speed. Gravity applies for y. | Yes |- | [[API/functions/unload_chunk|unload_chunk]]() | void | [world], x, z

[world], locationArray | {{object|CastException}}
{{object|FormatException}}
{{object|InvalidWorldException}} | Unloads a chunk for a world using the x and z coordinates. The current player's world is used if one is not provided. | Yes |- | [[API/functions/unload_world|unload_world]]() | boolean | world, [save] | {{object|InvalidWorldException}} | Unloads a world, and saves it if save is true (defaults true), and returns whether or not the operation was successful. | Yes |- | [[API/functions/world_info|world_info]]() | array | world | {{object|InvalidWorldException}} | Returns an associative array of immutable info about the world. The keys are name, uuid, seed, environment, generator, sealevel, minheight and maxheight. The worldtype key is deprecated as of 1.16. | Yes |}

== XGUI ==

This provides extremely limited gui control functions. This entire class is experimental, and will probably be removed at some point.

{| class="sticky" |- ! scope="col" width="8%" | Function Name ! scope="col" width="4%" | Returns ! scope="col" width="16%" | Arguments ! scope="col" width="8%" | Throws ! scope="col" width="62%" | Description ! scope="col" width="2%" | Res |- class="hiddenFunction" | [[API/functions/x_launch_browser|x_launch_browser]]() | void | url | {{object|IOException}} | Launches the desktop's default browser with the given url. On headless systems, this will throw an exception. | Yes |}

Show hidden

Find a bug in this page? Edit this page yourself, then submit a pull request.