Class UserRewardServiceClass

constructor

• new UserRewardServiceClass(): UserRewardServiceClass

  Returns UserRewardServiceClass

BoostRewardService

EpochTimes

Gacha

StepConstants

CreateDatastoreTemplate

• CreateDatastoreTemplate(): UserDataStore

  Returns UserDataStore

CreateReward

• CreateReward(
      ...args: [
          id: string,
          _DatastoreGet?: DatastoreGet,
          _DatastoreSet?: DatastoreSet,
          ProcessRedeem?: ProcessRedeem,
      ],
  ): UserRewardServiceReward

  Parameters

  • ...args: [
        id: string,
        _DatastoreGet?: DatastoreGet,
        _DatastoreSet?: DatastoreSet,
        ProcessRedeem?: ProcessRedeem,
    ]

  Returns UserRewardServiceReward

CreateSpinWheel

• CreateSpinWheel(...args: [Segments: number, SegmentSize: number]): SpinWheel

  Parameters

  • ...args: [Segments: number, SegmentSize: number]

  Returns SpinWheel

  Client

GetReward

• GetReward<RewardType = UserRewardServiceReward>(
      uniqueRewardId: string,
      timeOut?: number,
  ): RewardType

  Type Parameters

  • RewardType = UserRewardServiceReward

  Parameters

  • uniqueRewardId: string
  • OptionaltimeOut: number

  Returns RewardType

HasReward

• HasReward<RewardType = UserRewardServiceReward>(
      uniqueRewardId: string,
      timeOut?: number,
  ): undefined | RewardType

  Type Parameters

  • RewardType = UserRewardServiceReward

  Parameters

  • uniqueRewardId: string
  • OptionaltimeOut: number

  Returns undefined | RewardType

  Yields

  On the client.

RedeemReward

• RedeemReward(
      Player: Player,
      uniqueRewardId: string,
      timeOut?: number,
  ): Promise<LuaTuple<[boolean, RedeemStringResults?]>>

  Parameters

  • Player: Player
  • uniqueRewardId: string
  • OptionaltimeOut: number

  Returns Promise<LuaTuple<[boolean, RedeemStringResults?]>>

• RedeemReward(
      uniqueRewardId: string,
      timeOut?: number,
  ): Promise<LuaTuple<[boolean, RedeemStringResults?]>>

  Parameters

  • uniqueRewardId: string
  • OptionaltimeOut: number

  Returns Promise<LuaTuple<[boolean, RedeemStringResults?]>>

RegisterRewards

• RegisterRewards(
      Rewards: {
          AutoInitializePlayers?: number | boolean;
          Cooldown?: number;
          DatastoreGet: DatastoreGet;
          DatastoreSet: DatastoreSet;
          Expires?: number;
          Id: string;
          MaxLocalRedeems?: number;
          onReady?: (Reward: UserRewardServiceReward) => void;
          ProcessRedeem: ProcessRedeem;
          Quest?: UserQuestsConstructorProps;
          Stacks?: number;
          StepConstant?: number;
      }[],
  ): void

  Parameters

  • Rewards: {
        AutoInitializePlayers?: number | boolean;
        Cooldown?: number;
        DatastoreGet: DatastoreGet;
        DatastoreSet: DatastoreSet;
        Expires?: number;
        Id: string;
        MaxLocalRedeems?: number;
        onReady?: (Reward: UserRewardServiceReward) => void;
        ProcessRedeem: ProcessRedeem;
        Quest?: UserQuestsConstructorProps;
        Stacks?: number;
        StepConstant?: number;
    }[]

  Returns void

UseStepConstant

• UseStepConstant(StepConstant: number, Clocktime?: number): number

  Parameters

  • StepConstant: number
  • Clocktime: number = ...

  Returns number