footnote
* writable
** can be null
receiver "dev" / "online" / "SERVER" / player
living_hurt an entity gets hurt
Variablen living_entity
damage_source
*damage_amount
*cancel
living_heal an entity gets healed
Variablen living_entity
*heal_amount
*cancel
living_death an entity dies
Variablen living_entity
damage_source
*cancel
block_drop a destroyed block drops something
Variablen **entity
**item
location
block
block_type
*drops with item-entities as list
living_experience_drop an entity dies and drops exp
Variablen living_entity
*experience
*cancel
living_drop an entity dies and drops something
Variablen living_entity
damage_source
*drops with item-entities as list
looting (as double)
*cancel
entity_click an entity gets right_clicked
Variablen player
entity
hand ("MAIN_HAND", "OFF_HAND")
*cancel
entity_join an entity spawns
Variablen entity
*cancel
entity_leave an entity despawns
Variablen entity
animal_tame an entity gets tamed
Variablen animal
tamer
*cancel
entity_mount an entity (dis)mounts another entity
Variablen rider
entity
mounting as boolean
*cancel
player_login a player joins the server
Variablen player
*cancel
player_logout a player leaves the server
Variablen player
*cancel
player_pre_respawn the players will respawn
Variablen player
Info devs can set the spawn-location on this event
player_post_respawn the players has respawned
Variablen player
Info devs can refill the inventory on this event
living_pre_hurt an entity gets hurt (event is thrown before living_hurt and cancels damage-animation and knockback)
Variablen living_entity
damage_source
*damage_amount
*cancel
living_jump an entity jumps
Variablen living_entity
player_sneak a player sneaks
Variablen player
sneak as boolean
mob_griefing an entity destroys the world
Variablen entity
*cancel
player_toss a player tosses an item
Variablen player
item
*cancel
player_pickup a player picks up an item
Variablen player
entity (item)
item
*cancel
player_move a player moves in an before defined area
Variablen player
id
block_break a block is broken
Variablen player
block as object
block_loc
block_type (e.g. "minecraft:wool", "km:artefact")
*cancel
block_place a block is placed
Variablen player
block as object
block_loc
block_type
block_click a block gets clicked
Variablen player
block as object
block_loc
block_type
action ("left", "right")
hand ("MAIN_HAND", "OFF_HAND")
*cancel
bucket_use a bucket is filled / vacated
Variablen player
has_block as boolean
**block
**block_loc
**block_type
*cancel
container_click a slot in an container gets clicked
Variablen player
slot as double
item_list
type as string
drag_type as double
click_type as string
*cancel
Info Custom inventories are not script-across.
inv_click a slot in an inventory gets clicked
Variablen player
item
inv
inv_name
inv_slot as number
inv_id
click_type
*cancel
Info Custom inventories are not script-across.
inv_close an inventory gets closed
Variablen player
inv
inv_id
inv_name
item_use_start an item gets started to be used with rightclick
Variablen living_entity
item
duration as number
*cancel
item_use_finish an item gets finished to be used with rightclick
Variablen living_entity
item
result (result item)
craft a player crafts an item
Variablen player
*result
portal a player switches the world
Variablen player
from world as string
to world as string
ender_teleport an enderpearl lands
Variablen living_entity
location*cancel
fishing a player fishes something
Variablen player
rod_damage
hook (entity)
*drops with itemstacks as list
*cancel
command a player uses a vanilla command
Variablen player
command as string
*cancel
custom_command a player (or console) uses a custom-command
Variablen player (null if console)
player_name (null if console) (deprecated)
command as string
args as list
text_args as list with strings only
chat a player writes into chat
Variablen player
message as string
*cancel
projectile_hit a thrown projectile hits a block or an entity
Variablen shooter
projectile
**entity_hit (=hitted entity)
**loc_hit (=hitted location)
item_hit the item thrown with living.shootProjectile() hits a block or an entity
Variablen shooter
projectile (=thrown entity)
item
**entity_hit (=hitted entity)
**loc_hit (=hitted location)
item_air_click a player makes a rightclick into air with an item
Variablen player
hand ("MAIN_HAND", "OFF_HAND")
*cancel
left_click_air a player makes a leftclick into air
Variablen player
function_key a player pushes one of the mod-functional-keys
Variablen player
key as number from 1 to 9
*cancel
human_hurt an entity beats a human
Variablen entity
human
pre_explosion explosions are cancelled on default
Variablen location
damage_source
*cancel|true
explosion explosion
Variablen location
damage_source
*affected_blocks as list with BlockPos
affected_entities as list
missing_command a player uses an non-existing command
Variablen **player
**player_name (deprecated)
command_name
sender_name
missing_perm a player has no permissions for a used command
Variablen **player
**player_name (deprecated)
command_name
sender_name
player_data_tick thrown if timer from data.setTimer reached 0
Variablen player
var
player_elytra_start thrown if a player starts using an elytra
Variablen player
player_elytra_stop thrown if a player stops using an elytra
Variablen player
world_load a world gets loaded
Variablen world
vote a vote gets received
Variablen from
name
ip
timestamp
event.addMoveData defines an area for player_move event and returns the move_id
Format event.addMoveData(location1, location2, cooldown, livingtime, [uuid / string_uuid / player])
Arguments cooldown: -1 terminated after a single trigger
cooldown: > 0 clock rate in Ticks. no termination
livingtime: -1 area lives forever
livingtime: > 0 stays amount of ticks alive
player / uuid: event only triggers for this player
Info on script termination this area will be removed
event.removeMoveData removes a defined area for player_move event
Format event.removeMoveData(id)
ban.add bans a player from the server
Format ban.add(uuid / string_uuid / player, reason, banner, [end_date])
Arguments reason as string
banner as string (the person who bans, almost you can write in here what you want)
end_date as calendar object
ban.remove unbans a player from the server
Format ban.remove(uuid / string_uuid / player)
ban.kick kicks a player from the server
Format ban.kick(player, reason)
block.set set a block at a location
Format block.set(location, ItemString, [boolean|false])
Arguments boolean true places without block update
Examples block.set(loc, "km:apricot_leaves")
block.set(loc, "minecraft:oak_log[axis=x]")
block.clone clone a block from a location to another
Format block.clone(from-location, to-location)
block.setSpawnerType sets the spawnertype
Format block.setSpawnerType(location, entity_class)
block.setSign set text on a sign and returns true on success
Format block.setSign(location, row, text)
Arguments block.setSign(row: 0 to 3)
block.getSign returns the text of a sign from a specific row or null if block is no sign
Format block.getSign(location, row)
Arguments block.setSign(row: 0 to 3)
block.addItem adds an itemstack to a container
Format block.addItem(location, itemstack)
Returns the modified original itemstack that has not fit in. air itemstack if done perfectly
block.subItem removes an itemstack from a container
Format block.subItem(location, itemstack)
Returns the modified original itemstack that could not be removed. air itemstack if done perfectly
block.get returns a block object
Format block.get(location)
block.getSecChest returns the second location of a doublechest
Format block.getSecChest(location)
block.getInv returns the (non-copy) inventory of a block
Format block.getInv(location)
block.getType returns the type of a block at a location
Format block.getType(location)
Examples returns "minecraft:wool" / "km:artefact"
block.toStack returns an itemstack from a block at a location
Format block.toStack(location)
block.getItemAmount returns the amount from a specific itemtype in an container
Format block.getItemAmount(location, boolean, itemstack)
Info true means exact itemstack
block.setDoorStatus true opens a door
Format block.setDoorStatus(location, boolean)
block.getDoorStatus returns true if the door is open
Format block.getDoorStatus(location)
block.setTrapdoorStatus true opens a trapdoor
Format block.setTrapdoorStatus(location, boolean)
block.getTrapdoorStatus returns true if the trapdoor is open
Format block.getTrapdoorStatus(location)
block.isAir returns true if the block at the location is an air block
Format block.isAir(location)
block.countAir returns the amount of air blocks a location surrounded with
Format block.countAir(location)
block.isSolid returns true if the block is solid
Format block.isSolid(location)
block.getTag returns a tag
Format block.getTag(String tag_name)
block.hasTag returns true if a block has a tag
Format block.hasTag(tag, Block)
block.getProperties returns a collection of properties
Format block.getProperties(location)
block.getProperty returns a property
Format block.getProperty(String property_name)
Info some properties has to be renamed. look here: me.km.utils.Mapper
block.property.getValue returns the value of a property as double, string or boolean, demanding on the property
Format block.property.getValue(location, property)
block.property.setInt sets the value of a property
Format block.property.setInt(location, property, int)
block.property.setBool sets the value of a property
Format block.property.setBool(location, property, boolean)
block.property.setEnum sets the value of a property
Format block.property.setEnum(location, property, string))
block.setState sets the state of a block
Format block.setState(location, state, [boolean])
block.getState returns the state of a block
Format block.getState(location)
block.newState creates a block state
Format block.newState(state)
Examples block.newState("minecraft:stone")
Info returns null if invalid state
block.break breaks a block and drops the item
Format block.break(location, entity)
Info entity can be null
databank.prepare returns the prepared statement
Format databank.prepare(sql-query, [boolean autoclose|true])
databank.setInt sets an int into a statement
Format databank.setInt(statement, index, int)
databank.setDouble sets a double into a statement
Format databank.setDouble(statement, index, double)
databank.setLong sets a long into a statement
Format databank.setLong(statement, index, long)
databank.setString sets a string into a statement
Format databank.setString(statement, index, string)
databank.setBool sets a boolean into a statement
Format databank.setBool(statement, index, boolean)
databank.getInt returns an int from a result set
Format databank.getInt(result-set, index)
databank.getDouble returns a double from a result set
Format databank.getDouble(result-set, index)
databank.getLong returns a long from a result set
Format databank.getLong(result-set, index)
databank.getString returns a string from a result set
Format databank.getString(result-set, index)
databank.getBool returns a boolean from a result set
Format databank.getBool(result-set, index)
databank.execute returns a result-set after executing the statement (for all reading queries like SHOW, SELECT)
Format databank.execute(statement)
databank.workerExecute executing the statement (for all writing queries like UPDATE, DELETE, CREATE, INSERT, DROP)
Format databank.workerExecute(statement)
databank.next returns true and jumps to the next entry if the result-set has a next entry
Format databank.next(result-set)
databank.close manual closing of a result-set
Format databank.close(result-set)
config.saveAsync saves a config asynchronous
Format config.saveAsync(config)
gamerule.getKey returns the gamerule_key
Format gamerule.getKey(gamerule_string)
gamerule.getValue return the gamerule_value from a world
Format gamerule.getValue(world, gamerule_key)
gamerule.isBool returns true if the value is a boolean
Format gamerule.isBool(gamerule_value)
gamerule.isInt returns true if the value is an integer
Format gamerule.isInt(gamerule_value)
gamerule.getBool returns the gamerule_value as boolean
Format gamerule.getBool(gamerule_value)
gamerule.getInt returns the gamerule_value as integer
Format gamerule.getInt(gamerule_value)
gamerule.setBool sets a gamerule_value
Format gamerule.setBool(gamerule_value, boolean)
Info Gamerules in other worlds than the overworld are not persistent.
gamerule.setInt sets a gamerule_value
Format gamerule.setInt(gamerule_value, value)
Info Gamerules in other worlds than the overworld are not persistent.
msg sends a message
Format msg(receiver, string)
print prints a text for devs
Format print(string)
command executes a Minecraft command from console
Format command(minecraft command syntax as string without /)
worker.hasWork returns true if the worker is working
Format worker.hasWork()
isPlayer returns true if the argument is a player
Format isPlayer(anything)
isLiving returns true if the argument is a living entity
Format isLiving(anything)
setMOTD sets the server text in the server list
Format setMOTD(text)
modTimer modifies the timer for the auto scheduler
Format modTimer(milliseconds as long)
item.drop drops an itemstack at a location
Format item.drop(location, itemstack)
item.get returns an item as object
Format item.get(itemstack)
item.getType returns the type of an itemstack
Format item.getType(itemstack)
Examples "minecraft:wool" / "km:artefact"
item.getAmount returns the amount of items in an itemstack
Format item.getAmount(itemstack)
item.setAmount sets the amount of items for an itemstack
Format item.setAmount(itemstack, value)
item.getName returns the name of an itemstack
Format item.getName(itemstack)
item.setName sets the name of an itemstack
Format item.setName(itemstack, name)
item.getLore returns a list with all lores of an itemstack
Format item.getLore(ItemStack)
item.setLore sets the lore for an itemstack with the elements in the list
Format item.setLore(itemstack, List)
item.addLore sets the lore for an itemstack for a specific row
Format item.addLore(itemstack, lore, row)
item.addAttribute adds an attribute to an itemstack
Format item.addAttribute(itemstack, attribute, slot, double, operation)
Info attributes: generic.max_health, generic.follow_range, generic.knockback_resistance, generic.movement_speed, generic.flying_speed, generic.attack_damage, generic.attack_damage, generic.attack_knockback, generic.attack_speed, generic.armor, generic.armor_toughness, generic.luck, zombie.spawn_reinforcements, horse.jump_strength
slots: mainhand, offhand, head, chest, legs, feet
operation: 0 (ADDITION), 1 (MULTIPLY_BASE), 2 (MULTIPLY_TOTAL)
item.clearAttributes removes all custom attributes from an itemstack
Format item.clearAttributes(itemstack)
item.hasAttributes returns true if an itemstack has custom attributes
Format item.hasAttributes(itemstack)
item.addDefaultTags adds the default attributes to an itemstack
Format item.addDefaultTags(itemstack)
item.hide hides something on an itemstack and returns true on success
Format item.hide(itemstack, name)
Info name: "enchantments" / "attributes" / "unbreakable" / "destroys" / "placed_on" / "potion_effects"
item.addPotion unknown
Format item.addPotion(itemstack, potion_name, duration, power)
item.setCoolDown sets the cooldown for an item-type
Format item.setCoolDown(player, itemstack, ticks)
item.clone returns a copy of an itemstack
Format item.clone(itemstack)
item.getTag returns a tag
Format item.getTag(String tag_name)
item.hasTag returns true if an itemstack has a tag
Format item.hasTag(tag, itemstack)
item.hasName returns true if the itemstack has a modified name
Format item.hasName(itemstack)
item.getFullText returns the full text object
Format item.getFullText(itemstack)
item.isDamageable returns true if the itemstack is damageable
Format item.isDamageable(itemstack)
item.getMaxDamage returns the maximum damage the itemstack can get
Format item.getMaxDamage(itemstack)
item.setDamage sets the damage of the itemstack
Format item.setDamage(itemstack, amount)
item.getDamage returns the damage of an itemstack
Format item.getDamage(itemstack)
item.getMaxAmount returns the maximum amount of stackable items
Format item.getMaxAmount(itemstack)
item.entity.get returns an itemstack from an item-entity
Format item.entity.get(item-entity)
item.entity.set sets an itemstack to an item-entity
Format item.entity.set(item-entity, itemstack)
item.entity.new creates an item-entity from an itemstack and returns the item-entity
Format item.entity.new(location, itemstack)
item.entity.spawn spawns an item-entity
Format item.entity.spawn(entity)
item.entity.setLifespan sets the lifespan of an item-entity
Format item.entity.setLifespan(item-entity, ticks)
enchantment.get returns an enchantment
Format enchantment.get(enchantment_string)
Arguments Minecraft Wiki Verzauberungen (ID-Name verwenden)
enchantment.add adds an enchantment to an itemstack
Format enchantment.add(enchantment, itemstack, level)
enchantment.getLevel returns the level of an enchantment an itemstack has
Format enchantment.getLevel(enchantment, itemstack)
enchantment.readFromItem returns a map with all enchantments from an item with the level as value
Format enchantment.readFromItem(itemstack)
enchantment.writeToItem transfers all enchantments from the map on the itemstack
Format enchantment.writeToItem(map, itemstack)
error.clear clears all cached errors
Format error.clear()
error.getSize returns the amount of all cached errors
Format error.getSize()
error.getIndex returns the error from an index
Format error.getIndex(index)
error.setConsolePrint true prints snuvi errors on console (not stack traces)
Format error.setConsolePrint(boolean)
debug.clear clears all cached debug-messages
Format debug.clear()
debug.getSize returns the amount of all cached debug-messages
Format debug.getSize()
debug.getIndex returns the debug-message from an index
Format debug.getIndex(index)
debug.setConsolePrint true prints snuvi debug-messages on console (not stack traces)
Format debug.setConsolePrint(boolean)
loc.new creates a location
Format loc.new(World, x, y, z)
loc.new(World, x, y, z, yaw, pitch)
loc.getX returns the x coordinate
Format loc.getX(location)
loc.setX sets the x coordinate
Format loc.setX(location, value)
loc.addX adds the value to the x coordinate
Format loc.addX(location, value)
loc.getY returns the y coordinate
Format loc.getY(location)
loc.setY sets the y coordinate
Format loc.setY(location, value)
loc.addY adds the value to the y coordinate
Format loc.addY(location, value)
loc.getZ returns the z coordinate
Format loc.getZ(location)
loc.setZ sets the z coordinate
Format loc.setZ(location, value)
loc.addZ adds the value to the z coordinate
Format loc.addZ(location, value)
loc.setYaw sets the yaw of a location
Format loc.setYaw(location, Yaw)
loc.getYaw returns the yaw of a location
Format loc.getYaw(location)
loc.setPitch sets the pitch of a location
Format loc.setPitch(location, Pitch)
loc.getPitch returns the pitch of a location
Format loc.getPitch(location)
loc.getWorld returns the world of a location as object
Format loc.getWorld(location)
loc.distance returns the difference between two locations
Format loc.distance(location1, location2)
Info there is no error if the two locations have not the same world
loc.isBetween returns true if the location is between two other locations
Format loc.isBetween(location, location1, location2)
loc.mod returns a modified copy of the location
Format loc.mod(location, x, y, z)
loc.add modifies the original location
Format loc.add(location, x, y, z)
loc.set modifies the original location
Format loc.set(location, x, y, z)
loc.getCoord returns information from location
Format loc.getCoord(location, w/x/y/z/bx/by/bz)
Arguments w as world_name_string
b are block coordinates
loc.sort sort in lowest and highest coordinates
Format loc.sort(location1, location2)
loc.setBlockPos sets the coordinates of a location from a blockPos
Format loc.setBlockPos(location, blockPos)
loc.iterator returns the iterator for the area
Format loc.iterator(world, x1, y1, z1, x2, y2, z2)
loc.trace returns the traced original location or false if no block is found
Format loc.trace(location, direction_x, direction_y, direction_z, steps, boolean)
Arguments boolean true means the block before the last one
loc.explode makes an explosion at a location
Format loc.explode(location, entity, radius, fire_bool, block_damage_bool)
Info entity can be null
read.spawnMob spawns a mob and returns the entity
Format read.spawnMob(location, nbt-tag)
read.player returns the object player
Format read.player(playername)
read.item returns an itemstack
Format read.item(nbt-tag)
read.item(item_type)
read.item(item_type, item_amount)
read.item(item_type, item_amount)
read.item(item_type, item_amount, name)
read.item(item_type, item_amount, name, lore1, lore2, ...)
Info returns null if the item does not exist
read.location returns a location
Format read.location("location")
Arguments worldname:x:y:z[:yaw:pitch]
Examples read.location("gpvpnew:234:100:-341")
read.location("gpvpnew:234:100:-341:90:15")
read.uuid returns a uuid
Format read.uuid("uuid")
read.slot returns a slot
Format read.slot(slot)
Info slot: "head" / "chest" / "legs" / "feet" / "hand" / "offhand"
text.item returns an nbt-tag from an itemstack
Format text.item(itemstack)
text.location returns a string from a location
Format text.location(location)
text.locationBlock returns a string with rounded coordinates from a location
Format text.locationBlock(location)
text.entity returns a string from a entity
Format text.entity(entity)
removeFormat removes formatting
Format removeFormat(string)
text.click returns a clickable text object
Format text.click(show_text, execute_text)
Examples msg(player, text.click("Click me", "and i will appear in the player's text screen"));

