Denizen/0.7/Example Scripts/Beginner Scripts: Difference between revisions

Revision as of 20:10, 19 September 2012

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!

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

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

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 completely change how you use Denizen. 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 somehow, one at a time.

Code: A sample 'Karma' reward system.

{{{2}}}

Joe the Builder Script and Assignment

---- assignments.yml ----
Denizens:                         
  'Steve':    #This is the name of the Denizen               
    Interact Scripts: #These are the assigned interact scripts. The number before the script is the priority.                      
      - 0 Regular Joe
      - 10 ^Joe the Builder  


---- script.yml ----
'Regular Joe':
  Type: Interact   
  Requirements:  #There is no list of requirements, so this script can always be picked. That's why we assign it with low priority.
    Mode: None
  Steps:
    1:
      Click Trigger:
        Script:  #This sends a basic message to the interacting player.
        - CHAT "Hello <PLAYER>! I supply builders only!"   
      Proximity Trigger:
        Script:  #This sends a basic message to the player when he walks near.
        - CHAT "Hello <PLAYER>! Welcome to <WORLD>!"  
        
'Joe the Builder':
  Type: Interact   
  Requirements:
    Mode: All
    List: #Here we check if the player has this permission. If he does, this script is selected because it is higher priority.
    - PERMISSION modifyworld.*   
  Steps:
    1:
      Click Trigger:
        Script:
        - ENGAGE   
        #Engage prevents all interaction with this NPC until DISENGAGE is called.
        - CHAT "Hello <PLAYER> the Builder! Take this shovel!"
        - GIVE WOOD_SPADE
        - WAIT 1       
        - CHAT "If you have any questions, just say 'help'"
        - FINISH 
        #This increments the number of times this script (Joe The Builder) has been completed by this player.
        - DISENGAGE  
        #This sets the NPC Interactable again.
      Chat Trigger: #There can be multiple entries under a Chat Trigger or Location Trigger node. Hence the 1: on the next line.
        1:
          Trigger: I need some /help/
          Script:
           - CHAT "Press 'e' to open your inventory, and drag the shovel to your item bar"
           - CHAT "Press the number 1-9 to select the shovel, then start digging!"

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 Repeatable Fetch Quest

#--- assignments.yml ----
Denizens:
 John Q QuestGiver:
   Interact Scripts:
     - 0 StartFetch
     - 1 EndFetch

#--- RepeatableFetchQuest.yml ----
     
StartQuest:
  Type: Interact
  Requirements:
    Mode: None
  Steps:
     1:
      Click Trigger:
        Script:
        - CHAT "Hey, you there!"
        - CHAT "I have a special request of you!"
        - CHAT "Will you help me?"
      Chat Trigger:
         1:
          Trigger: /Yes/. I will.
          Script:
          #Tell the player what to do.
          - CHAT "I need you to bring me some thing. For testing!"
          - WAIT 1
          - CHAT "I need: 1 Iron Block, 1 Feather, and 3 Eggs."
          - WAIT 1
          - CHAT "Come back when you have them and I will reward you!"
          #Set this script as finished, so we know they're on the quest
          - FINISH
          #set this script to step 2. So the player gets the hint message.
          - ZAP
         2:
          Trigger: /No/. I will not.
          Script:
          - CHAT "Are you sure? OK. maybe later?"
    2:
      Click Trigger:
        Script:
        - CHAT "Come back you have 1 Iron Block, 1 Feather, and 3 Eggs!"


EndFetch:
  Type: Trigger   
  Requirements:
    Mode: All
    List: #Here we check if they are on the quest and have the items.
    - FINISHED StartQuest
    - ITEM 42 1
    - ITEM 288 1
    - ITEM 344 3
  Steps:
    '1':
      Click Trigger:
        Script:
        #Engage is used to keep the player from clicking twice.
        - ENGAGE
        - TAKE 42 QTY:1
        - TAKE 288 QTY:1
        - TAKE 344 QTY:3
        - CHAT "Thank you so much! Here, take this as a reward!"
        - GIVE 133 QTY:1
        - WAIT 1
        - CHAT "Bring me those items again, and I'll give you another!"       
        #Always disengagae after an Engage
        - DISENGAGE

