Citizens

https://wiki.citizensnpcs.co/
Admin
Citizens is a Minecraft server plugin that adds Non-Player Character (NPC) functionality, enabling...
Tokens:134,535
Snippets:902
Trust Score:7.7
Update:1 year ago
Show doc for...
Tokens:
Raw
### Basic Denizen Command Structure

Source: https://wiki.citizensnpcs.co/Denizen/Introduction

This snippet illustrates the general structure of Denizen commands, including a base command, command name, string/integer values, and flags. It provides a practical example for triggering damage on an NPC with a cooldown.

```CLI
/base_command command_name string value --flag value -t
/npc trigger damage --cooldown 5 -t
```

--------------------------------

### Item Definition Examples

Source: https://wiki.citizensnpcs.co/DtlTraders/patterns

Provides practical examples of how to define items using various keywords and flags, demonstrating common configurations like adding a red wool block, a named wool block at a specific slot, and an enchanted diamond sword with custom durability and price.

```Configuration
wool:14
```

```Configuration
wool s:3 n:My white wool
```

```Configuration
276 d:80% e:smite/2 p:1000
```

--------------------------------

### Denizen Commands with Multi-Word Flags

Source: https://wiki.citizensnpcs.co/Denizen/Introduction

This example demonstrates how to correctly use multi-word values within command flags by enclosing them in quotes. It includes a practical application of setting a constant value for an NPC's greeting text.

```CLI
/base_command command_name --flag “multi word value” --another_flag another_value  -t -f
/npc constant --name ‘Default Greeting Text’ --value ‘Hello, player!’
```

--------------------------------

### Example of Basic RPG-Style Permissions Setup

Source: https://wiki.citizensnpcs.co/1.x/Permissions

This example demonstrates a more robust permissions setup suitable for an RPG-style server. It grants 'admins' full control over Citizens while limiting regular players to specific NPC interactions like wizard use, quester interactions, blacksmith repairs, trader functions, and healer abilities. Users should refer to their specific permissions documentation for exact formatting.

```Permissions Configuration
admins:
citizens.*

default:
citizens.wizard.use.interact
citizens.quester.use.*
citizens.blacksmith.use.repair
citizens.trader.use.trade
citizens.healer.use.heal
```

--------------------------------

### Denizen Command Example: NPC Attack Player

Source: https://wiki.citizensnpcs.co/Denizen/Commands

Example demonstrating how to make an NPC start attacking the player.

```Denizen Script
- attack
```

--------------------------------

### Basic Pattern Syntax Example

Source: https://wiki.citizensnpcs.co/DtlTraders/patterns

Illustrates the fundamental structure of a pattern definition, including the pattern name, type, and sections for 'all', 'sell', and 'buy' entries.

```YAML
pattern_name:
  type: pattern_type
  all:
  - ...
  sell:
  - ...
  buy:
  - ...
```

--------------------------------

### Denizen Script: Multi-Step Trigger Script Example

Source: https://wiki.citizensnpcs.co/Denizen/0

A comprehensive example of a Denizen trigger script named 'Welcome to Harbortown', showcasing multiple steps, click triggers, and chat triggers with conditional responses and ZAP commands for flow control.

```Denizen Script
'Welcome to Harbortown':
  Type: Trigger
  Requirements:
    Mode: NONE
  Steps:
    '1':
      Click Trigger:
        Script:
        - CHAT What's your name, stranger?
      Chat Trigger:
        '1':
          Trigger: My name is /<PLAYER>/.
          Script:
          - CHAT Ah ha, your name sounds familiar!
          - CHAT Are you from around this area?
          - ZAP
    '2':
      Click Trigger:
        Script:
        - HINT
      Chat Trigger:
        '1':
          Trigger: /Yes/, I grew up in Harbortown!
          Script:
          - CHAT I thought so, welcome back!
            Have you heard about Tom the Taylor?
            Isn't that just horrible?
          - ZAP 3
        '2':
          Trigger: /No/, you must be mistaken.
          Script:
          - CHAT Oh, sorry about that.
          - CHAT Hey, if you're looking for some work,
            Bill the Baker is understaffed!
            This is the bakery's busy season.
          - ZAP 4
    '3':
      Click Trigger:
        Script:
        - CHAT I wonder if Tom the Taylor is doing any better.
        - NARRATE Perhaps you should check on Tom the Taylor.
    '4':
      Click Trigger:
        Script:
        - CHAT Oh, nice to see you again <PLAYER>!
        - CHAT Have you stopped by the bakery?
```

--------------------------------

### Display Denizen Version Information

Source: https://wiki.citizensnpcs.co/Denizen/Introduction

The /denizen version command displays the current version and build information of the loaded Denizen instance. It also shows any currently loaded 'extensibles', providing insight into the active components.

```CLI
/denizen version
```

--------------------------------

### Denizen Commands for Paged Output

Source: https://wiki.citizensnpcs.co/Denizen/Introduction

