Class default

Hierarchy

Implements

Constructors

constructor

Properties

_description? aberrant? bonusAttack? builderIdentifier? containedItems? crafterIdentifier? decay? disassembly? event gatherReady? growth? hasWater? hitchedCreature? id islandId itemOrders? magic? maxDur meltDecay? minDur orientation? preventRendering? quality? referenceId? renamed? spread? startingDecay? step? stillContainer? tradedFrom? type weight? x y z registrarId

Accessors

asContainer asCorpse asCreature asDoodad asEntity asEntityMovable asEntityWithStats asHuman asItem asLocalPlayer asNPC asPlayer asTileEvent constructorFunction description durability durabilityMax entityType island point reference tile tileUpdateType tilesAround

Methods

addReferenceId addTag addTreasureChestLoot animateSkeletalRemains attachStillContainer blocksMove canCauseStatus canGather canGrow canHarvest canInspect canPickUp canTrample changeCivilizationScore changeType checkForTrampling clearTileCache damage detachStillContainer dryDockBoat getActions getAssociatedItem getBookcaseFullness getBuilder getCivilizationScore getCrafter getCrafterOrLocalPlayer getDamage getData getDefaultDurability getDescription getDisplayDoodad getGrowthParticles getInspectionId getInsulation getItemUseBonus getLiquidGatherType getMagicalDoodadSkills getMeltRate getName getPickUpTypes getProducedTemperature getRegistrarId getTargetContainer getTileId getTrapDamageBonus getVehicle getcontainedItemSkillBonuses hasData hasTag healOrHarmPlant humansVisible increaseFertility isDangerous isEmbers isGatherable isInGroup isIslandPort isLitAndCanRevert isNearby isOnFire isTall isValid isVehicle isWithinHumanBounds notifyItem notifyStat onUnserialized queueSoundEffect refillSolarStill removeData removeTag revert setCachedTile setData setGrowingStage setHumansWithinBound setMeltingDecay setName setOffTrap setWellStatus switchWellStatus toString unhitch update updateBookcase updateGroupCache updateRender updateTile updateView getRegistrarId is setRegistrarId

Constructors

constructor

Properties

Protected Optional _description

_description?: IDoodadDescription

Optional aberrant

aberrant?: boolean

Optional bonusAttack

bonusAttack?: number

Optional builderIdentifier

builderIdentifier?: string

Optional containedItems

containedItems?: default[]

Optional crafterIdentifier

crafterIdentifier?: string

Optional decay

decay?: number

Optional disassembly

disassembly?: default[]

Readonly event

event: IEventEmitter<default, IDoodadEvents>

Optional gatherReady

gatherReady?: number

Optional growth

growth?: GrowingStage

Optional hasWater

hasWater?: IHasWater

Optional hitchedCreature

hitchedCreature?: number

id

id: number

islandId

islandId: `${number},${number}`

Optional itemOrders

itemOrders?: number[]

Optional magic

magic?: default

maxDur

maxDur: number

Optional meltDecay

meltDecay?: number

minDur

minDur: number

Optional orientation

orientation?: East | North | West | South | DoorOrientation

Optional preventRendering

preventRendering?: boolean

Optional quality

quality?: Quality

Optional referenceId

referenceId?: number

