Skip to main content

65 docs tagged with "utility"

View all tags

Appraisable

Provides callback hooks for entities to validate and perform appraisal actions on targets.

Armor Bramble

A wearable armor item that triggers thorn-based retaliation effects when the wearer is blocked or attacks, conditional on skill tree activation.

Attuner

Manages attunement relationships between a player and attunable entities.

Battery

Manages whether an entity can be used as a power source and tracks usage callbacks for gameplay interactions.

Bernie Common

Provides utility functions for evaluating Willow's sanity state and enemy proximity for Bernie AI behavior.

Blinkfocus Marker

A temporary, non-persistent marker entity used to visualize the maximum range of a blink-based ability (e.g., Wigfrid's Battle Truce).

Bottler

Provides a mechanism to bottle certain entities, invoking a customizable callback when the action succeeds.

Camerashake

Calculates camera offset vectors for vibration effects over time.

Chathistory

Manages client-side chat message storage, filtering, and network synchronization.

Class

Provides an object-oriented class system with inheritance, property setters, and instance tracking for Lua in DST.

Closeinspector

Adds a tag to an entity and provides hooks for custom inspect target and inspect point validation logic, typically used to restrict or customize inspector interactions.

Componentutil

Provides utility functions for entity state checking, tile change handling, bridge deployment, rose residue management, luck-based probability calculations, corpse conversion, impact sound selection, topology parsing, inventory tracking, and world migration logic.

Config

Manages global platform-specific configuration options and runtime settings.

Cooking

Provides cooking recipe registration, ingredient value tracking, and recipe calculation utilities for all cooker entities.

Datagrid

Provides a 2D grid data structure backed by a 1D table for efficient spatial data storage.

Debughelpers

Provides utility functions for logging entity and component state information to the console.

Debugtools

Provides utility functions for debugging, including callstack inspection, table dumping, conditional logging, and entity-based debug visualization.

Distancetracker

Tracks the distance an entity travels between update frames by recording its position and computing Euclidean displacement.

Dumper

Serializes Lua values (including tables and functions) into human-readable Lua source code strings for debugging or save/restore operations.

Easing

Provides a collection of mathematical easing functions for interpolating values over time, used for smooth animations and transitions.

Erasablepaper

Manages the conversion of a paper item into a configurable number of erasure产物 (e.g., papyrus), handling stack splitting and item distribution.

Farmtiller

Provides functionality to till soil at a given point in the world.

Fishingnetvisualizer

A visual proxy entity that displays a boat net animation and shadow, used to visually represent fishing nets placed by players or entities.

Fuelmaster

Manages fuel-burning multiplier bonuses for entities that consume fuel, such as fire sources or lanterns.

Ghostlyelixir

Handles the application of ghostly elixir effects to a target entity, consuming the item upon successful application.

Halloweenpotion Common

Provides utility functions for spawning and attaching Halloween-themed particle effects (firepuffs) to targets.

Healer

Applies healing to a target entity and consumes the healer item upon use.

Inspect

Provides a human-readable string representation of Lua tables, including support for recursive tables and metatables.

Junk pile common

Provides shared loot generation and dependency tracking logic for junk pile entities in DST.

Knownerrors

Centralized error definition and assertion helper for configuration and world-related failures in Don't Starve Together.

Lighter

Enables an entity to ignite burnable targets by calling Ignite on their burnable component.

Lunarsupernovaburning

Applies and manages damage and visual effects for the Alter Guardian's lunar supernova ability during Phase 4.

Magiciantool

Manages the usage lifecycle of magical tools by tracking user context and invoking custom callbacks when tools are started or stopped being used.

Math2D

A utility module providing optimized 2D geometric intersection and distance calculations for hitbox detection and collision queries.

Mathutil

A collection of mathematical utility functions for calculations including interpolation, rounding, angle normalization, distance computation, and line generation.

Messagebottletreasures

Provides utility functions to generate and manage treasure items in message bottle containers based on weighted templates and loot presets.

Prefabutil

Helper utilities for constructingplacer prefabs and deployable item prefabs in DST.

Random Damage

Applies a random reduction to an entity's health, uses, condition, armor, or fuel based on available components.

Reskin Tool

Defines the Reskin Tool item prefab that allows players to change the skin of valid entities.

Retrofit Archiveteleporter

A utility prefab used to generate and link a pair of teleporter wormholes in the Blue Forest region or at a specified location, replacing an existing marker entity.

Retrofit Fumaroleteleporter

Spawns a pair of linked wormholes to retrofit fumarole teleporter functionality in the game world, primarily for connecting cave zones via Tier4 tasks.

Saddlehorn

A consumable tool that removes saddles from beefalo and other animals, with limited durability and weapon functionality.

Simutil

Provides utility functions for world and entity queries, vision checks, camera effects, and world event management.

Skilltree Defs

Provides the data structure and validation logic for character-specific skill trees, including connection rules, locks, and helper utilities for modders.

SourceModifierList

A utility class that manages and calculates modifiers applied by multiple external sources with optional key-based tracking.

Spdamageutil

A singleton utility for managing and calculating special damage types and their interaction with special defenses across entities.

Spider Whistle

A consumable item that summons spiders from dens and wakes up sleeping spiders within range, while granting temporary buffs to nearby spider followers.

Stack

A utility class implementing a generic LIFO stack data structure for storing and retrieving ordered values.

Stringutil

Provides utilities for retrieving, formatting, and processing localized string content, including character-specific speech generation and string helpers.

Teleportedoverride

Stores custom destination functions for teleportation overrides on an entity.

Toggleableitem

Manages the toggle state (on/off) of an item and executes a user-defined callback when toggled.

Treegrowthsolution

Applies growth progression to a target tree entity, consuming the solution item after use.

Util

Central utility library providing table/string/math helpers, debugging tools, memory management, path resolution, PRNG, teleportation validation, and ECS extension functions for DST modding.

Vec3Util

Provides utility functions for 3D vector mathematics, including arithmetic, distance, and normalization operations.

Vector3

A lightweight 3D vector math utility for geometric calculations, distance, normalization, and vector operations in DST.

Vecutil

Provides utility functions for 2D vector mathematics used throughout the game codebase.

Wagboss Util

Utility module for managing lunar arena mechanics including fissures, lunar burn damage, and supernova line-of-sight blocking.

Walkingplankuser

Manages a player's or entity's current mounting state on a walking plank.

Waterproofer

Prevents an entity's inventory item from accumulating moisture and adds the `waterproofer` tag.

Waterpump

A functional entity that channels water in a circular area, launching water projectiles when used; breaks upon being hammered and extinguishes flames.

Waxable

Manages waxing interactions for an entity, including tag state and callback-based waxing logic.

Wendy Resurrectiongrave

Manages a special resurrection altar for Wendy that allows linking to a player and consuming health to enable resurrection of fallen allies.

Willow Ember Common

Provides shared utility functions for handling willow embers, including detection, spawning, and target selection logic.

Worker

Tracks which actions an entity can perform and their relative effectiveness.

Wortox Soul Common

Provides shared utility functions for Wortox's soul-based mechanics, including healing nearby players, spawning souls on death, and determining valid soul sources.