This snippet explains how to specify page numbers for Denizen commands that return multi-page feedback. If no page number is provided, the system defaults to displaying the first page.

```CLI
/base_command command_name 3
/denizen scripts 3
```

--------------------------------

### Wiki Template Usage for Code Examples

Source: https://wiki.citizensnpcs.co/Template:Code_example

This snippet demonstrates how to use the `{{code example}}` wiki template. It takes two parameters: `code` for the raw code to be displayed (often wrapped in `<pre>` tags) and `view` for the rendered output of that code. The example specifically uses the `{{hover}}` template to illustrate its functionality.

```Wiki Template
{{code example
 |code = <pre>{{hover|title|text|category=}}</pre>
 |view = {hover|title|text}}
}}
```

--------------------------------

### Configure Denizen Trigger Script Requirements Node Example (YAML)

Source: https://wiki.citizensnpcs.co/Denizen/0

Demonstrates a practical example of configuring the 'Requirements' node in a Denizen trigger script. It shows how to use 'Mode: All' to enforce multiple conditions simultaneously, such as specific time, a minimum money amount, and stormy weather, for script execution.

```YAML
  Requirements:
    Mode: All
    List:
    - TIME Night
    - MONEY 1000000
    - STORMY
```

--------------------------------

### API Example: Request All Help Documentation

Source: https://wiki.citizensnpcs.co/Special:ApiHelp

This example shows how to retrieve all available help documentation, including recursive submodules, in a single API request. It's useful for comprehensive documentation retrieval.

```HTTP Request
api.php?action=help&recursivesubmodules=1
```

--------------------------------

### API Example: Request Help for Main Module

Source: https://wiki.citizensnpcs.co/Special:ApiHelp

This example demonstrates how to request help documentation specifically for the main API module. It provides a direct URL for the API call.

```HTTP Request
api.php?action=help
```

--------------------------------

### List Loaded Denizen Scripts

Source: https://wiki.citizensnpcs.co/Denizen/Introduction

The /denizen scripts command displays a list of all scripts currently loaded into Denizen, identified by type and name. Users can specify a page number for multi-page results, or use --type and --filter flags to narrow down the search.

```CLI
/denizen scripts (--filter key_word) (--type script_container_type) (#)
```

--------------------------------

### Full 'Hello' Dialog Example

Source: https://wiki.citizensnpcs.co/Dialog_Tutorial

This complete example demonstrates a classic 'Hello' dialog. It includes a rule that triggers when a player says 'Hi!' and a response that replies 'Hello, (player name)!' targeting the sender.

```Adventures DSL
rule saidHi {
    criteria events=onchat $message="Hi!";
    response sayHi;
}
response sayHi {
    say message:"Hello, ${sender.name}!", target:$sender;
}
```

--------------------------------

### Interactive Program Startup Notice Example

Source: https://wiki.citizensnpcs.co/Special:Version/License/Pipe_Escape

This example shows a short notice that interactive programs should display upon startup when operating in an interactive mode. It informs users about the program's version, copyright, lack of warranty, and free software status, directing them to commands for more details on warranty and redistribution conditions.

```Text
    Gnomovision version 69, Copyright (C) year name of author
    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
    This is free software, and you are welcome to redistribute it
    under certain conditions; type `show c' for details.
```

--------------------------------

### Denizen Script: Negative Requirements Example

Source: https://wiki.citizensnpcs.co/Denizen/0

Demonstrates how to use negative requirements in Denizen scripts to inverse logic. This example requires time to be day, no storm, and the player to have less than 1,000,000 currency units.

```Denizen Script
Requirements:
  Mode: All
  List:
  - -TIME Night
  - -MONEY 1000000
  - -STORMY
```

--------------------------------

### Denizen Configuration: Automatic config.yml Generation

Source: https://wiki.citizensnpcs.co/Denizen/0

The config.yml file is now automatically generated upon plugin startup, streamlining the initial setup process for users.

```YAML
config.yml
```

--------------------------------

### List Denizen Scripts

Source: https://wiki.citizensnpcs.co/Denizen/Introduction

Displays a list of active Denizen scripts. You can filter scripts by name using the '--filter' flag or by type using the '--type' flag. Pagination is supported by providing a page number.

```Denizen
/denizen scripts --filter ‘bob quest’ 2
```

```Denizen
/denizen scripts --type task
```

--------------------------------

### Select an NPC

Source: https://wiki.citizensnpcs.co/Denizen/Introduction

Selects an NPC to apply subsequent commands to. If used without arguments, it selects the nearest NPC within range. Alternatively, a specific NPC can be selected by providing its ID.

```APIDOC
/npc select [npcid]
```

```Denizen
/npc select
```

```Denizen
/npc select 10
```

--------------------------------

### Sample Copyright Disclaimer for GPL Software

Source: https://wiki.citizensnpcs.co/Special:Version/License/WikiEditor

This example provides a template for a copyright disclaimer, typically signed by an employer or educational institution, to formally release their copyright interest in a program. This ensures the program can be freely distributed and licensed under terms like the GNU GPL without ownership conflicts.

```Text
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.