Do not use this property directly, instead use `game.references.getReference()

Optional renamed

renamed?: string | ISerializedTranslation

Optional spread

spread?: number

Optional startingDecay

startingDecay?: number

Optional step

step?: number

Optional stillContainer

stillContainer?: default

Optional tradedFrom

tradedFrom?: string[]

type

type: DoodadType

Optional weight

weight?: number

x

x: number

y

y: number

z

z: WorldZ

Static Protected registrarId

registrarId: number

Accessors

asContainer

  • get asContainer(): undefined | this & IContainer

  • Returns undefined | this & IContainer

asCorpse

  • get asCorpse(): undefined

  • Returns undefined

asCreature

  • get asCreature(): undefined

  • Returns undefined

asDoodad

  • get asDoodad(): undefined | default

  • Returns undefined | default

asEntity

  • get asEntity(): default<DescriptionType, TypeType, TagType, unknown>

  • Returns default<DescriptionType, TypeType, TagType, unknown>

asEntityMovable

  • get asEntityMovable(): undefined | default<DescriptionType, TypeType, TagType, unknown>

  • Returns undefined | default<DescriptionType, TypeType, TagType, unknown>

asEntityWithStats

  • get asEntityWithStats(): undefined | default<DescriptionType, TypeType, TagType>

  • Returns undefined | default<DescriptionType, TypeType, TagType>

asHuman

  • get asHuman(): undefined

  • Returns undefined

asItem

  • get asItem(): undefined

  • Returns undefined

asLocalPlayer

  • get asLocalPlayer(): undefined

  • Returns undefined

asNPC

  • get asNPC(): undefined

  • Returns undefined

asPlayer

  • get asPlayer(): undefined

  • Returns undefined

asTileEvent

  • get asTileEvent(): undefined

  • Returns undefined

constructorFunction

  • get constructorFunction(): typeof default

  • Returns typeof default

description

  • get description(): undefined | DescriptionType

  • Get the entities description

    Returns undefined | DescriptionType

durability

  • get durability(): number

  • Returns number

  • set durability(value: number): void

  • Parameters

    • value: number

    Returns void

durabilityMax

  • get durabilityMax(): number

  • Returns number

  • set durabilityMax(value: number): void

  • Parameters

    • value: number

    Returns void

entityType

  • get entityType(): Doodad

  • Returns Doodad

island

  • get island(): default

  • Returns default

point

  • get point(): IVector3

  • Location of the entity on the world. Parent classes will probably mark this as always defined

    Returns IVector3

reference

  • get reference(): undefined | Reference

  • Returns undefined | Reference

tile

  • get tile(): default

  • Tile the entity is on in the world. Parent classes will probably mark this as always defined

    Returns default

tileUpdateType

tilesAround

  • get tilesAround(): undefined | default[]

  • Returns undefined | default[]

Methods

addReferenceId

  • Adds a referenceId to the entity if it doesn't already have one

    Returns void

addTag

addTreasureChestLoot

  • Returns void

animateSkeletalRemains

  • Potentially animates a skeleton (if it can spawn) and returns a message to all those who can see it.

    Returns void

attachStillContainer

  • Parameters

    Returns void

blocksMove

  • Returns boolean

canCauseStatus

  • Returns boolean

canGather

  • Can the doodad be gathered from in its current form?

    Returns boolean

canGrow

  • Returns boolean

canHarvest

  • Returns boolean

canInspect

  • Parameters

    Returns boolean

canPickUp

  • Parameters

    Returns boolean

canTrample

  • Returns whether the doodad can be trampled

    Returns undefined | boolean

changeCivilizationScore

  • Gives civilization score based on how much is defined for this doodad.

    Parameters

    • add: boolean

    Returns void

changeType

  • Parameters

    Returns void

checkForTrampling

  • Trampling growing things.

    Parameters

    Returns boolean

clearTileCache

  • Returns void

damage

  • Parameters

    • forceBreak: boolean = false
    • skipDropAsItem: boolean = false
    • skipSound: boolean = false
    • skipResources: boolean = false

    Returns void

detachStillContainer

  • Parameters

    Returns undefined | default

dryDockBoat

  • Forces a boat to be drydocked (revert from doodad to an item if water was taken away for some reason).

    Parameters

    Returns void

getActions

  • Returns undefined | ActionType[]

getAssociatedItem

getBookcaseFullness

  • Determines which graphic to show based on how full the bookcase is with books/text.

    Returns

    DoodadTypeExtra or DisplayableItemType equal to which graphic it should show.

    Parameters

    • Optional item: boolean

      set to true if DisplayableItemType is to be returned.

    Returns undefined | DoodadTypeExtra | DisplayableItemType

getBuilder

  • Gets the builder of this doodad, or undefined if the doodad is builderless.

    Returns undefined | default

getCivilizationScore

  • Gets civilization score based on doodad's quality and type, but without the magical property values.

    Returns

    number of score (or 0 if no civilization score is set).

    Parameters

    • Optional excludeMagic: boolean

    Returns number

getCrafter

  • Gets the crafter of this doodad, or undefined if the doodad is crafterless.

    Returns undefined | default

getCrafterOrLocalPlayer

  • Gets the crafter of this doodad. If this doodad has no crafter, and this is not a multiplayer server, returns the local player.

    Returns undefined | default

getDamage

  • Parameters

    Returns number

getData

  • Gets a data

    Returns

    Data value or undefined if it wasn't found

    Type Parameters

    • T

    Parameters

    • key: string

      Data key

    Returns undefined | T

getDefaultDurability

Protected getDescription

getDisplayDoodad

  • Gets if the doodad is set to display any extra graphics/assets.

    Returns

    DisplayableDoodadType or DoodadType (if no extra is set)

    Returns DisplayableDoodadType

getGrowthParticles

  • Returns undefined | IRGB

getInspectionId

  • Returns string

getInsulation

  • Gets the insulation of this object.

    Insulation is a decimal number from 0 to 1.

    • An insulation of 0 means that the temperature inside this object is equivalent to the temperature outside.
    • An insulation of 1 means that no temperature inside this object is emitted to the outside tiles — it is a completely separate temperature "biome".
    • Values in between change how much of the temperatures are produced/used on either side.

    Parameters

    Returns undefined | number

getItemUseBonus

  • Gets the doodad's quality and action level (how good it is at doing the action) based on the item it is based off of (using repairItem property).

    Returns

    A number (possibly 0 if no quality or action level).

    Parameters

    • action: ActionType

      The ActionType you are trying to get the level for.

    Returns number

getLiquidGatherType

  • Returns the type of liquid that can be gathered from this doodad

    Returns undefined | keyof ILiquidGather

getMagicalDoodadSkills

  • Gets a set of skill types and values for magical adjacent skill bonuses from doodads.

    Returns

    Map of skill type and number (skill value).

    Returns Map<SkillType, number>

getMeltRate

  • Gets the decay rate of a doodad based on the temperature (returns as a default of 0).

    Returns

    The number of melt reduction of the doodad given the temperature of the point.

    Parameters

    Returns number

getName

  • Parameters

    • Optional article: Article

      Whether to include an article for the name of the doodad. Uses the article rules on the language.. @param count The number of this doodad that you're getting the name of. Defaults to 1`.

      Examples:

      • doodad.getName() // "a stone furnace"
      • doodad.getName(Article.None) // "stone furnace"
      • doodad.getName(Article.None, 3) // "stone furnaces"
    • Optional count: number

    Returns default

