DataType:RewardOption
Returns information on reward options
This Data Type is referenced in MQ2Rewards, and accessed by Top-Level Object(s): Rewards
RewardOption is used as a return type by these members: [ Toggle ]
| Page | Member | Description |
|---|---|---|
| RewardItem | Reward[<#/name>].Option[#/name] | Returns the appropriate option by index or name; else returns NULL |
Members
| Type | Member | Description |
|---|---|---|
| bool | Reward[<#/name>].Option[#/name].Select | Selects the specified option. TRUE if available and able to select; otherwise FALSE |
| Reward[<#/name>].Option[#/name].Selected | Returns TRUE if the indicated option is available and selected; otherwise FALSE | |
| int | Reward[<#/name>].Option[#/name].ItemCount | Returns number of items (right-side list) for the specified reward and selected option if available. Otherwise NULL. |
| RewardOptionItem | Reward[<#/name>].Option[#/name].Item[#/name] | Returns the appropriate item by index or name; else returns NULL |
| string | Reward[<#/name>].Option[#/name].Text | Returns name of the indicated option if available; else NULL |
Examples
- ${Rewards.Reward[<#/name>].Option[#/name].Text}
- ${Rewards.Reward[<#/name>].Option[#/name].Selected}
- ${Rewards.Reward[<#/name>].Option[#/name].Select}
- ${Rewards.Reward[<#/name>].Option[#/name].ItemCount}
- ${Rewards.Reward[<#/name>].Option[#/name].Item[#/name]}