Basic Unrepeatable Fetch Quest

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

Basic Repeatable Fetch Quest

#--- assignments.yml ----
Denizens:
 John Q QuestGiver:
   Interact Scripts:
     - 0 StartFetch
     - 1 EndFetch

#--- UnRepeatableFetchQuest.yml ----
     
StartQuest:
  Type: Interact
  Requirements:
    Mode: None
  Steps:
     1:
      Click Trigger:
        Script:
        - CHAT "Hey, you there!"
        - CHAT "I have a special request of you!"
        - CHAT "Will you help me?"
      Chat Trigger:
         1:
          Trigger: /Yes/. I will.
          Script:
          - CHAT "I need you to bring me some thing. For testing!"
          - WAIT 1
          - CHAT "I need: 1 Iron Block, 1 Feather, and 3 Eggs."
          - WAIT 1
          - CHAT "Come back when you have them and I will reward you!"
          - FINISH
          - ZAP
         2:
          Trigger: /No/. I will not.
          Script:
          - CHAT "Are you sure? OK. maybe later?"
    2:
      Click Trigger:
        Script:
        - CHAT "Come back you have 1 Iron Block, 1 Feather, and 3 Eggs!"
    3:
      Click Trigger:
        Script:
        - CHAT "Thanks for the help before!"


EndFetch:
  Type: Interact   
  Requirements:
    Mode: All
    List: #Here we check if they are on the quest and have the items, and haven't completed this yet.
    - FINISHED StartQuest
    - -FINISHED EndFetch
    - ITEM 42 1
    - ITEM 288 1
    - ITEM 344 3
  Steps:
    '1':
      Click Trigger:
        Script:
        - ENGAGE
        - TAKE 42 QTY:1
        - TAKE 288 QTY:1
        - TAKE 344 QTY:3
        - CHAT "Thank you so much! Here, take this as a reward!"
        - GIVE 133 QTY:1
        - WAIT 1
        - CHAT "Tbanks so much! see you around!"  
        #This handy command will move the first script to Step 3.
        - ZAP 3 SCRIPT:StartFetch
        #Mark this script as completed.
        - FINISH
        - DISENGAGE

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.

Joe the Builder Script and Assignment

---- assignments.yml----
Denizens:
  Coach:
    Interact Scripts:
      - 0 Coaches Race
    

---- Scripts.yml -----

'RaceEnd': 
  Type: Task    
  Script:       
  - NARRATE "%%cTimes Up!"
  - ZAP 'SCRIPT:Coaches Race' 3
  
"Coaches Race":
  Type: Interact   
  Requirements:
    Mode: All
    List:
     - -FINISHED Coaches Race
  Steps:
    1:
      Click Trigger:
        Script:
          - CHAT "Think you're fast, sonny-jim?"
          - CHAT "Lets see how fast you are. Run up that hill, around the tree, and back in 15 seconds, if you can!"
          - WAIT 1
          - CHAT "On your mark, get set, go!"
          - RUNTASK SCRIPT:RaceEnd DELAY:15
          - ZAP 2
    2:
      Location Trigger:
         1:
           Trigger: theTree
           Script: 
            - ZAP 4
      Click Trigger:
        Script:
          - CANCELTASK RaceEnd
          - CHAT "Trying to cheat eh?, you have to go around the tree!, try again later, slowpoke!"
          - ZAP 1
    3:
      Click Trigger:
        Script:
          - CHAT "Aww too slow!, go run some laps and try again!"
          - ZAP 1
    4:
      Click Trigger:
        Script:
          - CANCELTASK RaceEnd
          - CHAT "Woo, you are quick! Good job!"
          - GIVE MONEY QTY:1000
          - FINISH

@@ Line 220: / Line 220: @@
 This script is more of an intermediate script, but shows how flags can completely change how you use Denizen. 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 somehow, '''one at a time'''.
-{{codebox|height=250px|Complete with generic texts!|<syntaxhighlight line='false' lang="yaml">
+{{codebox|height=250px|A sample 'Karma' reward system.|<syntaxhighlight line='false' lang="yaml">
 # A script that shows the behavior of multiple assignments.
 #