mail_pattern

Vars
bad_feeling	If this property is not null, mail shows to opener this message with choices: to open or not to open
blacklisted_jobs	List of blacklisted jobs. Pattern will not be available if owner assigned role is one of them
blacklisted_quirks	List of blacklisted quirk types. Pattern will not be available if owner has one of them
blacklisted_roundtypes	List of blacklisted roundtypes (Extended, Dynamic Hard, etc). Pattern will not be available during them
blacklisted_species	List of blacklisted species types. Pattern will not be available if owner has one of them
category	Category of letter
envelope_type	Envelope / Package
initial_contents	Created items during pattern applying. If items should be customised, override apply() proc
letter_desc	Description for text letter in envelope
letter_html	HTML for text letter in envelope
letter_icon	Icon file for text letter in envelope
letter_icon_state	Icon state for text letter in envelope
letter_title	Name for text letter in envelope
mindshield_prohibited	Will the mindshield implant in the recipient disable this pattern?
mindshield_required	Is the mindshield implant required to get this pattern?
parent	Envelope, to which this pattern assigned
weight	Weight (chance) of getting this lettertype
whitelisted_jobs	List of whitelisted jobs. Pattern will be available only if owner assigned role is one of them
whitelisted_quirks	List of whitelisted quirk types. Pattern will be available only if owner has one of them
whitelisted_roundtypes	List of whitelisted roundtypes. (Extended, Dynamic Hard, etc). Pattern will be available only during them
whitelisted_species	List of whitelisted species types. Pattern will be available only if owner has one of them
Procs
apply	Proc, that applies settings of this pattern to piece of mail, for example customising text, creating letter and contents
on_mail_open	Special effects of pattern, when envelope is opened
regenerate_weight	Returns weight of selected pattern in accordance to all filters and checks, applied to specific recipient
special_open_check	Special check of pattern, that called by mail/try_open() proc. If returns FALSE, piece of mail will not be open.
text_customisation	Customising text piece for specific recipient

Var Details

var
bad_feeling
–

If this property is not null, mail shows to opener this message with choices: to open or not to open

var
blacklisted_jobs
– /list

List of blacklisted jobs. Pattern will not be available if owner assigned role is one of them

var
blacklisted_quirks
– /list

List of blacklisted quirk types. Pattern will not be available if owner has one of them

var
blacklisted_roundtypes
– /list

List of blacklisted roundtypes (Extended, Dynamic Hard, etc). Pattern will not be available during them

var
blacklisted_species
– /list

List of blacklisted species types. Pattern will not be available if owner has one of them

var
category
–

Category of letter

var
envelope_type
–

Envelope / Package

var
initial_contents
– /list/obj/item

Created items during pattern applying. If items should be customised, override apply() proc

var
letter_desc
–

Description for text letter in envelope

var
letter_html
–

HTML for text letter in envelope

var
letter_icon
–

Icon file for text letter in envelope

var
letter_icon_state
–

Icon state for text letter in envelope

var
letter_title
–

Name for text letter in envelope

var
mindshield_prohibited
–

Will the mindshield implant in the recipient disable this pattern?

var
mindshield_required
–

Is the mindshield implant required to get this pattern?

var
parent
– /obj/item/mail

Envelope, to which this pattern assigned

var
weight
–

Weight (chance) of getting this lettertype

var
whitelisted_jobs
– /list

List of whitelisted jobs. Pattern will be available only if owner assigned role is one of them

var
whitelisted_quirks
– /list

List of whitelisted quirk types. Pattern will be available only if owner has one of them

var
whitelisted_roundtypes
– /list

List of whitelisted roundtypes. (Extended, Dynamic Hard, etc). Pattern will be available only during them

var
whitelisted_species
– /list

List of whitelisted species types. Pattern will be available only if owner has one of them

Proc Details

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

Proc, that applies settings of this pattern to piece of mail, for example customising text, creating letter and contents

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

Special effects of pattern, when envelope is opened

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

Returns weight of selected pattern in accordance to all filters and checks, applied to specific recipient

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

Special check of pattern, that called by mail/try_open() proc. If returns FALSE, piece of mail will not be open.

proc
text_customisation
(text, /mob/living/carbon/human/recipient)

Customising text piece for specific recipient

mail_pattern /datum/mail_pattern

Vars

Procs

Var Details

var bad_feeling –

var blacklisted_jobs – /list

var blacklisted_quirks – /list

var blacklisted_roundtypes – /list

var blacklisted_species – /list

var category –

var envelope_type –

var initial_contents – /list/obj/item

var letter_desc –

var letter_html –

var letter_icon –

var letter_icon_state –

var letter_title –

var mindshield_prohibited –

var mindshield_required –

var parent – /obj/item/mail

var weight –

var whitelisted_jobs – /list

var whitelisted_quirks – /list

var whitelisted_roundtypes – /list

var whitelisted_species – /list