<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
```

--------------------------------

### Define Initial Actions for Quests

Source: https://wiki.citizensnpcs.co/1.x/Quests

This configuration block specifies actions that are triggered automatically once a player meets the conditions to take a quest. The example shows how to grant a specific item to the player at the start of the quest.

```YAML
initial:
    '0':
        type: item     # Gives an item when conditions are met.
        id: 268        # wooden_sword
        amount: 1
        take: false    # Optional. By default, take: is false.
```

--------------------------------

### Manage Denizen Listeners

Source: https://wiki.citizensnpcs.co/Denizen/Introduction

Shows a list of active listeners for a player. You can specify a different player using the '--player' flag or a page number. The '--finish' flag forces the listener to complete, running its associated script. The '--cancel' flag removes the listener, and '--report' outputs its current status.

```APIDOC
/denizen listener (--player player_name) (--finish|report|cancel listener_id)
```

```Denizen
/denizen listener --report apple_quest_1
```

```Denizen
/denizen listener --player aufdemrand 2
```

--------------------------------

### Install and Basic Usage of HyperMerchant

Source: https://wiki.citizensnpcs.co/HyperMerchant

This snippet outlines the essential steps to install the HyperMerchant plugin and assign it to an NPC, enabling basic shop functionality. It assumes HyperConomy is already set up.

```Minecraft Command
1. Have a HyperConomy shop already set up.
2. Create an npc: /create npc my_shopkeeper
3. Assign npc the hypermerchant trait: /trait hypermerchant
4. Assign npc to the shop: /hmerchant setshop shop-name

Alternately, you can open the shop's menu using the /shopmenu or /remotemenu commands
```

--------------------------------

### Builder Build Command Usage Examples

Source: https://wiki.citizensnpcs.co/Builder

Practical examples demonstrating various combinations of options for the `/builder build` command to customize the schematic construction process.

```CLI
/builder build
```

```CLI
/builder build excavate reverselinear yoffset:-3
```

```CLI
/builder build ignoreair ignoreliquid oncomplete:Celebrate
```

```CLI
/builder build groupall layers:3
```

--------------------------------

### MediaWiki Template Documentation Usage

Source: https://wiki.citizensnpcs.co/Template:Template

This snippet provides examples for using the 'Template' MediaWiki template. It illustrates the main syntax for invoking the template and specific examples for setting its various parameters like name, sample code, number of arguments, and individual argument details.

```MediaWiki Template
{{Template| NAME = Template Name| SAMPLE = <nowiki>{{Your Template Here}}</nowiki>| DESCRIPTION = Description of your template| A1=arg1| A1EXP=arg1}}
```

```MediaWiki Template
NAME=Name of your template
```

```MediaWiki Template
SAMPLE=<nowiki>Sample code for your template</nowiki>
```

```MediaWiki Template
ARGS=10
```

```MediaWiki Template
Ax=Argument name
```

```MediaWiki Template
AxEXP=Description of argument Ax
```

--------------------------------

### Install Citizens Builder Plugin

Source: https://wiki.citizensnpcs.co/Builder

This section outlines the steps required to install the Citizens Builder plugin, including placing the JAR file, schematic files, and creating an NPC with the Builder trait.

```Minecraft Command
/npc create Bob --trait builder
```

```Minecraft Command
/npc create Bob
/trait builder
```

--------------------------------

### Toggle Denizen Debugger

Source: https://wiki.citizensnpcs.co/Denizen/Introduction

The /denizen debug command enables or disables the dBugger, a crucial tool for writing and troubleshooting script flow. It supports optional flags like -s for stacktraces and -c for color, which are helpful for detailed error analysis.

```CLI
/denizen debug (-c) (-s)

/denizen debug
/denizen debug -c
```

--------------------------------

### Denizen Script: Using RUNTASK with a Task Script

Source: https://wiki.citizensnpcs.co/Denizen/0

Provides an example of a Denizen Task Script ('Apple Reward') that gives items and finishes, and demonstrates how it can be called from a Trigger Script ('Apple Quest 1') using the RUNTASK command for modularity.

```Denizen Script
'Apple Reward':
  Type: Task
  Script:
  - NARRATE You've received some APPLES. Nice!
  - GIVE APPLE 10
  - FINISH

'Apple Quest 1':
  Type: Trigger
  Requirements:
    Mode: All
    List:
    - -FINISHED Apple Reward
  Steps:
    '1':
      Click Trigger:
        Script:
        - CHAT Welcome to my house, have some apples!
        - RUNTASK Apple Reward
