RewardItem

Gives information about the specified reward, including number of options, items, and availability. (must specify reward, e.g. Rewards.Reward[1].Text)

Members

string Text

Returns name of the indicated reward if available; else NULL

bool Selected

Returns TRUE if indicated reward is available and selected; else FALSE

bool Select

Selects the specified reward. TRUE if available and able to select; otherwise FALSE.

bool Claim

Claims the specified reward if available and option (if any) selected. TRUE if able to claim; otherwise FALSE

int Options

Returns number of options for the specified reward if available. Otherwise NULL.

RewardOption Option[#|name]

Returns the appropriate option by index or name; else returns NULL

int Items

Returns number of items (right-side list) for the specified reward and selected option if available. Otherwise NULL.

RewardOptionItem Item[#|name]

Returns the appropriate item by index or name; else returns NULL

Examples

${Rewards.Reward[1].Text}
${Rewards.Reward[3].Item[2]}

This datatype is added by MQ2Rewards.