getPickUpTypes

  • Returns undefined | ItemType[]

getProducedTemperature

  • Gets the temperature produced by this object. Positive values are "heat", negative values are "cold". Refer to the values of the Temperature enum to see the possible range. If this method is not implemented, or it returns undefined, Temperature.Neutral is used.

    Returns undefined | number

getRegistrarId

  • Returns number

getTargetContainer

  • Gets the container to use for doodad executed actions

    Returns undefined | IContainer

getTileId

  • Returns number

getTrapDamageBonus

  • Return extra trap damage based on player multiplier and magical status

    Parameters

    • baseDamage: number
    • Optional human: default<number>

    Returns number

getVehicle

getcontainedItemSkillBonuses

  • Gets a set of skill types and values from doodads that have "containedItemGroupProvidesSkill" set for items that provide adjacent skill bonuses.

    Returns

    Map of skill type and number (skill value).

    Returns Map<SkillType, number>

hasData

  • Check if a data was set

    Returns

    True if the data exists, false if it doesn't

    Parameters

    • key: string

      Data key

    Returns boolean

hasTag

healOrHarmPlant

  • Increases or decreases plant fertility, growth and durability (health) based on the liquid applied.

    Parameters

    • liquid: LiquidType

      The LiquidType that is to be applied.

    • Optional growthBonus: number

      The bonus that is applied (on top of a default of 10) to the plants decay (so it grows faster).

    Returns void

humansVisible

increaseFertility

  • Increased the fertility (spread) of a plant/growing doodad.

    Returns

    True or false depending on if it increased in fertility or not.

    Parameters

    • Optional bypassChange: boolean

      Set to true if you just want to check if fertility can be increased.

    Returns boolean

isDangerous

  • Parameters

    Returns boolean

isEmbers

  • Returns boolean

isGatherable

  • Can the doodad be gathered from at all?

    Returns boolean

isInGroup

  • Parameters

    Returns boolean

isIslandPort

  • Returns boolean

isLitAndCanRevert

  • Returns boolean

isNearby

isOnFire

isTall

  • Checks if the doodad will be rendered as tall (2 tiles)

    Returns

    True if the doodad is tall

    Returns boolean

isValid

  • Returns boolean

isVehicle

  • Returns boolean

isWithinHumanBounds

  • Checks if the entity is within the viewport bounds of one or more humans

    Returns boolean

notifyItem

notifyStat

onUnserialized

queueSoundEffect

  • Parameters

    • type: SfxType
    • Optional delay: number
    • Optional speed: number

    Returns void

refillSolarStill

  • Refills solar stills when they are on shallow water automatically.

    Returns void

removeData

  • Removes a data

    Returns

    True when the data is removed. False if the key wasn't set

    Parameters

    • key: string

      Data key

    Returns boolean

removeTag

revert

  • Reverts lit doodads if they provide fire and have a revert doodad type set.

    Returns boolean

Protected setCachedTile

setData

  • Sets a data

    Rturns

    The value

    Type Parameters

    • T

    Parameters

    • key: string

      Data key

    • value: T

      Data value

    Returns T

setGrowingStage

  • Parameters

    Returns void

setHumansWithinBound

setMeltingDecay

  • Initialized the doodad's melting decay number

    Returns void

setName

setOffTrap

  • Parameters

    • Optional human: default<number>
    • Optional withMessage: boolean
    • Optional damage: boolean

    Returns void

setWellStatus

  • Keep our wells up-to-date with what is happening underground

    Parameters

    Returns IWell

switchWellStatus

  • Switch unlimited/limited water status based on underground water changes

    Returns void

toString

  • Returns string

unhitch

  • Returns void

update

  • Parameters

    • ticks: number
    • playingHumans: default<number>[]
    • playerHumanTiles: Set<default>
    • updatesPerTick: number = 1

    Returns void

updateBookcase

  • Updates a bookcase's graphics and civilization score (based on if books are added).

    Parameters

    • items: default[]
    • add: boolean

      True if adding score, false if you are substracting.

    Returns void

updateGroupCache

  • Parameters

    Returns boolean

updateRender

updateTile

  • Parameters

    Returns void

updateView

Static getRegistrarId

  • Returns number

Static is

  • Parameters

    • value: any

    Returns value is default

Static setRegistrarId

  • Parameters

    • id: number

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc