mail

Vars
all_patterns	Assoc list: pattern_name = pattern_object with all patterns, used in admin panel. Initialized in SSmail init.
all_patterns_by_category	Assoc list of all patterns by categories, initialized in SSmail/Initialize() proc
all_patterns_info	Assoc list: pattern_name = pattern_info_list with info about all patterns, used in admin panel. Initialized in SSmail init.
mail_categories_with_colors	Assoc list 'mail category' = 'mail category color'
mail_categories_with_names	Assoc list 'mail category' = 'mail category name'. Used in admin panel
mail_categories_with_weights	Assoc list 'mail category' = 'mail category weight'
mail_waiting	Count of mails, created by SSmail in main storage, waiting to be sent to station. Nullifies when storage was sent.
main_storage	Main storage of SSmail, where mails are created
main_storage_spawnpoint	Turf, where main mail storage of SSmail will be spawned
sealed_mails	Mails on station, which was not opened yet
total_mails_count	Total amount of arrived letters during the round
Procs
category_colorize	Converts subsystem to color
category_to_text	Converts subsystem to readable text
choose_pattern	Choosing mail pattern for specific recipient in accordance to all weights
create_mail_for_recipient	Creates a mail for a specific recipient
create_main_storage	Creates new main_storage on specific turf
delete_obsolete_mails	Deleting mails from sealed_mails list, which lifetime was expired, calling their mail/disappear() proc
generate_mails	Generate 'mail_gen_count' number of mails for random valid recipients in main_storage
parse_weights_to_html	Creates beatiful (maybe) HTML string from weights_assoc_list for debugging
regenerate_all_weights	Returns 'pattern type = modified weight' assoc list for specific recipient. If you want zero-chance patterns to be included in list, use include_zeros. Used in adminpanel. Filtering goes for specific categories, category or list of them passed in the 'categories' parameter. If 'MAIL_ALL_CATEGORIES' parameter was selected search goes for all categories Modification of weight for specific pattern can be specified in switch-case construction in this proc This modification can filter out incompatible (cookies for synths) patterns or take in accout recipient's prefs
register_mail	Registers mail, adding it to general list, where it will be destroyed in MAIL_DISAPPEAR_TIME if not opened
send_storage	Sends storage to cargo shuttle and creating new
unregister_mail	Unregister mail, removing it from lists

Var Details

var
all_patterns
– /static/list

Assoc list: pattern_name = pattern_object with all patterns, used in admin panel. Initialized in SSmail init.

var
all_patterns_by_category
– /static/list

Assoc list of all patterns by categories, initialized in SSmail/Initialize() proc

var
all_patterns_info
– /static/list

Assoc list: pattern_name = pattern_info_list with info about all patterns, used in admin panel. Initialized in SSmail init.

var
mail_categories_with_colors
– /static/list

Assoc list 'mail category' = 'mail category color'

var
mail_categories_with_names
– /static/list

Assoc list 'mail category' = 'mail category name'. Used in admin panel

var
mail_categories_with_weights
– /static/list

Assoc list 'mail category' = 'mail category weight'

var
mail_waiting
–

Count of mails, created by SSmail in main storage, waiting to be sent to station. Nullifies when storage was sent.

var
main_storage
– /obj/structure/closet/crate/mail

Main storage of SSmail, where mails are created

var
main_storage_spawnpoint
– /turf

Turf, where main mail storage of SSmail will be spawned

var
sealed_mails
– /list/obj/item/mail

Mails on station, which was not opened yet

var
total_mails_count
–

Total amount of arrived letters during the round

Proc Details

proc
category_colorize
(category)

Converts subsystem to color

proc
category_to_text
(category)

Converts subsystem to readable text

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

Choosing mail pattern for specific recipient in accordance to all weights

proc
create_mail_for_recipient
(/mob/living/carbon/human/recipient, /atom/mail_holder, /datum/mail_pattern/pattern, add_to_waiting_mails)

Creates a mail for a specific recipient

proc
create_main_storage
()

Creates new main_storage on specific turf

proc
delete_obsolete_mails
()

Deleting mails from sealed_mails list, which lifetime was expired, calling their mail/disappear() proc

proc
generate_mails
(mail_gen_count)

Generate 'mail_gen_count' number of mails for random valid recipients in main_storage

proc
parse_weights_to_html
(/list/weights_assoc_list)

Creates beatiful (maybe) HTML string from weights_assoc_list for debugging

proc
regenerate_all_weights
(/mob/living/carbon/human/recipient, categories, include_zeros)

Returns 'pattern type = modified weight' assoc list for specific recipient. If you want zero-chance patterns to be included in list, use include_zeros. Used in adminpanel. Filtering goes for specific categories, category or list of them passed in the 'categories' parameter. If 'MAIL_ALL_CATEGORIES' parameter was selected search goes for all categories Modification of weight for specific pattern can be specified in switch-case construction in this proc This modification can filter out incompatible (cookies for synths) patterns or take in accout recipient's prefs

proc
register_mail
(/obj/item/mail)

Registers mail, adding it to general list, where it will be destroyed in MAIL_DISAPPEAR_TIME if not opened

proc
send_storage
(/turf/destination)

Sends storage to cargo shuttle and creating new

proc
unregister_mail
(/obj/item/mail)

Unregister mail, removing it from lists

mail /datum/controller/subsystem/mail

Vars

Procs

Var Details

var all_patterns – /static/list

var all_patterns_by_category – /static/list

var all_patterns_info – /static/list

var mail_categories_with_colors – /static/list

var mail_categories_with_names – /static/list

var mail_categories_with_weights – /static/list

var mail_waiting –

var main_storage – /obj/structure/closet/crate/mail

var main_storage_spawnpoint – /turf

var sealed_mails – /list/obj/item/mail

var total_mails_count –

Proc Details

proc category_colorize(category)

proc category_to_text(category)

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

proc create_mail_for_recipient(/mob/living/carbon/human/recipient, /atom/mail_holder, /datum/mail_pattern/pattern, add_to_waiting_mails)

proc create_main_storage()

proc delete_obsolete_mails()

proc generate_mails(mail_gen_count)

proc parse_weights_to_html(/list/weights_assoc_list)

proc regenerate_all_weights(/mob/living/carbon/human/recipient, categories, include_zeros)

proc register_mail(/obj/item/mail)

proc send_storage(/turf/destination)

proc unregister_mail(/obj/item/mail)