Skip to content

Add XML Documentation across the API, and add GainMultipleGems as an Ability Class - #343

Merged
Chaosyr merged 74 commits into
InscryptionModding:Update-Installation-Guides-and-Documentation-and-Bug-Fixesfrom
HumabHatterZed:xml
Nov 16, 2026
Merged

Chaosyr merged 74 commits into
InscryptionModding:Update-Installation-Guides-and-Documentation-and-Bug-Fixesfrom
HumabHatterZed:xml

Conversation

@HumabHatterZed

@HumabHatterZed HumabHatterZed commented Nov 13, 2026 •

Copy link
Copy Markdown
Collaborator

Adds all missing XML in the API.

Also adds GainMultipleGems, an ability subclass that allows for modders to create sigils that provide multiple gem colours instead of just one or all three.

**Comment out unusued duplicate field**
Considering if the custom costs ID system can be deprecated, but it may have a use as a way of providing custom cost adjustments on CardModInfos
…verse key-value pair of currentSacrificedCardInfos, add XML

@Chaosyr Chaosyr left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If its of use, the following contains common XML tags that can be used and how to use them. https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/xmldoc/recommended-tags

This PR is good once the two items mentioned are fixed across the module ^^

@Chaosyr Chaosyr self-assigned this Nov 13, 2026
Add some missing XML and fix incorrect XML in AbilityExtensions

@Chaosyr Chaosyr left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Outside of what I mentioned in dms this looks good ^^


[HarmonyPostfix, HarmonyPatch(typeof(ResourcesManager), nameof(ResourcesManager.ForceGemsUpdate))]
private static void ForceOpponentGemsUpdate() => Singleton<OpponentGemsManager>.Instance?.ForceGemsUpdate();
private static void ForceOpponentGemsUpdate(ResourcesManager __instance) {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should the change here be something put in the Changelog?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is part of the GainMultipleGems class's functionality, so I don't think it needs to be specifically mentioned; people will assume that the changes have occurred to make the new class work properly.


GainGemTriple[] components2 = slot.Card.GetComponents<GainGemTriple>();
for (int i = 0; i < components2.Length; i++)
GainMultipleGems[] components2 = slot.Card.GetComponents<GainMultipleGems>();

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this change be something we note in the Changelog?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is part of the GainMultipleGems class's functionality, so I don't think it needs to be specifically mentioned; people will assume that the changes have occurred to make the new class work properly.

@Chaosyr Chaosyr changed the title Add XML to all classes in the Card folder, add GainMultipleGems ability class Add XML Documentation across the API, and add GainMultipleGems as an Ability Class Nov 16, 2026
@Chaosyr
Chaosyr merged commit 941c0b8 into InscryptionModding:Update-Installation-Guides-and-Documentation-and-Bug-Fixes Nov 16, 2026
1 check passed
@HumabHatterZed
HumabHatterZed deleted the xml branch November 17, 2026 00:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants