1.x/List of Rewards node types

From Citizens Wiki

< 1.x

Revision as of 00:48, 27 January 2012 by Aufdemrand (talk | contribs) (Created page with "The rewards: node is used in Quests.yml for rewarding the player when certain conditions have been met. ''Format:''' Name (''type specifier'') - '''description''' These can...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

The rewards: node is used in Quests.yml for rewarding the player when certain conditions have been met.

Format:' Name (type specifier) - description

These can be used as both rewards and requirements to start a quest. As rewards, they can be either give rewards, or take rewards. As requirements, they can only be used to take from a player. Rewards can also be specified under each objective, and also for each step, using the same syntax.

Command reward (command) - executes a command. Specified by the command: node. Use <player> as a variable that will be replaced with the name of the player who is receiving the reward. Use <world> as a variable that will be replaced with the name of the world the player is currently in. Use server: true to execute the command from the console. Ex:

   '0':
       type: command
       command: give <player> 1 100
       server: false

NPC reward (npc) - grants an npc to a player. Uses a name: node to specify the name of the npc, and a comma-separated list of toggles in the types: node (eg. trader,quester,guard). Will create an NPC owned by the player who completed the quest, with a generated UID. Ex:

   '0':
       type: npc
       npcid: 1 (optional - gives the ownership of npc specified by this id to the player)
       name: 'Bill'
       types: 'guard,trader,quester'
       location:
           x: 10
           y: 10
           z: -50
           world: 'test'

Rank reward (rank) - grants a group ('rank') to a player. Specified by the rank: node. Ex:

   '0':
       type: rank
       rank: 'admin'

Permission reward (permission) - grants a permission to a player. Specified by the permission: node. Ex:

   '0':
       type: permission
       permission: 'quests.admin'

Quest reward (quest) - grants a quest to a player. Note that it cannot be taken away from a player. Specified by the quest: node. Ex:

   '0':
       type: quest
       quest: 'builder'

Item reward (item) - gives an item to a player. Loaded from the item: nodes. Ex:

   '0':
       type: item
       item:
           id: 10
           amount: 50
           data: 0

Health reward (health) - gives health to a player. Loaded from the amount: node. Ex:

   '0':
       type: health
       amount: 10

Money reward (money) - gives money to a player. Loaded from the money: node. Ex:

   '0':
       type: money
       money: 100

Teleport reward (teleport) - teleports a player to a location. Loaded from the location: node. Ex:

   '0':
       type: teleport
       location:
           x: 10
           y: 50
           z: -10
           world: 'main'