custom_sprite_salon

One artist's custom work for one recipient and drawing target.

Hair work covers one drawing. Tattoo work covers every region of the body, and only the regions the draft changes are proposed, checked and applied. States: drafting -> awaiting approval -> applying -> completed. Declining, interruption or a stale approval returns to drafting and keeps the draft. Approval binds to an immutable copy of the exact reviewed revision, and every step checks the participants again.

Vars
artist_ckey	Account allowed to edit and resume this draft.
artist_ref	Weak reference to the artist's current body.
drawing_ambience	Steady tattoo-machine ambience, separate from the varied needle bursts.
drawing_sound	A single brush-triggered clip, stopped when the editor closes.
drawing_sound_cooldown	Earliest time another brush movement may start a work clip.
dress_timer	Pending rebuild after the recipient's clothing changed.
editor	Retained drawing editor owned by this session: the salon hair editor, or the whole-body tattoo canvas.
mirror	Current recipient approval window, if any.
original	Style key -> list("package", "hash", "bodypart", "taur", "signature") for each drawing as it was when work started.
proposal	list("token", "revision", "packages") for the reviewed revision. Packages map style key -> package.
rebuild_preview_body	A body-owned appearance changed; worn items alone can reuse the existing preview body.
recipient_ckey	Account allowed to approve the finished design.
recipient_emissives	Recipient's master emissive permission captured for the draft.
recipient_name	Recipient's display name captured when work starts.
recipient_ref	Weak reference to the original recipient body.
restoration	A restoration proposes these packages, by style key, instead of a draft.
save_on_completion	Recipient requested a permanent save after this exact proposal is successfully applied.
self_work	Working on your own body: no consent step, and views you can't see need a mirror.
state	Consent and application phase of this salon session.
target	Drawing kind: hair, facial_hair or markings. Markings cover the whole body.
tool_ref	Weak reference to the tool used to start the work.
tool_type	Required tool family when checking or resuming the work.
trimming_stage	How big the pile under the recipient has grown so far.
trimming_timer	Pending timer for the next lot of clippings to hit the floor.
uniform_ref	The recipient's jumpsuit, watched because adjusting it changes what it covers without taking it off.
watched_ref	Artist currently watched for mirror and movement changes.
Procs
accept	Recipient approval. Binds to the exact reviewed token and revision, then starts the timed action.
application_valid	Whether the timed application for `token` is still the current one.
apply_proposal	Runs the timed action and applies the approved package once. Duplicate or stale calls do nothing.
artist	The artist's body, or null once it's gone or another player controls it.
award	Gives a player an achievement, when they have a client.
changed_packages	The packages that differ from the look their drawing had when work started.
close_mirror	Closes the mirror without treating the close as a decision.
complete_application	Applies the approved packages after the timed action. Every check runs again first.
context_act	Window actions the salon owns, shared by the hair editor and the tattoo canvas.
context_ui_data	Window data the salon owns, shared by the hair editor and the tattoo canvas.
decline	The recipient (or the timeout) turns the proposal down; the draft is kept.
draft_changed	An edit withdraws a proposal the recipient is still reviewing.
drawing_activity	Brush activity is sent during a stroke; validate it without changing pixels or pushing UI data.
drawing_problem	Why one drawing can't be changed: its part's problem, or a look that changed on the body since work started.
export_draft	Sends the draft as a style file: the hair drawing, or the whole body as the tattoo canvas holds it.
export_proposal	Sends the reviewed proposal as a style file: the hair drawing, or the regions a tattoo changes.
finish_problem	Why the draft can't be proposed as drawn, such as a tattooed region over its own color limit, or null.
hair_problem	Scissors and tattoo machines change the haircut and its color, not the rest of the look.
held_tool	Returns the held tool of this session's type, preferring the one work started with.
label	What this work is called, such as "hairstyle".
locked_directions	Views this artist can't work on right now. Only self-styling restricts anything.
locked_view_problem	Refuses changes to views the artist can't see, in case the mirror is gone by the time they finish.
on_artist_changed	The artist moved: self-styling locks may have changed.
on_recipient_changed	The recipient's equipment changed: locks and the watched jumpsuit follow.
on_recipient_overlay_changed	A worn or body overlay changed: guides, previews and the mirror redraw shortly.
on_uniform_adjusted	Rolling a jumpsuit up or down changes what it covers and how it looks, without taking it off.
part_problem	Why a drawing's part can't take work right now, or null.
participant_problem	Returns why the work can't proceed, or null when it can.
propose	Sends the current revision to the recipient's mirror.
proposed_packages	Style key -> each package finishing would apply, before unchanged ones are dropped.
recipient	The recipient's body, or null once it's gone or another player controls it.
refresh_editor_body	Rebuilds the editor's resources after clothing or body changes settled.
region_problem	Why a tattoo region can't take paint right now, or null. Cheap enough for every region on every stroke.
return_to_drafting	Returns an awaiting or interrupted proposal to drafting. Restorations end instead.
schedule_preview_refresh	Groups a second of changes into one refresh, without postponing it while changes continue.
schedule_trimmings	Queues the next lot of clippings.
shed_trimmings	Drops or grows the pile under the recipient, then queues the next one.
stop_drawing_ambience	Stops the tattoo machine's ambience once drawing has gone quiet.
stop_drawing_sounds	Closing keeps the draft but silences both channels.
watch_artist	Self-styling locks depend on what the artist is holding and where they stand, so follow both.
watch_recipient	Observe the live body, never its preview, so redraws cannot schedule themselves.
watch_uniform	Follows whichever jumpsuit the recipient wears: rolling it down or up changes what it covers.
work_keys	Style keys of the drawings this work would change as it stands: a hair target's own, or each changed tattoo region.
work_phrase	How a retained draft is described to the artist it belongs to.

