id
/obj/item/card/id

"Retro" ID card that renders itself as the icon state with no overlays. Request Emergency Temporary Access - ID Card Extensions code\modules\reta\reta_system.dm

Vars
access	Access levels held by this card.
assignment	The job name registered on the card (for example: Assistant).
big_pointer	If true, the wearer will have bigger arrow when pointing at things. Passed down by trims.
chosen_honorific	What is our selected honorific?
honorific_position	Will this ID card use the first or last name as the name displayed with the honorific?
is_intern	Boolean value. If TRUE, the [Intern] tag gets prepended to this ID card when the label is updated.
pointer_color	If set, the arrow will have a different color.
registered_account	Linked bank account.
registered_age	Registered owner's age.
registered_name	The name registered on the card (for example: Dr Bryan See)
reta_temp_access	Dictionary of temporary department access: dept_name -> list(access_flags)
reta_timers	Dictionary of timer IDs for clearing temporary access: dept_name -> timer_id
trim	Trim datum associated with the card. Controls which job icon is displayed on the card and which accesses do not require wildcards.
trim_changeable	Whether the trim on this card can be changed.
wildcard_slots	List of wildcard slot names as keys with lists of wildcard data as values.
Procs
Destroy	Cleanup temporary access when ID card is deleted
add_access	Attempts to add the given accesses to the ID card as non-wildcards.
add_wildcards	Attempts to add the given wildcards to the ID card.
alt_click_can_use_id	Helper proc. Can the user alt-click the ID?
build_access_lists	Helper proc. Creates access lists for the access procs.
can_add_wildcards	Helper proc, checks whether the ID card can hold any given set of wildcards.
can_be_used_in_payment	Helper proc that determines if a card can be used in certain types of payment transactions.
clear_access	Clears all accesses from the ID card - both wildcard and normal.
clear_account	Clears the economy account from the ID card.
clear_reta_access	Clears all temporary department access from this ID card
clear_reta_access_for_dept	Clears temporary access for a specific department
equip_to_item_loc	ID card is being equipped to an item (like a pda or wallet)
get_displayed_name	Getter for the registered name, with optional honorifics
get_id_holder	Helper to get the human holding this ID card
get_reta_access	Gets all current temporary access flags for this ID card
get_reta_access_for_dept	Gets temporary access flags for a specific department
get_reta_summary	Gets a summary of all active RETA accesses (for debugging/display)
get_trim_assignment	Returns the trim assignment name.
get_trim_sechud_icon	Returns the trim sechud icon state.
get_trim_sechud_icon_state	Returns the trim sechud icon state.
grant_reta_access	Grants temporary department access to this ID card
has_any_reta_access	Checks if this ID card has any temporary access
has_reta_access	Checks if this ID card has temporary access to a specific flag
has_reta_access_for_dept	Checks if this ID card has temporary access for a specific department
insert_money	Insert credits or coins into the ID card and add their value to the associated bank account.
mass_insert_money	Insert multiple money or money-equivalent items at once.
remove_access	Removes the given accesses from the ID Card.
remove_wildcards	Removes wildcards from the ID card.
retrieve_access	Called when we're being used as access.
set_access	Attempts to set the card's accesses to the given accesses, clearing all accesses not in the given list.
set_account	Sets the bank account for the ID card.
set_new_account	Attempts to set a new bank account on the ID card.
unequip_from_item_loc	ID card is being unequipped from an item (like a pda or wallet)
update_honorific	Re-generates the honorific title. Returns the compiled honorific_title value
update_in_wallet	Called on COMSIG_ATOM_UPDATED_ICON. Updates the visuals of the wallet this card is in.
update_label	Updates the name based on the card's vars and state.

Var Details

var
access
– /list

Access levels held by this card.

var
assignment

The job name registered on the card (for example: Assistant).

var
big_pointer

If true, the wearer will have bigger arrow when pointing at things. Passed down by trims.

var
chosen_honorific

What is our selected honorific?

var
honorific_position

Will this ID card use the first or last name as the name displayed with the honorific?

var
is_intern

Boolean value. If TRUE, the [Intern] tag gets prepended to this ID card when the label is updated.

var
pointer_color

If set, the arrow will have a different color.

var
registered_account
– /datum/bank_account

Linked bank account.

var
registered_age

Registered owner's age.

var
registered_name

The name registered on the card (for example: Dr Bryan See)

var
reta_temp_access
– /list

Dictionary of temporary department access: dept_name -> list(access_flags)

var
reta_timers
– /list

Dictionary of timer IDs for clearing temporary access: dept_name -> timer_id

var
trim
– /datum/id_trim

Trim datum associated with the card. Controls which job icon is displayed on the card and which accesses do not require wildcards.

var
trim_changeable

Whether the trim on this card can be changed.

var
wildcard_slots
– /list

List of wildcard slot names as keys with lists of wildcard data as values.

Proc Details

↑
Destroy
()

Cleanup temporary access when ID card is deleted

proc
add_access
(/list/add_accesses, try_wildcard, mode)

Attempts to add the given accesses to the ID card as non-wildcards.

Depending on the mode, may add accesses as wildcards or error if it can't add them as non-wildcards. Arguments:

add_accesses - List of accesses to check.
try_wildcard - If not null, will attempt to add all accesses that require wildcard slots to this wildcard slot only.
mode - The method to use when adding accesses. See define for ERROR_ON_FAIL

proc
add_wildcards
(/list/wildcard_list, try_wildcard, mode)

Attempts to add the given wildcards to the ID card.

Arguments:

wildcard_list - List of accesses to add.
try_wildcard - If not null, will attempt to add all wildcards to this wildcard slot only.
mode - The method to use when adding wildcards. See define for ERROR_ON_FAIL

proc
alt_click_can_use_id
(/mob/living/user)

Helper proc. Can the user alt-click the ID?

proc
build_access_lists
(/list/accesses, /list/basic_access_list, /list/wildcard_access_list)

Helper proc. Creates access lists for the access procs.

Takes the accesses list and compares it with the trim. Any basic accesses that match the trim are added to basic_access_list and the rest are added to wildcard_access_list.

This proc directly modifies the lists passed in as args. It expects these lists to be instantiated. There is no return value. Arguments:

accesses - List of accesses you want to stort into basic_access_list and wildcard_access_list. Should not be null.
basic_access_list - Mandatory argument. The proc modifies the list passed in this argument and adds accesses the trim supports to it.
wildcard_access_list - Mandatory argument. The proc modifies the list passed in this argument and adds accesses the trim does not support to it.

proc
can_add_wildcards
(/list/wildcard_list, try_wildcard)

Helper proc, checks whether the ID card can hold any given set of wildcards.

Returns TRUE if the card can hold the wildcards, FALSE otherwise. Arguments:

wildcard_list - List of accesses to check.
try_wildcard - If not null, will attempt to add wildcards for this wildcard specifically and will return FALSE if the card cannot hold all wildcards in this slot.

proc
can_be_used_in_payment
(/mob/living/user)

Helper proc that determines if a card can be used in certain types of payment transactions.

proc
clear_access
()

Clears all accesses from the ID card - both wildcard and normal.

proc
clear_account
()

Clears the economy account from the ID card.

proc
clear_reta_access
()

Clears all temporary department access from this ID card

proc
clear_reta_access_for_dept
(dept)

Clears temporary access for a specific department

proc
equip_to_item_loc
(/atom/new_loc)

ID card is being equipped to an item (like a pda or wallet)

↑
get_displayed_name
(honorifics)

Getter for the registered name, with optional honorifics

proc
get_id_holder
()

Helper to get the human holding this ID card

proc
get_reta_access
()

Gets all current temporary access flags for this ID card

proc
get_reta_access_for_dept
(dept)

Gets temporary access flags for a specific department

proc
get_reta_summary
()

Gets a summary of all active RETA accesses (for debugging/display)

proc
get_trim_assignment
()

Returns the trim assignment name.

proc
get_trim_sechud_icon
()

Returns the trim sechud icon state.

proc
get_trim_sechud_icon_state
()

Returns the trim sechud icon state.

proc
grant_reta_access
(dept, duration_ds)

Grants temporary department access to this ID card

proc
has_any_reta_access
()

Checks if this ID card has any temporary access

proc
has_reta_access
(access_flag)

