Files
Bubberstation/code/datums/components/echolocation.dm
throwawayuseless 08e777bb5f Makes psyker playable (#91490)
## About The Pull Request
-# so help me space jesus if this doesn't compile despite working fine
on my local machine
Makes burdened chaplain and psyker pirates not blind, so that someone
playing them isnt assaulted by irregularly flashing monochromatic lights
on a black background. Instead the echolocation outlines will simply
pulse to highlight nearby objects regardless of lighting conditions or
other vision obscuring effects. adds support for if you want
psykerization to blind people or not.
keeps bitrunner psykers blind, since that's the point of the domain.
Just avoid those domains if you can't handle the effect, sorry.
## Why It's Good For The Game
A. It makes psyker an actual useful ability. I have personally seen, as
a ghost, psyker pirates fail to navigate out of their ship for a full
five minutes, and then die horribly because they are unable to actually
do anything because they're **Worse than blinded** since blindness has a
small radius of working vision.

B. In-game effects should not cause **real world eye pain and nausea**
thank you very much.

neat fact: blind seers only really work when the seer-ing makes up for
the blindness.

example of outline highlighting hidden underfloor objects (like that
satchel!) while user is not horribly blinded

![image](https://github.com/user-attachments/assets/04ce713d-5e4a-434d-b41a-5206240a27ff)

## Changelog
🆑
fix: blind psykers are not blinded twice by two different sources, head
and brain.
qol: Psyker bounty hunters and chaplains are no longer blinded by
default, so as to reduce the amount of eye strain from the echolocation
effect. The echolocation virtual domains remain as they are.
/🆑

---------

Co-authored-by: ThrowawayUseless <notarealemail@emailservice.fake>
2025-06-08 14:41:18 +00:00

208 lines
9.3 KiB
Plaintext

/datum/component/echolocation
/// Radius of our view.
var/echo_range = 4
/// Time between echolocations. IMPORTANT!! The effective time in local and the effective time in live are very different. The second is noticeably slower,
var/cooldown_time = 1 SECONDS
/// Time for the image to start fading out.
var/image_expiry_time = 0.7 SECONDS
/// Time for the image to fade in.
var/fade_in_time = 0.2 SECONDS
/// Time for the image to fade out and delete itself.
var/fade_out_time = 0.3 SECONDS
/// Are images static? If yes, spawns them on the turf and makes them not change location. Otherwise they change location and pixel shift with the original.
var/images_are_static = TRUE
/// Does this echolocation cause us to go blind?
var/blinding = TRUE
/// With mobs that have this echo group in their echolocation receiver trait, we share echo images.
var/echo_group = null
/// This trait blocks us from receiving echolocation.
var/blocking_trait
/// Ref of the client color we give to the echolocator.
var/client_colour
/// Associative list of receivers to lists of atoms they are rendering (those atoms are associated to data of the image and time they were rendered at).
var/list/receivers = list()
/// All the saved appearances, keyed by icon-icon_state.
var/static/list/saved_appearances = list()
/// Typecache of all the allowed paths to render.
var/static/list/allowed_paths
/// Typecache of turfs that are dangerous, to give them a special icon.
var/static/list/danger_turfs
/// A matrix that turns everything except #ffffff into pure blackness, used for our images (the outlines are #ffffff).
var/static/list/black_white_matrix = list(85, 85, 85, 0, 85, 85, 85, 0, 85, 85, 85, 0, 0, 0, 0, 1, -254, -254, -254, 0)
/// A matrix that turns everything into pure white.
var/static/list/white_matrix = list(255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 0, 0, 0, 1, 0, 0, 0, 0)
/// Cooldown for the echolocation.
COOLDOWN_DECLARE(cooldown_last)
/datum/component/echolocation/Initialize(echo_range, cooldown_time, image_expiry_time, fade_in_time, fade_out_time, images_are_static, blocking_trait, echo_group, echo_icon, color_path, blinding)
. = ..()
var/mob/living/echolocator = parent
if(!istype(echolocator))
return COMPONENT_INCOMPATIBLE
if(!danger_turfs)
danger_turfs = typecacheof(list(/turf/open/space, /turf/open/openspace, /turf/open/chasm, /turf/open/lava, /turf/open/floor/fakespace, /turf/open/floor/fakepit, /turf/closed/wall/space))
if(!allowed_paths)
allowed_paths = typecacheof(list(/turf/closed, /obj, /mob/living)) + danger_turfs - typecacheof(/obj/effect/decal)
if(!isnull(echo_range))
src.echo_range = echo_range
if(!isnull(cooldown_time))
src.cooldown_time = cooldown_time
if(!isnull(image_expiry_time))
src.image_expiry_time = image_expiry_time
if(!isnull(fade_in_time))
src.fade_in_time = fade_in_time
if(!isnull(fade_out_time))
src.fade_out_time = fade_out_time
if(!isnull(blinding))
src.blinding = blinding
if(!isnull(images_are_static))
src.images_are_static = images_are_static
if(!isnull(blocking_trait))
src.blocking_trait = blocking_trait
src.echo_group = echo_group || REF(src)
if(ispath(color_path))
client_colour = echolocator.add_client_colour(color_path, src.echo_group)
echolocator.add_traits(list(TRAIT_ECHOLOCATION_RECEIVER, TRAIT_TRUE_NIGHT_VISION), src.echo_group) //so they see all the tiles they echolocated, even if they are in the dark
if(blinding)
echolocator.become_blind(ECHOLOCATION_TRAIT)
echolocator.overlay_fullscreen("echo", /atom/movable/screen/fullscreen/echo, echo_icon)
START_PROCESSING(SSfastprocess, src)
/datum/component/echolocation/Destroy(force)
STOP_PROCESSING(SSfastprocess, src)
var/mob/living/echolocator = parent
QDEL_NULL(client_colour)
echolocator.remove_traits(list(TRAIT_ECHOLOCATION_RECEIVER, TRAIT_TRUE_NIGHT_VISION), echo_group)
if(blinding)
echolocator.cure_blind(ECHOLOCATION_TRAIT)
echolocator.clear_fullscreen("echo")
for(var/mob/living/echolocate_receiver as anything in receivers)
if(!echolocate_receiver.client)
continue
for(var/atom/rendered_atom as anything in receivers[echolocate_receiver])
echolocate_receiver.client.images -= receivers[echolocate_receiver][rendered_atom]["image"]
receivers -= list(echolocate_receiver)
return ..()
/datum/component/echolocation/process()
var/mob/living/echolocator = parent
if(echolocator.stat == DEAD)
return
echolocate()
/datum/component/echolocation/proc/echolocate()
if(!COOLDOWN_FINISHED(src, cooldown_last))
return
COOLDOWN_START(src, cooldown_last, cooldown_time)
var/mob/living/echolocator = parent
var/real_echo_range = echo_range
if(HAS_TRAIT(echolocator, TRAIT_ECHOLOCATION_EXTRA_RANGE))
real_echo_range += 2
var/list/filtered = list()
var/list/seen = dview(real_echo_range, get_turf(echolocator.client?.eye || echolocator), invis_flags = echolocator.see_invisible)
if(blinding)
for(var/atom/seen_atom as anything in seen)
if(!seen_atom.alpha)
continue
if(allowed_paths[seen_atom.type])
filtered += seen_atom
else
var/list/ranged_atoms = range(real_echo_range, get_turf(echolocator.client?.eye || echolocator))
for(var/atom/possible_atom as anything in ranged_atoms)
if(!possible_atom.alpha)
continue
if(allowed_paths[possible_atom.type])
filtered += possible_atom
if(!length(filtered))
return
var/current_time = "[world.time]"
for(var/mob/living/viewer in filtered)
if(blocking_trait && HAS_TRAIT(viewer, blocking_trait))
continue
if(HAS_TRAIT_FROM(viewer, TRAIT_ECHOLOCATION_RECEIVER, echo_group) && isnull(receivers[viewer]))
receivers[viewer] = list()
for(var/atom/filtered_atom as anything in filtered)
show_image(saved_appearances["[filtered_atom.icon]-[filtered_atom.icon_state]"] || generate_appearance(filtered_atom), filtered_atom, current_time)
addtimer(CALLBACK(src, PROC_REF(fade_images), current_time), image_expiry_time)
/datum/component/echolocation/proc/show_image(image/input_appearance, atom/input, current_time)
var/image/final_image = image(input_appearance)
//final_image.layer += FOV_EFFECT_LAYER
final_image.plane = FULLSCREEN_PLANE
final_image.loc = images_are_static ? get_turf(input) : input
final_image.dir = input.dir
final_image.alpha = 0
if(images_are_static)
final_image.pixel_x = input.pixel_x
final_image.pixel_y = input.pixel_y
if(HAS_TRAIT_FROM(input, TRAIT_ECHOLOCATION_RECEIVER, echo_group)) //mark other echolocation with full white
final_image.color = white_matrix
var/list/fade_ins = list(final_image)
for(var/mob/living/echolocate_receiver as anything in receivers)
if(echolocate_receiver == input)
continue
if(receivers[echolocate_receiver][input])
var/previous_image = receivers[echolocate_receiver][input]["image"]
fade_ins |= previous_image
receivers[echolocate_receiver][input] = list("image" = previous_image, "time" = current_time)
else
if(echolocate_receiver.client)
echolocate_receiver.client.images += final_image
receivers[echolocate_receiver][input] = list("image" = final_image, "time" = current_time)
for(var/image_echo in fade_ins)
animate(image_echo, alpha = 255, time = fade_in_time)
/datum/component/echolocation/proc/generate_appearance(atom/input)
var/use_outline = TRUE
var/mutable_appearance/copied_appearance = new /mutable_appearance()
copied_appearance.appearance = input
if(istype(input, /obj/machinery/door/airlock)) //i hate you
copied_appearance.cut_overlays()
copied_appearance.icon_state = "closed"
else if(danger_turfs[input.type])
copied_appearance.icon = 'icons/turf/floors.dmi'
copied_appearance.icon_state = "danger"
use_outline = FALSE
copied_appearance.color = black_white_matrix
if(use_outline)
copied_appearance.filters += outline_filter(size = 1, color = COLOR_WHITE)
if(!images_are_static)
copied_appearance.pixel_x = 0
copied_appearance.pixel_y = 0
copied_appearance.transform = matrix()
if(input.icon && input.icon_state)
saved_appearances["[input.icon]-[input.icon_state]"] = copied_appearance
return copied_appearance
/datum/component/echolocation/proc/fade_images(from_when)
var/fade_outs = list()
for(var/mob/living/echolocate_receiver as anything in receivers)
for(var/atom/rendered_atom as anything in receivers[echolocate_receiver])
if(receivers[echolocate_receiver][rendered_atom]["time"] <= from_when)
fade_outs |= receivers[echolocate_receiver][rendered_atom]["image"]
for(var/image_echo in fade_outs)
animate(image_echo, alpha = 0, time = fade_out_time)
addtimer(CALLBACK(src, PROC_REF(delete_images), from_when), fade_out_time)
/datum/component/echolocation/proc/delete_images(from_when)
for(var/mob/living/echolocate_receiver as anything in receivers)
for(var/atom/rendered_atom as anything in receivers[echolocate_receiver])
if(receivers[echolocate_receiver][rendered_atom]["time"] <= from_when && echolocate_receiver.client)
echolocate_receiver.client.images -= receivers[echolocate_receiver][rendered_atom]["image"]
receivers[echolocate_receiver] -= rendered_atom
if(!length(receivers[echolocate_receiver]))
receivers -= echolocate_receiver
/atom/movable/screen/fullscreen/echo
icon_state = "echo"
layer = ECHO_LAYER
show_when_dead = TRUE
/atom/movable/screen/fullscreen/echo/Initialize(mapload, datum/hud/hud_owner)
. = ..()
particles = new /particles/echo()
/atom/movable/screen/fullscreen/echo/Destroy()
QDEL_NULL(particles)
return ..()