# Use to set a custom display name on an entity.
- adjust <[some_entity]> custom_name:ANGRY!

# Use to set the skin of every online player.
- adjust <server.online_players> skin:Notch

# Use to modify an item held in a definition.
- adjust def:stick "display_name:Fancy stick"

# Use to put snow on the block at the player's feet.
- adjustblock <player.location.below> snowy:true

# Use to switch on the lever that the player is looking at, without actually providing redstone power.
- adjustblock <player.cursor_on> switched:true no_physics

# Use to keep the current interact script from meeting requirements.
- cooldown 20m

# Use to keep a player from activating a script for a specified duration.
- cooldown 11h script:bonus_script
- cooldown 5s script:hit_indicator

# Use the 'global' argument to indicate the script to be on cooldown for all players.
- cooldown global 24h script:daily_treasure_offering

# Use to call a custom event with path "on custom event id:things_happened:"
- customevent id:things_happened

# Use to call a custom event with path "on custom event id:things_happened:" and supply a context map of basic data.
- customevent id:things_happened context:[a=1;b=2;c=3]

# Use to call a custom event with a path such as "on custom event id:things_happened data:item:stone:" and supply a context map of more interesting data.
- definemap context:
    waffle: hello world
    item: <player.item_in_hand>
- customevent id:things_happened context:<[context]>

# Use to call a custom event and allow cancelling or replacing a value.
- definemap context:
    message: hello world
- customevent id:custom_message context:<[context]> save:event
- if <entry[event].was_cancelled>:
    - stop
- define message <entry[event].determination_list.first.if_null[<[context.message]>]>
- narrate "Final message is: <[message]>"

# Use to show an error.
- debug error "Something went wrong!"

# Use to add some information to help your own ability to read debug output from you script.
- debug debug "Time is currently <[milliseconds].div[1000].round> seconds!"

# Use to record a debug log of a certain script.
# NOTICE: Spamming debug recordings to the official Denizen Paste instance will result in you being blocked from the paste service.
- debug record start
- run myscript
- ~debug record submit save:mylog
- narrate "Recorded log as <entry[mylog].submitted||<red>FAILED>"

# Use to create or set a flag on a player.
- flag <player> playstyle:aggressive

# Use to set a temporary flag for five minutes on a player.
- flag <player> just_did_something expire:5m

# Use to flag an npc with a given tag value.
- flag <npc> location:<npc.location>

# Use to apply mathematical changes to a flag's value on a unique object.
- flag <context.damager> damage_dealt:+:<context.damage>

# Use to add an item to a server flag as a new value without removing existing values.
- flag server cool_people:->:<[player]>

# Use to add multiple items as individual new values to a server flag that is already a list.
- flag server cool_people:|:<[player]>|<[someplayer]>

# Use to remove an entry from a server flag.
- flag server cool_people:<-:<[someplayer]>

# Use to completely remove a flag.
- flag server cool_people:!

# Use to modify a specific index in a list flag.
- flag server myflag[3]:HelloWorld

# Use to connect to a Mongo instance.
- ~mongo id:name connect:<secret[uri]>

# Use to disconnect from a Mongo instance.
- mongo id:name disconnect

# Run a simple command.
- ~mongo id:name command:[dbStats=1]

# Run more complex commands.
- definemap commands:
     count: my_collection
     skip: 4
 - ~mongo id:name command:<[commands]>

# Simple find query.
- ~mongo id:name find:[name=Bob]

# Complex find query with query filters.
- definemap filters:
     $and:
         - number_greater_than:
             $gt: 2
         - number_less_than:
             $lt: 5
- ~mongo id:name find:<[filters]>

# Insert data into a Collection.
- definemap data:
     name: Pluto
     order_from_sun: 9
     has_rings: false
     main_atmosphere:
         - N2
         - CH4
         - CO
- ~mongo id:name insert:<[data]> save:mg

# Update data.
- definemap old_data:
     name: Pluto
- definemap new_data:
     $set:
         name: Pluto (A Dwarf Planet)
