Skip to main content

Icebox Porcelain Fx

Based on game build 714014 | Last updated: 2026-03-05

Overview​

icebox_porcelain_fx is a lightweight, non-persistent prefab used to render a transient visual effect, typically for porcelain item interactions (e.g., breaking porcelain in the Icebox). It uses animation states (pre, loop, pst) to control playback, starts with a pre-animation, transitions to a loop, and is scheduled for automatic removal after completion. The prefab is client-safe and only actively managed on the master simulation.

Usage example​

This prefab is instantiated internally by the game during specific interactions and is not typically added directly by modders. As a reference, here is how the underlying logic would be invoked if manually created:

local inst = SpawnPrefab("icebox_porcelain_fx")
inst.Transform:SetPosition(x, y, z)
inst.Kill() -- triggers immediate termination with post-animation

Dependencies & tags​

Components used: None identified
Tags: Adds FX via inst:AddTag("FX")

Properties​

PropertyTypeDefault ValueDescription
_killtaskTask or nilnilStores the scheduled task for entity removal.

Main functions​

Kill(inst)​

  • Description: Schedules the entity for removal. If no kill task exists, calculates remaining animation time to align removal with animation completion and schedules OnKillTask. If already scheduled, does nothing.
  • Parameters: inst (Entity) — the instance to destroy.
  • Returns: Nothing.
  • Error states: If called before animation starts, GetCurrentAnimationLength() may be 0, leading to immediate or incorrect timing.

OnKillTask(inst)​

  • Description: Internal helper that plays the post-animation (pst) and schedules entity removal after animation duration + padding (2 * FRAMES).
  • Parameters: inst (Entity) — the instance being destroyed.
  • Returns: Nothing.
  • Error states: None documented; assumes valid AnimState state.

Events & listeners​

None identified

Assets​

The prefab references the following assets:

  • anim/ice_box.zip (static bank)
  • anim/dynamic/icebox_porcelain.zip (dynamic animation)
  • anim/dynamic/icebox_porcelain.dyn (dynamic animation data)