Retrofit Fumaroleteleporter
Based on game build 714014 | Last updated: 2026-03-06
Overview
retrofit_fumaroleteleporter is a helper prefab used during world initialization to retroactively establish teleporter links between fumarole locations in the Caves and the main surface world. It does not persist as an active entity in gameplay, but instead executes a one-time setup routine via its DoRetrofitting method — spawning two wormhole prefabs linked bidirectionally via the teleporter component. This is used to ensure legacy or procedurally placed terrain features can participate in DST’s teleporter system without requiring manual world editing.
Usage example
local inst = SpawnPrefab("retrofit_fumaroleteleporter")
inst.DoRetrofitting(inst, {x = 50, y = 0, z = -30}) -- Force spawn at world coordinates
-- or
inst.DoRetrofitting(inst) -- Auto-select a valid Tier4 task node
Dependencies & tags
Components used: None directly — but it spawns and configures wormhole prefabs (which use the teleporter component).
Tags: Adds CLASSIFIED, NOCLICK, NOBLOCK to itself only.
Properties
No public properties.
Main functions
DoRetrofitting(inst, force_pt)
- Description: Spawns two linked wormholes to retrofit teleporter access at or near the fumarole’s location. If
force_ptisnil, it searches for valid spawn points in cave areas tagged withKEYS.TIER4andKEYS.CAVEin the world topology. Ifforce_ptis provided, it places the wormhole at the exact coordinates. - Parameters:
inst(entity) — theretrofit_fumaroleteleporterinstance (implicitly theselfcontext).force_pt({x, y, z}ornil) — optional point table with numericx,y,zkeys for exact placement; ifnil, auto-generates placement.
- Returns:
trueif both wormholes were successfully spawned and linked;falseotherwise. - Error states: Returns
falseif no valid point is found, if spawningwormholefails, or if theforce_pttable is malformed (e.g., missingx,y, orzkeys).
Events & listeners
None.