Class PercentGiftItem

A Percent-Driven random reward gift.

Hierarchy (view full)

Constructors

constructor

Properties

chance reward typeId

Methods

giveReward register

Constructors

constructor

  • new PercentGiftItem(typeId, chance, reward): PercentGiftItem

  • Parameters

    • typeId: string

      Identifier of the type of items for the stack. If a namespace is not specified, 'minecraft:' is assumed.

    • chance: number

      The probability of give reward when use the gift, should be a percentage (0~1).

    • reward: RewardType

      Rewards of the gift.

    Returns PercentGiftItem

Properties

chance

chance: number

The probability of give reward when use the gift, should be a percentage (0~1).

reward

reward: RewardType

Rewards of the gift.

ReadonlytypeId

typeId: string

Identifier of the type of items for the stack. If a namespace is not specified, 'minecraft:' is assumed.

Methods

giveReward

  • giveReward(player): void

  • Give reward to a player.

    Parameters

    • player: Player

    Returns void

Protectedregister

  • register(): void

  • Registry the gift.

    Returns void

    Deprecated

    Use Register.giftRegistry() to registry the gift.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods