Skip to main content

74 docs tagged with "interaction"

View all tags

Animbutton

A specialized button widget that displays an animated visual instead of static text, typically used for interactive UI elements with dynamic feedback.

Appraisable

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

Balatro Machine

Hosts the Balatro mini-game session, manages card gameplay state, joker selection, and reward distribution for player interaction.

Bathbombable

Manages whether an entity can be transformed by bath bombs, tracking its bath-bombable state and providing a callback hook for bath-bomb activation.

Bedazzler

Determines whether a target entity can be bedazzled and performs the bedazzlement action, consuming uses if applicable.

Birdcage

Manages the behavior of a birdcage that houses birds, handles feeding, interaction, sleeping cycles, and loot generation based on bird state and food type.

Boat Magnet Beacon

Manages the beacon that pairs with a boat magnet to control magnet movement when placed on a boat.

Boatrace Start

Acts as the starting beacon for the Year of the Dragon boat race event, managing race initialization, checkpoint coordination, beacon tracking, and prize distribution.

Book

Manages interactive reading and perusing behavior for books, including sanity effects, use consumption, and optional visual FX.

Bottler

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

Brushable

Manages brushable interactions for an entity, calculating prizes awarded based on time elapsed since last brushing and handling brush events.

Carnivalgamefeedable

Manages whether an entity can be fed during carnival minigames by toggling the `carnivalgame_canfeed` tag and providing a callback hook for feeding logic.

Catcher

Manages the ability to catch thrown projectiles based on proximity and state.

Cattoy

Manages a callback-based interaction handler for cat toy items in DST, invoked when an entity plays with the item.

Channelcastable

Manages the state and callbacks for an item being channel-cast by a user, including tracking the active user and handling startup/shutdown logic.

Chest Explosion

Sets up a chest prefab to explode upon interaction, dropping a predefined set of loot items and registering a trap trigger function.

Container

Manages item storage and interactions for entities, providing slot-based inventory logic, opening/closing behavior, and item transfer operations.

Cooker

Validates and executes cooking operations for items placed on a cooking entity, ensuring required conditions are met and handling side effects like sound playback and event callbacks.

Craftslot

Renders a single slot in the crafting interface, handling recipe display, locking states, and user interaction for crafting or purchasing items.

Farmplanttendable

Controls whether a farm plant entity can be tended to, managing the `tendable_farmplant` tag and tend completion logic.

Fertilizable

Provides a callback hook for handling fertilizer application on an entity.

Fertilizer

Stores nutrient data and handles application logic for fertilizer items, including usage consumption and cleanup upon depletion.

Fillable

Manages the logic for transforming an empty container or vessel into a filled version when interacting with a water source.

Fishingnetvisualizer

Manages visual behavior and logic for a fishing net entity during casting, opening, retrieving, and final pickup phases.

Gravediggable

Marks an entity as diggable by grave-digging actions and provides a hook for custom dig behavior.

Gravedigger

A callback-triggering component invoked when a gravesite is used, commonly attached to grave-related prefabs.

Groomer

Manages clothing and grooming interactions for dressable entities, handling entering/exiting the grooming state, skin changes, and shared/single-user access.

Heavyobstacleusetarget

Controls whether an entity can interact with heavy obstacles and updates the `can_use_heavy` tag accordingly.

Hitchable

Manages the hitched state of an entity, allowing it to be attached to or detached from another entity via a hitching mechanic.

Icefishing Hole

Creates a stationary environmental hazard that repels players and triggers knockback upon proximity.

Inspectaclesscreen

Manages the UI screen for the Inspectacles minigame, handling input, animation flows, and solution reporting.

Inspectacleswidget

Renders and manages a family of interactive puzzle minigames (Wires, Gears, Tape) in the Inspectacles interface, handling grid layout, button interactions, rotation/toggling mechanics, and state synchronization with the game logic.

Inventoryitemholder

Holds a single item for indirect interaction, allowing other entities to take or stack items under controlled conditions.

Key

Manages the type of key associated with an entity and provides callbacks for lock interactions.

Kitcoonfood

A UI widget representing a clickable food bag for the Kitcoon pet, which initiates feeding actions when interacted with.

Kitcoonpoop

A UI widget representing a single piece of poop in the Kitcoon Poop minigame that responds to user interaction and animates upon interaction.

Klaussacklock

Manages keyed interaction logic for Klaus sack locks, allowing or denying access based on a callback function and key consumption behavior.

Machine

Manages machine state including power (on/off), cooldowns, and interaction permissions.

Mapspotrevealer

Adds functionality to an entity to reveal map areas at specified locations, supporting pre-reveal hooks and conditional map opening.

Mightydumbbell

Manages workout and attack interactions for strongman characters, dynamically adjusting mightiness gain rates and consumption based on current mightiness state.

Minigametile

A UI widget representing a tile in a minigame, handling visual state, number display, highlighting, and user interaction via clicks and focus.

Moonaltarlink

Manages bidirectional linking between an entity and a set of moon altar targets, updating positions and triggering callbacks on connection or disconnection.

Moontrader

Manages acceptance and processing of offerings for moon-based trading interactions, typically used by entities like Moon Moths or Moon Altars.

Papereraser

Enables an entity to erase erasable paper items, converting them into their erased form via the ErasablePaper component.

Pumpkincarvingscreen

A UI screen for interactively carving pumpkins by placing carved shapes and fills on a target entity.

Pumpkinhatcarvable

Manages the carving interaction and face customization logic for pumpkin-based wearable items, including validation, state transitions, and tool requirements.

Pushable

Enables an entity to be pushed by another entity and maintains relative positioning during the push.

Quagmire Soil

Represents a soil tile prefab used in the Quagmire biome that supports the Plant Soil action and integrates with the mouse interaction system.

Recipescanner

Enables scanning of entities to automatically unlock associated recipes for a builder.

Roseinspectableuser

Manages the Rose Glasses' inspection logic, including cooldown tracking, residue spawning, and interaction with roseinspectable targets.

Saltlicker

Manages the salt-licking behavior for entities, including detecting nearby saltlicks, applying timed salted states, and consuming uses from the saltlick.

Searchable

Provides search interaction logic for entities, including tagging, search callbacks, and removal behavior.

Sgsalty Dog

Manages the state machine and behavior of the Salty Dog character, including movement, summoning, desummoning, interactions, and salt-shaking animations.

Sgwaveyjoneshand

Manages state transitions and animation control for Wavey Jones' mechanical hand entity, coordinating locomotion, actions, and trap responses.

Shaveable

Manages the ability for an entity to be shaved, producing configurable loot items upon successful shaving.

Shelf

Manages items stored on a shelf entity, including item placement, retrieval, and accessibility state.

Simplebook

Provides a read interaction for simple books, triggering a custom callback when read by an entity.

Singable

Provides a sing interaction that triggers a song effect on a singer with the SingingInspiration component.

Sittable

Manages entity seating state and occupier tracking for interactive furniture-like objects.

Speech Wortox

Manages speech-related logic for the Wortox character, including speech activation and interaction triggers.

Steeringwheel

Manages the logic and state for a steering wheel entity that allows sailors to control boat movement.

Tackler

Handles collision detection and interaction logic for entities that can tackle or trample other entities and work on workable targets.

Teacher

Teaches a specific recipe to a target entity by interacting with the Builder component.

Thief

Enables an entity to steal items from other entities' inventories or containers.

Useabletargeteditem

Manages the targeted use behavior and tags for items that can be actively used on specific targets.

Walkingplank

Manages the state and lifecycle of a walking plank, including mounting, dismounting, extending, and retracting behaviors.

Waxable

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

Workable

Manages the work state and completion logic for interactable entities in the game world.

Writeable

Manages the ability for entities to hold and display custom text written by players.

Writeable Replica

Manages client-side networked writing interactions for writeable entities by coordinating with the server-hosted writeable component and classified data.

Writeables

Manages named sign and gravestone UI layouts for in-game writing interfaces, including prompt text, animation banks, and button configurations.

Yotb Sewingmachine

Provides a structure-based crafting interface for beefalo sewing recipes, managing sewing state, animations, sound, and interaction callbacks.

Yotb Stage

Manages the stage booth structure, handling placement, interaction (hammering, hitting), voice playback, and cleanup with event notifications and loot drops.

Yotc Carrat Race Checkpoint

Manages the behavior and visual state of a checkpoint used in the Carrat Race minigame, including light toggling, racer detection, and interaction callbacks.