Denizen/0.7/Example Scripts/Beginner Scripts

From Citizens Wiki

< Denizen‎ | 0.7

Revision as of 16:10, 24 March 2020 by Mcmonkey (talk | contribs)

For more up-to-date information and full details on specific features (individual commands or tags, for example), check the Meta Documentation.

If you want a full tutorial to help get you set up, check out the Tutorial Videos on youtube or the Beginner's Guide text website.

If you need quick help, visit our Discord group.




This wiki is outdated, please view the tutorial videos/guide, meta documentation, or Discord group (all linked above) for up-to-date information!


Sometimes the best way to learn is by looking at some examples. The following beginner scripts use basic denizen commands and requirements to provide some nice basic functionality for your Denizens.

Example scripts are provided with both the assignments and the scripts in the same box. Be sure and put the text in the correct file in your plugins folder.
  • Assignments should always be appended to plugins\Denizen\assignments.yml
  • Scripts can be placed in any .yml file in the plugins\Denizen\scripts\ directory. Remember: You can have multiple scripts per file!



and now... the scripts!

Denizen Basics

Though Denizen can be very advanced, it can perform very simple tasks, as well. Most of the basics can be covered with a QUICK SCRIPT. Check out these examples.

The Click and Damage Triggers

Clicking on a Denizen NPC can activates the Click Trigger or Damage Trigger, depending on which buttom was pressed. This is probably the easiest and most straight-forward way to interact with a NPC. Be sure to turn on the Damage Trigger! (Use /denizen trigger toggle damage)


Code: Right click to speak, left click hurts!
{{{2}}}


The Chat and Proximity Triggers

The two remaining Quick Script triggers are the Chat and Proximity Triggers. Chat will catch any text said near the Denizen NPC and intercept it. The Player's text is directed towards the NPC and the NPC can respond back. Proximity is triggered when the Player comes into a specified range. (Note: Proximity is not enabled by default, so select the NPC you desire to have the Prox. Trigger and type /denizen trigger toggle proximity)


Code: The worst therapist ever.
{{{2}}}


Simple, random conversations

A great way to provide some nice immersion into your world is as simple as a basic interaction with a Denizen NPC outputting a random response. There are a couple different ways this can be done, as provided in the examples below. Since this concept is simple, it can be done with a Quick Script as well as an Interact Script.

A conversation with RANDOM

Code: Quick Script conversation with the RANDOM command.
{{{2}}}


A conversation with ZAP RANDOM

Code: Interact Script conversation with the ZAP command.
{{{2}}}


Notch's Cookies

Code: Notch loves cookies, and RANDOM chat.
{{{2}}}


Multiple Scripts & Requirements

Random chat is nice, but controlling the flow of conversation and events is just as important. One of the best features of Denizen's Interact Scripts is the requirements system, which can be used to control multiple scripts. Imagine NPCs greeting players based on weather, or having conversations only when on a quest. For further understanding, you should check out [Denizen/Script Assignments#Multiple Scripts], but take these examples below to get a basic understanding.


A Simple Multiple Requirement Script

Code: Two scripts are better than one.
{{{2}}}


Script sequencing with the SCRIPT requirement

Another good way to control the flow of multiple scripts is by using the SCRIPT requirement, which can check if the player has completed or failed scripts. Since 'Quest, part 2' requires the completion of 'Quest, part 1', the player will be forced to complete the scripts in an order set forth by the arguments in the requirement.


Code: You must do them in order!
{{{2}}}


Script sequencing with FLAGS

This script is more of an intermediate script, but shows how flags can be used to control sequence of a script. In this example, multiple NPCs are part of this karma example. Note: Scottie's Script/Jason's Script/etc. are not shown, and aren't necessarily important to this example, but it is assumed that the player collects karma from these characters, somehow, one at a time.


Code: A sample 'Karma' reward system.
{{{2}}}




Basic Repeatable Fetch Quest

Here is the fastest way to do a repeatable 'fetch' quest. Useful for custom crafting-type NPCs. Once the player agrees to help, he can turn in the items as often as he wants to receive the reward.

Basic Unrepeatable Fetch Quest

By adding 3 lines to the script above, it becomes un-repeatable.

The Race

Coach wants you to RUN, BOY! This script uses a TASK script and a Location trigger to make a timed race for the player. Good example of ZAP and RUNTASK/CANCELTASK command usage. Be sure and define a Location Bookmark called 'theTree' using the /denizen bookmark location command. Be sure to turn on the Location Trigger for this NPC! (Use /denizen trigger toggle location)

Retrieved from ‘https://wiki.citizensnpcs.co/index.php?title=Denizen/0.7/Example_Scripts/Beginner_Scripts&oldid=5234’