API Specifications (Tentative) - brandonandzeus/Trainworks2 GitHub Wiki

MT-BaseMod Tentative Specifications

Adding Custom Game Objects

  • Cards
  • Clans
  • Buffs & Effects
  • Keywords
  • Artifacts
  • Enemies/Bosses
  • Units/Champions
  • Map Nodes
  • Map Areas (Rings)

New Game Objects

  • Potions

Hooks

  • Add card to deck
  • Artifact pickup
  • Artifact triggers
  • Battle end
  • Battle phase changes
  • Battle start
  • Card Enhanced
  • Card Pool setup
  • Card Reward
  • Card added to hand (not drawn)
  • Card consumed
  • Card discarded
  • Card drawn
  • Card triggered Offering
  • Card used
  • Death
  • Ember recharge
  • Enemy enters train
  • Floor capacity changed
  • Floor frozen (by boss)
  • Hand drawn (start of turn)
  • MaxHP Change
  • Post-Use of map objects (heal, shop, etc)
  • Potion use
  • Powers modified (buffs/statuses applied anywhere)
  • Re-roll in shop
  • Remove card from deck
  • Run end
  • Run win
  • Start new ring of hell
  • Starting Deck created
  • Unit Draft
  • Unit ascended
  • Unit damaged
  • Unit descended
  • Unit healed
  • Unit killed
  • Unit moved floors
  • Unit sacrificed
  • Unit summoned

UI Changes

  • Disable/Remove Multiplayer button
  • UI space for custom clans
  • Arrows for selecting alternate Champions for each clan at start of run
  • UI options for modifying start of run settings on the run start screen
  • Ability for cards to target multi-floors or entire train (if not already possible?)
  • Potions UI for displaying and using them

Dev Console

  • Add cards to Hand/Deck
  • Add/Remove buffs/status effects to Units
  • Consume cards from Hand/Deck
  • Damage/Kill enemies
  • Draw cards
  • Fight specific encounters
  • Gain/Lose Ember
  • Gain/Lose Max Pyre HP
  • Gain/Lose Pyre HP
  • Gain/Lose gold
  • Increase/decrease floor capacity
  • Obtain/Remove Artifacts and potions
  • Skip/Replay specific rings of hell

Misc

  • Saving/loading custom data (for Strings, integers, lists, etc. to be savable by mods. Like CustomSavable from StS-BaseMod)