persistent_paintings

Painting persistence has one writer queue. No player dialog is held inside it.

Vars
admin_painting_data	A list of paintings' data for paintings that are currently stored in the library, with admin metadata
cached_painting_data	A list of paintings' data for paintings that are currently stored in the library.
deleted_paintings_md5s	Hashes of paintings deleted this round
frame_types_by_patronage_tier	The list of available frame reskins (they are purely cosmetic) and the associated patronage amount required for them.
gallery_programs	Live Art Galaxy programs to refresh after gallery or status changes.
nova_import_busy	Ckeys with an active confirmation/import flow, shared across devices.
nova_import_status	Latest player-facing import outcome or progress message, keyed by ckey.
nova_painting_ids_by_owner	Only IDs for accounts offered an import; null means not checked, an empty list means no matches.
owner_painting_data	Owner UI data is populated on demand and invalidated after committed changes.
painting_frames	A list of painting frames that this controls
paintings	A list of /datum/paintings saved or ready to be saved this round.
paintings_by_id	Committed painting datums by MD5; reused so open canvases keep their references.
pending_canvases	Include unframed canvases when checking conflicts with imported identities.
store_busy	One queue worker owns mutations until every pending request completes.
store_error	Initialization or recovery failure explaining why painting writes are disabled.
store_queue	FIFO requests with payload, completion flag, and result; released when drained.
store_writable	Enabled only after the native helper recovers and validates the live store.
Procs
apply_store_snapshot	Reuse painting datums from committed metadata and refresh indexes, assets, and open galleries.
cache_gallery_owners	Invalidate owner payloads; the ID index also lets snapshot loading reuse live painting datums.
can_retry_nova_import	Allow confirmed importers to retry when source availability is unknown or owned records remain absent.
execute_store_operation	Rebuild each queued operation against the latest committed bytes, never a stale live-datum dump.
get_available_frames	returns a list of cosmetic frames which patronage tier values are are within credit_value. If only_current_tier is TRUE, the list will be populated only by the ones from the highest tier.
get_owned_paintings	Build only the authenticated owner's payload, once per committed snapshot.
get_paintings_with_tag	Returns paintings with given tag.
initialize_store	Recover and migrate through the native helper; failures leave writes disabled and allow intact v3 data to be viewed.
migrate_to_version_1	Merge legacy category entries by identity and prepare image copies for the shared transaction.
migrate_to_version_2	Add patronage-tier cosmetic frames to version-1 records without writing files directly.
offer_nova_import	UI entry points share this gate. No UI update tick can spawn another dialog.
painting_ui_data	Generates painting data ready to be consumed by ui. Args:
patch_painting	Queue named metadata changes with optional ownership and stale-value checks at execution time.
pending_canvas_ids	Collect unsaved local pixel identities so imports cannot claim artwork still being created.
perform_nova_import_offer	Validate owned source records and obtain import consent; closing the second prompt keeps imported art private.
prepare_nova_import	Release other owners' records before waiting for input; keep the full-source SHA for native verification.
process_store_queue	Drain mutations serially, report failures, and release temporary files and canvas save guards.
refresh_gallery_uis	Invalidate searches after commits; only open Art Galaxy views need UI or new asset updates.
remove_deleted_painting_frames	Remove displayed canvases only after deletion has committed, for player and administrator actions alike.
run_store_operation	Queue a mutation and wait for its result; player dialogs must finish before calling this proc.
save_paintings	Saves all persistent paintings
save_to_file	All changes now commit explicitly; this compatibility hook refreshes external changes.
stage_painting_image	Write one new painting's PNG into its own staging directory, for the commit to promote or the queue to clean up.
store_call	Isolated for unit tests; only the native helper resolves filesystem paths.
store_request	Poll asynchronous native work cooperatively and release its caller lease after a failed response.
store_result_message	Extract a storage failure message with a safe fallback for incomplete responses.
update_format	Updates paintings data format to latest if necessary

Var Details

var
admin_painting_data
– /list

A list of paintings' data for paintings that are currently stored in the library, with admin metadata

var
cached_painting_data
– /list

A list of paintings' data for paintings that are currently stored in the library.

var
deleted_paintings_md5s
– /list

Hashes of paintings deleted this round

var
frame_types_by_patronage_tier
– /list

The list of available frame reskins (they are purely cosmetic) and the associated patronage amount required for them.

var
gallery_programs
– /list

Live Art Galaxy programs to refresh after gallery or status changes.

var
nova_import_busy
– /list

Ckeys with an active confirmation/import flow, shared across devices.

var
nova_import_status
– /list

Latest player-facing import outcome or progress message, keyed by ckey.

var
nova_painting_ids_by_owner
– /list

Only IDs for accounts offered an import; null means not checked, an empty list means no matches.

var
owner_painting_data
– /list

Owner UI data is populated on demand and invalidated after committed changes.

var
painting_frames
– /list/obj/structure/sign/painting

A list of painting frames that this controls

var
paintings
– /list

A list of /datum/paintings saved or ready to be saved this round.

var
paintings_by_id
– /list

Committed painting datums by MD5; reused so open canvases keep their references.

var
pending_canvases
– /list

Include unframed canvases when checking conflicts with imported identities.

var
store_busy

One queue worker owns mutations until every pending request completes.

var
store_error

Initialization or recovery failure explaining why painting writes are disabled.

var
store_queue
– /list

FIFO requests with payload, completion flag, and result; released when drained.

var
store_writable

Enabled only after the native helper recovers and validates the live store.

Proc Details

