Back to the complete JSONAPI docs


API Documentation for JSONAPI

This page documents all the methods that ship with JSONAPI. This includes the base method that work as long as JSONAPI is installed and enabled, along with the methods that require another plugin to be installed and enabled for them to work.

The methods that require another plugin to be installed simply do not work if that plugin is not installed and enabled.

Methods (196)

Name
chat.broadcast
Description
Send a message to every player on the server
Arguments
String
The message to broadcast
Returns
int The number of players the message was broadcast to
Name
chat.enabled
Description
Checks if chat methods are enabled
Returns
boolean Success or Failure
Name
chat.groups
Description
Returns a list of all known groups
Returns
String[] A list of all known groups
Name
chat.with_name
Description
Similar to broadcast, but lets you specify a name to chat as and displays the message with the proper format. Looks just like the person specified is on the esrver
Arguments
String
The message
String
The name to send as
Returns
boolean True on success, false on failure
Name
dynmap.host
Description
Returns the IP.hostname that the dynmap webserver is running on
Returns
String The dynmap port as a string
Name
dynmap.port
Description
Returns the port that the dynmap webserver is running on
Returns
String The dynmap port as an integer
Name
economy.bank.has_support
Description
Returns true if the given implementation supports banks
Returns
boolean true if the implementation supports banks
Name
economy.banks.name.balance
Description
Returns the amount the bank has
Arguments
String
name
Returns
net.milkbowl.vault.economy.EconomyResponse
Name
economy.banks.name.delete
Description
Deletes a bank account with the specified name
Arguments
String
name
Returns
net.milkbowl.vault.economy.EconomyResponse if the operation completed successfully
Name
economy.banks.name.deposit
Description
Deposit an amount into a bank account
Arguments
String
name
double
amount -
Returns
net.milkbowl.vault.economy.EconomyResponse
Name
economy.banks.name.has
Description
Returns true or false whether the bank has the amount specified
Arguments
String
name
double
amount -
Returns
net.milkbowl.vault.economy.EconomyResponse
Name
economy.banks.name.is_member
Description
Check if the player is a member of the bank account
Arguments
String
name
String
playerName -
Returns
net.milkbowl.vault.economy.EconomyResponse
Name
economy.banks.name.is_owner
Description
Check if a player is the owner of a bank account
Arguments
String
name
String
playerName -
Returns
net.milkbowl.vault.economy.EconomyResponse
Name
economy.banks.name.withdraw
Description
Withdraw an amount from a bank account
Arguments
String
name
double
amount -
Returns
net.milkbowl.vault.economy.EconomyResponse
Name
economy.banks.names
Description
Gets the list of banks
Returns
String[] the List of Banks
Name
economy.currency.format
Description
Format amount into a human readable String This provides translation into economy specific formatting to improve consistency between plugins
Arguments
double
amount
Returns
String Human readable string describing amount
Name
economy.currency.name
Description
Returns the name of the currency in singular form. If the economy being used does not support currency names then an empty string will be returned
Returns
String name of the currency (singular)
Name
economy.currency.name_plural
Description
Returns the name of the currency in plural form. If the economy being used does not support currency names then an empty string will be returned
Returns
String name of the currency (plural)
Name
economy.is_enabled
Description
Checks if economy method is enabled
Returns
boolean Success or Failure
Name
economy.name
Description
Gets name of permission method
Returns
String Name of Permission Method
Name
essentials.config.get_keys
Description
Returns
java.util.Set Gets the list of keys as Set<string>
Name
essentials.config.get_text
Description
Returns
String Gets the whole configuration file as String
Name
essentials.config.get_value
Description
Arguments
String
Path to the key
Returns
Object path as key.key.key...
Name
essentials.config.restore_default
Description
Resets the configuration file to it's default
Arguments
boolean
Should the plugin be reloaded after the operation
Returns
boolean true on success
Name
essentials.config.set_value
Description
Arguments
String
Path to config key
Object
The value to set
boolean
Should the plugin be reloaded after changing the value
Returns
boolean path as key.key.key...
Name
essentials.reload
Description
Reloads the plugin
Returns
void void
Name
essentials.users.add_mail
Description
Adds a mail to users' mailbox
Arguments
String
Username
String
Contents of the message
Returns
boolean true on success
Name
essentials.users.add_mail_all
Description
Adds a mail to all users
Arguments
String
Contents of the message
Returns
boolean true on success
Name
essentials.users.burn
Description
Set the player on fire.
Arguments
String
Username
Integer
Time
Returns
boolean true on success
Name
essentials.users.clear_all_powertools
Description
Clear all powertools of player
Arguments
String
Username
Returns
Boolean true on success
Name
essentials.users.clear_inventory
Description
Clear inventory and armor of player
Arguments
String
Username
Boolean
Clear armor?
Returns
boolean true on success
Name
essentials.users.clear_nick
Description
Clear the nickanme of player
Arguments
String
Username
Returns
Boolean true on success
Name
essentials.users.fly
Description
Change fly mode of player.
Arguments
String
Username
Boolean
Mode (true - flying)
Returns
boolean true on success
Name
essentials.users.get_base
Description
Change status of AFK of user
Arguments
String
Status to set
Returns
Object true on success
Name
essentials.users.get_pos
Description
Return location of player
Arguments
String
Username
Returns
Object Location of player on success
Name
essentials.users.get_uuid
Description
Returns the UUID of a player(has to be online)
Arguments
String
Username
Returns
Object on success
Name
essentials.users.heal
Description
Heal the player
Arguments
String
Username
Returns
Boolean true on success
Name
essentials.users.player_get_all
Description
Return all informations about player
Arguments
String
Username
Returns
java.util.HashMap on success
Name
essentials.users.seen
Description
Return the last logout time of player.
Arguments
String
Username
Returns
Object Timestamp if offline, -1 if online
Name
essentials.users.set_afk
Description
Change status of AFK of user
Arguments
String
Status to set (true - AFK)
Boolean
Returns
boolean true on success
Name
essentials.users.set_nick
Description
Change the nickanme of player
Arguments
String
Username
String
Nickname to set
Returns
Boolean true on success
Name
essentials.users.toggle_god
Description
Change god mode of player
Arguments
String
Username
Boolean
Mode
Returns
Boolean true on success
Name
essentials.users.tp_back
Description
Teleport player to last location
Arguments
String
Username
Returns
boolean true on success
Name
essentials.users.vanish
Description
Change visible of player
Arguments
String
Username
Boolean
Mode to set
Returns
Boolean true on success
Name
files.append
Description
Appends to the contents of the specified file. The file path is relative to the folder that the craftbukkit jar is in
Arguments
String
The name of the file to read
String
The content to append to the file
Returns
boolean True if call succeeded. False will never be returned, instead an exception will be thrown and the call will not return as successful. This will occur if the specified file does not exist
Name
files.copy
Description
Copies the specified file or folder
Arguments
String
The old path to the file or folder relative to the server root
String
The new path to the file or folder relative to the server root
Returns
boolean True if successful, false otherwise
Name
files.create
Description
Creates a empty file at the given path
Arguments
String
Path to file
Returns
String Path to file
Name
files.create_folder
Description
Makes a new folder
Arguments
String
Path to file
Returns
String Path to folder
Name
files.delete
Description
Deletes the specified file or folder
Arguments
String
The path to the file or folder relative to the server root
Returns
boolean True if successful, false otherwise
Name
files.list_directory
Description
Retrieves an array of files and directories that are direct children of the specified directory
Arguments
String
The directory that will have its files listed, relative to the folder that contains the the plugins folder
Returns
String[] The files in string format
Name
files.move
Description
Renames the specified file or folder
Arguments
String
The old path to the file or folder relative to the server root
String
The new path to the file or folder relative to the server root
Returns
boolean True if successful, false otherwise
Name
files.read
Description
Gets the contents of the specified file. The file path is relative to the folder that the craftbukkit jar is in
Arguments
String
The name of the file to read
Returns
String The file's contents
Name
files.read_binary
Description
Gets the binary contents of the specified file encoded in base64. The file path is relative to the folder that the craftbukkit jar is in
Arguments
String
The name of the file to read
Returns
String The file's contents
Name
files.write
Description
Sets (not appends to) the contents of the specified file. The file path is relative to the folder that the craftbukkit jar is in
Arguments
String
The name of the file to read
String
The content to put in the file
Returns
boolean True if call succeeded. False will never be returned, instead an exception will be thrown and the call will not return as successful. This will occur if the specified file does not exist
Name
files.write_binary
Description
Sets (not appends to) the contents of the specified binary file. The file path is relative to the folder that the craftbukkit jar is in. The second argument is base64 decoded and then set as the file's contents
Arguments
String
The name of the file to read
String
The base64 encoded content to put in the file
Returns
boolean True if call succeeded. False will never be returned, instead an exception will be thrown and the call will not return as successful. This will occur if the specified file does not exist
Name
groups.all
Description
Retrieves all groups
Returns
String[] All the groups in use on the server
Name
groups.group.players
Description
Gets all the players in a group
Arguments
String
The name of the group to retrieve players for
Returns
String[] Gets all the players in a specific group
Name
jsonapi.groups
Description
Lists all the JSONAPI groups on the server
Returns
Object[] The JSONAPI group objects
Name
jsonapi.groups.add
Description
Creates a new group
Arguments
String
The group name.
String[]
An array of methods to add to the group.
String[]
An array of streams to add to the group.
String[]
An array of permissions to add to the group.
Returns
boolean If the execution was successful
Name
jsonapi.groups.group.methods.add
Description
Add a JSONAPI method to a group
Arguments
String
The group name.
String
The method name.
Returns
boolean If the execution was successful
Name
jsonapi.groups.group.methods.remove
Description
Removes a JSONAPI method from a group
Arguments
String
The group name.
String
The method name.
Returns
boolean If the execution was successful
Name
jsonapi.groups.group.permissions.add
Description
Add a JSONAPI permission node to a group
Arguments
String
The group name.
String
The permission node name.
Returns
boolean If the execution was successful
Name
jsonapi.groups.group.permissions.remove
Description
Removes a JSONAPI permission node from a group
Arguments
String
The group name.
String
The permission node name.
Returns
boolean If the execution was successful
Name
jsonapi.groups.group.streams.add
Description
Add a JSONAPI stream to a group
Arguments
String
The group name.
String
The stream name.
Returns
boolean If the execution was successful
Name
jsonapi.groups.group.streams.remove
Description
Removes a JSONAPI stream from a group
Arguments
String
The group name.
String
The stream name.
Returns
boolean If the execution was successful
Name
jsonapi.groups.name
Description
Gets all information for a JSONAPI group
Arguments
String
The group to fetch
Returns
Object The JSONAPI group
Name
jsonapi.groups.name.set
Description
Sets all the settings an existing group
Arguments
String
The group name.
String[]
An array of methods to add to the group.
String[]
An array of streams to add to the group.
String[]
An array of permissions to add to the group.
Returns
boolean If the execution was successful
Name
jsonapi.groups.names
Description
Lists all the JSONAPI group anmess on the server
Returns
String[] The JSONAPI group names
Name
jsonapi.groups.remove
Description
Removes a group
Arguments
String
The group name.
Returns
boolean If the execution was successful
Name
jsonapi.methods
Description
Returns
java.util.List Returns details about API methods provided by default with JSONAPI.
Name
jsonapi.methods.all
Description
Returns
java.util.Map Returns details about all API methods in all namespaces. You should use `jsonapi.methods` unless you want to work with custom methods or ones loaded in a specific namespace.
Name
jsonapi.methods.all.for_namespace
Description
Arguments
String
Returns
java.util.List Returns details about all the API methods currently available for a given namespace. You should use `jsonapi.methods` unless you want to work with custom methods or ones loaded in a specific namespace.
Name
jsonapi.methods.all.namespaces
Description
Returns
java.util.List Returns a list of all the namespaces currently loaded on the server.
Name
jsonapi.permissions
Description
Lists all the JSONAPI permissions on the server
Returns
String[] The JSONAPI permissions
Name
jsonapi.streams
Description
Lists all the JSONAPI streams on the server
Returns
String[] The JSONAPI streams
Name
jsonapi.users
Description
Lists all the JSONAPI users on the server
Returns
Object[] The JSONAPI user objects
Name
jsonapi.users.add
Description
Adds a new JSONAPI user
Arguments
String
The JSONAPI username.
String
The JSONAPI password.
String[]
The groups this new user should belong to.
Returns
boolean If the execution was successful
Name
jsonapi.users.remove
Description
Removes a JSONAPI user from the server
Arguments
String
The JSONAPI username.
Returns
boolean If the execution was successful
Name
jsonapi.users.user.groups.add
Description
Adds a user to a group
Arguments
String
The JSONAPI username.
String
The group name.
Returns
boolean If the execution was successful
Name
jsonapi.users.user.groups.remove
Description
Removes a user from a group
Arguments
String
The JSONAPI username.
String
The group name.
Returns
boolean If the execution was successful
Name
jsonapi.users.user.methods
Description
Lists all the API methods a user is allowed to access. Methods prefixed with jsonapi. will be able to be accessed by any user, regardless of groups.
Arguments
String
The JSONAPI user's name.
Returns
String[] The permission node names
Name
jsonapi.users.user.password.set
Description
Changes the password for a JSONAPI user
Arguments
String
The JSONAPI username.
String
The JSONAPI user's new password.
Returns
boolean If the execution was successful
Name
jsonapi.users.user.permissions
Description
Lists all the permission nodes a user is allowed to access. Methods prefixed with jsonapi. will be able to be accessed by any user, regardless of groups.
Arguments
String
The JSONAPI user's name.
Returns
String[] The permission node names
Name
jsonapi.users.user.streams
Description
Lists all the streams a user is allowed to access. Methods prefixed with jsonapi. will be able to be accessed by any user, regardless of groups.
Arguments
String
The JSONAPI user's name.
Returns
String[] The permission node names
Name
jsonapi.users.username
Description
Gets all information for a JSONAPI user
Arguments
String
The username to fetch
Returns
Object The JSONAPI user
Name
jsonapi.users.usernames
Description
Lists all the JSONAPI usernamess on the server
Returns
String[] The JSONAPI usernames
Name
permissions.all
Description
Retrieves all permissions for all players
Returns
Object A map from player to a list of permission settings
Name
players.ban_ip
Description
Bans the specified IP
Arguments
String
The IP to be banned
Returns
void Method return desc
Name
players.banned.names
Description
Gets the players on the ban list
Returns
String[] Returns an array of strings; where each item in the array is a string that contains a player's name
Name
players.banned_ips
Description
Gets the IPs on the ban list
Returns
String[] Returns an array of strings; where each item in the array is a string that contains an IP address
Name
players.name
Description
Gets a |player| object representing the specified person. Works for online and offline players
Arguments
String
name
Returns
org.bukkit.entity.Player A player object respresenting the specified person
Name
players.name.ban
Description
Bans the specified player
Arguments
String
name
String
The reason this player is being banned
Returns
void Method return desc
Name
players.name.bank.balance
Description
Gets balance of a player
Arguments
String
name
Returns
double Amount currently held in players account
Name
players.name.bank.create
Description
Creates a bank account with the specified name and the player as the owner
Arguments
String
name
String
route
Returns
net.milkbowl.vault.economy.EconomyResponse
Name
players.name.bank.create_account
Description
Attempts to create a player account for the given player
Arguments
String
name
String
Returns
boolean if the account creation was successful
Name
players.name.bank.deposit
Description
Deposit an amount to a player
Arguments
String
name
double
amount - Amount to deposit
Returns
net.milkbowl.vault.economy.EconomyResponse Detailed response of transaction
Name
players.name.bank.has
Description
Checks if the player account has the amount
Arguments
String
name
double
amount
Returns
boolean
Name
players.name.bank.has_account
Description
Checks if this player has an account on the server yet This will always return true if the player has joined the server at least once as all major economy plugins auto-generate a player account when the player joins the server
Arguments
String
name
Returns
boolean if the player has an account
Name
players.name.bank.withdraw
Description
Withdraw an amount from a player
Arguments
String
name
double
amount - Amount to withdraw
Returns
net.milkbowl.vault.economy.EconomyResponse Detailed response of transaction
Name
players.name.deop
Description
Deops the specified player
Arguments
String
name
Returns
void Method return desc
Name
players.name.drop_item
Description
Gives the specified player the specified quanity of the item id by dropping it in front of them
Arguments
String
name
int
Id of item to drop
int
Quantity of item to drop
int
Decimal representation of the data value
Returns
boolean True if the item was given. False will be returned if the player is not on the server
Name
players.name.groups
Description
Gets the groups for a specific player
Arguments
String
name
Returns
String[] Gets all the groups for a player
Name
players.name.groups.add
Description
Add a group for a player
Arguments
String
name
String
The group name
Returns
boolean Success?
Name
players.name.groups.remove
Description
Remove a group from a player
Arguments
String
name
String
The group name
Returns
boolean Success?
Name
players.name.inventory.give_item
Description
Gives the specified player the specified quanity of the item id by placing it in the first empty slot
Arguments
String
name
int
Id of item to give
int
Quantity of item to give
int
Decimal representation of the data value
Returns
boolean True if the item was given. False will be returned if the player is not on the server
Name
players.name.inventory.remove_item
Description
Removes all items of the given type from the given player's inventory
Arguments
String
name
int
Id of block type to remove
Returns
Object An object of all the things that couldn't be removed. This shouldn't happen though. Null will be returned if the player is not on the server
Name
players.name.inventory.slots.slot.clear
Description
Removes everything from the specified slot in the player's inventory
Arguments
String
name
int
slot
Returns
boolean True if the slot was cleared. False will be returned if the player is not on the server
Name
players.name.inventory.slots.slot.enchant
Description
Adds an enchantment to the specified slot in the specified player's inventory with the specified level
Arguments
String
name
int
slot
int
The enchantment ID (EID): http:..www.minecraftwiki.net.wiki.Enchanting#Enchantment_Types
int
The enchantment level
Returns
boolean True if the enchanting process was successful. False is usually the restult will be returned if the player is not on the server
Name
players.name.inventory.slots.slot.enchantments.enchantment_id.remove
Description
Removes an enchantment to the specified slot in the specified player's inventory with the specified enchantment id
Arguments
String
name
int
slot
String
enchantment_id
Returns
boolean True if the de-enchanting process was successful. False is usually the restult will be returned if the player is not on the server
Name
players.name.inventory.slots.slot.set
Description
Sets the specified slot in the specified player's inventory to the specified type with the specified quantity, data and damage
Arguments
String
name
int
slot
int
Id of block type to set
int
The data value of the item
int
The damage of the item
int
Quantity to set
Returns
boolean True if the item was given. False will be returned if the player is not on the server
Name
players.name.kick
Description
Kick a player with the specified name and the optional message
Arguments
String
name
String
Custom message to display to the player after they are kicked
Returns
void Method return desc
Name
players.name.op
Description
Ops the specified player
Arguments
String
name
Returns
void Method return desc
Name
players.name.pardon
Description
Unbans the specified player
Arguments
String
name
Returns
void Method return desc
Name
players.name.permissions
Description
Gets the permissions for a specific player
Arguments
String
name
Returns
Object[] Gets all the permissions and their values for a player
Name
players.name.permissions.add
Description
Add a permission node for a player
Arguments
String
name
String
The permission node
Boolean
The value to assign to the node
Returns
boolean Success?
Name
players.name.permissions.remove
Description
Removes a permission node for a player
Arguments
String
name
String
The permission node
Returns
boolean Success?
Name
players.name.send_message
Description
Send a private message to the specified player
Arguments
String
name
String
The message to send
Returns
void Method return desc
Name
players.name.set_experience
Description
Sets a player's experience on a scale of 0-4625 (level 50)
Arguments
String
name
int
The amount of experience to set
Returns
boolean True on succes, false if the player is not on the server
Name
players.name.set_food_level
Description
Sets a player's food level on a scale of 0-20
Arguments
String
name
int
The amount of food to set
Returns
boolean True on succes, false if something went wrong.
Name
players.name.set_game_mode
Description
Sets the game mode for a player. 0 is creative. 1 is survivial
Arguments
String
name
int
The game mode
Returns
boolean True on succes, false if the player is not on the server
Name
players.name.set_health
Description
Sets a player's health on a scale of 0-20
Arguments
String
name
int
The amount of health to set
Returns
boolean True on succes, false if the player is not on the server
Name
players.name.set_level
Description
Sets a player's level on a scale of 0-50
Arguments
String
name
int
The level to set
Returns
boolean True on succes, false if something went wrong.
Name
players.name.teleport
Description
Teleports the specified player to the specified x, y and z co-ordinates
Arguments
String
name
int
The x-coord of the block
int
The y-coord of the block
int
The z-coord of the block
Returns
boolean True if successful, false otherwise
Name
players.name.teleport_to.to_name
Description
Teleports the first specified player to the second specified player
Arguments
String
name
String
to_name
Returns
void Method return desc
Name
players.name.teleport_world
Description
Teleports the specified player to the specified world and xyz co-ordinates
Arguments
String
name
String
The world name
int
The x-coord of the block
int
The y-coord of the block
int
The z-coord of the block
Returns
boolean True if successful, false otherwise
Name
players.name.unwhitelist
Description
Removes the specified player from the whitelist
Arguments
String
name
Returns
void Method return desc
Name
players.name.whitelist
Description
Adds the specified player to the whitelist
Arguments
String
name
Returns
void Method return desc
Name
players.offline
Description
Retrieves an array of all the players who have ever played on the server but are not currently on the server
Returns
org.bukkit.OfflinePlayer[] An array of offlinePlayers
Name
players.offline.name
Description
Gets an offlinePlayer object representing the specified person
Arguments
String
name
Returns
org.bukkit.OfflinePlayer A offlinePlayer object respresenting the specified person
Name
players.offline.names
Description
Retrieves an array of the names of all the players who have ever played on the server but are not currently on the server
Returns
String[] The offline players' names
Name
players.online
Description
Gets an array of |player| objects that represent all of the players on the server
Returns
org.bukkit.entity.Player[] An array of |Player| objects
Name
players.online.count
Description
Gets the amount of players currently on the server
Returns
int The number of players on the server
Name
players.online.ips
Description
Returns a mapping of online player names to their connected IP address
Returns
java.util.Map
Name
players.online.limit
Description
Gets the maximum amount of players allowed on the server
Returns
int The player limit
Name
players.online.names
Description
Retrieves an array of the names of all the players currently on the server
Returns
String[] The players' names
Name
players.ops.names
Description
Gets the players who are opped
Returns
String[] Returns an array of strings; where each item in the array is a string that contains a player's name
Name
players.pardon_ip
Description
Bans the specified IP
Arguments
String
The IP to be pardoned
Returns
void Method return desc
Name
players.whitelisted.names
Description
Gets the players on the whitelist
Returns
String[] Returns an array of strings; where each item in the array is a string that contains a player's name
Name
plugins
Description
Gets an array of all loaded plugins
Returns
org.bukkit.plugin.Plugin[] An array of |plugin| objects
Name
plugins.disable_all
Description
Disables all plugins on the server
Returns
void Method return desc
Name
plugins.install
Description
Installs a plugin from a URL
Arguments
String
A URL that points to a .jar file that should be installed/
Returns
boolean If the plugin was successfully downloaded, installed and loaded.
Name
plugins.name
Description
Gets the |plugin| object for the plugin with the given name
Arguments
String
name
Returns
org.bukkit.plugin.Plugin The specified plugin
Name
plugins.name.commands
Description
Gets all the commands for a plugin with details
Arguments
String
The plugin name to fetch commands for
Returns
Object The commands with details
Name
plugins.name.disable
Description
Disables the specified plugin. Attempting to disable a plugin that is not enabled will have no effect
Arguments
String
name
Returns
boolean True if the plugin was disabled. False will be returned if the plugin is not on the server
Name
plugins.name.enable
Description
Enables the specified plugin. Attempting to enable a plugin that is already enabled will have no effect
Arguments
String
name
Returns
boolean True if the plugin was enabled. False will be returned if the plugin is not on the server
Name
plugins.name.files
Description
Retrives an array of files and directories that exist in the plugins data folder. Recursive
Arguments
String
name
Returns
String[] The files in string format
Name
plugins.name.version
Description
Gets version of a plugin
Arguments
String
name
Returns
String A string representing the version
Name
server
Description
Gets server information: maxPlayers, players, port, name, serverName, version, worlds
Returns
Object Key value object with information about the server
Name
server.bukkit.version
Description
Gets the Bukkit version that this server is running
Returns
String A string representing the version
Name
server.commands.list
Description
Gets the name of all the commands on the server
Returns
String[] The command names
Name
server.commands.list_with_details
Description
Gets the all the commands on the server with details, organized by plugins
Returns
Object The commands
Name
server.commands.name
Description
Gets the details of a command based on its name
Arguments
String
The command name to fetch details for
Returns
Object The command names
Name
server.map.save
Description
Saves the map to the filesystem
Returns
void Method return desc
Name
server.map.save_off
Description
Disables automatic terrian saving
Returns
void Method return desc
Name
server.map.save_on
Description
Enables automatic terrian saving
Returns
void Method return desc
Name
server.performance.disk.free
Description
Returns the number of free byte on the disk that Minecraft is located on
Returns
int Disk free space in megabytes
Name
server.performance.disk.size
Description
Gets the total size of the disk that Minecraft is located on
Returns
int Disk size in megabytes
Name
server.performance.disk.used
Description
Returns the number of bytes that have been used on the disk that Minecraft is located on
Returns
int Disk usage in megabytes
Name
server.performance.memory.total
Description
Gets the amount of memory available to Java.Bukkit.Minecraft. Note that is not a measurement of all the memory in the machine. To find system wide information look at getSystemMemoryTotal
Returns
int Java memory size in megabytes
Name
server.performance.memory.used
Description
Gets the amount of memory used by Java.Bukkit.Minecraft. Note that is not a measurement of all the memory used in the machine. To find system wide information look at getSystemMemoryUsage
Returns
int Java memory usage in megabytes
Name
server.performance.tick_health
Description
Returns expectedTicks, elapsedTicks, C, expectedClockRate, expectedTime, elapsedTime and % error
Returns
Object key value pairs with all the values in the descriptions
Name
server.power.reschedule_restart
Description
Reschedules the next server restart. The time parameter can either be in either the #h #m #s format, or the HH:MM format
Arguments
String
Time in either the #h #m #s format, or the HH:MM format
Returns
boolean False on error. Null otherwise
Name
server.power.restart
Description
Restarts the Minecraft server. THIS WILL TAKE DOWN JSONAPI FOR A SHORT TIME
Returns
boolean False on error. Null otherwise
Name
server.power.start
Description
Starts the Minecraft server. DO NOT CALL IF remotetookit.stopServer HAS NOT BEEN CALLED!
Returns
boolean True if successful, false otherwise
Name
server.power.stop
Description
Stops the Minecraft server. THIS WILL SHUT THE SERVER DOWN AND WILL NOT RESTART IT
Returns
boolean False on error. Null otherwise
Name
server.reload
Description
Reloads the server, refreshing settings and plugin information
Returns
void Method return desc
Name
server.run_command
Description
Runs a command in the console
Arguments
String
Command to send
Returns
void Method return desc
Name
server.settings.ip
Description
Get the IP that this server is bound to or empty string if not specified
Returns
String The IP
Name
server.settings.max_players
Description
Gets the maximum amount of players allowed on the server
Returns
int The player limit
Name
server.settings.motd
Description
Gets server's MOTD
Returns
String The MOTD
Name
server.settings.port
Description
Get the game port that the server runs on
Returns
int The port
Name
server.version
Description
Gets the version string of this server implementation
Returns
String A string representing the version
Name
streams.chat.latest
Description
Gets up to the last n lines in chat where n is the limit passed. Returned as an array of JSON stream objects
Arguments
int
The maximum number of items to return
Returns
Object[] The array of objects
Name
streams.connections.limit
Description
Gets up to the last n connections.disconnections where n is the limit passed. Returned as an array of JSON stream objects
Arguments
int
The maximum number of items to return
Returns
Object[] The array of objects
Name
streams.console.latest
Description
Gets up to the last n lines in the console where n is the limit passed. Returned as an array of JSON stream objects
Arguments
int
The maximum number of items to return
Returns
Object[] The array of objects
Name
streams.formatted_chat.latest
Description
Gets up to the last n lines in formatted_chat where n is the limit passed. Returned as an array of JSON stream objects
Arguments
int
The maximum number of items to return
Returns
Object[] The array of objects
Name
streams.name.limit
Description
Returns all the messages in a stream with the given name
Arguments
String
name
int
The maximum number of items to return
Returns
Object[] An array of message objects which are different for each kind of stream
Name
worlds.all
Description
Gets an array of all the |world| objects on the server
Returns
org.bukkit.World[] All of the worlds on the server
Name
worlds.names
Description
Gets an array of all the world names on the server
Returns
String[] All of the names of the worlds on the server
Name
worlds.world
Description
Gets the |world| object with the given name
Arguments
String
world
Returns
org.bukkit.World The world with the given name
Name
worlds.world.chat.groups.group.has_player
Description
Check if player is member of a group
Arguments
String
world
String
group
String
Player name
String
Group name
Returns
boolean Success or Failure
Name
worlds.world.get_block
Description
Set the type of the block in the specified world at the specified coordinate
Arguments
String
world
int
The x-coord of the block
int
The y-coord of the block
int
The z-coord of the block
int
The type ID to change the block to
Returns
void Method return desc
Name
worlds.world.groups.group.prefix
Description
Get group prefix
Arguments
String
world
String
group
Returns
String Prefix
Name
worlds.world.groups.group.set_prefix
Description
Set group prefix
Arguments
String
world
String
group
String
Prefix
Returns
String Prefix
Name
worlds.world.groups.group.set_suffix
Description
Set group suffix
Arguments
String
world
String
group
String
Suffix
Returns
String Suffix
Name
worlds.world.groups.group.suffix
Description
Get group suffix
Arguments
String
world
String
group
Returns
String Suffix
Name
worlds.world.players.names
Description
Retrieves an array of the names of all the players currently in the given world
Arguments
String
world
Returns
String[] The players' names
Name
worlds.world.players.player.chat.groups
Description
Gets the list of groups that this player has
Arguments
String
world
String
player
Returns
String[] A list of all known groups for a user
Name
worlds.world.players.player.chat.groups.primary
Description
Get player primary group
Arguments
String
world
String
player
Returns
String Group name
Name
worlds.world.players.player.chat.prefix
Description
Get player prefix
Arguments
String
world
String
player
Returns
String Prefix
Name
worlds.world.players.player.chat.set_prefix
Description
Set player prefix
Arguments
String
world
String
player
String
Prefix
Returns
String Prefix
Name
worlds.world.players.player.chat.set_suffix
Description
Set player suffix
Arguments
String
world
String
player
String
Suffix
Returns
String Suffix
Name
worlds.world.players.player.chat.suffix
Description
Get player suffix
Arguments
String
world
String
player
Returns
String Suffix
Name
worlds.world.set_block
Description
Set the data value of the block in the specified world at the specified coordinate
Arguments
String
world
int
The x-coord of the block
int
The y-coord of the block
int
The z-coord of the block
int
The decimal representation of the data value to set on the block
Returns
void Method return desc
Name
worlds.world.set_difficulty
Description
Sets the difficulty for a given world
Arguments
String
world
int
Difficulty. 0 is easy, 1 is hard, 2 is normal, 3 is peaceful.
Returns
boolean True on succes, false if the world does not exist
Name
worlds.world.set_time
Description
Sets the time for a given world
Arguments
String
world
int
Time (from 0-24000), 6000 is dawn, 24000 is midnight
Returns
boolean True on succes, false if the world does not exist