/tg/ Station 13 - Modules - TypesVar Details - Proc Details

id

"Retro" ID card that renders itself as the icon state with no overlays.

Vars

accessAccess levels held by this card.
assignmentThe job name registered on the card (for example: Assistant).
mining_pointsHow many magical mining Disney Dollars this card has for spending at the mining equipment vendors.
my_storeLinked paystand.
registered_accountLinked bank account.
registered_ageRegistered owner's age.
registered_nameThe name registered on the card (for example: Dr Bryan See)
trimTrim datum associated with the card. Controls which job icon is displayed on the card and which accesses do not require wildcards.
wildcard_slotsList of wildcard slot names as keys with lists of wildcard data as values.

Procs

add_accessAttempts to add the given accesses to the ID card as non-wildcards.
add_wildcardsAttempts to add the given wildcards to the ID card.
alt_click_can_use_idHelper proc. Can the user alt-click the ID?
build_access_listsHelper proc. Creates access lists for the access procs.
can_add_wildcardsHelper proc, checks whether the ID card can hold any given set of wildcards.
clear_accessClears all accesses from the ID card - both wildcard and normal.
get_icon_sourceSimple helper proc. Returns the source of the icon for this card. Advanced cards can override this to return their icon that has been cached due to using overlays.
insert_moneyInsert credits or coins into the ID card and add their value to the associated bank account.
mass_insert_moneyInsert multiple money or money-equivalent items at once.
remove_accessRemoves the given accesses from the ID Card.
remove_wildcardsRemoves wildcards from the ID card.
set_accessAttempts to set the card's accesses to the given accesses, clearing all accesses not in the given list.
set_new_accountAttempts to set a new bank account on the ID card.
update_in_walletCalled on COMSIG_ATOM_UPDATED_ICON. Updates the visuals of the wallet this card is in.
update_labelUpdates 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).

mining_points

How many magical mining Disney Dollars this card has for spending at the mining equipment vendors.

my_store

Linked paystand.

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_wildcards

Attempts to add the given wildcards to the ID card.

Arguments:

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.

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:

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:

clear_access

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

get_icon_source

Simple helper proc. Returns the source of the icon for this card. Advanced cards can override this to return their icon that has been cached due to using overlays.

insert_money

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

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.

mass_insert_money

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.

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:

remove_wildcards

Removes wildcards from the ID card.

Arguments:

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:

set_new_account

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

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.