Files
SmArtKar f58b8511f0 Refactors effect_system (#94999)
## About The Pull Request

This PR refactors ``effect_system``s to be a bit easier to use by
getting rid of ``set_up``, allowing ``attach()`` to be chained into
``start()`` and refactoring most direct system usages in our code to use
helper procs.

``set_up`` was unnecessary and only existed to allow ``New``'s behavior
to be fully overriden, which is not required if we split
sparks/lightning/steam into a new ``/datum/effect_system/basic`` subtype
which houses the effect spreading behavior. This allows us to roll all
logic from ``set_up`` into ``New`` and cut down on code complexity.
Chaining setup as ``system.attach(src).start()`` also helps a bit in
case no helper method exists

I've added ``do_chem_smoke`` and ``do_foam`` helpers, which respectively
allow chemical smoke or foam to be spawned easily without having to
manually create effect datums and reagent holders.

Also turns out we've had some nonfunctional effect systems which either
never set themselves up, or never started, so I fixed those while I was
at it (mostly by moving them to aforementioned helper procs)

## Why It's Good For The Game

Cleaner code, makes it significantly easier for users to work with. Also
most of our effect system usage was copypasta which was passing booleans
as numbers, while perfectly fine helper procs existed in our code.

## Changelog
🆑
refactor: Refactored sparks, foam, smoke, and other miscellaneous effect
systems.
refactor: Vapes now have consistent rigging with cigs using the new
system.
fix: Fixed some effects never working.
/🆑
2026-02-03 22:23:09 -05:00

170 lines
6.7 KiB
Plaintext

#define FOAM_INTERVAL 5 SECONDS
/mob/living/basic/bot/firebot
name = "\improper Firebot"
desc = "A little fire extinguishing bot. He looks rather anxious."
icon = 'icons/mob/silicon/aibots.dmi'
icon_state = "firebot1"
light_color = "#8cffc9"
light_power = 0.8
custom_materials = list(/datum/material/iron = SHEET_MATERIAL_AMOUNT * 0.9, /datum/material/glass = SMALL_MATERIAL_AMOUNT * 2)
req_one_access = list(ACCESS_ROBOTICS, ACCESS_CONSTRUCTION)
radio_key = /obj/item/encryptionkey/headset_eng
radio_channel = RADIO_CHANNEL_ENGINEERING
bot_type = FIRE_BOT
additional_access = /datum/id_trim/job/station_engineer
hackables = "fire safety protocols"
path_image_color = "#FFA500"
possessed_message = "You are a firebot! Protect the station from fires to the best of your ability!"
ai_controller = /datum/ai_controller/basic_controller/bot/firebot
///our inbuilt fire extinguisher
var/obj/item/extinguisher/internal_ext
///Flags firebots use to decide how they function.
var/firebot_mode_flags = FIREBOT_EXTINGUISH_PEOPLE | FIREBOT_EXTINGUISH_FLAMES
//Selections: FIREBOT_STATIONARY_MODE | FIREBOT_EXTINGUISH_PEOPLE | FIREBOT_EXTINGUISH_FLAMES
///cooldown before we release foam all over
COOLDOWN_DECLARE(foam_cooldown)
/mob/living/basic/bot/firebot/generate_speak_list()
var/static/list/idle_lines = list(
FIREBOT_VOICED_NO_FIRES = 'sound/mobs/non-humanoids/firebot/nofires.ogg',
FIREBOT_VOICED_ONLY_YOU = 'sound/mobs/non-humanoids/firebot/onlyyou.ogg',
FIREBOT_VOICED_TEMPERATURE_NOMINAL = 'sound/mobs/non-humanoids/firebot/tempnominal.ogg',
FIREBOT_VOICED_KEEP_COOL = 'sound/mobs/non-humanoids/firebot/keepitcool.ogg',
)
var/static/list/fire_detected_lines = list(
FIREBOT_VOICED_FIRE_DETECTED = 'sound/mobs/non-humanoids/firebot/detected.ogg',
FIREBOT_VOICED_STOP_DROP = 'sound/mobs/non-humanoids/firebot/stopdropnroll.ogg',
FIREBOT_VOICED_EXTINGUISHING = 'sound/mobs/non-humanoids/firebot/extinguishing.ogg',
)
var/static/list/emagged_lines = list(
FIREBOT_VOICED_CANDLE_TIP = 'sound/mobs/non-humanoids/firebot/candle_tip.ogg',
FIREBOT_VOICED_ELECTRIC_FIRE = 'sound/mobs/non-humanoids/firebot/electric_fire_tip.ogg',
FIREBOT_VOICED_FUEL_TIP = 'sound/mobs/non-humanoids/firebot/gasoline_tip.ogg'
)
ai_controller.set_blackboard_key(BB_FIREBOT_EMAGGED_LINES, emagged_lines)
ai_controller.set_blackboard_key(BB_FIREBOT_IDLE_LINES, idle_lines)
ai_controller.set_blackboard_key(BB_FIREBOT_FIRE_DETECTED_LINES, fire_detected_lines)
return idle_lines + fire_detected_lines
/mob/living/basic/bot/firebot/Initialize(mapload)
. = ..()
ADD_TRAIT(src, TRAIT_SPACEWALK, INNATE_TRAIT)
update_appearance(UPDATE_ICON)
var/static/list/things_to_extinguish = typecacheof(list(/mob/living/carbon))
ai_controller.set_blackboard_key(BB_FIREBOT_CAN_EXTINGUISH, things_to_extinguish)
create_extinguisher()
AddElement(/datum/element/atmos_sensitive, mapload)
/mob/living/basic/bot/firebot/Destroy()
QDEL_NULL(internal_ext)
return ..()
/mob/living/basic/bot/firebot/bot_reset(bypass_ai_reset)
. = ..()
create_extinguisher()
/mob/living/basic/bot/firebot/proc/create_extinguisher()
internal_ext = new /obj/item/extinguisher(src)
internal_ext.safety = FALSE
internal_ext.precision = TRUE
internal_ext.max_water = INFINITY
internal_ext.refill()
/mob/living/basic/bot/firebot/melee_attack(atom/attacked_atom, list/modifiers, ignore_cooldown = FALSE)
use_extinguisher(attacked_atom, modifiers)
/mob/living/basic/bot/firebot/RangedAttack(atom/attacked_atom, list/modifiers)
use_extinguisher(attacked_atom, modifiers)
/mob/living/basic/bot/firebot/proc/use_extinguisher(atom/attacked_atom, list/modifiers)
if(!(bot_mode_flags & BOT_MODE_ON))
return
spray_water(attacked_atom, modifiers)
/mob/living/basic/bot/firebot/emag_act(mob/user, obj/item/card/emag/emag_card)
. = ..()
if(!(bot_access_flags & BOT_COVER_EMAGGED))
return
to_chat(user, span_warning("You enable the very ironically named \"fighting with fire\" mode, and disable the targeting safeties.")) // heheehe. funny
audible_message(span_danger("[src] buzzes oddly!"))
playsound(src, SFX_SPARKS, 75, TRUE, SHORT_RANGE_SOUND_EXTRARANGE)
internal_ext.chem = /datum/reagent/clf3 //Refill the internal extinguisher with liquid fire
internal_ext.power = 3
internal_ext.safety = FALSE
internal_ext.precision = FALSE
internal_ext.max_water = INFINITY
internal_ext.refill()
return TRUE
// Variables sent to TGUI
/mob/living/basic/bot/firebot/ui_data(mob/user)
var/list/data = ..()
if(!(bot_access_flags & BOT_COVER_LOCKED) || HAS_SILICON_ACCESS(user))
data["custom_controls"]["extinguish_fires"] = firebot_mode_flags & FIREBOT_EXTINGUISH_FLAMES
data["custom_controls"]["extinguish_people"] = firebot_mode_flags & FIREBOT_EXTINGUISH_PEOPLE
data["custom_controls"]["stationary_mode"] = firebot_mode_flags & FIREBOT_STATIONARY_MODE
return data
// Actions received from TGUI
/mob/living/basic/bot/firebot/ui_act(action, list/params, datum/tgui/ui, datum/ui_state/state)
. = ..()
var/mob/user = ui.user
if(. || (bot_access_flags & BOT_COVER_LOCKED && !HAS_SILICON_ACCESS(user)))
return
switch(action)
if("extinguish_fires")
firebot_mode_flags ^= FIREBOT_EXTINGUISH_FLAMES
if("extinguish_people")
firebot_mode_flags ^= FIREBOT_EXTINGUISH_PEOPLE
if("stationary_mode")
firebot_mode_flags ^= FIREBOT_STATIONARY_MODE
update_appearance()
/mob/living/basic/bot/firebot/should_atmos_process(datum/gas_mixture/air, exposed_temperature)
return (exposed_temperature > T0C + 200 || exposed_temperature < BODYTEMP_COLD_DAMAGE_LIMIT)
/mob/living/basic/bot/firebot/atmos_expose(datum/gas_mixture/air, exposed_temperature)
if(!COOLDOWN_FINISHED(src, foam_cooldown))
return
do_foam(3, src, loc, foam_type = /datum/effect_system/fluid_spread/foam/firefighting)
COOLDOWN_START(src, foam_cooldown, FOAM_INTERVAL)
/mob/living/basic/bot/firebot/proc/spray_water(atom/attacked_atom, list/modifiers)
if(firebot_mode_flags & FIREBOT_STATIONARY_MODE)
flick("firebots_use", src)
else
flick("firebot1_use", src)
internal_ext?.interact_with_atom(attacked_atom, src, modifiers)
/mob/living/basic/bot/firebot/update_icon_state()
. = ..()
if(!(bot_mode_flags & BOT_MODE_ON))
icon_state = "firebot0"
return
if(IsStun() || IsParalyzed() || (firebot_mode_flags & FIREBOT_STATIONARY_MODE)) //Bot has yellow light to indicate stationary mode.
icon_state = "firebots1"
return
icon_state = "firebot1"
/mob/living/basic/bot/firebot/explode()
var/turf/my_turf = drop_location()
new /obj/item/assembly/prox_sensor(my_turf)
new /obj/item/clothing/head/utility/hardhat/red(my_turf)
if(isopenturf(my_turf))
var/turf/open/open_turf = my_turf
open_turf.MakeSlippery(TURF_WET_WATER, min_wet_time = 10 SECONDS, wet_time_to_add = 5 SECONDS)
return ..()
#undef FOAM_INTERVAL