Reward Classes

• Section
• Spacer
• Achievement
• Currency
• Follower
• Item
• Heirloom
• Mount
• Pet
• Quest
• Recipe
• Spell
• Title
• Toy
• Transmog
• Reputation

All rewards are accessible via ns.reward

---

Section

Adds a separator between the Rewards.

Section("Title of the Section")

---

Spacer

The Spacer Reward just adds a blank line.

Example

Spacer()

---

Achievement

Example

-- From Azj-Kahet plugin - Zone exploration achievement
Achievement({id = 40840, criteria = 69392}) -- Adventurer of Azj-Kahet

-- From treasure nodes - Collection achievement with criteria
Achievement({id = 40625, criteria = 68993}) -- Azj-Kahet Treasures

-- Multiple criteria example
Achievement({id = 17736, criteria = {qty = true, id = 1}}) -- Counter-based achievement

Properties

• id (int) (required)
  • The ID of the achievement
• criteria (int)
  • The criteria id (preferred) or criteria index of the achievement.
  • Supports following properties:
    • id (id)
      • criteria id (preferred) or criteria index
    • qty (bool)
      • For achievements with a counter. For example Grand Treasure Hunter
    • suffix (string)
      • Can be used with qty to add a custom suffix.
• oneline (boolean)
  • When true, the criteria text won’t be rendered.
• note (string)
  • This can be used to add a short note underneath the reward line.

---

Currency

Is Used to display a Currency in the Node rewards

Example

Currency({id = 2245}) -- Flightstones

Properties

• id (int) (required)
  • The ID of the currency
• note (string)
  • a short note behind the reward text

---

Follower

Example

Follower({id = 467, icon = 608952}) -- Fen Tao

Properties

• id (int) (required)
  • The follower ID.
• icon (name / int)
  • This sets the icon to be shown before the reward text.
• note (string)
  • a short note behind the reward text

---

Item

The Item reward is used as the base class for other item related rewards

Example

-- From Azj-Kahet plugin - Basic currency item
Item({item = 224581}) -- Nerubian Doubloons

-- From vendor nodes - Equipment with quest tracking
Item({item = 223924, quest = 82745}) -- Web-Woven Hood

-- From profession treasures - Knowledge items with notes
Item({item = 226271, note = 'Alchemy Knowledge'}) -- Nerubian Mixing Salts

-- Treasure items with completion tracking
Item({item = 224584, quest = 82721}) -- Memory Fragments

Properties

• item (int) (required)
  • The Item ID.
• type (string)
  • The type string is added behind the reward text
• note (string)
  • A short note behind the reward for additional information. Is placed behind the type string.
• status (string)
  • Is used to set a custom status string on the end of the line.
• bag (boolean)
  • If set to true the GetStatus() function checks if the player has the item in his bag and sets status to Green(L['completed']) or Red(L['incomplete'])
• quest (int)
  • If a quest id is added the GetStatus() function checks if the player has completed the quest and sets status to Green(L['completed']) or Red(L['incomplete'])
• weekly (int)
  • If a weekly quest id is added the GetStatus() function checks if the player has completed the quest and sets status to Green(L['weekly']) or Red(L['weekly'])

---

Heirloom

Uses Item as its base class, all properties from Item can be used here too.

Example

Heirloom({item = 122250}) -- Tattered Dreadmist Mask

Properties

• item (int) (required)
  • The ID of the Heirloom Item
• type (string)
  • L['heirloom'] by default.

---

Mount

Uses Item as its base class, all properties from Item can be used here too.

Example

-- From project plugins - Standard mount reward
Mount({item = 212346, id = 2174}) -- Alliance War Horse

-- From rare encounters - Mount with completion tracking
Mount({item = 221760, id = 2205, quest = 81705}) -- Siesbarg

-- Mount from vendor with currency note
Mount({item = 205209, id = 1736, note = '170x Residual Memories'}) -- Boulder Hauler

Properties

• item (int) (required)
  • The Item ID from which you learn the mount.
• id (int) (required)
  • The MountID.

---

Pet

Uses Item as its base class, all properties from Item can be used here too.

Example

-- From Azj-Kahet Kej Pet Vendor - Standard pet rewards
Pet({item = 221546, id = 4486}) -- Colossal Warsquid
Pet({item = 221547, id = 4487}) -- Kej'ra Wool Krolusk
Pet({item = 221548, id = 4485}) -- Invasive Kej'ra Drone
Pet({item = 221549, id = 4484}) -- Ominous K'arthok Broodling

-- Pet with currency note
Pet({item = 205120, id = 3537, note = '85x Residual Memories'}) -- Thimblerig

Properties

• item (int) (required)
  • The Item ID from which you learn the pet.
• id (int) (required)
  • The BattlePetSpeciesID of the Pet.

---

Quest

Example

Quest({id = 60}) -- Kobold Candles

Properties

• id (int) (required)
  • The ID of the rewarded quest.

---

Recipe

Uses Item as its base class, all properties from Item can be used here too.

Example

Recipe({item = 198104, profession = 185}) -- Recipe: Blubbery Muffin

Properties

• item (int) (required)
  • Them Item ID of the Recipe, not the Product.
• profession (int) (required)
  • The profession ID
  • Base SkillLineID

  SkillLineID	Profession
  129	First Aid
  164	Blacksmithing
  165	Leatherworking
  171	Alchemy
  182	Herbalism
  185	Cooking
  186	Mining
  197	Tailoring
  202	Engineering
  333	Enchanting
  356	Fishing
  393	Skinning
  755	Jewelcrafting
  773	Inscription
  794	Archeology

---

Spell

Uses Item as its base class, all properties from Item can be used here too.

Is Used to track Items that reward a Spell

Example

Spell({item = item_id, spell = spell_id})

Properties

• item (int) (required)
  • The Item ID.
• spell (int) (required)
  • The Spell ID that is learned when Using the Item.

---

Title

Example

Title({id = title_id, pattern = '{title} {player}'})

Properties

• id (int) (required)
  • The TitleID.
• pattern (string) (required)
  • Required to show the title in the right order.
    • '{title} {player}'
    • '{player}, {title}'
• type (string)
  • Optional type after the title text.
• note (string)
  • Optional note after the title text

---

Toy

Uses Item as its base class, all properties from Item can be used here too.

Example

Toy({item = item_id})

Properties

• item (int) (required)
  • The ID of the Toy.

---

Transmog

Uses Item as its base class, all properties from Item can be used here too.

Example

Transmog({item = item_id, slot = L[slot_locale]})

Properties

• item (int) (required)
  • The ID of the Transmog Item
• type (string) (Locale)
  • Should always be set to mark the Item Type (leather, 1h_sword, cloak, cosmetic, etc.)
  • Important for cosmetic cloaks.
• slot (string) (Locale)
  • Obsolete, was replaced by type.

---

Reputation

Example:

Reputation({id = 2590, gain = 150, quest = 84036, note = 'Example Note'})

Properties

• id (int) (required)
  • The FactionID of the faction the reputation is for, The FactionID is in the url for each factions page.
• gain (int) (required)
  • Amount of Reputation gained.
• quest (int)
  • If a quest id is added the GetStatus() function checks if the player has completed the quest and sets status to Green(L['claimed']) or Red(L['unclaimed'])
• note (string)
  • Optional note at the end of the reward item.