Rewards¶
Holds several data types which return detailed information on the reward screen, its options and items.
Forms¶
Rewards Rewards¶
- Returns the word "Rewards" if loaded
Associated DataTypes¶
Rewards¶
- Information on the number of rewards, and their index or name
-
Members
int
Count¶- Returns number of currently pending rewards
RewardItem
Reward[#]¶- Returns the reward by specified index
RewardItem
Reward[name]¶- Returns the reward by name
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
RewardOption¶
- Returns information on reward options. Must specify reward and option, e.g.
Rewards.Reward[1].Option[1].Text -
Members
string
Text¶- Returns name of the indicated option if available; else NULL
bool
Selected¶- Returns TRUE if the indicated option is available and selected; otherwise FALSE
bool
Select¶- Selects the specified option. TRUE if available and able to select; otherwise FALSE
int
ItemCount¶- 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
RewardOptionItem¶
- Returns name of the indicated option if available; else NULL. Must specify reward, option, and item, e.g.
${Rewards.Reward[<#/name>].Item[#/name].Text} -
Members
string
Text¶- Returns name of the indicated option if available; else NULL
This TLO is added by MQ2Rewards.