Implement Recurring and Placed Credits

[lostgeek]

Overview

Currently, paying costs is awaitable through pay-sync, but we delegate individual cost types to their own functions which may or may not individually be awaited, and right now paying credits is not. This PR introduces a new function that will check for any installed and active cards that have usable credits, and if so, will open a select prompt that's based on the pick-virus-counters-to-spend function (used for Khumalo and the Khumalo breakers) to pay or partially pay the appropriate cost.

Changelog

Costs

• Create new awaited cost handler for credits: pay-credits
• Wrote a bunch of helper functions to be used in that service
• Expand can-pay? to accept an eid to check installed cards for the appropriate credits
• Add :pay-credits to :interactions map, which connects the credits on the card (or a custom function) with the pay-credits function. It currently has 3 usable fields:
  • :req: Works as other reqs, checking to see whether the current action is the right kind to use this card's credits/ability
  • :type: Only 3 allowed values: :credit, :recurring, and :custom. :credit is for credits that are placed on the card (eg Miss Bones or Cold Read). :recurring is for recurring credits (eg Smoke or Dedicated Server). :custom is for cards that have payment-related abilities but aren't placed/recurring credits (eg Flame-out or Patchwork)
  • :custom: Only used when :type is :custom. Effectively an :effect map, it's an async 5-fn that should use make-result to return the amount of credits that will be applied to the effect.

Engine

• Update make-eid calls to use existing eid for passing along :source and :source-type where appropriate
• Update make-eid calls at base levels (actions) to provide the necessary :source-type
• Make advancing cards payment awaited
• Make removing tag payment awaited
• Make runner install payment awaited
• Add :play-area to all-active for each side

Runs

• Make paying for runs awaited
• Clean up can-pay logic so we know definitively if the runner can pay to trash a given card or not
• Make paying to trash an accessed card awaited, which cleans up the issue of repeatedly showing the prompt if you haven't taken enough credits from cards
• Fix bug where handle-run-end would dissoc :access even tho it was still happening

Traces

• Refactor/clean up to be properly awaited
• Pull out traces as their own process in prompt-handling logic, so as to display the true number of available credits
• Pull out traces in the UI logic as well to handle the above
• Remove paying for traces in prompt-handling, use pay-sync within trace prompts where appropriate

Cards

See below for full list of implemented cards

Tests

See below for full list of implemented cards. Every single one got a small test for this functionality

[lostgeek]

Cards that benefit from this implementation

• Installing cards (runner)
  • Cyberfeeder (virus)
  • Cybsoft MacroDrive
  • Ice Analyzer
  • Inside Man
  • Sahasrara
  • Patchwork
• Stealth
  • Cloak
  • Cold Read
  • Dyson Fractal Generator
  • Smoke
  • Ghost Runner
  • Lockpick
  • Net Mercur
  • Silencer
  • Trickster Taka
• Paid abilities on icebreakers/programs
  • Cyberfeeder
  • Flame-out
  • Multithreader
  • Omni-drive
  • Spinal Modem
  • The Toolbox
• Credits during the run
  • Maui
  • Net Celebrity
  • Pheromones
• Trashing cards
  • Miss Bones
  • Paricia
  • Scrubber
  • Whizzard
• Play events
  • Prepaid VoicePAD
  • Public Terminal
  • Patchwork
• Removing Tags
  • Crash Space
• Rez cards
  • Dedicated Server
  • Khondi Plaza
  • Mumba Temple
  • The Root
• Installing cards (Corp)
  • Dedicated Technician Team
  • The Root
• Advance cards
  • Simone Diego
  • Weyland Because We Built It
  • The Root
• Traces
  • Compromised Employee
  • NBN:MN
  • Net Police
  • Primary Transmission Dish

[NoahTheDuke]

I think Net Mercur needs a better req, but I’m loving this.

[lostgeek]

ToDo List

• Make play-auto-pump awaitable and group together costs
  • Will be done in Implement Subroutine Tracking #4265
• Build a break-ice-full mechanism to group together all breaking related costs
  • Will be done in Implement Subroutine Tracking #4265
• Include credit providing cards in can-pay?
• Write tests for installing cards (Runner)
• Write tests for Stealth
• Write tests for paid abilities on icebreakers/programs
• Write tests for credits during the run
• Write tests for trashing cards
• Write tests for playing events
• Write tests for removing tags
• Write tests for rezzing cards
• Write tests for installing cards (Corp)
• Write tests for advancing cards
• Write tests for traces
• Check why Flame-out doesn't produce a message when using the breaker on it

[NoahTheDuke]

With removing tags, make sure you effect-complete payment and non-payment.

[lostgeek]

Since removing tags is now awaitable, I should test a case of Sahasrara + Thunder Art Gallery to check if all the prompts are handled correctly.

[lostgeek]

I think we're done here! 🎊

[NoahTheDuke]

Thinking about Net Mercur more, I think we could get 80% by requiring :icebreaker, :run, or :trace. By my count, that will cover nearly all uses. If someone wants to use it to play or install, they can manually take credits off. Everything else I can think of falls under those uses.

What do you think?

[NoahTheDuke]

Closes #362