lambdaisland.witchcraft — com.lambdaisland/witchcraft 0.29.292

Clojure API for Minecraft/Bukkit

*default-world* clj

-set-block clj multimethod

Server-specific set-block implementation

-set-blocks clj multimethod

-set-direction clj multimethod

active-item clj

(active-item player)

active-potion-effects clj

(active-potion-effects player)

add clj

(add this that)

(add this that & more)

Add multiple vector/location-like things together. Returns a value with the same type of the first argument.

add-inventory clj

(add-inventory has-inventory item)

(add-inventory has-inventory item n)

Add the named item to the player or entity's inventory, or n copies of it

allow-flight clj

(allow-flight player)

(allow-flight player bool)

block clj

(block block-or-loc)

Get the block at the given location, returns a Clojure map. See get-block if you need the actual block object.

block-actions clj

Map from keyword to block.Action value

block-data clj

(block-data b)

block-face clj

(block-face kw)

Coerce to BlockFace

Use to convert keywords like :east/:west/:self to BlockFace instances. Idempotent.

block-face-names clj

Map from BlockFace value to keyword

block-faces clj

Map from keyword to BlockFace value

block-set clj

(block-set coll)

(block-set xform coll)

Create a block set, a set of maps where every :x/:y/:z value can only occur once.

blockv clj

(blockv block-or-loc)

Like block, but return a vector instead of a map. Contains in order: x,y,z,material, and optionally a direction and/or a block-data map (or block-data integer pre-flattening). Generally the same structure as can be passed to set-blocks.

break-naturally clj

(break-naturally block-like)

(break-naturally block-like tool-or-effect)

(break-naturally block-like tool effect?)

Breaks the block and spawns items, can optionally take a tool argument, as if a player had digged the block with that specific tool (ItemStack, or something that can be coerced to an item-stack or material, like a keyword). Optionally also takes an effect? boolean, which determines whether to play the block break particle effect and sound.

effect? is not supported on all implementations.

build! clj

Alias for set-blocks, for symmetry with lambdaisland.witchcraft.cursor/build!

CanBreakNaturally clj protocol

-break-naturally clj

(-break-naturally _)

CanBreakNaturallyEffect clj protocol

-break-naturally-effect clj

(-break-naturally-effect _ effect)

CanBreakNaturallyTool clj protocol

-break-naturally-tool clj

(-break-naturally-tool _ tool)

CanBreakNaturallyToolEffect clj protocol

-break-naturally-tool-effect clj

(-break-naturally-tool-effect _ tool effect?)

CanParseBlockData clj protocol

-parse-block-data clj

(-parse-block-data _ _)

CanRenderDisplayName clj protocol

-render-and-set-display-name clj

(-render-and-set-display-name _ _)

CanSpawn clj protocol

-spawn clj

(-spawn thing location)

clear-weather clj

(clear-weather)

(clear-weather world)

Get clear weather

contents clj

(contents o)

Get the contents of the inventory of something as a sequence of maps.

create-explosion clj

(create-explosion loc-like)

(create-explosion loc-like strength)

Create an explosion at a certain location, with a given explosion size (default: 5)

create-world clj

(create-world name opts)

Create a new world with a given name and options

• :seed long
• :structures? boolean
• :hardcore? boolean

default-world clj

(default-world)

World used for commands when no explicit world is given. Uses *default-world*, or the first world on the server.

defprint clj

(defprint type tag to-edn)

despawn clj

(despawn entity)

Remove an entity from the world

difficulty clj

(difficulty)

(difficulty the-world)

Get the difficulty of the world (keyword, World instance, or anything coercible by world)

difficulty-types clj

Map from keyword to Difficulty

direction clj

(direction block-or-loc)

Get the direction of a Block, or of the block at a certain location.

display-name clj

(display-name o)

Get the display-name for an item, itemstack, itemmeta, or nameable block or blockstate.

distance clj

(distance this that)

Get the euclidian distance between two locations. Can take various bukkit objects (Location, Block, Vector), as well as Clojure vectors [x y z] or maps {:x x :y y :z z}, and any combination thereof.

empty-inventory clj

(empty-inventory entity)

Clear out the inventory

EMPTY_BLOCK_SET clj

Make sure there is only one block for each coordinate in the set, and keep them sorted by x/z/y.

enchant-types clj

Map from keyword to Enchantment

enchantment clj

(enchantment o)

enchantment-key clj

(enchantment-key e)

entity clj

(entity o)

Get an object's entity, or get entity by UUID.

entity-types clj

Map from keyword to EntityType value

eye-height clj

(eye-height e)

eye-location clj

