eyes

Vars
blink_animation	Do these eyes have blinking animations
color_cutoffs	List of color cutoffs from eyes, or null if not applicable
flash_protect	How much innare flash protection these eyes have, usually paired with tint
iris_overlay	Icon state for iris overlays
light_reactive	do these eyes have pupils (or equivalent) that react to light when penlighted.
lighting_cutoff	How much darkness to cut out of your view (basically, night vision)
native_fov	Native FOV that will be applied if a config is enabled
no_glasses	Glasses cannot be worn over these eyes. Currently unused
penlight_message	The (custom, sometimes) messages we get when we use a flashlight or penlight on these eyes. Completely optional but good if you wanna be FANCY this message should never show up for default eyes, do not change on default eyes.
pepperspray_protect	Are these eyes immune to pepperspray?
pupils_name	what are the pupils called? eg. pupils, apertures, etc.
scarring	Scarring on this organ
see_invisible	What level of invisibility these eyes can see
sight_flags	Sight flags this eye pair imparts on its user.
synchronized_blinking	Should our blinking be synchronized or can separate eyes have (slightly) separate blinking times
tint	How much innate tint these eyes have
Procs
animate_eyelid	Animates one eyelid at a time, thanks BYOND and thanks animation chains
generate_body_overlay	This proc generates a list of overlays that the eye should be displayed using for the given parent
get_emissive_overlays	Returns the two emissive overlays built for the left and right eyes, in order.
get_status_appendix	Similar to get_status_text, but appends the text after the damage report, for additional status info
on_face_wash	When our owner washes their face. The idea that spessmen wash their eyeballs is highly disturbing but this is the easiest way to get rid of cursed crayon eye coloring
on_shiny_eyes_trait_update	Called whenever the luminescent and/or reflective eyes traits are added or removed
penlight_examine	by default, returns the eyes' penlight_message var as a notice span. May do other things when overridden, such as eldritch insanity, or eye damage, or whatnot. Whatever you want, really.
refresh	Refreshes the visuals of the eyes If call_update is TRUE, we also will call update_body
refresh_atom_color_overrides	Adds eye color overrides to our owner from our atom color
setup_eyelids	Modifies eye overlays to also act as eyelids, both for blinking and for when you're knocked out cold

Var Details

var
blink_animation

Do these eyes have blinking animations

var
color_cutoffs
– /list

List of color cutoffs from eyes, or null if not applicable

var
flash_protect

How much innare flash protection these eyes have, usually paired with tint

var
iris_overlay

Icon state for iris overlays

var
light_reactive

do these eyes have pupils (or equivalent) that react to light when penlighted.

var
lighting_cutoff

How much darkness to cut out of your view (basically, night vision)

var
native_fov

Native FOV that will be applied if a config is enabled

var
no_glasses

Glasses cannot be worn over these eyes. Currently unused

var
penlight_message

The (custom, sometimes) messages we get when we use a flashlight or penlight on these eyes. Completely optional but good if you wanna be FANCY this message should never show up for default eyes, do not change on default eyes.

var
pepperspray_protect

Are these eyes immune to pepperspray?

var
pupils_name

what are the pupils called? eg. pupils, apertures, etc.

var
scarring

Scarring on this organ

var
see_invisible

What level of invisibility these eyes can see

var
sight_flags

Sight flags this eye pair imparts on its user.

var
synchronized_blinking

Should our blinking be synchronized or can separate eyes have (slightly) separate blinking times

var
tint

How much innate tint these eyes have

Proc Details

proc
animate_eyelid
(/obj/effect/abstract/eyelid_effect/eyelid, /mob/living/carbon/human/parent, sync_blinking, /list/anim_times)

Animates one eyelid at a time, thanks BYOND and thanks animation chains

proc
generate_body_overlay
(/mob/living/carbon/human/parent)

This proc generates a list of overlays that the eye should be displayed using for the given parent

proc
get_emissive_overlays
(/mutable_appearance/eye_left, /mutable_appearance/eye_right, /atom/spokesman)

Returns the two emissive overlays built for the left and right eyes, in order.

↑
get_status_appendix
(advanced, add_tooltips)

Similar to get_status_text, but appends the text after the damage report, for additional status info

proc
on_face_wash
()

When our owner washes their face. The idea that spessmen wash their eyeballs is highly disturbing but this is the easiest way to get rid of cursed crayon eye coloring

proc
on_shiny_eyes_trait_update
(/mob/living/carbon/human/source)

Called whenever the luminescent and/or reflective eyes traits are added or removed

proc
penlight_examine
(/mob/living/viewer)

by default, returns the eyes' penlight_message var as a notice span. May do other things when overridden, such as eldritch insanity, or eye damage, or whatnot. Whatever you want, really.

proc
refresh
(/mob/living/carbon/eye_owner, call_update)

Refreshes the visuals of the eyes If call_update is TRUE, we also will call update_body

proc
refresh_atom_color_overrides
()

Adds eye color overrides to our owner from our atom color

proc
setup_eyelids
(/mutable_appearance/eye_left, /mutable_appearance/eye_right, /mob/living/carbon/human/parent)

Modifies eye overlays to also act as eyelids, both for blinking and for when you're knocked out cold

eyes /obj/item/organ/eyes

Vars

Procs

Var Details

var blink_animation

var color_cutoffs – /list

var flash_protect

var iris_overlay

var light_reactive

var lighting_cutoff

var native_fov

var no_glasses

var penlight_message

var pepperspray_protect

var pupils_name

var scarring

var see_invisible

var sight_flags

var synchronized_blinking

var tint