R2API.Director - Simplified addition of Enemies, Interactables and more to the Director Systems.

About

R2API.Director is a submodule assembly for R2API that allows mod creators to add new Entries to the Director, which allows things such as Interactables, Enemies and more to spawn in runs.

Use Cases / Features

R2API.Director is used for adding new Enemies and Interactables to the Director's SpawnCard pools, the main method of using this is with the events provided by the API, these events are:

• StageSettingsActions (Modify the the stage settings such as the stage's monster and interactable credits.)
• MonsterActions (Modify the stage's Monsters's DCCSPool)
• InteractableActions (Modify the stage's Interactable's DCCSPool)

Alongside this, R2API.Director also comes bundled with DirectorAPIHelpers, which contains helper methods which greatly simplify interacting with the Events described above.

Related Pages

Changelog

'2.3.7'

• Support for Alloyed Collective DLC3.
• Added missing spawn cards for DLC2.

'2.3.6'

• Both AddressableDirectorCardCategorySelection and AddressableDCCSPool now have more intricate validation during upgrading process.
  • This means that they should catch issues such as invalid spawn cards, invalid addresses and more.

'2.3.5'

• Added MixEnemiesDccsActions action that would allow interaction with MixEnemy artifact DCCS replacement.

'2.3.4'

• Fixed.

'2.3.3'

• Fixed custom monsters and interactables being added to stage pool multiple times as a result of SoTS Phase 2 changes.

'2.3.2'

• Fixed RemoveExistingMonsterFromStage, which by default removed the given monster from family DCCSs, potentially affecting other scenes unintentionally since those are shared between stages.

'2.3.1'

• Fixed the AddressableDCCSPool's ConditionalPool class not upgrading properly when it was using the new FamilyDCCSOption

'2.3.0'

• Added an "AddressReferencedFamilyDirectorCardCategorySelection" class, which is used to reference the FamilyDCCS from the base game
• AddressableDCCSPool's "PoolEntry" can now reference a FamilyDCCS, this FamilyDCCS takes precedence over the AddressableDirectorCardCategorySelection field.

'2.2.1'

• Add StageSerde struct, which acts as a workaround for Unity's inability to correctly serialize the Stage enum now that it is 64 bits long.

'2.2.0'

• Add SOTS stages and support Storm Stuff interactable category.

'2.1.3'

• Initial fixes for SOTS DLC2 Release.

'2.1.2'

• Add support for 'lakes'/'Verdant Falls' from Devotion update.

'2.1.1'

• Fix AddNewMonster / RemoveExistingMonster helper methods not properly handling arena stage.

'2.1.0'

• Added Dependency for the Addressables Submodule
• Added AddressableDCCSPool and AddressableDirectorCardCategorySelection, both intended for usage in the Unity Editor.

'2.0.0'

• Fixed issue where DirectorCardHolder's custom category selection weights where integers instead of floats.

'1.1.2'

• Make the API safer.

'1.1.1'

• Fix issue where the Stage ParseToInternalStageName(string) and string ToInternalStageName(Stage stage) would return invalid values for The Planetarium and Void Locus respectively.

'1.1.0'

• Tentative fix a bug where family events could occur unannounced, and earlier than expected (for the Void & Lunar family). Usually, this would only become apparent if multiple runs are completed in a single game session. Thanks to 6thmoon for helping finding the root cause of the bug. If the bug is still not fixed do not hesitate to tell us in the modding discord!
• Add to most DirectorAPI.Helpers methods an optional predicate parameter for more granular control on whether or not a monster / interactable should be added / removed to / from a stage. The predicate have a DirectorCardCategorySelection parameter that you can inspect (you don't have to, you can do other checks instead, like if a specific ExpansionDef is active) to decide whether or not the monster / interactable should be added / removed.

'1.0.0'

• Split from the main R2API.dll into its own submodule.