msg(player, text.click("Click me", "/wusi"));
text.hover returns a hoverable text object
Format text.hover(show_text, execute_text)
Examples msg(player, text.hover("Move over this text", "to see this text"));

msg(player, text.hover(text.click("Click or move over me", "to print text or execute a command like /wusi"), "or to show this hover_text"));
text.link returns a clickable message for links
Format text.link(message, link)
text.copyText returns a clickable message to copy text from a website
Format text.copyText(message, string)
text.clipBoard returns a clickable message to set text to the clipboard
Format text.clipBoard(message, string)
text.concat2 connects all given arguments and returns a string object
Format text.concat2(arg, ...)
Info Colorcodes gets lost with this.
plot.add returns the created plot
Format plot.add(location1, location2, [plot_id])
plot.remove removes a plot from a world
Format plot.remove(plot, world)
plot.getId returns the plot_id
Format plot.getId(plot)
plot.setName sets the name of a plot
Format plot.setName(plot, name)
plot.getName returns the name of a plot
Format plot.getName(plot)
plot.get returns a list with all plots at a location
Format plot.get(location)
plot.getMinX returns the lowest x coordinate of a plot
Format plot.getMinX(plot)
plot.getMinY returns the lowest y coordinate of a plot
Format plot.getMinY(plot)
plot.getMinZ returns the lowest z coordinate of a plot
Format plot.getMinZ(plot)
plot.getMaxX returns the lowest x coordinate of a plot
Format plot.getMaxX(plot)
plot.getMaxY returns the lowest y coordinate of a plot
Format plot.getMaxY(plot)
plot.getMaxZ returns the lowest z coordinate of a plot
Format plot.getMaxZ(plot)
plot.intersecting returns a list with all intersecting plots
Format plot.intersecting(world, x1, y1, z1, x2, y2, z2)
plot.setFlags sets all flags to the boolean
Format plot.setFlags(plot, flags, boolean)
plot.getFlags returns all flags as double
Format plot.getFlags(plot)
plot.hasFlags returns true if all flags existing
Format plot.hasFlags(plot, flags)
plot.getOwners returns a list with all owners as uuid (modifying the list changes the owners)
Format plot.getOwners(plot)
plot.check returns true if the player is owner of any plot from that location OR if any plot contains all given flags. returns empty if there is no plot
Format plot.check(location, player, Int flags, Boolean empty)
Arguments player can be null
flags: 0 if not desired
1 PLACE_FLAG
2 BREAK_FLAG
4 BUCKET_FLAG
8 HIT_AMBIENT_FLAG
16 BLOCK_INTERACT_FLAG
32 ENTITY_INTERACT_FLAG
Examples plot.check(loc, null, 1, false) ==> true if place_flag existing
plot.check(loc, null, 2, false) ==> true if break_flag existing
plot.check(loc, null, 3, false) ==> true if break_flag and place_flag existing
plot.check(loc, player, 0, false) ==> true if player is owner
plot.check(loc, player, 0, true) ==> true if player is owner or if there is no plot
plot.iterator returns the iterator for the plots in a world [for a player]
Format plot.iterator(world, [uuid])
table.new returns a table object
Format table.new(color, width, width, width, ...)
table.getStart returns the tables head
Format table.getStart(table)
table.getMiddle returns a tables middle
Format table.getMiddle(table)
table.getEnd returns the tables end
Format table.getEnd(table)
table.get returns a tables line
Format table.get(table, args...)
table.setSize defines the pixel size of a character
Format table.setSize("character", pixel_int)
command.add registers a custom command
Format command.add(string)
command.remove removes a custom command
Format command.remove(string)
command.clear removes all custom commands
Format command.clear()
command.exists returns true if a custom command exists
Format command.exists(string)
command.addIgnored ignores a (vanilla) command-help
Format command.addIgnored(string)
command.clearIgnored removes all ignored command-helps
Format command.clearIgnored()
command.newHelp returns a help-object
Format command.newHelp(string, perm)
command.newHelpLiteral returns a help-sub-object
Format command.newHelpLiteral(string, [perm])
command.newHelpBool returns a help-sub-object
Format command.newHelpBool(string, [perm])
command.newHelpDouble returns a help-sub-object
Format command.newHelpDouble(string, min, max, [perm])
command.newHelpFloat returns a help-sub-object
Format command.newHelpFloat(string, min, max, [perm])
command.newHelpInt returns a help-sub-object
Format command.newHelpInt(string, min, max, [perm])
command.newHelpLong returns a help-sub-object
Format command.newHelpLong(string, min, max, [perm])
command.newHelpString returns a help-sub-object
Format command.newHelpString(string, boolean, [perm])
Arguments boolean true means greedy
command.newHelpSpecial returns a help-sub-object
Format command.newHelpSpecial(type, string, [perm])
Arguments type = "Item", "Block", "Potion", "Enchantment", "Player"
command.addHelp registers a command-help
Format command.addHelp(help-object)
command.addHelpChild help-sub-object2 is added tp help-(sub-)object1 as a new argument
Format command.addHelpChild(help-(sub-)object1, help-sub-object2)
command.addHelpAlias help-object1 refers to help-object2
Format command.addHelpAlias(help-object1, help-object2)
command.sendHelp sends all registered command-helps to all players
Format command.sendHelp()
command.clearHelp removes all registered command-helps
Format command.clearHelp()
sb.add add text to the scoreboard
Format sb.add(receiver, index, string)
Arguments index as number from 1 to 99
Info vanilla handling:
maximum 12 rows
rows with the same content are only shown once
sb.remove removes a row from the scoreboard
Format sb.remove(receiver, index)
Arguments index as number from 1 to 99
sb.reset removes the whole scoreboard
Format sb.reset(receiver)
display.add add icons or text to the players display
Format display.add(receiver, index, string)
Arguments index as number from 1 to 99
Info maximum 32 characters each row
you will find all icons in the mod file .minecraft/mods/km-x.xx/assets/km/textures/gui/icons
every icon has an id beginning with 1 in the left upper corner
you show icons in this format: "#id-amount-" e.g. "#3-1-"
fallback id is 0 (shows nothing)
display.remove removes a row from the display
Format display.remove(receiver, index)
Arguments index as number from 1 to 99
display.reset removes the whole display
Format display.reset(receiver)
stacks.set fills a slot of the stacks-display with an icon
Format stacks.set(receiver, index, item_name)
Arguments index as number from 0 to 8
stacks.setActive shows/removes the stacks-display
Format stacks.setActive(receiver, boolean)
stacks.clearIndex clears a slot from the stacks-display
Format stacks.clearIndex(receiver, index)
Arguments index as number from 0 to 8
stacks.clear clears the whole stacks-display
Format stacks.clear(receiver)
script.start connects all scripts, starts them as one script and returns the script
Format script.start(scriptpath1, scriptpath2, ...)
script.startNamed connects all scripts, starts them as one script and returns the script
Format script.startNamed(custom_name, scriptpath1, scriptpath2, ...)
Info named scripts can be selected with script.get by their custom_name
script.callEvent calls an event
Format script.callEvent(event, [script])
title.send shows a player a title (and subtitle if set)
Format title.send(player, title)
title.setSub sets a subtitle
Format title.setSub(player, subtitle)
title.setTime sets the times for title
Format title.setTime(player, fadeIn|20, show|60, fadeOut|20)
Arguments times in ticks
title.reset resets the times for title to default
Format title.reset(player)
title.clear removes the shown title
Format title.clear(player)
perm.clear removes all permissions
Format perm.clear()
perm.registerGroup adds a permission to a permission-group
Format perm.registerGroup(id, permission)
Info id 0 = default
id 1 = worldedit
perm.registerPlayer adds a permission-group to a a player
Format perm.registerPlayer(uuid / string_uuid / player, id)
perm.unregisterPlayer removes a permission-group from a player
Format perm.unregisterPlayer(uuid / string_uuid / player, id)
perm.has returns true if the player has the permission
Format perm.has(player, permission)
players.toList returns a list with all players online
Format players.toList()
players.toWorldList returns a list with all players in a world
Format players.toWorldList(World)
Alias world.getPlayers(World)
players.near returns a list with all players within a radius of a location
Format players.near(location, radius)
player.damageArmor damages an players armor, portioned on all armor parts
Format player.damageArmor(player, damage_float, damage_source)
player.near returns a list with all players within a radius of a player (without that player)
Format player.near(player, radius)
players.getAmount returns the number of online players
Format players.getAmount()
player.getHead returns a players head as an itemstack
Format player.getHead(uuid, name)
Arguments uuid and(!) name of the player
player.getNearest returns the next player to a location
Format player.getNearest(location)
player.setDisplayName set the player's name in tab list
Format player.setDisplayName(player, display_name)
player.speak (deprecated) sends a message with prefix
Format player.speak(receiver, präfix, text)
player.action shows a message in the action bar
Format player.action(receiver, text)
player.getTarget returns the location from the block the player is looking at
Format player.getTarget(player, radius|5, [blockmode|true], [fluidmode|true])
Arguments blockmode: true ignores blocks without player collision
fluidmode: true does not ignores water
player.inventoryToList returns a list with the inventory of a player
Format player.inventoryToList(player)
Info an empty slot is null
changes effects the player inventory directly
player.getName returns the name of a player
Format player.getName(uuid / string_uuid / player)
player.getUuid returns the uuid of a player
Format player.getUuid(player / player_name)
player.getUuidFromId returns the uuid of a player from his id
Format player.getUuidFromId(player_id)
player.getNameFromId returns the name of a player from his id
Format player.getNameFromId(player_id)
player.getId returns the id of a player
Format player.getId(player / uuid / string_uuid)
player.get returns the player
Format player.get(uuid / string_uuid)
player.respawn awakes a player from death if the parser reaches wait() and activates the respawn events
Format player.respawn(player)
player.setCompass set the direction for a players compass
Format player.setCompass(player, location)
player.setHunger set the players hunger (vanilla default: 0-20)
Format player.setHunger(player, number)
player.getHunger returns the players hunger as number
Format player.getHunger(player)
player.setSaturation set the players saturation (vanilla default: 0-20)
Format player.setSaturation(player, number)
player.getSaturation returns the players saturation as number
Format player.getSaturation(player)
player.setGamemode set the gamemode for a player
Format player.setGamemode(player, gamemode)
Arguments gamemode as "survival" / "creative" / "adventure" / "spectator"
player.isSurvival returns true if the player is in gamemode survival or adventure
Format player.isSurvival(player)
player.isCreative returns true if the player is in gamemode creative
Format player.isCreative(player)
player.isAdventure returns true if the player is in gamemode adventure or spectator
Format player.isAdventure(player)
player.isSpectator returns true if the player is in gamemode spectator
Format player.isSpectator(player)
player.hasFly returns true if the player can fly
Format player.hasFly(player)
player.setFly set true for a flying player
Format player.setFly(player, boolean)
player.getLastDamager returns the entity which harmed the player the last time
Format player.getLastDamager(player)
player.dropInventory drops the inventory from a player at a location
Format player.dropInventory(player, location)
player.getItemAmount returns the amount of an item-type from a players inventory
Format player.getItemAmount(player, boolean, itemstack)
Arguments true means exact itemstack
player.damageItem damages the item in a player's hand
Format player.damageItem(player, damage_amount)
Info unbreaking (and more) is considered
player.setBedSpawn sets the spawn-location for a player
Format player.setBedSpawn(player, location, [yaw])
player.setSpawn(player, location, [yaw])
player.getBedSpawn returns the spawn-location for a player
Format player.getBedSpawn(player)
player.getSpawn(player)
player.giveItem gives an itemstack to a player and returns the itemstack which didn't fit in the players inventory
Format player.giveItem(player, itemstack)
player.removeItem removes an itemstack from a player and returns the itemstack which couldn't be removed from the players inventory
Format player.removeItem(player, itemstack)
player.say send a message to global chat, like a player has written the message by himself
Format player.say(player, text)
player.getIP returns the ip-address of a player as string
Format player.getIp(player)
player.clearInventory clears the inventory of a player
Format player.clearInventory(player)
player.openEnderchest opens the enderchest from a player and shows it to a player
Format player.openEnderchest(from_player, to_player)
player.getInv returns the (non-copy) players inventory
Format player.getInv(player)
player.getEnderInv returns the (non-copy) players ender inventory
Format player.getEnderInv(player)
player.getTargetEntity returns the targeted entity
Format player.getTargetEntity(player, radius, class)
Examples player.getTargetEntity(player, 4, "net.minecraft.entity.player.EntityPlayer")
player.getLevel returns the level of a player
Format player.getLevel(player)
player.setLevel sets the level of a player
Format player.setLevel(player, level)
player.getExp returns the exp of a player
Format player.getExp(player)
player.setExp sets the exp of a player
Format player.setExp(player, exp)
player.addTotalExp modifies the exp of a player
Format player.addTotalExp(player, exp)
player.hide hides a player
Format player.hide(player)
Info bug: effects show the player
player.show shows a player
Format player.show(player)
inv.new returns a new created custom-inventory
Format inv.new(String slotdata)
Arguments slotdata: 0 = no slot / 1 = normal slot / 2 = button throws inv_click event, backgroundcolor like frame / 3 = button throws inv_click event, backgroundcolor different to frame
Examples inv.new("002133")
inv.getSize returns the size of an inventory
Format inv.getSize(inventory)
inv.setItem sets an itemstack on a specific slot in an inventory
Format inv.setItem(inventory, slotindex, itemstack)
inv.getItem returns an itemstack from a specific slot of an inventory
Format inv.getItem(inventory, slotindex)
inv.open shows an custom-inventory to a player
Format inv.open(inventory, player, inv_title)
inv.close closes an inventory from a player
Format inv.close(player)
inv.update updates an inventory from a player
Format inv.update(player)
inv.loadChest copies the content of a chest and put it into an inventory
Format inv.loadChest(location)
inv.getID returns the id of an inventory
Format inv.getID(inventory)
world.get returns a world as object
Format world.get(world_name_string)
world.getName returns the name of a world
Format world.getName(World)
world.setDifficulty sets the difficulty of a world
Format world.setDifficulty(difficulty_string)
Arguments difficulty_string: PEACEFUL, EASY, NORMAL, HARD
world.setSpawn sets the world spawn
Format world.setSpawn(World, Location, [yaw])
world.getSpawn returns the world spawn as location
Format world.getSpawn(World)
world.getAll returns a list with all loaded worlds
Format world.getAll()
world.setTime sets the time (0 - 24000) for a minecraft world
Format world.setTime(World, time)
world.getTime returns the time (0 - 24000) of a minecraft world
Format world.getTime(World)
world.hasStorm returns true if it is raining in the world
Format world.hasStorm(World)
world.clearWeather clears the weather in a world
Format world.clearWeather(World, time)
Info effect of time unknown
world.setRain sets the weather in a world to rain
Format world.setRain(World, time)
Info effect of time unknown
world.setThunder sets the weather in a world to thunder
Format world.setThunder(World, time)
Info effect of time unknown
world.getEntities returns a list with all entities from a world
Format world.getEntities(world)
entity.getType returns the type of an entity
Format entity.getType(entity)
entity.setName sets the name of an entity, true for an always visible name
Format entity.setName(entity, name, nameVisibility|false)
entity.getName returns the name of an entity
Format entity.getName(entity)
entity.getLocation returns the location of an entity
Format entity.getLocation(entity / player)
entity.teleport teleports an entity
Format entity.teleport(entity / player, location)
entity.setInvulnerable sets an entity (in)vulverable
Format entity.setInvulnerable(entity / player, boolean)
entity.throw throws an entity in relative direction to the entity
Format entity.throw(entity / player, x, y, z)
Info x/y/z is claimed in the interval from -3.9 to 3.9 by minecraft
entity.setInvisible sets an entity (in)visible
Format entity.setInvisible(entity / player, boolean)
entity.clearEffects remove all effects from an entity
Format entity.clearEffects(entity)
entity.remove removes an entity
Format entity.remove(entity)
entity.removeAll remove specific entities from an area
Format entity.removeAll(entity_class, location, radius)
Info not all entity_classes are allowed (filtered and blocked)
Examples entity.removeAll("net.minecraft.entity.passive.CowEntity", location, radius)
entity.setSilent true sets an entity silent
Format entity.setSilent(entity, boolean)
entity.mount let an entity ride another entity (for any living entities)
Format entity.mount(entity, horse_entity)
entity.unmount unmounts the rider
Format entity.unmount(entity)
entity.isWet returns true if an entity is wet
Format entity.isWet(entity)
entity.isBurning returns true if an entity burns
Format entity.isBurning(entity)
entity.setBurning sets an entity on fire
Format entity.setBurning(entity, seconds)
Info 0 seconds extinguish the entity
entity.setNoPickup this arrow-entity cannot be picked up
Format entity.setNoPickup(arrow-entity)
entity.get returns the next entity to a location
Format entity.get(location, radius, entity_class)
Examples entity.get(location, radius, "net.minecraft.entity.passive.CowEntity")
entity.getItemFromFrame returns the itemstack of an itemframe
Format entity.getItemFromFrame(itemframe-entity)
entity.spawnItemFrame sets an itemframe with an itemstack
Format entity.spawnItemFrame(location, direction, itemstack)
Arguments direction "north" / "east" / "south" / "west"
entity.spawn spawns an entity and returns the entity
Format entity.spawn(type, location, [daten])
entity.getEnchantmentModifier returns the summarized enchantment modificator of the armor for the damagesource
Format entity.getEnchantmentModifier(entity, damagesource)
entity.setGravity toggles the gravity of an entity
Format entity.setGravity(entity, boolean)
entity.setPickupDelay unknown
Format entity.setPickupDelay(item-entity, ticks)
entity.setGrowingAge sets the growing age of an entity
Format entity.setGrowingAge(entity, age_int)
entity.getEffectAmplifier returns the amplifier (effect level), 0 if not existing
Format entity.hasEffect(entity / player, effect)
Arguments String effect
entity.addEffect adds an effect to an entity
Format entity.addEffect(entity / player, effect, ticks, amplifier, [particle|true])
Arguments String effect / number ticks (infinite: 32760) / number amplifier (1 means potion-level 1)
entity.getPotionType returns the type of a potion
Format entity.getPotionType(potion-entity)
entity.near returns a list with all entities within a location / a radius of an entity
Format entity.near(location / entity, radius)
entity.getLook returns an array with vectors
Format entity.getLook(entity / player)
Examples array[0] = x
array[1] = y
array[2] = z
entity.getMotion returns an array with vectors
Format entity.getMotion(entity)
entity.addTag adds a tag to an entity
Format entity.addTag(entity, tag as string)
entity.removeTag removes a tag from an entity
Format entity.removeTag(entity, tag as string)
entity.clearTag removes all tags from an entity
Format entity.clearTag(entity)
entity.hasTag returns true if an entity has a tag
Format entity.hasTag(entity, tag as string)
Info default entity-tags: no_tick, mod_spawned
creeper.explode let a creeper explode
Format creeper.explode(entity)
sheep.isSheared returns true if a sheep is sheared
Format sheep.isSheared(entity)
sheep.getColor(entity) returns the color of a sheep
Format sheep.getColor(entity)
pet.isTamed returns true if a pet is tamed
Format pet.isTamed(tamable_entity)
pet.setTamed set tame state for a tamable entity
Format pet.setTamed(tamable_entity, boolean, [owner])
Example pet.setTamed(horse, true)
pet.setTamed(horse, false)
pet.setTamed(horse, true, owner)
pet.setTamed(horse, false, owner)
pet.getOwner returns the owner's uuid from an pet
Format pet.getOwner(tamable_entity)
living.setHealth sets the health points for an living_entity
Format living.setHealth(living_entity, amount)
living.getHealth returns the health points from an living_entity
Format living.getHealth(living_entity)
living.damage damages an living_entity
Format living.damage(living_entity, damage_amount, [damagesource])
Info triggers events on the next server tick
living.heal heals an living_entity
Format living.heal(living_entity, heal_amount)
Info triggers events on the next server tick
living.setEquip set the equipment of an living_entity
Format living.setEquip(living_entity, bodypart, itemstack)
Info bodypart: "head" / "chest" / "legs" / "feet" / "hand" / "offhand"
living.getEquip returns the equipment of an living_entity
Format living.getEquip(living_entity, bodypart)
Arguments bodypart: "head" / "chest" / "legs" / "feet" / "hand" / "offhand"
living.near returns a list with all living entities within a location / a radius of an entity
Format living.near(location / entity, radius)
living.removeAi removes the AI of an entity
Format living.removeAi(living_entity)
commands for living properties
Format living.get...(living_entity)
living.getBase...(living_entity)
living.set..(living_entity, value)
living.setPersistent...(living_entity, value)
Properties ...maxHealth
...AttackKnockback
...AttackDamage
...AttackSpeed
...FollowRange
...Luck
...Armor
...ArmorThoughness
...MovementSpeed
...FlyingSpeed
...KnockbackResistance
living.shootProjectile returns the shooten entity. A projectile is shooten into viewing direction of the player
Format living.shootProjectile(living_entity, String entity_class, Number power, [data])
Arguments data: always null, except for arrows and potions use itemstacks