Checks if this ID card has temporary access to a specific flag

proc
has_reta_access_for_dept
(dept)

Checks if this ID card has temporary access for a specific department

proc
insert_money
(/obj/item/money, /mob/user)

Insert credits or coins into the ID card and add their value to the associated bank account.

Returns TRUE if the money was successfully inserted, FALSE otherwise. Arguments: money - The item to attempt to convert to credits and insert into the card. user - The user inserting the item. physical_currency - Boolean, whether this is a physical currency such as a coin and not a holochip.

proc
mass_insert_money
(/list/money, /mob/user)

Insert multiple money or money-equivalent items at once.

Arguments: money - List of items to attempt to convert to credits and insert into the card. user - The user inserting the items.

proc
remove_access
(/list/rem_accesses)

Removes the given accesses from the ID Card.

Will remove the wildcards if the accesses given are on the card as wildcard accesses. Arguments:

rem_accesses - List of accesses to remove.

proc
remove_wildcards
(/list/wildcard_list)

Removes wildcards from the ID card.

Arguments:

wildcard_list - List of accesses to remove.

proc
retrieve_access
(/datum/source, /list/player_access)

Called when we're being used as access.

proc
set_access
(/list/new_access_list, mode)

Attempts to set the card's accesses to the given accesses, clearing all accesses not in the given list.

Depending on the mode, may add accesses as wildcards or error if it can't add them as non-wildcards. Arguments:

new_access_list - List of all accesses that this card should hold exclusively.
mode - The method to use when setting accesses. See define for ERROR_ON_FAIL

proc
set_account
(/datum/bank_account/account, transfer_funds)

Sets the bank account for the ID card.

proc
set_new_account
(/mob/living/user)

Attempts to set a new bank account on the ID card.

proc
unequip_from_item_loc
(/atom/old_loc)

ID card is being unequipped from an item (like a pda or wallet)

proc
update_honorific
()

Re-generates the honorific title. Returns the compiled honorific_title value

proc
update_in_wallet
()

Called on COMSIG_ATOM_UPDATED_ICON. Updates the visuals of the wallet this card is in.

proc
update_label
()

Updates the name based on the card's vars and state.

id /obj/item/card/id

Vars

Procs

Var Details

var access – /list

var assignment

var big_pointer

var chosen_honorific

var honorific_position

var is_intern

var pointer_color

var registered_account – /datum/bank_account

var registered_age

var registered_name

var reta_temp_access – /list

var reta_timers – /list

var trim – /datum/id_trim

var trim_changeable

var wildcard_slots – /list

Proc Details

↑Destroy()

proc add_access(/list/add_accesses, try_wildcard, mode)

proc add_wildcards(/list/wildcard_list, try_wildcard, mode)

proc alt_click_can_use_id(/mob/living/user)

proc build_access_lists(/list/accesses, /list/basic_access_list, /list/wildcard_access_list)

proc can_add_wildcards(/list/wildcard_list, try_wildcard)

proc can_be_used_in_payment(/mob/living/user)

proc clear_access()

proc clear_account()

proc clear_reta_access()

proc clear_reta_access_for_dept(dept)

proc equip_to_item_loc(/atom/new_loc)

↑get_displayed_name(honorifics)

proc get_id_holder()

proc get_reta_access()

proc get_reta_access_for_dept(dept)

proc get_reta_summary()

proc get_trim_assignment()

proc get_trim_sechud_icon()

proc get_trim_sechud_icon_state()

proc grant_reta_access(dept, duration_ds)

proc has_any_reta_access()

proc has_reta_access(access_flag)

proc has_reta_access_for_dept(dept)

proc insert_money(/obj/item/money, /mob/user)

proc mass_insert_money(/list/money, /mob/user)

proc remove_access(/list/rem_accesses)

proc remove_wildcards(/list/wildcard_list)

proc retrieve_access(/datum/source, /list/player_access)

proc set_access(/list/new_access_list, mode)

proc set_account(/datum/bank_account/account, transfer_funds)

proc set_new_account(/mob/living/user)

proc unequip_from_item_loc(/atom/old_loc)

proc update_honorific()

proc update_in_wallet()

proc update_label()