Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Corpse

Hierarchy

Implements

Index

Constructors

constructor

  • new Corpse(type?: CreatureType, x?: number, y?: number, z?: number, decay?: undefined | number): Corpse
  • Parameters

    • Optional type: CreatureType
    • Default value x: number = 0
    • Default value y: number = 0
    • Default value z: number = 0
    • Optional decay: undefined | number

    Returns Corpse

Properties

Optional aberrant

aberrant: boolean | undefined

Optional decay

decay: number | undefined

id

id: number

objectType

objectType: Corpse

Optional qualityBonus

qualityBonus: number | undefined

Optional referenceId

referenceId: undefined | number

Optional renamed

renamed: string | ISerializedTranslation | undefined

Optional step

step: number | undefined

type

x

x: number

y

y: number

z

z: number

Methods

getName

  • getName(article?: undefined | false | true, count?: undefined | number): Translation
  • Parameters

    • Optional article: undefined | false | true

      Whether to include an article for the name of the creature. Uses the article rules on the language. Defaults to true.

    • Optional count: undefined | number

      The number of this creature that you're getting the name of. Defaults to 1.

      Examples:

      • corpse.getName() // "an acid spitter demon"
      • corpse.getName(false) // "acid spitter demon"
      • corpse.getName(undefined, 3) // "acid spitter demons"

    Returns Translation

getResources

  • getResources(clientSide?: undefined | false | true): ItemType[]
  • Parameters

    • Optional clientSide: undefined | false | true

    Returns ItemType[]

toString

  • toString(): string
  • Returns string

update

  • update(): void
  • Returns void

Static is

  • is(value: any): value is Corpse
  • Parameters

    • value: any

    Returns value is Corpse

Generated using TypeDoc