scar

scars are cosmetic datums that are assigned to bodyparts once they recover from wounds. Each wound type and severity have their own descriptions for what the scars look like, and then each body part has a list of "specific locations" like your elbow or wrist or wherever the scar can appear, to make it more interesting than "right arm"

Arguments:

Vars
applicable_zones	What zones this scar can be applied to
coverable	Whether this scar can actually be covered up by clothing
fake	Scars from the longtimer quirk are "fake" and won't be saved with persistent scarring, since it makes you spawn with a lot by default
visibility	How many tiles away someone can see this scar, goes up with severity. Clothes covering this limb will decrease visibility by 1 each, except for the head/face which is a binary "is mask obscuring face" check
Procs
format	Used to format a scar to safe in preferences for persistent scars
format_amputated	Used to format a scar to safe in preferences for persistent scars
generate	generate() is used to actually fill out the info for a scar, according to the limb and wound it is provided.
get_examine_description	What will show up in examine_more() if this scar is visible
is_visible	Whether a scar can currently be seen by the viewer
lazy_attach	Used when we finalize a scar from a healing cut
load	Used to "load" a persistent scar

Var Details

var
applicable_zones
– /list

What zones this scar can be applied to

var
coverable
–

Whether this scar can actually be covered up by clothing

var
fake
–

Scars from the longtimer quirk are "fake" and won't be saved with persistent scarring, since it makes you spawn with a lot by default

var
visibility
–

How many tiles away someone can see this scar, goes up with severity. Clothes covering this limb will decrease visibility by 1 each, except for the head/face which is a binary "is mask obscuring face" check

Proc Details

proc
format
()

Used to format a scar to safe in preferences for persistent scars

proc
format_amputated
(body_zone)

Used to format a scar to safe in preferences for persistent scars

proc
generate
(/obj/item/bodypart/BP, /datum/wound/W, add_to_scars)

generate() is used to actually fill out the info for a scar, according to the limb and wound it is provided.

After creating a scar, call this on it while targeting the scarred bodypart with a given wound to apply the scar.

Arguments:

BP- The bodypart being targeted
W- The wound being used to generate the severity and description info
add_to_scars- Should always be TRUE unless you're just storing a scar for later usage, like how cuts want to store a scar for the highest severity of cut, rather than the severity when the wound is fully healed (probably demoted to moderate)

proc
get_examine_description
(/mob/viewer)

What will show up in examine_more() if this scar is visible

proc
is_visible
(/mob/viewer)

Whether a scar can currently be seen by the viewer

proc
lazy_attach
(/obj/item/bodypart/BP, /datum/wound/W)

Used when we finalize a scar from a healing cut

proc
load
(/obj/item/bodypart/BP, version, description, specific_location, severity)

Used to "load" a persistent scar

scar /datum/scar

Vars

Procs

Var Details

var applicable_zones – /list

var coverable –

var fake –

var visibility –

Proc Details

proc format()

proc format_amputated(body_zone)

proc generate(/obj/item/bodypart/BP, /datum/wound/W, add_to_scars)

proc get_examine_description(/mob/viewer)

proc is_visible(/mob/viewer)

proc lazy_attach(/obj/item/bodypart/BP, /datum/wound/W)

proc load(/obj/item/bodypart/BP, version, description, specific_location, severity)