(eye-location e)

fast-forward clj

(fast-forward time)

(fast-forward world time)

Fast forward the clock, time is given in ticks, with 20 ticks per second, or 24000 ticks in a Minecraft day.

fly! clj

(fly!)

(fly! player)

Set a player as allowing flight and flying. Note: doesn't seem to actually cause flying, but it does make flying possible.

fly-speed clj

(fly-speed player)

food-level clj

(food-level player)

Get the player's food level, a number between 0 and 20

game-mode clj

(game-mode)

(game-mode player)

Get the current game mode

get-block clj

(get-block loc)

Get the block at a given location. Idempotent.

get-block-data clj

(get-block-data b)

get-inventory clj

(get-inventory o)

Get the org.bukkit.inventory.Inventory for the given object/entity. Works for players, blocks (e.g. chests), itemstacks (e.g. shulker box in inventory), etc.

get-target-block clj

(get-target-block entity)

(get-target-block entity transparent)

(get-target-block entity transparent max-distance)

Get the target block in the line of sight of the entity/player, as org.bukkit.block.Block

HasBlock clj protocol

-block clj

(-block _)

HasBlockData clj protocol

-get-block-data clj

(-get-block-data _)

-set-block-data clj

(-set-block-data _ _)

HasBlockState clj protocol

-block-state clj

(-block-state _)

HasCustomName clj protocol

-get-custom-name clj

(-get-custom-name _)

-set-custom-name clj

(-set-custom-name _ _)

HasDifficulty clj protocol

-get-difficulty clj

(-get-difficulty _)

-set-difficulty clj

(-set-difficulty _ d)

HasDisplayName clj protocol

-display-name clj

(-display-name _)

-set-display-name clj

(-set-display-name _ _)

HasEntity clj protocol

-entity clj

(-entity _)

HasInventory clj protocol

-inventory clj

(-inventory _)

HasItemMeta clj protocol

-item-meta clj

(-item-meta _)

-set-item-meta clj

(-set-item-meta _ _)

HasItemStack clj protocol

-item-stack clj

(-item-stack _)

HasLocation clj protocol

-location clj

(-location _)

Get the location of the given object

HasLore clj protocol

-lore clj

(-lore _)

-set-lore clj

(-set-lore _ _)

HasMaterial clj protocol

-material clj

(-material _)

HasPitchYaw clj protocol

-pitch clj

(-pitch _)

-yaw clj

(-yaw _)

HasPlayer clj protocol

-player clj

(-player _)

HasTargetBlock clj protocol

-get-target-block clj

(-get-target-block _ transparent max-distance)

HasUUID clj protocol

-uuid clj

(-uuid _)

HasWorld clj protocol

-world clj

(-world _)

(-world _ _)

HasWorlds clj protocol

-world-by-name clj

(-world-by-name _ _)

-world-by-uuid clj

(-world-by-uuid _ _)

-worlds clj

(-worlds _)

HasXYZ clj protocol

-x clj

(-x _)

-y clj

(-y _)

-z clj

(-z _)

health clj

(health player)

Get the player's health, a number between 0 and 20

highest-block-at clj

(highest-block-at loc)

Retrieve the highest block at the given location

in-front-of clj deprecated

(in-front-of loc)

(in-front-of loc n)

Get the location n blocks in front of the given location, based on the location's direction. Polymorphic, can work with most things that have a location. Returns plain data.

init-xmaterial! clj

(init-xmaterial!)

We can only access the XMaterial class once a Bukkit server is available

into-inventory clj

(into-inventory has-inventory items)

Add multiple items to an inventory at once

inventory clj

(inventory i)

Get a Clojure/EDN representation of an inventory (or of something that has an inventory). Has :type and :contents keys, and :size for chest type inventories (others have a fixed size).

inventory-type clj

(inventory-type i)

Get the type of an inventory object, or of something that has an inventory (like a player or chest entity) as a keyword.

inventory-types clj

item-in-hand clj

(item-in-hand entity)

item-in-hand-count clj

(item-in-hand-count entity)

item-in-hand-type clj

(item-in-hand-type entity)

item-meta clj

(item-meta o)

Get the ItemMeta for an item or compatible object, this object contains things like the display name of the item, if it has been renamed.

item-stack clj

(item-stack o)

(item-stack material count)

Create (from a material) or get (from something that has an item-stack) an ItemStack object

listen! clj

(listen! event k f)

Listen for an event

