Class NumberLimitedProp

A prop (an item that can be used) , it has a limited number of uses.

Hierarchy (view full)

Prop
- NumberLimitedProp

Index

Constructors

Properties

options typeId useEvent?

Methods

Constructors

constructor

new NumberLimitedProp(typeId, options, useEvent?): NumberLimitedProp
Parameters
- typeId: string
  Identifier of the type of items for the stack. If a namespace is not specified, 'minecraft:' is assumed.
- options: NumberLimitedPropOptions
  Options of the prop.
- OptionaluseEvent: ((arg: ItemUseAfterEvent) => void)
  The event when an item is successfully used by a player.
  - - (arg): void
    - Parameters
      arg: ItemUseAfterEvent
      Returns void
Returns NumberLimitedProp
Overrides Prop.constructor
- Defined in lazuli-api/item/prop.ts:55

Properties

options

options: NumberLimitedPropOptions

Options of the prop.

`Readonly`typeId

typeId: string

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

`Optional`useEvent

useEvent?: ((arg: ItemUseAfterEvent) => void)

The event when an item is successfully used by a player.

Methods

`Protected`register

register(): void
Registry the prop.

Returns void
Deprecated
Use Register.propRegistry() to registry the prop.
Overrides Prop.register
- Defined in lazuli-api/item/prop.ts:75