# Use to create a simple slash command without options and save it.
- ~discordcommand create group:<discord[mybot].group[Denizen]> name:hello "description:Hello world!" save:mycmd
- debug log <entry[mycmd].command.name>

# Use to create a global slash command with one option, using definemap.
- definemap options:
    1:
      type: string
      name: animal
      description: Your favorite animal
      required: true
- ~discordcommand id:mybot create name:animal "description:Pick your favorite!" options:<[options]>

# Suggests fruits that are only longer in length than the current input.
on discord command autocomplete name:eat option:fruit:
- define length <context.options.get[fruit].length>
- define fruits <list[lime|apple|orange|blueberry|dragonfruit]>
- determine choices:<[fruits].filter_tag[<[filter_value].length.is_more_than[<[length]>]>]>

# Suggests the 25 best-matching selections from some dataset against the current input.
on discord command autocomplete:
- define value <context.options.get[<context.focused_option>]>
- determine choices:<server.flag[dataset].sort_by_number[difference[<[value]>]].first[25].if_null[<list>]>

# The name of the script doesn't matter, and will not affect the command in any way.
Command_Script_Name:

    type: command

    # The name of the command. This will be the default method for running the command, and will show in '/help'.
    # | All command scripts MUST have this key!
    name: mycmd

    # The description of the command. This will be shown in the '/help' command.
    # Multiple lines are acceptable, via <&nl> (the tag for a new line), but you should
    # make the first line a brief summary of what your command does.
    # | All command scripts MUST have this key!
    description: My command.

    # Correct usage for the command. This will show in the '/help' command.
    # This is NOT the name of the command, and it is NOT used to control input parsing. It is EXCLUSIVELY for '/help'.
    # | All command scripts MUST have this key!
    usage: /mycmd <&lt>myArg1<&gt>

    # A list of aliases for the command. These will be used as alternative ways to trigger the command, and will show in the '/help' command.
    # | Some command scripts might have this key, but it's optional.
    aliases:
    - myalias
    - mycommand

    # The permission node to check for permissions plugins. This will automatically
    # block players without the permission from accessing the command and help for
    # the command.
    # Note that you can include multiple permission nodes (a player only needs to have any one permission from the list)
    # by separating them with a semicolon, like: perm.one;perm.two;third.perm
    # | Most command scripts should have this key!
    permission: my.permission.node

    # The message to send to the player when they try to use the command without
    # permission. If this is not specified, the default Bukkit message will be sent.
    # Has "permission" def available.
    # | Most command scripts should NOT have this key, but it's available.
    permission message: Sorry, <player.name>, you can't use my command because you don't have the permission '<[permission]>'!

    # The procedure-based script that will be checked when a player or the console
    # is trying to view help for this command. This must always be determined true
    # or false. If there is no script, it's assumed that all players and the console
    # should be allowed to view the help for this command.
    # Available context: <context.server> returns whether the server is viewing the help (a player if false).
    # | Most command scripts should NOT have this key, but it's available.
    allowed help:
    - determine <player.has_flag[special_allowed_help_flag]||<context.server>>

    # You can optionally specify tab completions on a per-argument basis.
    # Available context:
    # <context.args> returns a list of input arguments.
    # <context.raw_args> returns all the arguments as raw text.
    # <context.server> returns whether the server is using tab completion (a player if false).
    # <context.alias> returns the command alias being used.
    # | This key is great to have when used well, but is not required.
    tab completions:
        # This will complete "alpha" and "beta" for the first argument
        1: alpha|beta
        # This will complete any online player name for the second argument
        2: <server.online_players.parse[name]>
        # This will allow flags "-a", "-b", or "-c" to be entered in the third, fourth, or fifth argument.
        3 4 5: -a|-b|-c
        # Any argument other than the ones explicitly listed will be handled here with a tab complete that just says 'StopTyping'.
        default: StopTyping

    # You can also optionally use the 'tab complete' key to build custom procedure-style tab complete logic
    # if the simply numeric argument basis isn't sufficient.
    # Has the same context available as 'tab completions'.
    # | Most scripts should leave this key off, though it can be useful to some.
    tab complete:
    - determine some|dynamic|logic|here

    # The script that will run when the command is executed.
    # No, you do not need '- determine fulfilled' or anything of the sort, since the command is fully registered.
    # Available context:
    # <context.args> returns a list of input arguments.
    # <context.raw_args> returns all the arguments as raw text.
    # <context.source_type> returns the source of the command. Can be: PLAYER, SERVER, COMMAND_BLOCK, or COMMAND_MINECART.
    # <context.alias> returns the command alias being used.
    # <context.command_block_location> returns the command block's location (if the command was run from one).
    # <context.command_minecart> returns the EntityTag of the command minecart (if the command was run from one).
    # | All command scripts MUST have this key!
    script:
    - narrate Yay!
    - narrate "My command worked!"
    - narrate "And I typed '/<context.alias> <context.raw_args>'!"

- animatechest [<location>] ({open}/close) (sound:{true}/false)

- repeat 3:
  - narrate "<[value]>"
  - narrate "everything spaced out as a sub-block (these two narrates) following a ":" ended command (that repeat) is for the <commands> input!"

- narrate "You can <element[click here].on_click[/help]> for help!"

- narrate "You can <element[click here].on_click[/denizenclickable chat hello]> to say hello to an NPC's interact script!"

# Should show "Denizen".
- narrate <server.command_plugin[ex].name>

# Use to run a simple announce command on another server;
- bungee lobby:
  - announce "Wow! Stuff is happening!"

# Use to run the 'alert' bungee command.
- bungeeexecute "alert Network restart in 5 minutes..."

# Use to generate a clickable that just narrates "hello there!" when clicked.
- clickable save:my_clickable:
    - narrate "Hello there!"
- narrate "Click <blue><element[here].on_click[<entry[my_clickable].command>]><reset>!"

# Use to generate a clickable message that will run a task script named 'test_script'.
- clickable test_script save:my_clickable
- narrate "Click <blue><element[here].on_click[<entry[my_clickable].command>]><reset>!"

# Use to generate a clickable message that will run a task script named 'reward_drop', that can be used by only the first person to click it.
- clickable reward_drop usages:1 save:reward
- announce "<blue><bold><element[Reward Here].on_click[<entry[reward].command>]><reset>!"

# Use to generate a clickable message exclusively for the linked player, that must be used within a minute.
- clickable your_secret def:quest3 for:<player> until:1m save:secretmessage
- narrate "Do you want to know the secret? <blue><element[Yes].on_click[<entry[secretmessage].command>]><reset> / No."

# Use to generate a clickable message and cancel it manually later.
- clickable test_script save:my_clickable save:myclickable
- narrate "Click <blue><element[here].on_click[<entry[my_clickable].command>]><reset> before you land!"
- waituntil rate:1s max:30s <player.is_on_ground>
- clickable cancel:<entry[myclickable].id>

# Use to reenable an NPC's triggers, disabled via 'engage'.
- engage
- chat 'Be right there!'
- walk <player.location>
- wait 5s
- disengage

# See IF command documentation.

# Use to execute the save-all command as the server.
- execute as_server "save-all"

# Use to make the linked (non-op) player execute a command that normally only ops can use. Generally avoid ever doing this.
- execute as_op "staffsay hi"

# Use to run commands 'for each entry' in a manually created list of objects/elements.
- foreach <[some_entity]>|<[some_npc]>|<[player]> as:entity:
    - announce "There's something at <[entity].location>!"

# Use to iterate through entries in any tag that returns a list.
- foreach <player.location.find_entities[zombie].within[50]> as:zombie:
    - narrate "There's a zombie <[zombie].location.distance[<player.location>].round> blocks away"

# Use to iterate through a list of players and run commands automatically linked to each player in that list.
- foreach <server.online_players> as:__player:
    - narrate "Thanks for coming to our server, <player.name>! Here's a bonus $50.00!"
    - money give quantity:50

- goto potato
- narrate "This will never show"
- mark potato

# Use to jump forward to a location.
- goto potato

# Use to narrate a message only if a player has a flag.
- if <player.has_flag[secrets]>:
    - narrate "The secret number is 3!"

# Use to narrate a different message depending on a player's money level.
- if <player.money> > 1000:
    - narrate "You're rich!"
- else:
    - narrate "You're poor!"

# Use to stop a script if a player doesn't have all the prerequisites.
- if !<player.has_flag[quest_complete]> || !<player.has_permission[new_quests]> || <player.money> < 50:
    - narrate "You're not ready!"
    - stop
- narrate "Okay so your quest is to find the needle item in the haystack build next to town."

# Use to perform a complicated requirements test before before changing some event.
- if ( poison|magic|melting contains <context.cause> and <context.damage> > 5 ) or <player.has_flag[weak]>:
    - determine <context.damage.mul[2]>

# Use to mark a location.
- mark potato

# Use to choose randomly from a braced set of commands
- random:
  - narrate "hi"
  - narrate "hello"
  - narrate "hey"

# Use to perform multiple commands randomly
- random:
  - repeat 1:
    - narrate "Hello"
    - narrate "How are you?"
  - repeat 1:
    - narrate "Hey"
    - narrate "It is a nice day."

# Use to reload scripts automatically
- reload

# Use to loop through a command five times.
- repeat 5:
    - announce "Announce Number <[value]>"

# Use to announce the numbers: 1, 2, 3, 4, 5.
- repeat 5 as:number:
    - announce "I can count! <[number]>"

# Use to announce the numbers: 21, 22, 23, 24, 25.
- repeat 5 from:21:
    - announce "Announce Number <[value]>"

# Make the linked NPC sit at the player's cursor location.
- sit <player.cursor_on>

# Make the linked NPC sleep at the player's cursor location.
- sleep <player.cursor_on>

# Use to loop until a player sneaks, or the player goes offline. (Note: generally use 'waituntil' for this instead)
- while !<player.is_sneaking> && <player.is_online>:
    - narrate "Waiting for you to sneak..."
    - wait 1s

on custom event id:my_custom_event:
- narrate <context.my_custom_info>

on system time hourly:
- announce "Whoa an hour passed!"

on system time 12:00:
- announce "Whoa it's noon!"

on system time 03:00:
- announce "Daily restart in 5 minutes!"
- wait 5m
- adjust server restart

# This example supplies a manual response to any of the "/", "/index", or "/index.html" paths.
my_world_script:
    type: world
    data:
        index:
        - <!DOCTYPE html>
        - <html><head><title>Welcome to my site</title></head>
        - <body><h1>Hi!</h1></body></html>
    events:
        on webserver web request port:8080 path:/|/index|/index.html method:get:
        - determine code:200 passively
        - determine headers:[Content-Type=text/html] passively
        - determine raw_text_content:<script.data_key[data.index].separated_by[<n>]>

# This example gives a default response to any pages not handled on port 8080.
on webserver web request port:8080 priority:1000 has_response:false:
- determine code:404 passively
- determine headers:[Content-Type=text/plain] passively
- determine "raw_text_content:Invalid path"

# This example serves a favicon from the local file path "plugins/Denizen/webroot/favicon.ico" with RAM caching to any open web ports.
on webserver web request path:/favicon.ico:
- determine code:200 passively
- determine cached_file:favicon.ico

- stop if:<player.has_flag[forbidden]>
# Equivalent to
- if <player.has_flag[forbidden]>:
  - stop

- foreach <server.players> as:__player:
    - narrate "Hi <player.name> isn't it nice how the player is linked here"

# Use to trigger a custom action
- action "custom action"