Var Details

var
artist_ckey

Account allowed to edit and resume this draft.

var
artist_ref
– /datum/weakref

Weak reference to the artist's current body.

var
drawing_ambience
– /datum/looping_sound

Steady tattoo-machine ambience, separate from the varied needle bursts.

var
drawing_sound
– /datum/looping_sound/salon_snipping

A single brush-triggered clip, stopped when the editor closes.

var
drawing_sound_cooldown

Earliest time another brush movement may start a work clip.

var
dress_timer

Pending rebuild after the recipient's clothing changed.

var
editor
– /datum/custom_sprite_editor

Retained drawing editor owned by this session: the salon hair editor, or the whole-body tattoo canvas.

var
mirror
– /datum/custom_sprite_mirror

Current recipient approval window, if any.

var
original
– /list

Style key -> list("package", "hash", "bodypart", "taur", "signature") for each drawing as it was when work started.

var
proposal
– /list

list("token", "revision", "packages") for the reviewed revision. Packages map style key -> package.

var
rebuild_preview_body

A body-owned appearance changed; worn items alone can reuse the existing preview body.

var
recipient_ckey

Account allowed to approve the finished design.

var
recipient_emissives

Recipient's master emissive permission captured for the draft.

var
recipient_name

Recipient's display name captured when work starts.

var
recipient_ref
– /datum/weakref

Weak reference to the original recipient body.

var
restoration
– /list

A restoration proposes these packages, by style key, instead of a draft.

var
save_on_completion

Recipient requested a permanent save after this exact proposal is successfully applied.

var
self_work

Working on your own body: no consent step, and views you can't see need a mirror.

var
state

Consent and application phase of this salon session.

var
target

Drawing kind: hair, facial_hair or markings. Markings cover the whole body.

var
tool_ref
– /datum/weakref

Weak reference to the tool used to start the work.

var
tool_type

Required tool family when checking or resuming the work.

var
trimming_stage

How big the pile under the recipient has grown so far.

var
trimming_timer

Pending timer for the next lot of clippings to hit the floor.

var
uniform_ref
– /datum/weakref

The recipient's jumpsuit, watched because adjusting it changes what it covers without taking it off.

var
watched_ref
– /datum/weakref

Artist currently watched for mirror and movement changes.

Proc Details

proc
accept
(/mob/user, token, save_permanently)

Recipient approval. Binds to the exact reviewed token and revision, then starts the timed action.

proc
application_valid
(token)

