Skip to main content

71 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

Provides a callback-based interface for entities that can be consumed or drained by other systems.

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.

Braincommon

Provides shared utility functions and behavior tree nodes for AI brain construction.

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.

Clockwork Common

Utility module providing shared helper functions for clockwork entity behavior including sleep cycles, combat targeting, befriending, health regeneration, and trader interactions.

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

A comprehensive utility module providing helper functions for entity state validation, tile transition handling, bridge deployment, combat effects, lightning mechanics, luck calculations, and mutation logic across multiple game systems.

Config

Manages global platform-specific configuration options and runtime settings.

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.

Efficientuser

Manages action efficiency multipliers for an entity, tracking modifiers per action type.

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.

Player Common Extensions

A utility module providing shared helper functions for player entity lifecycle management, including death, resurrection, locomotion configuration, and network synchronization.

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

A global utility module providing helper functions for entity searching, vision checks, spawning logic, and asset atlas management.

Skinsutils

A utility module providing helper functions and data tables for skin rarity, inventory management, pack operations, and item categorization in Don't Starve Together.

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.

Storage Robot Common

Utility module providing helper functions for Storage Robot entity logic, including spawn point management and item collection routines.

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

A comprehensive utility module providing helper functions for table manipulation, string operations, math calculations, spawning, file resolution, memory tracking, and specialized classes like RingBuffer and LinkedList.

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

Utility module providing helper functions for Willow's ember mechanics and fire burst targeting.

Wobycommon

Utility module providing shared functions, constants, and command definitions for Woby (Walter's pet) including command wheel setup, courier delivery logic, and transformation effects.

Worker

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

Wortox Soul Common

Utility module providing shared logic for Wortox soul harvesting, healing, and spawning mechanics.

WX78 Common

Utility module providing shared functions for WX-78 character systems including upgrade modules, dizzy effects, socket handling, and visual modifications.