lambdaisland.witchcraft — com.lambdaisland/witchcraft 0.6.147

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 player item)

(add-inventory player item n)

Add the named item to the player'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-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.

clear-weather clj

(clear-weather)

(clear-weather world)

Get clear weather

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)

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)

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 player)

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.

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

game-rule-types clj

Map from keyword to GameRule

get-block clj

(get-block loc)

Get the block at a given location. Idempotent.

HasDisplayName clj protocol

-display-name clj

(-display-name _)

-set-display-name clj

(-set-display-name _ _)

HasItemMeta clj protocol

-item-meta clj

(-item-meta _)

-set-item-meta clj

(-set-item-meta _ _)

HasLocation clj protocol

-location clj

(-location _)

Get the location of the given object

HasLore clj protocol

-lore clj

(-lore _)

-set-lore clj

(-set-lore _ _)

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 _)

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

(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

inventory clj

(inventory player)

Get the player's inventory

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)

item-stack clj

(item-stack material count)

Create 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

lore clj

(lore o)

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)

online-players clj

(online-players)

List all online players

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

x clj

(x _)

chunk clj

(chunk _)

Retrieve the chunk for a location, entity, etc.

-add clj

(-add this that)

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

y clj

(y _)

with-xyz clj

(with-xyz _ xyz)

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

material-data clj

(material-data _)

direction-vec clj

(direction-vec _)

entities clj

(entities _)

Get the chunk's entities

yaw clj

(yaw _)

pitch clj

(pitch _)

material-name clj

(material-name _)

as-vec clj

(as-vec _)

Coerce to org.bukkit.util.Vector

z clj

(z _)

material clj

(material _)

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 player item)

(remove-inventory player item n)

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

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

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)

(set-block loc material)

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.

set-blocks clj

(set-blocks blocks)

(set-blocks blocks {:keys [keep-history?]})

Set blocks in bulk

Takes a sequence of maps with :x, :y, :z, :material, and optionally :world and :data.

Currently only optimized on Glowstone, elsewhere it repeatedly calls set-block

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-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-game-rule clj

(set-game-rule wrld kw bool)

Set a game rule like :do-daylight-cycle or :do-insomnia. See (keys wc/game-rule-types) for all options

set-game-rules clj

(set-game-rules world m)

Set multiple game rules like :do-daylight-cycle or :do-insomnia. See (keys wc/game-rule-types) for all options. Takes a map from keyword to bool.

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-lore clj

(set-lore o lore)

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)

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

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 all worlds

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.

xyz1 clj

(xyz1 o)

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