Class RewardClaimManager
Component that manages claiming Reward Items.
Inherited Members
Namespace: UnityEngine.GameFoundation.Components
Syntax
public class RewardClaimManager : MonoBehaviour
Fields
onRewardItemClaimFailed
Callback that will get triggered if a Reward Item claim fails.
Declaration
public RewardClaimManager.RewardClaimFailedEvent onRewardItemClaimFailed
Field Value
Type | Description |
---|---|
RewardClaimManager.RewardClaimFailedEvent |
onRewardItemClaimInitiated
Callback that will get triggered when a Reward Item claim is initiated.
Declaration
public RewardClaimManager.RewardItemClaimInitiatedEvent onRewardItemClaimInitiated
Field Value
Type | Description |
---|---|
RewardClaimManager.RewardItemClaimInitiatedEvent |
onRewardItemClaimProgressed
Callback that will get triggered when a Reward Item claim progresses.
Declaration
public RewardClaimManager.RewardItemClaimProgressedEvent onRewardItemClaimProgressed
Field Value
Type | Description |
---|---|
RewardClaimManager.RewardItemClaimProgressedEvent |
onRewardItemClaimSucceeded
Callback that will get triggered if a Reward Item claim completes successfully.
Declaration
public RewardClaimManager.RewardClaimSuccessEvent onRewardItemClaimSucceeded
Field Value
Type | Description |
---|---|
RewardClaimManager.RewardClaimSuccessEvent |
Methods
Claim(RewardItemDefinition)
Claims a Reward Item. If already a Reward Item is in the claim progress, it adds the new Reward Item to the queue. If there is no Reward Item in the queue, it initiates a claim on the Reward Item.
Declaration
public bool Claim(RewardItemDefinition definition)
Parameters
Type | Name | Description |
---|---|---|
RewardItemDefinition | definition | The reference to definition of Reward Item. |
Returns
Type | Description |
---|---|
Boolean |
|
IsInQueue(RewardItemDefinition)
Specifies whether the Reward Item is in the queue.
Declaration
public bool IsInQueue(RewardItemDefinition definition)
Parameters
Type | Name | Description |
---|---|---|
RewardItemDefinition | definition | The reference to Reward Item definition. |
Returns
Type | Description |
---|---|
Boolean | Returns whether the Reward Item is in the queue. |