Class Rewards

Hierarchy (view full)

EventEmitter<RewardsEvents>
- Rewards

Constructors

constructor

new Rewards(gp, syncManager, rewards): Rewards
Parameters
- gp: CoreSDK
- syncManager: SyncManager
- rewards: Reward[]
Returns Rewards
Overrides EventEmitter.constructor
- Defined in core/rewards/Rewards.ts:52

Properties

`Private` #notFoundList

#notFoundList: any[] = []

`Private` #playerRewardsList

#playerRewardsList: PlayerReward[] = []

`Private` #playerRewardsMap

#playerRewardsMap: Record<string, PlayerReward> = {}

`Private` #rewardsList

#rewardsList: Reward[] = []

`Private` #rewardsMapID

#rewardsMapID: Record<number, Reward> = {}

`Private` #rewardsMapTag

#rewardsMapTag: Record<string, Reward> = {}

`Private` #syncManager

#syncManager: SyncManager

`Private` _events

_events: EventLite = ...

`Private` gp

Accessors

givenList

get givenList(): PlayerReward[]
Returns PlayerReward[]
- Defined in core/rewards/Rewards.ts:116

list

get list(): Reward[]
Returns Reward[]
- Defined in core/rewards/Rewards.ts:112

Methods

`Private` #acceptReward

#acceptReward(playerReward): void
Private
Parameters
- playerReward: PlayerReward
Returns void
- Defined in core/rewards/Rewards.ts:357

`Private` #addReward

#addReward(id): void
Private
Parameters
- id: number
Returns void
- Defined in core/rewards/Rewards.ts:335

`Private` #applyRewardMutations

#applyRewardMutations(reward): void
Private
Parameters
- reward: Reward
Returns void
- Defined in core/rewards/Rewards.ts:370

`Private` #getPlayerRewardById

#getPlayerRewardById(id): PlayerReward
Parameters
- id: number
Returns PlayerReward
- Defined in core/rewards/Rewards.ts:243

`Private` #getReward

#getReward(idOrTag): Reward
Parameters
- idOrTag: string | number
Returns Reward
- Defined in core/rewards/Rewards.ts:239

`Private` #getRewardInfo

#getRewardInfo(idOrTag): PlayerRewardInfo
Parameters
- idOrTag: string | number
Returns PlayerRewardInfo
- Defined in core/rewards/Rewards.ts:263

`Private` #refreshPlayerRewardsMap

#refreshPlayerRewardsMap(): void
Returns void
- Defined in core/rewards/Rewards.ts:387

`Private` #refreshRewardsMap

#refreshRewardsMap(): void
Returns void
- Defined in core/rewards/Rewards.ts:378

`Private` #setRewardsList

#setRewardsList(playerRewards, notSentGivenRewards, notSentAcceptedRewards): void
Parameters
- playerRewards: PlayerReward[]
- notSentGivenRewards: RewardToIncrement[]
- notSentAcceptedRewards: RewardToIncrement[]
Returns void
- Defined in core/rewards/Rewards.ts:287

accept

accept(input): Promise<AcceptPlayerRewardOutput>
Parameters
- input: Omit<AcceptPlayerRewardInput, "platformData">
Returns Promise<AcceptPlayerRewardOutput>
- Defined in core/rewards/Rewards.ts:205

getReward

getReward(idOrTag): PlayerRewardInfo
Parameters
- idOrTag: string | number
Returns PlayerRewardInfo
- Defined in core/rewards/Rewards.ts:283

give

give(input): Promise<GivePlayerRewardOutput>
Parameters
- input: Omit<GivePlayerRewardInput, "platformData"> & {
  lazy?: boolean;
  }
Returns Promise<GivePlayerRewardOutput>
- Defined in core/rewards/Rewards.ts:120

has

has(idOrTag): boolean
Parameters
- idOrTag: string | number
Returns boolean
- Defined in core/rewards/Rewards.ts:247

hasAccepted

hasAccepted(idOrTag): boolean
Parameters
- idOrTag: string | number
Returns boolean
- Defined in core/rewards/Rewards.ts:251

hasUnaccepted

hasUnaccepted(idOrTag): boolean
Parameters
- idOrTag: string | number
Returns boolean
- Defined in core/rewards/Rewards.ts:255

off

off<ET>(type, handler): void
Type Parameters
- ET extends keyof RewardsEvents
Parameters
- type: ET
- handler: ((event, ...args) => void)
  - - (event, ...args): void
    - Parameters
      event: RewardsEvents[ET]
      Rest ...args: any
      Returns void
Returns void
Inherited from EventEmitter.off
- Defined in core/events/EventEmitter.ts:12

on

on<ET>(type, handler): void
Type Parameters
- ET extends keyof RewardsEvents
Parameters
- type: ET
- handler: ((event, ...args) => void)
  - - (event, ...args): void
    - Parameters
      event: RewardsEvents[ET]
      Rest ...args: any
      Returns void
Returns void
Inherited from EventEmitter.on
- Defined in core/events/EventEmitter.ts:9

once

once<ET>(type, handler): void
Type Parameters
- ET extends keyof RewardsEvents
Parameters
- type: ET
- handler: ((event, ...args) => void)
  - - (event, ...args): void
    - Parameters
      event: RewardsEvents[ET]
      Rest ...args: any
      Returns void
Returns void
Inherited from EventEmitter.once
- Defined in core/events/EventEmitter.ts:15