1.x/List of Objective node types: Difference between revisions

From Citizens Wiki

< 1.x

No edit summary
No edit summary
Line 26: Line 26:
=== Quest Types ===
=== Quest Types ===


Build quest (build) - place a certain number of blocks
== Build ==
 
Build quests require the player to place a certain number of blocks.


<pre>
<pre>
Line 36: Line 38:
</pre>
</pre>


Location quest (move location)- be within a certain range of a location.
== Location ==
 
Location quests (move location) require the player be within a certain range of a location.


<pre>'0':
<pre>'0':
Line 45: Line 49:
             z: 420
             z: 420
         time: 10        # The time (in seconds) that the player has to stay in this location for.
         time: 10        # The time (in seconds) that the player has to stay in this location for.
         amount: 1        # The leeway in blocks that the player can be away from the location before finishing.
         leeway: 1        # The leeway in blocks that the player can be away from the location before finishing.
</pre>
</pre>


Note by aufdemrand: Location quest is currently producing console errors when using /quest status. They also do not trigger when the objective is complete. This is a reported bug and is being worked on.


== Hunt ==
Hunt quests require the player to kill a certain number of monsters.


Hunt quest (hunt) - kill a certain number of monsters.
<pre>'0':
Uses:  
    '0':   
* ''amount'' - the number of monsters to kill.
        type: hunt   # Specifies hunt objective.
* ''string'' - which monsters should be killed. Using '-' as the first character makes a whitelist. '*' represents all.
        amount: 10        # The amount of monsters the player needs to kill.
        string: *       # Any monster will do.  You can also specify.  Zombie, for example, will require only Zombies.
                      # Using '-' as the first character makes a whitelist. '*' represents all.
</pre>


Distance quest (move distance)- walk a certain number of blocks.
Distance quest (move distance)- walk a certain number of blocks.

Revision as of 15:14, 13 February 2012

Note by aufdemrand: Still formatting this page, sorry. Will finish soon.

Objective nodes types

To aid with generic objective design, each objective can use one of a common set of variables:

  • amount
  • string
  • materialid
  • location
  • item
  • npcdestination (destination NPC ID)

Each objective type may use one or more of these variables.

- Specifying item and locations - Item nodes have three sub-nodes, two that must be included and one optional. The id sub-node designates the item/block ID. The amount sub-node specifies the item amount. The optional data sub-node specifies the item data value to be used.

Location nodes have 4 required sub-nodes, two optional. The world node specifies the world name of the location. The x, y, and z nodes specifies the x, y, and z values. The optional pitch/yaw nodes specify the rotation (think aeroplanes) of the location.

Quest Types

Build

Build quests require the player to place a certain number of blocks.

'0':
    '0':    
        type: build      # Specifies build objective.
        materialsid: 54  # Chest. Material player is required to build.
        amount: 1        # Number of items that must be placed.

Location

Location quests (move location) require the player be within a certain range of a location.

'0':
    '0':    
        type: move location   # Specifies loaction objective.
            x: 150       # Coordinates of location required to visit.
            y: 47
            z: 420
        time: 10         # The time (in seconds) that the player has to stay in this location for.
        leeway: 1        # The leeway in blocks that the player can be away from the location before finishing.


Hunt

Hunt quests require the player to kill a certain number of monsters.

'0':
    '0':    
        type: hunt   # Specifies hunt objective.
        amount: 10         # The amount of monsters the player needs to kill.
        string: *        # Any monster will do.  You can also specify.  Zombie, for example, will require only Zombies.
                      # Using '-' as the first character makes a whitelist. '*' represents all.

Distance quest (move distance)- walk a certain number of blocks. Uses:

  • amount - the amount of blocks to walk.

Block destroy quest (destroy block) - break a certain amount of blocks. Uses:

  • amount - the amount of blocks to break.
  • materialid - the block ID to break.

Delivery quest (delivery)- deliver an item to an npc. Uses:

  • npcdestination - the NPC ID to deliver to.
  • materialid - the material that must be in hand.
  • amount - the amount of the material that must be in hand.

Combat quest (player combat) - kill a certain number of players. Uses:

  • amount - the amount of players to kill.
  • string - which players should be killed. Using '-' as the first character makes a whitelist. '*' represents all. g:group represents groups.

Collect quest (collect) - pick up a certain number of items. Uses:

  • amount - the number of items to pick up.
  • materialid - the ID to pick up.