Event is a keyword based on the event type, like :player-interact or :item-spawn, k`` is a key this event is registered under, so you canunlisten!` with the same key afterwards. Re-registering a listener with the same event and key will replace the old listener.

See (keyslambdaisland.witchcraft.events/events) for all known events.

loc clj

(loc obj)

Get the location of a thing, as a clojure map. Can take most objects that have some kind of location, e.g. Location, Player, Vector, Block, Entity. Can also take Clojure maps or vectors, so you can use it to coerce input of unknown type.

Location clj

location clj

(location o)

Get the location of the given object

locv clj

lore clj

(lore o)

Get the lore for an item or compatible object.

make-inventory clj

(make-inventory {:keys [owner type size title contents] :or {size 27}})

Make a new Bukkit inventory object, with either :type (keyword) or :size (must be multiple of 9), and optional :owner and/or :title.

map->blockdata clj

(map->blockdata _ _)

mat clj

(mat m)

Get the material name of something, as a keyword.

material clj

(material m)

Get the org.bukkit.Material for the given object.

• map: looks for a :material key
• vector: will look for a keyword in the fourth position (so you can use `[x y z material]``)
• keyword: looks up the named material
• Objects that implement getMaterial() or getType(), use the object method to get the material
• location-like things: pass on to get-block to get the material at that location

material-name clj

(material-name m)

Get the material name of something, as a keyword. Alias for mat.

material-names clj

Map from XMaterial value to keyword

materials clj

Map from keyword to XMaterial value

nearby-entities clj

(nearby-entities entity x y z)

normalize-text clj

(normalize-text txt)

When dealing with text which contains §-based color and markup codes, "normalize" it by setting it on an item and reading back the result. This will cause the server to strip out redundant markup. Useful if you later want to use equality checks on the name of items.

Can also take hiccup-like markup as per lambdaisland.witchcraft.markup

online-players clj

(online-players)

List all online players

open-inventory clj

(open-inventory target)

(open-inventory target inventory)

Open the inventory UI, pass it a player and the inventory to show.

pitch clj

(pitch o)

player clj

(player)

(player name)

Get a player by name, or simply the first player found.

player-chunk clj

(player-chunk player)

Return the chunk the player is in

plugin clj

For the rare API calls that really want a plugin instance

plugin-manager clj

(plugin-manager)

Get the Bukkit plugin manager

PolymorphicFunctions clj protocol

-add clj

(-add this that)

Add locations, vectors, etc. That can also be a map of :x, :y, :z

as-vec clj

(as-vec _)

Coerce to org.bukkit.util.Vector

chunk clj

(chunk _)

Retrieve the chunk for a location, entity, etc.

direction-vec clj

(direction-vec _)

entities clj

(entities _)

Get the chunk's entities

material-data clj

(material-data _)

with-xyz clj

(with-xyz _ xyz)

Return the same type, but with x/y/z updated

pre-flattening? clj

(pre-flattening?)

redo! clj

(redo!)

Redo the last build that was undone with undo!

redo-history clj

remove-inventory clj

(remove-inventory has-inventory item)

(remove-inventory has-inventory item n)

Remove the named items from the player or entity's inventory, or n copies of it

render-markup clj

Render hiccup-like markup into a string with color and styling codes that Minecraft understand, see the lambdaisland.witchcraft.markup namespace for details.

run-task clj

(run-task f)

Schedule a task for the next server tick

run-task-later clj

(run-task-later f ticks)

Schedule a task for after n ticks

satisfies-cache clj

satisfies? clj

(satisfies? protocol x)

Like clojure.core/satisfies?, but cache the result. We make heavy use of satisfies, and this is not very well optimized in core.

scheduler clj

(scheduler)

The Bukkit scheduler

send-message clj

(send-message p message)

Send a chat message to a specific player

Takes strings or vectors (markup), e.g.

[:red "hello " [:underline "world"]]

See [[markup/codes]].

send-title clj

(send-title p title)

(send-title p title subtitle)

Send a title and optionally subtitle to the player

Titles are splashed in big type over the middle of the screen, before they fade out.

Takes strings or vectors (markup), e.g.

[:red "hello " [:underline "world"]]

See [[markup/codes]].

server clj

(server)

Get the currently active server.

server-type clj

set-bed-spawn-location clj

(set-bed-spawn-location player loc)

(set-bed-spawn-location player loc force?)

Set the location where the player will respawn, set force? to true to update the spawn location even if there is no valid bed available.

set-block clj

(set-block loc-or-map)

(set-block loc material-or-map)

Set the block at a specific location to a specific material

material can be a keyword (see materials), a String like RED_WOOL or WOOL:14, a bukkit Material, a Bukkit ItemStack, or an xseries XMaterial.

Single-arity version takes a map with :x/:y/:z/:world/:material/:material-data/:block-data (some optional)

