Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Item

The client-side Item document which extends the common BaseItem model.

mixes

ClientDocumentMixin

see

{@link documents.Items} The world-level collection of Item documents

see

{@link applications.ItemSheet} The Item configuration application

Hierarchy

  • any
    • Item

Index

Constructors

Accessors

Methods

Constructors

constructor

  • Returns Item

Accessors

actor

  • A convenience alias of Item#parent which is more semantically intuitive

    Returns Actor

thumbnail

  • get thumbnail(): string

  • Provide a thumbnail image path used to represent this document.

    Returns string

isOwned

  • get isOwned(): boolean

  • A convenience alias of Item#isEmbedded which is preserves legacy support

    Returns boolean

transferredEffects

  • Return an array of the Active Effect instances which originated from this Item. The returned instances are the ActiveEffect instances which exist on the Item itself.

    Returns ActiveEffect[]

Methods

getRollData

  • getRollData(): any

  • Prepare a data object which defines the data schema used by dice roll commands against this Item

    Returns any

Static _onCreateDocuments

  • _onCreateDocuments(items: any, context: any): Promise<any>
  • inheritdoc

    Parameters

    • items: any
    • context: any

    Returns Promise<any>

Static _onDeleteDocuments

  • _onDeleteDocuments(items: any, context: any): Promise<any>
  • inheritdoc

    Parameters

    • items: any
    • context: any

    Returns Promise<any>