Optional entityOptions: IEntityConstructorOptions<DoodadType>Protected Optional _descriptionOptional aberrantOptional addOptional allowUsed for smart vehicle movement (minecarts) Note: This is clientside only.
Optional animOptional attackUsed for attack animations. Note: This is clientside only.
Optional bonusOptional builderOptional connectedOptional containedOptional crafterOptional decayOptional directionundefined = Vector2.ZERO for this
Optional disassemblyOptional equippedOptional facingundefined = Direction.None for this
Optional fromXNote: This might not be a whole number.
Optional fromYNote: This might not be a whole number.
Optional gatherOptional growthOptional hasOptional historicalOptional hitchedOptional isNot guaranteed to be synced between the server and client for Human entities
Optional magicOptional meltOptional moveOptional movementOnly used for Human entities
Readonly movingUsed for movement animations. Note: This is clientside only.
Optional orientationNotifier marker assigned to this entity
Optional preventOptional protectedUsed to store protection status for built doodads
Optional qualityOptional referenceDo not use this property directly, instead use `game.references.getReference()
Optional renamedOptional shouldProtected Optional shouldProtected Optional slippingOptional sortOptional sortOptional spreadOptional stacksOptional startingOptional stepOptional stillOptional tradedOptional weightStatic Protected registrarundefined if this entity's island is not loaded, this if it is
Get the entities description
Whether this entity's island is loaded
Checks if the entity is within the viewport bounds of one or more humans
Optional fieldOfView: FieldOfViewOptional customRadius: numberOptional customRadius: numberOptional fieldOfView: FieldOfViewOptional customRadius: numberDetermines which graphic to show based on how full the bookcase is with books/text.
DoodadTypeExtra or DisplayableItemType equal to which graphic it should show.
Optional item: booleanset to true if DisplayableItemType is to be returned.
Protected getCalled when filling out the entities description for the first time
Gets if the doodad is set to display any extra graphics/assets.
DisplayableDoodadType or DoodadType (if no extra is set)
Gets the insulation of this object.
Insulation is a decimal number from 0 to 1.
0 means that the temperature inside this object is equivalent to the temperature outside.1 means that no temperature inside this object is emitted to the outside tiles — it is a completely
separate temperature "biome".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).
A number (possibly 0 if no quality or action level).
The ActionType you are trying to get the level for.
Returns the type of liquid that can be gathered from this doodad
Gets the decay rate of a doodad based on the temperature (returns as a default of 0).
The number of melt reduction of the doodad given the temperature of the point.
Optional article: ArticleWhether 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: numberGets 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.
Gets the container to use for doodad executed actions
Optional getOptional getOptional getOptional getOptional getIncreases or decreases plant fertility, growth and durability (health) based on the liquid applied.
The LiquidType that is to be applied.
Optional growthBonus: numberThe bonus that is applied (on top of a default of 10) to the plants decay (so it grows faster).
Increased the fertility (spread) of a plant/growing doodad.
True or false depending on if it increased in fertility or not.
Optional bypassChange: booleanSet to true if you just want to check if fertility can be increased.
Move the entity to the tile
Optional options: IMoveToOptionsProtected onProtected setProtected setProtected setOptional toZ: numberOptional options: IMoveToOptionsThis is the correct way to change quality, but it is not completely implemented. It does not perform any required changes due to the quality change, like durability, all it does is change the quality and emit an event.
Start slipping the entity
Faces in the direction
Faces the target tile
Start slipping if the tile is slippable. Stops slipping if above the max slip count or if the tile is not slippable.
Protected updateUpdates the world renderer & flow field state for the tile
Optional updateNeighbors: booleanOptional skipFlowFieldUpdate: booleanStatic getStatic isStatic setGenerated using TypeDoc
Entity class that allows movement