Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Doodad

Hierarchy

  • Doodad

Implements

Index

Constructors

constructor

  • Parameters

    • Optional type: DoodadType
    • Default value x: number = 0
    • Default value y: number = 0
    • Default value z: number = 0
    • Default value options: IDoodadOptions = {}

    Returns Doodad

Properties

containedItems

containedItems: IItemArray

Optional decay

decay: number

Optional gatherReady

gatherReady: boolean

Optional gfx

gfx: number

id

id: number

Optional itemOrders

itemOrders: number[]

Optional maxDur

maxDur: number

Optional minDur

minDur: number

Optional orientation

orientation: DoorOrientation

Optional ownerIdentifier

ownerIdentifier: string

Optional quality

quality: ItemQuality

Optional renamed

renamed: string

Optional spread

spread: number

Optional treasure

treasure: boolean

type

Optional weight

weight: number

weightCapacity

weightCapacity: number

x

x: number

y

y: number

z

z: number

Methods

addTreasureChestLoot

  • addTreasureChestLoot(): void

blocksMove

  • blocksMove(): boolean
  • Returns boolean

canGrow

  • canGrow(): boolean
  • Returns boolean

canHarvest

  • canHarvest(): boolean
  • Returns boolean

canPickup

  • canPickup(player: IPlayer): boolean

causeStatus

  • causeStatus(player: IPlayer): void

changeType

checkForTrampling

  • checkForTrampling(playerOrCreatureId: IPlayer | number): boolean

damage

  • damage(forceBreak?: boolean, isTrample?: boolean, skipSound?: boolean, skipResources?: boolean): void
  • Parameters

    • Default value forceBreak: boolean = false
    • Default value isTrample: boolean = false
    • Default value skipSound: boolean = false
    • Default value skipResources: boolean = false

    Returns void

description

getDefaultDurability

  • getDefaultDurability(): number

getDurabilityMessage

  • Parameters

    Returns Message

getGrowingMessage

getGrowingStage

getInspect

getTile

isEmbers

  • isEmbers(): boolean
  • Returns boolean

isGatherable

  • isGatherable(): boolean

isReadyToGather

  • isReadyToGather(): boolean

isValid

  • isValid(): boolean
  • Returns boolean

onUnserialized

  • onUnserialized(): void

setGrowingStage

  • setGrowingStage(stage: GrowingStage, updateTile?: boolean): void

setOffTrap

  • setOffTrap(player?: IPlayer, withMessage?: boolean): void
  • Parameters

    • Optional player: IPlayer
    • Optional withMessage: boolean

    Returns void

update

  • update(): void
  • Returns void

Generated using TypeDoc