- ~mongo id:name update:<[old_data]> new:<[new_data]>

# Change Databases.
- ~mongo id:name use_database:my_new_database

# Change Collections.
- ~mongo id:name use_collection:my_new_collection

# Use to note a cuboid.
- note <[some_cuboid]> as:mycuboid

# Use to remove a noted cuboid.
- note remove as:mycuboid

# Use to note a location.
- note <context.location> as:mylocation

# Use to connect to a Redis server.
- ~redis id:name connect:localhost

# Use to connect to a Redis server with a secret auth key.
- ~redis id:name connect:localhost auth:<secret[my_redis_secret]>

# Use to connect to a Redis server over ssl.
- ~redis id:name connect:localhost port:6380 ssl:true

# Set a key/value pair in the Redis server.
- ~redis id:name "command:set my_key my_value"

# Delete the "foo" key.
- ~redis id:name "command:del my_key"

# Set a key that auto-expires in 60 seconds.
- ~redis id:name "command:setex my_key 60 'value with spaces'"

# Run a command with unpredictable input.
- ~redis id:name command:set args:<list[my_key].include_single[<context.message>]>

# Get a key's value.
- ~redis id:name "command:get my_key" save:result

# Get a key's value in the background via a waitable.
- ~redis id:name "command:get my_key" save:result

# Append values to the front or back of a redis list.
- ~redis id:name "command:rpush my_list a"
- ~redis id:name "command:rpush my_list b"
- ~redis id:name "command:lpush my_list c"

# Retrieve a ListTag of the members stored in a redis list (0 is the start of the list, -1 is the end).
- ~redis id:name "command:lrange my_list 0 -1"

# Subscribe to a redis channel. This will match published messages to channel_1, channel_foo, etc.
- ~redis id:name subscribe:channel_*

# Subscribe to multiple redis channels. Supports wildcards for any list entry.
- ~redis id:name subscribe:a|b*|c|d

# Publish a message to a redis channel. This will trigger the <@link event redis pubsub message> event for any subscribed connections for any server.
- ~redis id:name publish:channel_1 "message:hey look something happened"

# Unsubscribe from a redis channel. Leaves the connection intact.
- redis id:name unsubscribe

# Disconnect from redis.
- redis id:name disconnect

# Use to change Bukkit's reference to a world's environment to the_end.
- narrate <world[world].environment>
- define obj <world[world].reflected_internal_object>
- narrate <[obj].reflect_field[environment].interpret>
- reflectionset object:<[obj]> field:environment value:the_end
- narrate <world[world].environment>
- narrate <[obj].reflect_field[environment].interpret>

# Use to reload scripts automatically
- reload

# Use to reset all cooldowns for a script when an event that limits usage completes.
- reset global_cooldown MyScriptName

# Use to connect to an SQL server.
- ~sql id:name connect:localhost:3306/test username:space password:<secret[sql_pw]>

# Use to connect to an SQL server over an SSL connection.
- ~sql id:name connect:localhost:3306/test username:space password:<secret[sql_pw]> ssl:true

# Use to connect to an SQL server with a UTF8 text encoding.
- ~sql id:name connect:localhost:3306/test?characterEncoding=utf8 username:space password:<secret[sql_pw]>

# Use to update an SQL server.
- ~sql id:name "update:CREATE table things(id int,column_name1 varchar(255),column_name2 varchar(255));"

# Use to update an SQL server.
- ~sql id:name "update:INSERT INTO things VALUES (3, 'hello', 'space');"

# Use to query an SQL server.
- ~sql id:name "query:SELECT id,column_name1,column_name2 FROM things;" save:saveName
- narrate <entry[saveName].result_list>

# Use to query an SQL server.
- ~sql id:name "query:SELECT id,column_name1,column_name2 FROM things WHERE id=3;" save:saveName2
- narrate <entry[saveName2].result_list>

# Use to disconnect from an SQL server.
- sql disconnect id:name

# Use to download the google home page.
- ~webget https://google.com save:google
- narrate <entry[google].result>

# Use to save a webpage to your server's base directory
- ~webget https://google.com savefile:google.html

# Use to post data to a server.
- ~webget https://api.mojang.com/orders/statistics 'data:{"metricKeys":["item_sold_minecraft"]}' headers:<map.with[Content-Type].as[application/json]> save:request
- narrate <entry[request].result>

# Use to retrieve and load an API response into yaml.
- ~webget https://api.mojang.com/users/profiles/minecraft/<player.name> save:request
- yaml loadtext:<entry[request].result> id:player_data

# Use to start a webserver on port 8081.
- webserver start port:8081

# Use to stop the webserver on port 8081.
- webserver stop port:8081

# Use to change the step to 2.
- zap 2

# Use to return to the default step.
- zap *

# Use to change the step to 3 in a script called Interact_Example.
- zap 3 Interact_Example

# Use to change the step to 1 for the defined player in a script called InteractScript.
- zap 1 InteractScript player:<[player]>

# Use to make an ageable entity a permanant baby.
- age <[some_entity]> baby lock

# ...or a mature adult.
- age <[some_entity]> adult lock

# Use to make a baby entity an adult.
- age <[some_npc]> adult

# Use to mature some animals so that they are old enough to breed.
- age <player.location.find_entities.within[20]> adult

# Use to attach random NPC to the air 3 blocks above a linked NPC.
- attach <server.list_npcs.random> to:<npc> offset:0,3,0

# Use to make the player's target entity attack a nearby entity.
- attack <player.target> target:<npc.location.find.living_entities.within[10].random>

# Use to make a random nearby entity attack a player.
- attack <player.location.find.living_entities.within[10].random> target:<player>

# Use to stop an entity from attacking.
- attack <[entity]> cancel

# Use to set an entity on fire.
- burn <player> duration:10s

# Use to cancel fire on entities.
- burn <player.location.find.living_entities.within[10]> duration:0

# Use to cast a level 1 effect onto the linked player or NPC for 50 seconds.
- cast speed duration:50s amplifier:0

# Use to cast an effect onto the linked player or NPC for an infinite duration with an amplifier of 3 (effect level 4).
- cast jump duration:infinite amplifier:3

# Use to remove an effect from a specific entity.
- cast jump remove <[entity]>

# Use to equip a stone block on the player's head.
- equip <player> head:stone

# Use to equip an iron helmet on two defined players.
- equip <[player]>|<[someplayer]> head:iron_helmet

# Use to unequip all armor off the player.
- equip <player> head:air chest:air legs:air boots:air

# Use to equip a saddle on the horse the player is riding.
- equip <player.vehicle> saddle:saddle

# Use to equip a saddle on all nearby pigs.
- equip <player.location.find_entities[pig].within[10]> saddle:saddle

# Use to fake-equip a stone block on the player's head.
- fakeequip <player> head:stone duration:10s

# Use to fake-equip an iron helmet on two defined players.
- fakeequip <[player]>|<[someplayer]> head:iron_helmet duration:1m

# Use to fake-unequip all armor off the player.
- fakeequip <player> head:air chest:air legs:air boots:air duration:5s

# Use to make all players within 30 blocks of an entity see it permanently equip a shield.
- fakeequip <[entity]> offhand:shield for:<[entity].find_players_within[30]> duration:0

# Animates an item display entity's item for the linked player, and slowly scales it up.
- fakeinternaldata entity:<[item_display]> data:[item=iron_ingot;scale=0.6,0.6,0.6]|[item=gold_ingot;scale=0.8,0.8,0.8]|[item=netherite_ingot;scale=1,1,1] speed:0.5s

# Changes an item display's item, then its scale a second later, then its item again another second later.
- fakeinternaldata entity:<[item_display]> data:[item=stone]|[scale=2,2,2]|[item=waxed_weathered_cut_copper_slab] speed:1s

# Animates a rainbow glow on a display entity for all online players.
- define color <color[red]>
- repeat 256 from:0 as:hue:
  - define frames:->:[glow_color=<[color].with_hue[<[hue]>].argb_integer>]
- fakeinternaldata entity:<[display]> data:<[frames]> for:<server.online_players> speed:0.01s

# Use to feed the player for 5 foodpoints (or 2.5 bars).
- feed amount:5

# Use to feed an NPC for 10 foodpoints (or 5 bars).
- feed <npc> amount:10

# Use to feed a player from a definition fully without refilling saturation.
- feed <[player]> saturation:0

# Use to make a player ride+fly a newly spawned dragon.
- fly <player>|ender_dragon

# To make an NPC follow the player in an interact script.
- follow

# To make an NPC stop following.
- follow stop

# To explicitly make an NPC follow the player.
- follow followers:<npc> target:<player>

# To make an NPC follow the player, slowly and at distance.
- follow speed:0.7 lead:10

# Use to make the linked player (or NPC, if there isn't one) glow.
- glow

# Use to toggle whether the linked NPC is glowing.
- glow <npc> toggle

# Use to make an entity glow for specific players, without changing the way other players see it.
- glow <[entity]> for:<[player1]>|<[player2]>

# Use to reset an entity's fake glow state for the linked player.
- glow <[entity]> reset for:<player>

# Use to fully heal a player.
- heal

# Use to heal a player 5 hearts.
- heal 10

# Use to heal a defined player fully.
- heal <[someplayer]>

# Use to set the NPC's maximum health to 50.
- health 50

# Use to disable tracking of health value on the NPC.
- health state:false

# Use to change a player's health limit and current health both to 50.
- health <player> 50 heal

# Use to change a list of entities' health limits all to 50.
- health <player.location.find.living_entities.within[10]> 50

# Use to hurt the player for 1 HP.
- hurt

# Use to hurt the NPC for 5 HP.
- hurt 5 <npc>

# Use to cause the player to hurt the NPC for all its health (if unarmored).
- hurt <npc.health> <npc> cause:CUSTOM source:<player>

# Use to make the linked player (or NPC, if there isn't one) invisible.
- invisible

# Use to make the linked NPC visible if previously invisible, and invisible if not.
- invisible <npc> toggle

# Use to make an entity visible for specific players, without changing the way other players see it.
- invisible <[entity]> false for:<[player1]>|<[player2]>

# Use to reset an entity's fake visibility state for the linked player.
- invisible <[entity]> reset for:<player>

# Use to kill the linked player.
- kill

# Use to kill the linked NPC.
- kill <npc>

# Use to kill all monsters within 10 blocks of the linked player.
- kill <player.location.find_entities[monster].within[10]>

# Use to attach a leash to the player's target.
- leash <player.target> holder:<player>

# Use to attach the closest cow in 10 blocks to the fence the player is looking at.
- leash <player.location.find_entities[cow].within[10].first> holder:<player.cursor_on>

# Use to release the target entity.
- leash cancel <player.target>

# Use to point an npc towards a spot.
- look <npc> <player.location>

# Use to force a player to stare at a spot for some time.
- look <player> <npc.location> duration:10s

# Use to mount an NPC on top of a player.
- mount <npc>|<player>

# Use to spawn a mutant pile of mobs.
- mount cow|pig|sheep|chicken

# Use to place a diamond block above a player's head.
- mount falling_block,diamond_block|<player>

# Use to force an entity in a vehicle.
- mount <player>|boat

# Use to launch an arrow straight towards a target.
- push arrow destination:<player.location>

# Use to launch an entity into the air.
- push cow

# Use to remove the entity the player is looking at.
- remove <player.target>

# Use to remove all nearby entities around the player, excluding the player itself.
- remove <player.location.find_entities.within[10].exclude[<player>]>

# Use to remove all dropped items in the world called cookies.
- remove dropped_item world:cookies

# Use to rename the linked NPC to 'Bob'.
- rename Bob

# Use to rename a different NPC to 'Bob'.
- rename Bob t:<[some_npc]>

# Use to make an entity show players their own name for 10 seconds.
- rename <green><player.name> t:<[some_entity]> per_player
- wait 10s
- rename cancel t:<[some_entity]> per_player

# Use to rotate the player's yaw by 10 every tick for 3 seconds total
- rotate <player> duration:3s

# Use to rotate the player's pitch by 20 every 5 ticks for a second total
- rotate <player> yaw:0.0 pitch:20.0 frequency:5t

# Use to prematurely stop the player's rotation
- rotate cancel <player>

# Use to shoot an arrow from the NPC to perfectly hit the player.
- shoot arrow origin:<npc> destination:<player.location>

# Use to shoot an arrow out of the player with a given speed.
- shoot arrow origin:<player> speed:2

# Make the linked NPC start sneaking.
- sneak <npc>

# Make the linked NPC stop sneaking.
- sneak <npc> stop

# Use to spawn a spider at the player's location.
- spawn spider <player.location>

# Use to spawn a spider at the player's location which will automatically target the player.
- spawn spider <player.location> target:<player>

# Use to spawn a swarm of creepers around the npc, which will not despawn until killed.
- spawn creeper|creeper|creeper|creeper|creeper <npc.location> persistent

# Use to teleport a player to the location their cursor is pointing at.
- teleport <player> <player.cursor_on>

# Use to teleport a player high above.
- teleport <player> <player.location.above[200]>

# Use to teleport to a random online player.
- teleport <player> <server.online_players.random.location>

# Use to teleport all players to your location.
- teleport <server.online_players> <player.location>

# Use to teleport the NPC to a location that was noted with the <@link command note> command.
- teleport <npc> my_prenoted_location

# Use to teleport a player to some location, and inform events that it was caused by a nether portal.
- teleport <player> <server.flag[nether_hub_location]> cause:nether_portal

# Use to teleport the player without closing their currently open inventory.
- teleport <player> <player.location.below[5]> entity_options:retain_open_inventory

# Use to make the NPC walk to an anchored position.
- walk <npc> <npc.anchor[spot1]>

# Use to make the NPC walk to an anchored position that may be far away.
- walk <npc> <npc.anchor[spot2]> auto_range

# Use to make the NPC walk to an anchored position while looking backwards.
- walk <npc> <npc.anchor[spot3]> lookat:<npc.anchor[spot2]>

# Use to make the NPC walk to an anchored position, and then say something after arrival, using ~waitable syntax.
- ~walk <npc> <npc.anchor[spot4]>
- chat "I'm here!"

# Use to make a list of NPCs stored in a flag all move together, with a flocking radius based on the number of NPCs included.
- walk <player.flag[squad]> radius:<player.flag[squad].size> <player.location>

# Use to make a player appear to get hurt.
- animate <player> animation:hurt

# Use to make a wolf NPC shake.
- animate <npc> animation:wolf_shake

# Use to copy a custom YAML data file to a backup folder, overwriting any old backup of it that exists.
- ~filecopy o:data/custom.yml d:data/backup.yml overwrite save:copy
- narrate "Copy success<&co> <entry[copy].success>"

# Use to read 'myfile' and narrate the text content.
- ~fileread path:data/myfile.dat save:read
- narrate "Read data: <entry[read].data.utf8_decode>"

# Use to write some simple text to 'myfile'
- ~filewrite path:data/myfile.dat data:<element[Hello].utf8_encode>

# Use to log some information to a file.
- ~log "Security breach on level 3!" type:severe file:securitylog.txt

# Use to log a player's name and location when they did something dangerous.
- ~log "<player.name> used the '/EXPLODE' command at <player.location.simple>!" type:warning file:security.log

# Use to write information directly to a file.
- ~log "This won't have a date or type" type:none file:example.log

# Use to clear a log file and write some text at the start.
- ~log "// Log File Generated by my Denizen script, do not edit!" type:clear file:myfile.log

# Use to clear a log file entirely.
- ~log "" type:clear file:myfile.log

# Use to create a new YAML file.
- yaml create id:myfile

# Use to load a YAML file from disk.
- ~yaml load:myfile.yml id:myfile