```

--------------------------------

### Denizen Command Example:

Source: https://wiki.citizensnpcs.co/Denizen/Commands

No description

--------------------------------

### Denizen Command Example: NPC Chat to Player

Source: https://wiki.citizensnpcs.co/Denizen/Commands

Example demonstrating an NPC sending a personalized greeting message to the player.

```Denizen Script
- chat "It's nice to see you again, <player.name>."
```

--------------------------------

### Denizen Command Example: Cast Blindness

Source: https://wiki.citizensnpcs.co/Denizen/Commands

Example demonstrating how to use the 'cast' command to apply a strong blindness effect to the player interacting with the NPC for 7 seconds.

```Denizen Script
- cast blindness power:3 duration:7
```

--------------------------------

### Teleport Node YAML Configuration Example

Source: https://wiki.citizensnpcs.co/1.x/List_of_Initial_node_types

Example YAML configuration for a 'teleport' node. This snippet demonstrates how to define a teleport point with specific X, Y, Z coordinates and a target world name.

```YAML
'0':
    type: teleport
    location:
        x: 10
        y: 50
        z: -10
        world: 'rivers'
```

--------------------------------

### Reload Denizen Configuration and Scripts

Source: https://wiki.citizensnpcs.co/Denizen/Introduction

The /denizen reload command reloads specified disk files (scripts, saves, config, or all) into memory, overwriting current data. Note that some configuration changes may require a full server reboot to take effect.

```CLI
/denizen reload scripts|saves|config|-a

/denizen reload -a
/denizen reload scripts
```

--------------------------------

### Denizen Command Example: Set NPC Assignment (Default)

Source: https://wiki.citizensnpcs.co/Denizen/Commands

Example demonstrating how to set an NPC's assignment to 'Pet Cat' script, using the default 'set' action.

```Denizen Script
- assignment "script:Pet Cat"
```

--------------------------------

### Denizen Command Example: Cast Regeneration on Owner

Source: https://wiki.citizensnpcs.co/Denizen/Commands

Example demonstrating how to use the 'cast' command to apply a weak regeneration effect to the NPC's owner for 10 seconds.

```Denizen Script
- cast regeneration power:1 duration:10 target:p@<npc.owner>
```

--------------------------------

### Denizen Command Example: Set NPC Assignment

Source: https://wiki.citizensnpcs.co/Denizen/Commands

Example demonstrating how to set an NPC's assignment to 'Evil Wizard' script.

```Denizen Script
- assignment set "script:Evil Wizard"
```

--------------------------------

### Interactive Program Startup Notice for GPL Licensed Software

Source: https://wiki.citizensnpcs.co/COPYING

This snippet provides a template for a short notice that interactive programs licensed under the GPL should output upon startup. It informs users about the program's copyright, lack of warranty, and free software status, directing them to commands for more details. The specific commands (`show w`, `show c`) are examples and can be adapted.

```Text Template
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
```

--------------------------------

### Denizen Interact Script Command YAML Example

Source: https://wiki.citizensnpcs.co/Denizen/0.7/Interact_Scripts/Commands

Illustrates the YAML structure for defining commands within a Denizen Interact Script. It shows how commands are listed under a 'Script' node, including examples of modifiers, modifiers with spaces, and the caret prefix for instant execution.

```YAML
Some Trigger:
  Script:
  - COMMAND1 MODIFIER1 MODIFIER2:VALUE
  - COMMAND2 'MODIFIER1:Value With Spaces'
  - ^COMMAND3 'This will run instantly after COMMAND2'
```

--------------------------------

### Citizens NPC Old Configuration Example

Source: https://wiki.citizensnpcs.co/Config

This YAML configuration block provides an example of an older Citizens NPC configuration, detailing chat prefixes, selection settings (quick-select, item, message), default behaviors (look-close, random-talker, talk-close), talk cooldowns, talk item, server ownership, debug mode, and subplugins folder.

```YAML
# Citizens Configuration
npc:
  chat:
    prefix: '[<npc>]: '
  selection:
    quick-select: false
    item: 280
    message: "<b>You selected <a><npc><b>!"
  default:
    look-close: false
    random-talker: true
    talk-close: false
  talk:
    max-cooldown: 60
    min-cooldown: 30
    talk-item: 340
  server-ownership: false
general:
  debug-mode: false
subplugins:
  folder: 'plugins'
```

--------------------------------

### Denizen Command Example: NPC Stop Attack

Source: https://wiki.citizensnpcs.co/Denizen/Commands

Example demonstrating how to make an NPC stop attacking.

```Denizen Script
- attack stop
```

--------------------------------

### Example: Slime Slaying Quest Definition

Source: https://wiki.citizensnpcs.co/1.x/Quests

A comprehensive example of a quest definition, including description, acceptance, completion texts, repeat settings, and multiple objectives with rewards. This quest involves hunting slimes and optionally delivering slimeballs.

```YAML
"Slime Slaying":
    texts:
        description: "<Theo> The best way to take care of those slimes is to slay
            <br>them with a sword. We have a bit of overcrowding, as you can
            <br>see.. would you be willing you help our small city?
            <br>&6Quest: <g>The Slime Slayer, Part 1
            <br>&6Objective: Destroy 12 slimes."
        acceptance: "<Theo> Great! You are truly a friend! Our small
            <br>city has a lot to offer, so stick around.
            <delay=60><Theo> HAHAHA... get it? <g>STICK&f around? HAH HAH HAH!
            <delay=80>&6Quest: <g>The Slime Slayer, Part 1 &6started!
            <delay=40><g>Remember, you can use &6/quest status <g>to check your progress."
        completion: "<Theo> Wow! You've taken care of the slimes already?
            <br>We really appreciate the help!
            <br>&6Quest: You have recieved 100 bucks for your effort. Sweet!
            <br><Theo> Don't bounce outta here too soon.
            <delay=40><Theo> HAHA.. get it? <g>BOUNCE&f? Oh.. HAH HAH!"
    repeats: -1
    objectives:
        '0':
            '0':
                type: hunt
                string: 'slime'
                amount: 12
                message: "&6Quest: A dozen slimes down. That wasn't so hard.
                    <delay=120>&fPerhaps you should see if <g>Theo &frequires any additional help?"
            '1':
                type: delivery
                materialid: 341 # Slimeballs
                amount: 6
                npcdestination: 22
                optional: True # Optional sub-objective triggers only if you bring slimeballs
                               # before the other objective is complete.
                message: "&6Quest: Slimeballs delivered.
                    <delay=50><Theo> Oh, what's this?
                    <delay=20><Theo> OH! Slimeballs, Yes! You can keep what you find, but I
                    <br>appreciate the gesture! Take this -- perhaps it will help you
                    <br>become a more efficient slime slayer!
                    <br><Theo>What have you got to l-ooze?
                    <delay=40><Theo> HAHA. Get it? L-<g>OOOOZE&f? HAHAHA
                    <delay=20>&6Quest: You have received a bow and some arrows! Nice!"
                rewards:
                    '0':
                         type: item
                         id: 261  # Bow
                         amount: 1
                    '1':
                         type: item
                         id: 262  # Arrows
                         amount: 64
    rewards:
        '0':
            type: money
            money: 100
```

--------------------------------

### NPC Nameplate Color Change

Source: https://wiki.citizensnpcs.co/Denizen/Introduction

Explains how to change the color of an NPC's nameplate.

```Denizen Command
/npc nameplate red
```

--------------------------------

### GPL Interactive Program Startup Notice

Source: https://wiki.citizensnpcs.co/Special:Version/License/Nuke

For interactive programs, this short notice should be displayed when the program starts in interactive mode. It informs users about the program's copyright, the absence of warranty, and the conditions for redistribution, directing them to further details via hypothetical commands.

```Text
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
```

--------------------------------

### GNU GPL Interactive Program Startup Message

Source: https://wiki.citizensnpcs.co/Special:Version/License/WikiEditor

This snippet illustrates a short notice to be displayed by interactive programs upon startup when licensed under the GNU GPL. It informs users about the software's free nature, the lack of warranty, and provides commands to access detailed license information.

```Text
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
```

--------------------------------

### GNU GPL Interactive Program Startup Notice

Source: https://wiki.citizensnpcs.co/Special:Version/License/Gadgets

This short notice should be displayed by interactive programs when they start, informing users about the program's copyright, lack of warranty, and free software status under certain conditions, with prompts to view more details.

```Text
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
```

--------------------------------

### Standard GPL Copyright Notice Template

Source: https://wiki.citizensnpcs.co/Special:Version/License/Pipe_Escape

This template provides the essential copyright and licensing information to be included at the beginning of each source file for a program released under the GNU General Public License. It specifies the program's name, author, year, and a clear statement of its free software status, warranty disclaimer, and how to obtain the full license text.

```License Text
    <one line to give the program's name and a brief idea of what it does.>
    Copyright (C) <year>  <name of author>

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License along
    with this program; if not, write to the Free Software Foundation, Inc.,
    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
```

--------------------------------

### NPC Sleep and Wakeup Actions

Source: https://wiki.citizensnpcs.co/Denizen/Introduction

Describes how to make an NPC sleep at a specified location or anchor. The /npc wakeup command will make the NPC stop sleeping.

```Denizen Command
/npc sleep --location 128,64,64,world
```

```Denizen Command
/npc sleep --anchor chair_location
```

```Denizen Command
/npc wakeup
```

--------------------------------

### Denizen CLI: Manipulate Block Data

Source: https://wiki.citizensnpcs.co/Denizen/0

Commands for checking, adding, or decreasing block data. While not directly related to Denizens, these are handy for interacting with block properties, for example, on a tree.

```CLI
/denizen adddata|decdata|getdata
```

--------------------------------

### Denizen Switch Command Examples

Source: https://wiki.citizensnpcs.co/Denizen/Commands

Examples demonstrating the Denizen 'switch' command to toggle or set the state of various interactive blocks like levers, buttons, and doors. The command supports specifying a precise location, a desired state (on/off), and an optional duration for which the state will remain active.

```Denizen
- switch location:500,45,700,world
- switch state:on location:<anchor:Secret Lever> duration:30
```

--------------------------------

### GNU GPL Source File Copyright and License Notice

Source: https://wiki.citizensnpcs.co/Special:Version/License/WikiEditor

This block provides the standard copyright and licensing notice required to be attached to the beginning of each source file for software distributed under the GNU General Public License. It informs users about the terms of redistribution, modification, and the absence of warranty, directing them to the full GPL text.

```Text
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year>  <name of author>

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
```

--------------------------------

### Standard GPL Copyright and License Notice for Source Files

Source: https://wiki.citizensnpcs.co/Special:Version/License/Nuke

This multi-line notice should be attached to the start of each source file of a program released under the GNU General Public License. It includes placeholders for the program's name, copyright year, and author, along with a summary of the license terms, emphasizing the absence of warranty.

```Text
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year>  <name of author>

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
```

--------------------------------

### Add Notable Location

Source: https://wiki.citizensnpcs.co/Denizen/Introduction

An experimental command to add a 'notable location', which serves as a location bookmark within Denizen. These locations are used in World Script events, such as 'on walk over...'.

```Denizen Command
/notable add ‘secret spot 1’
```

```Denizen Command
/notable add treasure
```

--------------------------------

### NPC Pushable Behavior

Source: https://wiki.citizensnpcs.co/Denizen/Introduction

Describes how to make NPCs pushable by players, allowing them to be moved out of the way upon collision. The behavior can be toggled, and NPCs can be set to return to their previous location after a delay.

```Denizen Command
/npc pushable
```

```Denizen Command
/npc pushable -r --delay 6
```

```Denizen Command
/npc pushable -t
```

--------------------------------

### Standard GNU GPL Copyright and License Notice for Source Files

Source: https://wiki.citizensnpcs.co/COPYING

This template provides the standard copyright and licensing notice required for programs distributed under the GNU General Public License (GPL). It should be attached to the start of each source file to clearly state the program's free software status, warranty disclaimers, and where to find the full license text. Developers must fill in the program name, year, and author.

```Text Template
<one line to give the program's name and a brief idea of what it does.>

