Files
Bubberstation/code/modules/cargo/universal_scanner.dm
T
Profakos fe27d3198e Cargo category cleanup (#75374)
## About The Pull Request

I accidentally discovered that when #55504 removed cargo export
categories being a thing during export value evaluation, in two
instances, they forgot to remove passing over the now defunct export
categories, causing it to be passed in as the elasticity value, and by
sheer coincidence, this was not causing problems (due to being overriden
by a named argument in the pirates case, and cargo_exports being
evaluated as true in another).

This PR fixes the arguments, preventing possible bugs in the future.
This also removes the code that set if the cargo shuttle could sell
contraband and emagged items, as that is no longer a thing. I talked
with @ArcaneMusic about this, and they agreed, albeit with the caveat
that if someone finds a good use case for this feature, it could be
saved.

This PR also autodocs several export related files, and cleans up
various single and two letter vars.

## Why It's Good For The Game

Cleaner code, unused code removed.

## Changelog

🆑
code: cleaned up cargo export code a bit
/🆑
2023-05-12 20:43:00 -06:00

240 lines
9.7 KiB
Plaintext

#define PAPER_PER_SHEET 10
/obj/item/universal_scanner
name = "universal scanner"
desc = "A device used to check objects against Nanotrasen exports database, assign price tags, or ready an item for a custom vending machine."
icon = 'icons/obj/device.dmi'
icon_state = "export scanner"
inhand_icon_state = "radio"
lefthand_file = 'icons/mob/inhands/items/devices_lefthand.dmi'
righthand_file = 'icons/mob/inhands/items/devices_righthand.dmi'
item_flags = NOBLUDGEON
w_class = WEIGHT_CLASS_SMALL
/// Which mode is the scanner currently on?
var/scanning_mode = SCAN_EXPORTS
/// A list of all available export scanner modes.
var/list/scale_mode = list()
/// The paper currently stored by the export scanner.
var/paper_count = 10
/// The maximum paper to be stored by the export scanner.
var/max_paper_count = 20
/// The price of the item used by price tagger mode.
var/new_custom_price = 1
/// The account which is receiving the split profits in sales tagger mode.
var/datum/bank_account/payments_acc = null
/// The person who tagged this will receive the sale value multiplied by this number in sales tagger mode.
var/cut_multiplier = 0.5
/// Maximum value for cut_multiplier in sales tagger mode.
var/cut_max = 0.5
/// Minimum value for cut_multiplier in sales tagger mode.
var/cut_min = 0.01
/obj/item/universal_scanner/Initialize(mapload)
. = ..()
scale_mode = sort_list(list(
"export scanner" = image(icon = src.icon, icon_state = "export scanner"),
"price tagger" = image(icon = src.icon, icon_state = "price tagger"),
"sales tagger" = image(icon = src.icon, icon_state = "sales tagger"),
))
register_context()
/obj/item/universal_scanner/attack_self(mob/user, modifiers)
. = ..()
var/choice = show_radial_menu(user, src, scale_mode, custom_check = CALLBACK(src, PROC_REF(check_menu), user), radius = 36, require_near = TRUE)
if(!choice)
return FALSE
if(icon_state == "[choice]")
return FALSE
switch(choice)
if("export scanner")
scanning_mode = SCAN_EXPORTS
if("price tagger")
scanning_mode = SCAN_PRICE_TAG
if("sales tagger")
scanning_mode = SCAN_SALES_TAG
icon_state = "[choice]"
playsound(src, 'sound/machines/click.ogg', 40, TRUE)
/obj/item/universal_scanner/afterattack(obj/object, mob/user, proximity)
. = ..()
if(!istype(object) || !proximity)
return
. |= AFTERATTACK_PROCESSED_ITEM
if(scanning_mode == SCAN_EXPORTS)
export_scan(object, user)
return .
if(scanning_mode == SCAN_PRICE_TAG)
price_tag(target = object, user = user)
return .
/obj/item/universal_scanner/attackby(obj/item/attacking_item, mob/user, params)
. = ..()
if(scanning_mode == SCAN_SALES_TAG && isidcard(attacking_item))
var/obj/item/card/id/potential_acc = attacking_item
if(potential_acc.registered_account)
if(payments_acc == potential_acc.registered_account)
to_chat(user, span_notice("ID card already registered."))
return
else
payments_acc = potential_acc.registered_account
playsound(src, 'sound/machines/ping.ogg', 40, TRUE)
to_chat(user, span_notice("[src] registers the ID card. Tag a wrapped item to create a barcode."))
else if(!potential_acc.registered_account)
to_chat(user, span_warning("This ID card has no account registered!"))
return
if(istype(attacking_item, /obj/item/paper))
if (!(paper_count >= max_paper_count))
paper_count += PAPER_PER_SHEET
qdel(attacking_item)
if (paper_count >= max_paper_count)
paper_count = max_paper_count
to_chat(user, span_notice("[src]'s paper supply is now full."))
return
to_chat(user, span_notice("You refill [src]'s paper supply, you have [paper_count] left."))
else
to_chat(user, span_notice("[src]'s paper supply is full."))
/obj/item/universal_scanner/attack_self_secondary(mob/user, modifiers)
. = ..()
if(scanning_mode == SCAN_SALES_TAG)
if(paper_count <= 0)
to_chat(user, span_warning("You're out of paper!'."))
return
if(!payments_acc)
to_chat(user, span_warning("You need to swipe [src] with an ID card first."))
return
paper_count--
playsound(src, 'sound/machines/click.ogg', 40, TRUE)
to_chat(user, span_notice("You print a new barcode."))
var/obj/item/barcode/new_barcode = new /obj/item/barcode(src)
new_barcode.payments_acc = payments_acc // The sticker gets the scanner's registered account.
new_barcode.cut_multiplier = cut_multiplier // Also the registered percent cut.
user.put_in_hands(new_barcode)
if(scanning_mode == SCAN_PRICE_TAG)
if(loc != user)
to_chat(user, span_warning("You must be holding \the [src] to continue!"))
return
var/chosen_price = tgui_input_number(user, "Set price", "Price", new_custom_price)
if(!chosen_price || QDELETED(user) || QDELETED(src) || !user.can_perform_action(src, FORBID_TELEKINESIS_REACH) || loc != user)
return
new_custom_price = chosen_price
to_chat(user, span_notice("[src] will now give things a [new_custom_price] cr tag."))
/obj/item/universal_scanner/CtrlClick(mob/user)
. = ..()
if(scanning_mode == SCAN_SALES_TAG)
payments_acc = null
to_chat(user, span_notice("You clear the registered account."))
/obj/item/universal_scanner/AltClick(mob/user)
. = ..()
if(!scanning_mode == SCAN_SALES_TAG)
return
var/potential_cut = input("How much would you like to pay out to the registered card?","Percentage Profit ([round(cut_min*100)]% - [round(cut_max*100)]%)") as num|null
if(!potential_cut)
cut_multiplier = initial(cut_multiplier)
cut_multiplier = clamp(round(potential_cut/100, cut_min), cut_min, cut_max)
to_chat(user, span_notice("[round(cut_multiplier*100)]% profit will be received if a package with a barcode is sold."))
/obj/item/universal_scanner/examine(mob/user)
. = ..()
. += span_notice("It has [paper_count]/[max_paper_count] available barcodes. Refill with paper.")
if(scanning_mode == SCAN_SALES_TAG)
. += span_notice("Profit split on sale is currently set to [round(cut_multiplier*100)]%. <b>Alt-click</b> to change.")
if(payments_acc)
. += span_notice("<b>Ctrl-click</b> to clear the registered account.")
if(scanning_mode == SCAN_PRICE_TAG)
. += span_notice("The current custom price is set to [new_custom_price] cr. <b>Right-click</b> to change.")
/obj/item/universal_scanner/add_context(atom/source, list/context, obj/item/held_item, mob/user)
switch(scanning_mode)
if(SCAN_SALES_TAG)
context[SCREENTIP_CONTEXT_LMB] = "Tag package"
context[SCREENTIP_CONTEXT_ALT_LMB] = "Change price"
context[SCREENTIP_CONTEXT_CTRL_LMB] = "Clear target account"
context[SCREENTIP_CONTEXT_ALT_LMB] = "Change payout %"
if(SCAN_PRICE_TAG)
context[SCREENTIP_CONTEXT_LMB] = "Price item"
context[SCREENTIP_CONTEXT_RMB] = "Set price"
if(SCAN_EXPORTS)
context[SCREENTIP_CONTEXT_LMB] = "Scan for export value"
return CONTEXTUAL_SCREENTIP_SET
/**
* Scans an object, target, and provides it's export value based on selling to the cargo shuttle, to mob/user.
*/
/obj/item/universal_scanner/proc/export_scan(obj/target, mob/user)
// Before you fix it:
// yes, checking manifests is a part of intended functionality.
var/datum/export_report/report = export_item_and_contents(target, dry_run = TRUE)
var/price = 0
for(var/exported_datum in report.total_amount)
price += report.total_value[exported_datum]
if(price)
to_chat(user, span_notice("Scanned [target], value: <b>[price]</b> credits[target.contents.len ? " (contents included)" : ""]."))
else
to_chat(user, span_warning("Scanned [target], no export value."))
if(ishuman(user))
var/mob/living/carbon/human/scan_human = user
if(istype(target, /obj/item/bounty_cube))
var/obj/item/bounty_cube/cube = target
var/datum/bank_account/scanner_account = scan_human.get_bank_account()
if(!istype(get_area(cube), /area/shuttle/supply))
to_chat(user, span_warning("Shuttle placement not detected. Handling tip not registered."))
else if(cube.bounty_handler_account)
to_chat(user, span_warning("Bank account for handling tip already registered!"))
else if(scanner_account)
cube.AddComponent(/datum/component/pricetag, scanner_account, cube.handler_tip, FALSE)
cube.bounty_handler_account = scanner_account
cube.bounty_handler_account.bank_card_talk("Bank account for [price ? "<b>[price * cube.handler_tip]</b> credit " : ""]handling tip successfully registered.")
if(cube.bounty_holder_account != cube.bounty_handler_account) //No need to send a tracking update to the person scanning it
cube.bounty_holder_account.bank_card_talk("<b>[cube]</b> was scanned in \the <b>[get_area(cube)]</b> by <b>[scan_human] ([scan_human.job])</b>.")
else
to_chat(user, span_warning("Bank account not detected. Handling tip not registered."))
/**
* Scans an object, target, and sets it's custom_price variable to new_custom_price, presenting it to the user.
*/
/obj/item/universal_scanner/proc/price_tag(obj/target, mob/user)
if(isitem(target))
var/obj/item/selected_target = target
selected_target.custom_price = new_custom_price
to_chat(user, span_notice("You set the price of [selected_target] to [new_custom_price] cr."))
/**
* check_menu: Checks if we are allowed to interact with a radial menu
*
* Arguments:
* * user The mob interacting with a menu
*/
/obj/item/universal_scanner/proc/check_menu(mob/living/user)
if(!istype(user))
return FALSE
if(user.incapacitated())
return FALSE
return TRUE
/obj/item/barcode
name = "barcode tag"
desc = "A tiny tag, associated with a crewmember's account. Attach to a wrapped item to give that account a portion of the wrapped item's profit."
icon = 'icons/obj/bureaucracy.dmi'
icon_state = "barcode"
w_class = WEIGHT_CLASS_TINY
//All values inherited from the sales tagger it came from.
///The bank account assigned to pay out to from the sales tagger.
var/datum/bank_account/payments_acc = null
///The percentage of profit to give to the payments_acc, from 0 to 1.
var/cut_multiplier = 0.5
#undef PAPER_PER_SHEET