entity_classes:

me.km.entities.EntityItemProjectile
net.minecraft.entity.projectile.SnowballEntity
net.minecraft.entity.projectile.EggEntity
net.minecraft.entity.item.EnderPearlEntity
net.minecraft.entity.projectile.PotionEntity
net.minecraft.entity.item.ExpBottleEntity
net.minecraft.entity.projectile.ArrowEntity
net.minecraft.entity.projectile.TippedArrowEntity
net.minecraft.entity.projectile.SpectralArrowEntity
net.minecraft.entity.projectile.ArrowEntity
net.minecraft.entity.projectile.SmallFireballEntity
net.minecraft.entity.projectile.WitherSkullEntity
net.minecraft.entity.projectile.DragonFireballEntity
net.minecraft.entity.projectile.FireballEntity
living.isBlocking returns true if an entity is blocking (e.g. activated shield)
Format living.isBlocking(entity)
particle.get returns particle data
Format particle.get(name, [data])
Arguments block particle: data = block_name
dust particle: data = float red, float green, float blue, float alpha
item particle: data = item_name
particle.getAll returns a list with all particles
Format particle.getAll()
particle.spawn spawns particle
Format particle.spawn(location, particle_data, [count|1], [speed,0.0], [offX,0.0], [offY,0.0], [offZ,0.0])
particle.spawnPlayer spawns particle
Format particle.spawnPlayer(location, particle_data, player, [count|1], [speed,0.0], [offX,0.0], [offY,0.0], [offZ,0.0])
particle.spawnCircle spawns particle
Format particle.spawnCircle(location, particle_data, instances, radius, [count|1], [speed,0.0], [offX,0.0], [offY,0.0], [offZ,0.0])
particle.spawnCircle(location, particle_data, instances, stepX, stepY, stepZ, [count|1], [speed,0.0], [offX,0.0], [offY,0.0], [offZ,0.0])
sound.get returns a sound
Format sound.get(String sound_name)
sound.getCategory returns a sound category
Format sound.getCategory(String sound_category|"master")
sound.spawn plays a sound
Format sound.spawn(location, sound, soundCategory, [volume|1.0], [pitch|random von 0.9 - 1.0])
sound.spawnForPlayer plays a sound for a player (not hearable for that one player!)
Format sound.spawnForPlayer(player, sound, soundCategory, [volume|1.0], [pitch|random von 0.9 - 1.0])
human.spawn returns the new created human
Format human.spawn(location)
human.setSkin sets the skin of a human
Format human.setSkin(human, file_name OR uuid)
Info file_name is for skins saved local on our own server. if file_name not found, global skin are searched via uuid
human.setSlim true makes the human slim (slim is for alex skins)
Format human.setSlim(human, boolean)
human.setScale sets the size of the human
Format human.setScale(human, value)
human.setStatue toggles between human and statue
Format human.setStatue(human, bool)
damage.get returns a damagesource
Format damage.get(String damage_name)