Two-arity version takes something that is or has a location (can also be a vector or map), and a material or map with :material/:direction/:block-data.

set-block-data clj

(set-block-data block prop-map)

(set-block-data block mat prop-map)

Set BlockData properties, these are material dependent, e.g. slabs can have {:type :top} or {:type :bottom}.

We need to get a matching Material object to construct the correct type of BlockData, if you already have one handy you should pass it in to prevent an extra lookup.

set-blocks clj

(set-blocks blocks)

(set-blocks blocks
            {:keys [keep-history? start anchor palette]
             :or {keep-history? true}})

Set blocks in bulk

Takes a sequence of maps with :x, :y, :z, :material, and optionally :world and :data, or a sequence of [x y z material] vectors. Alternatively you can pass a sequence of any object that responds to the x, y, z, and material-name methods.

This adds an entry to the undo history, capturing the previous state of the blocks it is changing, so you can undo! and then redo! the result, unless :keep-history? is set to false.

Optionally takes an :start or :anchor option, which then offsets the whole structure by that distance (can be a map, vector, Location, bukkit Vector, etc.), so you can define the structure you are passing in independently of its position in the world.

Can take a :palette, which is a map with material name aliases (keyword to keyword, or keyword to [keyword map] pair, to provide block-data).

Currently only optimized on Glowstone, elsewhere it repeatedly calls set-block, so changing really large amounts of blocks at once will incur significant lag.

set-contents clj

(set-contents inv items)

Set inventory contents on an inventory or something that has an inventory.

set-difficulty clj

(set-difficulty level)

(set-difficulty the-world level)

Set the world's difficulty (keyword)

set-direction clj

(set-direction loc dir)

Set the direction of a block, takes a keyword or BlockFace, see block-faces

set-display-name clj

(set-display-name o name)

Set the display-name on an item, itemstack, itemmeta. Takes a list (sequence) of strings, or of markup vectors as per lambdaisland.witchcraft.markup/render.

set-fly-speed clj

(set-fly-speed player speed)

set-food-level clj

(set-food-level player food-level)

Set the player's food level, a number between 0 and 20

set-health clj

(set-health player health)

Set the player's health, a number between 0 and 20

set-item-meta clj

(set-item-meta o im)

Set the ItemMeta for compatible objects, like an ItemStack. Either takes an actual ItemMeta object, or a map with :name and/or :lore keys.

set-lore clj

(set-lore o lore)

Set the lore on an item, itemstack, itemmeta. Takes a list (sequence) of strings, or of markup vectors as per lambdaisland.witchcraft.markup/render.

set-time clj

(set-time time)

(set-time world time)

Set the time in a world, or the first world on the current server. Time is given in ticks, with 20 ticks per second, or 24000 ticks in a Minecraft day.

spawn clj

(spawn loc entity-or-npc)

Spawn a new entity

start-glowstone! clj

(start-glowstone! & args)

Start an embedded Glowstone server

Optionally provided with a map of config options. See [[lambdaisland.witchcraft.config/key-values]]

start-paper! clj

(start-paper! & [gui?])

Start an embedded PaperMC server

stop! clj

(stop!)

Stop the embedded server

target-block clj

(target-block & args)

Get the target block in the line of sight of the entity/player, as a map

teleport clj

(teleport loc)

(teleport entity l)

Teleport to a given location

time clj

(time)

(time world)

Get the current time in the world in ticks.

tree-species clj

Map from keyword to TreeSpecies value

undo! clj

(undo!)

Undo the last build. Can be repeated to undo multiple builds.

undo-history clj

unlisten! clj

(unlisten! event k)

Remove an event listener

vec3 clj

(vec3 x y z)

Create a org.bukkit.util.Vector instance

world clj

(world o)

(world o n)

Get the world associated with a given object, or look up a world by string or UUID.

world-creator clj

(world-creator name opts)

worlds clj

(worlds)

(worlds o)

Get a list of all worlds on the server

x clj

(x o)

xmaterial clj

(xmaterial m)

Get an XMaterial instance from a keyword, string, Material, or ItemStack, or anything else for which the polymorphic material method is implemented.

This is a shim class which provides version-independent material handling.

xyz clj

(xyz o)

Get the x/y/z values of an object as a vector, can work with maps containing :x/:y/:z keys, or virtually any Glowstone object that encodes or has a location.

xyz-round clj

(xyz-round o)

Like xyz, but returns rounded integers.

xyz1 clj

(xyz1 o)

Like xyz, but add an extra 1 at the end, for affine transformations

y clj

(y o)

yaw clj

(yaw o)

z clj

(z o)