DataType:RewardItem

From the wonderful RedGuides Wiki

Gives information about the specified reward, including number of options, items, and availability.


This Data Type is referenced in MQ2Rewards, and accessed by Top-Level Object(s): Rewards
RewardItem is used as a return type by these members:  [ Toggle ]

Page Member Description
Rewards Reward[#] Returns the reward by specified index
Reward[name] Returns the reward by name

Members

Type Member Description
bool Reward[<#/name>].Claim Claims the specified reward if available and option (if any) selected. TRUE if able to claim; otherwise FALSE
Reward[<#/name>].Select Selects the specified reward. TRUE if available and able to select; otherwise FALSE.
Reward[<#/name>].Selected Returns TRUE if indicated reward is available and selected; else FALSE
int Reward[<#/name>].Items Returns number of items (right-side list) for the specified reward and selected option if available. Otherwise NULL.
Reward[<#/name>].Options Returns number of options for the specified reward if available. Otherwise NULL.
RewardOption Reward[<#/name>].Option[#/name] Returns the appropriate option by index or name; else returns NULL
RewardOptionItem Reward[<#/name>].Item[#/name] Returns the appropriate item by index or name; else returns NULL
string Reward[<#/name>].Text Returns name of the indicated reward if available; else NULL

Examples

  • ${Rewards.Reward[<#/name>].Text}
  • ${Rewards.Reward[<#/name>].Selected}
  • ${Rewards.Reward[<#/name>].Select}
  • ${Rewards.Reward[<#/name>].Claim}
  • ${Rewards.Reward[<#/name>].Options}
  • ${Rewards.Reward[<#/name>].Option[#/name]}
  • ${Rewards.Reward[<#/name>].Items}
  • ${Rewards.Reward[<#/name>].Item[#/name]}

See also