id
"Retro" ID card that renders itself as the icon state with no overlays.
Vars | |
access | Access levels held by this card. |
---|---|
assignment | The job name registered on the card (for example: Assistant). Set by trim usually. |
blood_type | Registered owner's blood type. |
cached_flat_icon | Cached icon that has been built for this card. Intended for use in chat. |
dna_hash | Registered owner's dna hash. |
fingerprint | Registered owner's fingerprint. |
is_intern | Boolean value. If TRUE, the [Intern] tag gets prepended to this ID card when the label is updated. |
label | The name used in the ID UI. See update_label() |
mining_points | How many magical mining Disney Dollars this card has for spending at the mining equipment vendors. |
registered_account | Linked bank account. |
registered_age | Registered owner's age. |
registered_name | The name registered on the card (for example: Dr Bryan See) |
trim | Trim datum associated with the card. Controls which job icon is displayed on the card and which accesses do not require wildcards. |
wildcard_slots | List of wildcard slot names as keys with lists of wildcard data as values. |
Procs | |
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. |
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_use_id | Helper proc. Can the user interact with the ID? |
clear_access | Clears all accesses from the ID card - both wildcard and normal. |
clear_account | Clears the economy account from the ID card. |
get_cached_flat_icon | If no cached_flat_icon exists, this proc creates it and crops it. This proc then returns the cached_flat_icon. Intended only for use displaying ID card icons in chat. |
get_trim_assignment | Returns the trim assignment name. |
get_trim_sechud_icon_state | Returns the trim sechud icon state. |
remove_access | Removes the given accesses from the ID Card. |
remove_wildcards | Removes wildcards from the ID card. |
set_access | Attempts to set the card's accesses to the given accesses, clearing all accesses not in the given list. |
set_icon | Sets the UI icon of the ID to their datacore entry, or their current appearance if no record is found. |
set_new_account | Attempts to set a new bank account on the ID card. |
update_label | Updates the name based on the card's vars and state. |
Var Details
access
Access levels held by this card.
assignment
The job name registered on the card (for example: Assistant). Set by trim usually.
blood_type
Registered owner's blood type.
cached_flat_icon
Cached icon that has been built for this card. Intended for use in chat.
dna_hash
Registered owner's dna hash.
fingerprint
Registered owner's fingerprint.
is_intern
Boolean value. If TRUE, the [Intern] tag gets prepended to this ID card when the label is updated.
label
The name used in the ID UI. See update_label()
mining_points
How many magical mining Disney Dollars this card has for spending at the mining equipment vendors.
registered_account
Linked bank account.
registered_age
Registered owner's age.
registered_name
The name registered on the card (for example: Dr Bryan See)
trim
Trim datum associated with the card. Controls which job icon is displayed on the card and which accesses do not require wildcards.
wildcard_slots
List of wildcard slot names as keys with lists of wildcard data as values.
Proc Details
add_access
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
add_wildcards
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
build_access_lists
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.
can_add_wildcards
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.
can_use_id
Helper proc. Can the user interact with the ID?
clear_access
Clears all accesses from the ID card - both wildcard and normal.
clear_account
Clears the economy account from the ID card.
get_cached_flat_icon
If no cached_flat_icon exists, this proc creates it and crops it. This proc then returns the cached_flat_icon. Intended only for use displaying ID card icons in chat.
get_trim_assignment
Returns the trim assignment name.
get_trim_sechud_icon_state
Returns the trim sechud icon state.
remove_access
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.
remove_wildcards
Removes wildcards from the ID card.
Arguments:
- wildcard_list - List of accesses to remove.
set_access
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
set_icon
Sets the UI icon of the ID to their datacore entry, or their current appearance if no record is found.
set_new_account
Attempts to set a new bank account on the ID card.
update_label
Updates the name based on the card's vars and state.