proc
apply_store_snapshot
(/list/snapshot)

Reuse painting datums from committed metadata and refresh indexes, assets, and open galleries.

proc
cache_gallery_owners
()

Invalidate owner payloads; the ID index also lets snapshot loading reuse live painting datums.

proc
can_retry_nova_import
(/client/player)

Allow confirmed importers to retry when source availability is unknown or owned records remain absent.

proc
execute_store_operation
(kind, /list/payload)

Rebuild each queued operation against the latest committed bytes, never a stale live-datum dump.

proc
get_available_frames
(credit_value, only_current_tier)

returns a list of cosmetic frames which patronage tier values are are within credit_value. If only_current_tier is TRUE, the list will be populated only by the ones from the highest tier.

proc
get_owned_paintings
(owner)

Build only the authenticated owner's payload, once per committed snapshot.

proc
get_paintings_with_tag
(tag_name)

Returns paintings with given tag.

proc
initialize_store
()

Recover and migrate through the native helper; failures leave writes disabled and allow intact v3 data to be viewed.

proc
migrate_to_version_1
(/list/current_data, /list/images)

Merge legacy category entries by identity and prepare image copies for the shared transaction.

proc
migrate_to_version_2
(/list/current_data)

Add patronage-tier cosmetic frames to version-1 records without writing files directly.

proc
offer_nova_import
(/client/player, manual, /client/admin)

UI entry points share this gate. No UI update tick can spawn another dialog.

proc
painting_ui_data
(filter, admin, search_text)

Generates painting data ready to be consumed by ui. Args:

filter: a bitfield argument is used to filter out paintings that don't match certain requisites.
admin : whether all the json data of the painting is added to the return value or only the more IC details
search_text : text to search for if the PAINTINGS_FILTER_SEARCH_TITLE or PAINTINGS_FILTER_SEARCH_CREATOR filters are enabled.

proc
patch_painting
(/datum/painting/painting, /list/patch, owner, /list/expected)

Queue named metadata changes with optional ownership and stale-value checks at execution time.

proc
pending_canvas_ids
()

Collect unsaved local pixel identities so imports cannot claim artwork still being created.

proc
perform_nova_import_offer
(/client/player, /datum/preferences/preferences, owner, /client/admin)

Validate owned source records and obtain import consent; closing the second prompt keeps imported art private.

proc
prepare_nova_import
(/list/snapshot, owner)

Release other owners' records before waiting for input; keep the full-source SHA for native verification.

proc
process_store_queue
()

Drain mutations serially, report failures, and release temporary files and canvas save guards.

proc
refresh_gallery_uis
(rebuild)

Invalidate searches after commits; only open Art Galaxy views need UI or new asset updates.

proc
remove_deleted_painting_frames
(id)

Remove displayed canvases only after deletion has committed, for player and administrator actions alike.

proc
run_store_operation
(kind, /list/payload)

Queue a mutation and wait for its result; player dialogs must finish before calling this proc.

proc
save_paintings
()

Saves all persistent paintings

proc
save_to_file
()

All changes now commit explicitly; this compatibility hook refreshes external changes.

proc
stage_painting_image
(id, width, height, pixels, /list/payload, /list/images)

Write one new painting's PNG into its own staging directory, for the commit to promote or the queue to clean up.

proc
store_call
(/list/request)

Isolated for unit tests; only the native helper resolves filesystem paths.

proc
store_request
(/list/request)

Poll asynchronous native work cooperatively and release its caller lease after a failed response.

proc
store_result_message
(/list/result)

Extract a storage failure message with a safe fallback for incomplete responses.

proc
update_format
(/list/current_data, /list/images)

Updates paintings data format to latest if necessary

persistent_paintings /datum/controller/subsystem/persistent_paintings

Vars

Procs

Var Details

var admin_painting_data – /list

var cached_painting_data – /list

var deleted_paintings_md5s – /list

var frame_types_by_patronage_tier – /list

var gallery_programs – /list

var nova_import_busy – /list

var nova_import_status – /list

var nova_painting_ids_by_owner – /list

var owner_painting_data – /list

var painting_frames – /list/obj/structure/sign/painting

var paintings – /list

var paintings_by_id – /list

var pending_canvases – /list

var store_busy

var store_error

var store_queue – /list

var store_writable

Proc Details

proc apply_store_snapshot(/list/snapshot)

proc cache_gallery_owners()

proc can_retry_nova_import(/client/player)

proc execute_store_operation(kind, /list/payload)

proc get_available_frames(credit_value, only_current_tier)

proc get_owned_paintings(owner)

proc get_paintings_with_tag(tag_name)

proc initialize_store()

proc migrate_to_version_1(/list/current_data, /list/images)

proc migrate_to_version_2(/list/current_data)

proc offer_nova_import(/client/player, manual, /client/admin)

proc painting_ui_data(filter, admin, search_text)

proc patch_painting(/datum/painting/painting, /list/patch, owner, /list/expected)

proc pending_canvas_ids()

proc perform_nova_import_offer(/client/player, /datum/preferences/preferences, owner, /client/admin)

proc prepare_nova_import(/list/snapshot, owner)

proc process_store_queue()

proc refresh_gallery_uis(rebuild)

proc remove_deleted_painting_frames(id)

proc run_store_operation(kind, /list/payload)

proc save_paintings()

proc save_to_file()

proc stage_painting_image(id, width, height, pixels, /list/payload, /list/images)

proc store_call(/list/request)

proc store_request(/list/request)

proc store_result_message(/list/result)

proc update_format(/list/current_data, /list/images)