# Use to trigger multiple custom action with context on a different NPC
- action "player dances|target enemy" <[some_npc]> context:action|custom|target|<player.selected_npc>

# 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

# Creates a new advancement that has a potato icon.
- advancement id:hello_world icon:baked_potato "title:Hello World" "description:You said hello to the world."

# Creates a new advancement with the parent "hello_world" and a CHALLENGE frame. Hidden until it is completed.
- advancement id:hello_universe parent:hello_world icon:ender_pearl "title:Hello Universe" "description:You said hello to the UNIVERSE." frame:challenge hidden:true x:1

# Grants the "hello_world" advancement to the current player.
- advancement id:hello_world grant:<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 add and remove anchors to an NPC.
- define location_name <context.message>
- chat "I have saved this location as <[location_name]>.'
- anchor add <npc.location> id:<[location_name]>

# 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 animate a chest opening, which only the linked player will see.
- animatechest <context.location>

# Use to then animate a chest closing, which only the linked player will see.
- animatechest <context.location> close

# Use to animate a chest opening with no sound, which only the linked player will see.
- animatechest <context.location> sound:false

# Use to animate a chest opening that only a single specific player will see.
- animatechest <context.location> sound:false <[someplayer]>

# Use to animate a chest opening that only a list of specific players will see.
- animatechest <context.location> sound:false <[someplayer]>|<[player]>|<[thatplayer]>

# Use to assign an npc with exactly one assignment script named 'Bob_the_Builder'.
- assignment set script:Bob_the_Builder

# Use to give a different NPC an assignment.
- assignment set script:Bob_the_Builder npc:<[some_npc]>

# Use to clear an npc's assignments.
- assignment clear

# Use to add an extra assignment to the NPC.
- assignment add script:name_fix_assign

# Use to remove an extra assignment from the NPC.
- assignment add script:name_fix_assign

# 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 make the npc break a related block.
- ~break <context.location>

# Use to make a different NPC break a related block.
- ~break <context.location> <[some_npc]>

# Use to make a different NPC break a related block and start digging from 5 blocks away.
- ~break <context.location> <[some_npc]> radius:5

# Use to run a simple task on another server.
- bungeerun lobby my_script def:32

# Use to read a simple tag from another server.
- ~bungeetag server:lobby <server.motd> save:motd
- narrate "The lobby's MOTD is <entry[motd].result>"

# 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]>

- chat 'Hello!'

# Use to emulate an NPC talking out loud to a Player within an interact script-container.
- chat "Hello, <player.name>! Nice day, eh?"

# Use to have an NPC talk to a group of individuals.
- chat targets:<npc.location.find_players_within[6].filter[has_flag[clan_initiate]]> "Welcome, initiate!"

# Use to choose the only case.
- choose 1:
  - case 1:
    - debug LOG "Success!"

# Use to choose the default case.
- choose 2:
  - case 1:
    - debug log "Failure!"
  - default:
    - debug log "Success!"

# Use for dynamically choosing a case.
- choose <[entity_type]>:
  - case zombie:
    - narrate "You slayed an undead zombie!"
  - case skeleton:
    - narrate "You knocked the bones out of a skeleton!"
  - case creeper:
    - narrate "You didn't give that creeper a chance to explode!"
  - case pig cow chicken:
    - narrate "You killed an innocent farm animal!"
  - default:
    - narrate "You killed a <[entity_type].to_titlecase>!"

# Use to reset the compass direction to its default.
- compass reset

# Use to point with a compass to the player's current location.
- compass <player.location>

# Use to point with a compass to the world's spawn location.
- compass <player.world.spawn_location>

# 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 create a normal world with name 'survival'
- createworld survival

# Use to create a flat world with the name 'superflat'
- createworld superflat worldtype:FLAT

# Use to create an end world with the name 'space'
- createworld space environment:THE_END

# Use to create a new world named 'dungeon3' as a copy of an existing world named 'dungeon_template'.
- ~createworld dungeon3 copy_from:dungeon_template

# 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>"