Whether the timed application for token is still the current one.

proc
apply_proposal
(token)

Runs the timed action and applies the approved package once. Duplicate or stale calls do nothing.

proc
artist
()

The artist's body, or null once it's gone or another player controls it.

proc
award
(/mob/player, award_type)

Gives a player an achievement, when they have a client.

proc
changed_packages
(/list/packages)

The packages that differ from the look their drawing had when work started.

proc
close_mirror
()

Closes the mirror without treating the close as a decision.

proc
complete_application
(token, finished)

Applies the approved packages after the timed action. Every check runs again first.

Only the drawings the proposal changes are applied, and each keeps its previous look as round history. Achievements are awarded once per application.

Returns:

TRUE: Applied. The session is deleted, so a replayed call finds nothing to apply.
FALSE: Stale, duplicate, interrupted or invalid. Nothing changed.

proc
context_act
(action, /list/params, /mob/user)

Window actions the salon owns, shared by the hair editor and the tattoo canvas.

proc
context_ui_data
()

Window data the salon owns, shared by the hair editor and the tattoo canvas.

proc
decline
(/mob/user, reason)

The recipient (or the timeout) turns the proposal down; the draft is kept.

proc
draft_changed
()

An edit withdraws a proposal the recipient is still reviewing.

proc
drawing_activity
(/mob/user, /list/params)

Brush activity is sent during a stroke; validate it without changing pixels or pushing UI data.

proc
drawing_problem
(/mob/living/carbon/human/recipient, key)

Why one drawing can't be changed: its part's problem, or a look that changed on the body since work started.

proc
export_draft
(/client/receiver)

Sends the draft as a style file: the hair drawing, or the whole body as the tattoo canvas holds it.

proc
export_proposal
(/client/receiver)

Sends the reviewed proposal as a style file: the hair drawing, or the regions a tattoo changes.

proc
finish_problem
()

Why the draft can't be proposed as drawn, such as a tattooed region over its own color limit, or null.

proc
hair_problem
(/list/hair)

Scissors and tattoo machines change the haircut and its color, not the rest of the look.

proc
held_tool
(/mob/living/carbon/human/artist)

Returns the held tool of this session's type, preferring the one work started with.

proc
label
()

What this work is called, such as "hairstyle".

proc
locked_directions
()

Views this artist can't work on right now. Only self-styling restricts anything.

proc
locked_view_problem
(/list/packages)

Refuses changes to views the artist can't see, in case the mirror is gone by the time they finish.

proc
on_artist_changed
(/datum/source)

The artist moved: self-styling locks may have changed.

proc
on_recipient_changed
(/datum/source)

The recipient's equipment changed: locks and the watched jumpsuit follow.

proc
on_recipient_overlay_changed
(/datum/source, layer)

A worn or body overlay changed: guides, previews and the mirror redraw shortly.

proc
on_uniform_adjusted
(/datum/source)

Rolling a jumpsuit up or down changes what it covers and how it looks, without taking it off.

proc
part_problem
(/mob/living/carbon/human/recipient, key)

Why a drawing's part can't take work right now, or null.

The part must be the one work started on: the same bodypart, and the same taur organ for the taur region. It must also be reachable: not missing, covered, husked or hidden. This is cheap enough to run for every region on every stroke.

proc
participant_problem
(/list/keys)

Returns why the work can't proceed, or null when it can.

This covers both participants and their controlling players, consciousness, the held tool and reachability, then each drawing it checks: the part it's on, whether that can be reached, and its look since work started.

Arguments:

keys: Style keys of the drawings to check. By default the proposal's, or the drawings this work would change as it stands.

proc
propose
(/mob/user)

Sends the current revision to the recipient's mirror.

Returns:

null: The mirror opened.
text: Why it didn't. The draft is unchanged.

proc
proposed_packages
()

Style key -> each package finishing would apply, before unchanged ones are dropped.

proc
recipient
()

The recipient's body, or null once it's gone or another player controls it.

proc
refresh_editor_body
()

Rebuilds the editor's resources after clothing or body changes settled.

proc
region_problem
(/mob/living/carbon/human/recipient, key)

Why a tattoo region can't take paint right now, or null. Cheap enough for every region on every stroke.

Answers exactly as drawing_problem() does, but only compares the full look once the region's fingerprint has changed.

proc
return_to_drafting
(message)

Returns an awaiting or interrupted proposal to drafting. Restorations end instead.

proc
schedule_preview_refresh
(body_changed)

Groups a second of changes into one refresh, without postponing it while changes continue.

proc
schedule_trimmings
()

Queues the next lot of clippings.

Only hair work sheds, and only a real cut rather than a restoration. Cutting your own hair still drops it. Mid-cut the pile stops growing at SALON_TRIMMING_WORKING_MAX; completion takes it the rest of the way.

proc
shed_trimmings
()

Drops or grows the pile under the recipient, then queues the next one.

proc
stop_drawing_ambience
()

Stops the tattoo machine's ambience once drawing has gone quiet.

proc
stop_drawing_sounds
()

Closing keeps the draft but silences both channels.

proc
watch_artist
(/mob/living/carbon/human/artist)

Self-styling locks depend on what the artist is holding and where they stand, so follow both.

proc
watch_recipient
(/mob/living/carbon/human/recipient)

Observe the live body, never its preview, so redraws cannot schedule themselves.

proc
watch_uniform
(/mob/living/carbon/human/recipient)

Follows whichever jumpsuit the recipient wears: rolling it down or up changes what it covers.

proc
work_keys
()

Style keys of the drawings this work would change as it stands: a hair target's own, or each changed tattoo region.

proc
work_phrase
()

How a retained draft is described to the artist it belongs to.

custom_sprite_salon /datum/custom_sprite_salon

Vars

Procs

Var Details

var artist_ckey

var artist_ref – /datum/weakref

var drawing_ambience – /datum/looping_sound

var drawing_sound – /datum/looping_sound/salon_snipping

var drawing_sound_cooldown

var dress_timer

var editor – /datum/custom_sprite_editor

var mirror – /datum/custom_sprite_mirror

var original – /list

var proposal – /list

var rebuild_preview_body

var recipient_ckey

var recipient_emissives

var recipient_name

var recipient_ref – /datum/weakref

var restoration – /list

var save_on_completion

var self_work

var state

var target

var tool_ref – /datum/weakref

var tool_type

var trimming_stage

var trimming_timer

var uniform_ref – /datum/weakref

var watched_ref – /datum/weakref

Proc Details

proc accept(/mob/user, token, save_permanently)

proc application_valid(token)

proc apply_proposal(token)

proc artist()

proc award(/mob/player, award_type)

proc changed_packages(/list/packages)

proc close_mirror()

proc complete_application(token, finished)

proc context_act(action, /list/params, /mob/user)

proc context_ui_data()

proc decline(/mob/user, reason)

proc draft_changed()

proc drawing_activity(/mob/user, /list/params)

proc drawing_problem(/mob/living/carbon/human/recipient, key)

proc export_draft(/client/receiver)

proc export_proposal(/client/receiver)

proc finish_problem()

proc hair_problem(/list/hair)

proc held_tool(/mob/living/carbon/human/artist)

proc label()

proc locked_directions()

proc locked_view_problem(/list/packages)

proc on_artist_changed(/datum/source)

proc on_recipient_changed(/datum/source)

proc on_recipient_overlay_changed(/datum/source, layer)

proc on_uniform_adjusted(/datum/source)

proc part_problem(/mob/living/carbon/human/recipient, key)

proc participant_problem(/list/keys)

proc propose(/mob/user)

proc proposed_packages()

proc recipient()

proc refresh_editor_body()

proc region_problem(/mob/living/carbon/human/recipient, key)

proc return_to_drafting(message)

proc schedule_preview_refresh(body_changed)

proc schedule_trimmings()

proc shed_trimmings()

proc stop_drawing_ambience()

proc stop_drawing_sounds()

proc watch_artist(/mob/living/carbon/human/artist)

proc watch_recipient(/mob/living/carbon/human/recipient)

proc watch_uniform(/mob/living/carbon/human/recipient)

proc work_keys()

proc work_phrase()