Copyright (C) <year>  <name of author>

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
```

--------------------------------

### GNU GPL Source File License Notice

Source: https://wiki.citizensnpcs.co/Special:Version/License/Gadgets

This notice should be attached to the start of each source file of a program licensed under the GNU General Public License. It includes a one-line program description, copyright information, and a statement about the program being free software distributed under the GPL, emphasizing the lack of warranty.

```Text
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year>  <name of author>

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
```

--------------------------------

### Criteria with Regex Chat Match

Source: https://wiki.citizensnpcs.co/Dialog_Tutorial

This example shows how to use regular expressions within criteria to match chat messages. The rule will trigger on 'onchat' events where the message starts with 'h' followed by one or more letters.

```Adventures DSL
criteria events="onchat" $message~=/h[a-zA-Z]+/
```

--------------------------------

### Denizen Scripting: Item Requirements with TypeId:Data

Source: https://wiki.citizensnpcs.co/Denizen/0

Script requirements that involve items can now utilize the typeId:data syntax for more specific item matching. For example, 35:7 can be used to specify gray wool.

```Denizen Scripting
35:7
```

--------------------------------

### NPC Fishing Actions

Source: https://wiki.citizensnpcs.co/Denizen/Introduction

Explains how to make an NPC cast a fishing line to a specified location, anchor, or the player's cursor position. The /npc stopfishing command makes the NPC reel in its line.

```Denizen Command
/npc fish --location 128,64,64,world
```

```Denizen Command
/npc fish -c
```

```Denizen Command
/npc fish --anchor chair_location
```

```Denizen Command
/npc stopfishing
```

--------------------------------

### Add NPC to Playerlist

Source: https://wiki.citizensnpcs.co/Denizen/Introduction

Adds an NPC to the Bukkit Playerlist, enabling Minecraft Monsters to attack it as if it were a player. This feature only works on Player-Type NPCs and may introduce slight overhead or conflicts with other plugins, so it should be used only when necessary.

```APIDOC
/npc playerlist
```

```Denizen
/npc playerlist
```

--------------------------------

### Create a New NPC

Source: https://wiki.citizensnpcs.co/Denizen/Introduction

Creates a new Non-Player Character (NPC). A string name is required. Optionally, you can specify the entity type of the NPC using the '--type' flag, allowing for various mob or player models.

```APIDOC
/npc create <name> [--type <EntityType>]
```

```Denizen
/npc create Jack
```

```Denizen
/npc create Henry the Great --type enderman
```

```Denizen
/npc create Susan --type cow
```

--------------------------------

### NPC Sitting and Standing Poses

Source: https://wiki.citizensnpcs.co/Denizen/Introduction

Details how to make an NPC sit at a specific location, anchor, or the player's cursor position. The /npc stand command or initiating navigation will make the NPC assume a standing position.

```Denizen Command
/npc sit --location 128,64,64,world
```

```Denizen Command
/npc sit
```

```Denizen Command
/npc sit --anchor chair_location
```

```Denizen Command
/npc sit -c
```

```Denizen Command
/npc stand
```

--------------------------------

### Set NPC Vulnerability

Source: https://wiki.citizensnpcs.co/Denizen/Introduction

Configures an NPC to be vulnerable to damage and capable of being killed. This is often required when using the 'health trait' provided by Denizen. The '-t' flag makes the vulnerability temporary, meaning it will not persist across server restarts.

```APIDOC
/npc vulnerable [-t]
```

```Denizen
/npc vulnerable
```

```Denizen
/npc vulnerable -t
```

--------------------------------

### Checking if Entity is NPC and Getting Name in Java

Source: https://wiki.citizensnpcs.co/1.x/API

This Java example illustrates how to use the `CitizensManager` to determine if a given Bukkit `Entity` is an NPC. If it is, the code retrieves the NPC's stripped name and broadcasts a message to the server, showcasing basic API interaction.

```Java
//checks if the passed Bukkit entity is an NPC
public void checkNPC(Entity entity) {
    if(CitizensManager.isNPC(entity)) {
        Bukkit.getServer().broadcastMessage(CitizensManager.get(entity).getStrippedName() + " is an NPC!");
    }
}
```

--------------------------------

### ScriptEntry Object Methods Reference

Source: https://wiki.citizensnpcs.co/Denizen_API_Command_Template

Detailed API documentation for the methods available on the Denizen ScriptEntry object, which provides contextual information about the command execution.

```APIDOC
ScriptEntry:
  getCommand(): String
    Return: String value of the name of the command. Used by default in alerting the user when denizen is in debug mode, if the template is used. Also could be useful if your command module contains instructions for more than one command. You can register multiple commands to your module.
  arguments(): String[]
    Return: String[] value of the arguments used in the script. This is the output of Denizen's argBuilder method. It splits the command arguments up with spaces and quotes. For instance: `arg1 arg2 'this is argument 3' "and that's argument 4" would return a string array with a size of 4. Note argument 4, which handles an argument using a single quote. Hint: Double quotes around the argument, and vice-versa.`
  sendingQueue(): QueueType
    Return: QueueType of either QueueType.TRIGGER, QueueType.TASK, or QueueType.ACTIVITY. Denizen's Script Engine contains a method called runQeues which sends the ScriptEntries off to the executer. During this process, it stores which queue the command was called from. Can be used in advanced situations. Typically, if called by an Interact Script, this contains QueueType.TRIGGER.
  getScript(): String
    Return: String value of the script name. Could be useful if storing information about a Script. For example, Denizen's FINISH command takes this information for granted if no script is otherwise indicated in the arguments.
  getStep(): Integer
    Return: Integer value of the script's step. Could be used similarly to getScript(). The ZAP command uses this information to know which step to proceed to.
  getPlayer(): Player
    Return: Player object of the script triggerer. The bukkit Player object can get all kinds of information about the player.
  getDenizen(): DenizenNPC
    Return: DenizenNPC object of the script triggeree. DenizenNPC makes it easy to work with the Denizen that has been interacted with. Good example: LOOK command.
  getInitiatedTime(): Long
    Return: Long value of System.currentTimeMillis(). Contains a `Long System.currentTimeMillis()` of the system time in which it was sent to your Command for processing which you can use to check against.
  setDelayedTime(time: Long): void
    time: should be a Long value in the format of System.currentTimeMillis(). Advanced usage. See the DELAY command for an example.
  getDelayedTime(): Long
    Return: Long value that was set with setDelayedTime(). Advanced usage. Again, see the DELAY command for an example. If not set with setDelayedTime(), this is null by default.
  getTexts(): String[]
    Return: String[2] of text sent by a Trigger. Vanilla Denizen will use this to store information sent to/from a Chat Trigger. Element [0] contains the text typed by the Player when the script was triggered, and element [1] contains the text as set in the Trigger: node of the script.
```

--------------------------------

### Set Denizen World Time (dtime)

Source: https://wiki.citizensnpcs.co/Denizen/Introduction

An experimental command used to set the in-game time, based on a 24-hour clock. It is intended for use with the World Script 'On Time' event, where Minecraft time 0 corresponds to 6:00 in dTime.

```Denizen Command
/dtime 6
```

```Denizen Command
/dtime 23
```

--------------------------------

### Display Builder Help Information

Source: https://wiki.citizensnpcs.co/Builder

Shows the help documentation for the Builder plugin, listing available commands and their usage for quick reference.

```APIDOC
/builder help: Display the help.
```

--------------------------------

### Configure Quest Rewards with Item and Quest Triggers

Source: https://wiki.citizensnpcs.co/1.x/Quests

This snippet illustrates how to define the rewards a player receives upon successful completion of a quest. Examples include rewarding a specific item and automatically starting another quest immediately after the current one is finished.

```YAML
rewards:
    '0':
        type: item    # Rewards an item
        id: 15        # iron_ore
        amount: 30
    '1':
        type: quest   # Rewards a quest.  This quest will start immediately.
        quest: "Part II"
```

--------------------------------

### NPC Nickname Management

Source: https://wiki.citizensnpcs.co/Denizen/Introduction

Explains how to set, view, and remove nicknames for NPCs, including dynamic content using replaceable tags. Nicknames do not affect nameplates above player-type NPCs currently. The <npc.name.nickname> tag can be used to reference an NPC's nickname.

```Denizen Command
/npc nickname
```

```Denizen Command
/npc nickname -r
```

```Denizen Command
/npc nickname --set ‘<magic><npc.name><gold>,
     the friendly Wizard’
```

```Denizen Command
/npc nickname --set ‘<npc.name>, of Clan
     <flag.n:clan_name>’
```

--------------------------------

### Calling a Response from a Rule

Source: https://wiki.citizensnpcs.co/Dialog_Tutorial

This example illustrates how a defined response can be called from within a rule. This allows for modularity, separating the triggering logic (rule) from the action logic (response).

```Adventures DSL
rule example {
    criteria events="any";
    response example;
}
```

--------------------------------

### TAKE Command for Denizen

Source: https://wiki.citizensnpcs.co/Denizen/0.7/Interact_Scripts/Commands

Takes something from the Player. If QTY is not specified, it defaults to 1.

```APIDOC
TAKE [MONEY or ITEMINHAND or ID or ID:Data or MATERIAL or MATERIAL:Data] (QTY:#)
  QTY: The quantity to take. Default is 1.
  MONEY: Takes in-game money.
  ITEMINHAND: Takes the item currently held in hand.
  ID: Item ID.
  ID:Data: Item ID with data value.
  MATERIAL: Material name.
  MATERIAL:Data: Material name with data value.

Example Usages:
- TAKE MONEY QTY:1000
- TAKE 17:2 QTY:1
- TAKE LOG:2
- TAKE ITEMINHAND
```

--------------------------------

### Save Denizen dScript Data

Source: https://wiki.citizensnpcs.co/Denizen/Introduction

The /denizen save command persists the in-memory dScript saves to the saves.yml file on disk. While useful for live editing, it's recommended to edit saves.yml primarily when the server is offline, especially in production environments, to prevent data inconsistencies.

```CLI
/denizen save
```

--------------------------------

### Sample GPL Copyright Disclaimer for Employers/Schools

Source: https://wiki.citizensnpcs.co/Special:Version/License/Nuke

This is a sample copyright disclaimer to be signed by an employer or school, relinquishing their copyright interest in a program developed by an employee or student. This ensures the program can be freely released under the GNU General Public License without intellectual property claims from the organization.

```Text
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.

<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
```

--------------------------------

### Create a Denizen NPC with a specific trait

Source: https://wiki.citizensnpcs.co/Denizen/0.7/Before_Using_Denizen

This command uses Citizens2 to create a new NPC named 'Notch' and immediately assigns the 'denizen' trait to it. This trait is essential for the NPC to be recognized and managed by the Denizen plugin, allowing it to execute Denizen scripts.

```Minecraft Command
/npc create Notch --trait denizen
```

--------------------------------

### Configure Initial Node in Quests.yml

Source: https://wiki.citizensnpcs.co/1.x/List_of_Initial_node_types

This example demonstrates the basic structure for an initial node in Quests.yml. It shows how to configure an 'item' type initial node that gives a wooden sword (ID 268) to the player when the quest starts. The 'take' property is optional and defaults to false. Multiple initial nodes can be defined sequentially.

```YAML
initial:
    '0':
        type: item     # Gives an item when conditions are met.
        id: 268        # wooden_sword
        amount: 1
        take: false    # Optional. By default, take: is false.
```

--------------------------------

### Sample Employer/School Copyright Disclaimer

Source: https://wiki.citizensnpcs.co/Special:Version/License/Pipe_Escape

This sample provides a template for a copyright disclaimer that an employer or school might sign to relinquish their copyright interest in a program developed by an employee or student. It includes placeholders for the organization's name, program name, author, and signature details.

```Legal Text
  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
  `Gnomovision' (which makes passes at compilers) written by James Hacker.

  <signature of Ty Coon>, 1 April 1989
  Ty Coon, President of Vice
```

--------------------------------

### Create a Basic NPC with Name and Text

Source: https://wiki.citizensnpcs.co/1.x/Quick_Start

This command demonstrates how to create a new Non-Player Character (NPC) in Citizens 1.x. It uses the `/npc create` command, followed by the desired NPC name and optional text that will be associated with the NPC.

```Command Line
/npc create Notch I like cookies!
```
Tokens:
Raw