damage.get("thorns", entity)

damage.get(entity, creative, armor, absolute, explosion, fire, magic, projectile)
Arguments damage_name = inFire, lightningBolt, onFire, lava, hot_floor, inWall, cramming, drown, starve, cactus, fall, flyIntoWall, outOfWorld, generic, magic, wither, anvil, falling_block, dragon_breath, dryout, sweet_berry_bush

creative: boolean, true also deals damage in creative mode
armor: boolean, true ignores armor
absolute: boolean, true ignores enchantments and potions
explosion: boolean, tag for explosion enchantment
fire: boolean, tag for fire enchantment
magic: boolean, true makes the damage magic
projectile: boolean, tag for projectile enchantment
damage.getType returns the type of a damagesource as string
Format damage.getType(damagesource)
damage.getImmediateSource returns the direct damager entity of a damagesource
Format damage.getImmediateSource(damagesource)
damage.getTrueSource returns the indirect damager entity of a damagesource
Format damage.getTrueSource(damagesource)
damage.isCreativePlayer returns true if the damagesource can damage an creative player
Format damage.isCreativePlayer(damagesource)
damage.isAbsolute returns true if the damage ignores modifications by potion effects or enchantments
Format damage.isAbsolute(damagesource)
damage.isDifficultyscaled returns true if the damagesource will have its damageamount scaled based on the current difficulty
Format damage.isDifficultyscaled(damagesource)
damage.isExplosion returns true if the damage is explosion based
Format damage.isExplosion(damagesource)
damage.isFire returns true if the damage is fire based
Format damage.isFire(damagesource)
damage.isMagic returns true if the damage is magic based
Format damage.isMagic(damagesource)
damage.isProjectile returns true if the damage is projectile based
Format damage.isProjectile(damagesource)
damage.isUnblockable returns true if the damage cannot be blocked by armor
Format damage.isUnblockable(damagesource)
data.set sets data for a player (script-across)
Format data.set(player, String varname, value)
data.get returns data from a player (script-across)
Format data.get(player, String varname)
data.setTimer sets timed data for a player (script-across)
Format data.setTimer(player, String varname, ticks)
Arguments set ticks to -1 to delete the timer. after the timer expires the event player_data_tick is thrown
data.getTimer returns the remaining ticks of timed data (script-across)
Format data.getTimer(player, String varname)
data.clear deletes all datas from a player (script-across)
Format data.clear(player)
shop.new returns a new shop
Format shop.new()
shop.addOffer adds an offer to a shop
Format shop.addOffer(shop, buy_item, sell_item, max_uses)
shop.addDoubleOffer adds a double offer to a shop
Format shop.addDoubleOffer(shop, buy_item_1, buy_item_2, sell_item, max_uses)
shop.open shows a shop to a player
Format shop.open(shop, player, shop_name)
status.add adds a message to the enchantment-display
Format status.add(receiver, byte index, message)
status.addTimed adds a timed message to the enchantment-display
Format status.addTimed(receiver, byte index, int time, message)
status.remove removes a single message from the enchantment-display
Format status.remove(receiver, byte index)
status.reset removes all messages from the enchantment-display
Format status.reset(receiver)
boss.setColor sets the color for the bossbar
Format boss.setColor("PINK" / "BLUE" / "RED" / "GREEN" / "YELLOW" / "PURPLE" / "WHITE")
boss.setCreateFog sets a property for the bossbar
Format boss.setCreateFog(boolean)
boss.setDarkenSky sets a property for the bossbar
Format boss.setDarkenSky(boolean)
boss.setPlayEndbossmusic sets a property for the bossbar
Format boss.setPlayEndbossmusic(boolean)
boss.setName sets the name for the bossbar
Format boss.setName(string)
boss.setOverlay sets an overlay to split the bossbar
Format boss.setOverlay("PROGRESS" / "NOTCHED_6" / "NOTCHED_10" / "NOTCHED_12" / "NOTCHED_20")
boss.setPercent sets the progress of the bossbar
Format boss.setPercent(0 - 1)
boss.send sends the bossbar to the players
Format boss.send(receiver, "ADD" / "REMOVE" / "UPDATE_PCT" / "UPDATE_NAME" / "UPDATE_STYLE" / "UPDATE_PROPERTIES")
Arguments ADD sends name, percent, color, overlay, properties(booleans)
UPDATE_PCT sends percent
UPDATE_NAME sends name
UPDATE_STYLE sends color, overlay
UPDATE_PROPERTIES sends properties(booleans)