Skip to content

Commit

Permalink
[Addition] - Player.HeirGeneration.X documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
TacoConKvass authored Oct 13, 2024
1 parent 39ce2e4 commit 03f91f6
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions RL2.API/APIEndpoints/Player.cs
Original file line number Diff line number Diff line change
Expand Up @@ -419,8 +419,10 @@ internal static void EquipmentWeight_Invoke(ref int additive) {
public static class HeirGeneration
{
/// <summary>
///
/// Used to modify character data after character randomization by either the Contrarian trait or by the use of the Transmogrifier<br></br>
/// Ran at the end of <see cref="CharacterCreator.ApplyRandomizeKitTrait"/>
/// </summary>
/// <param name="characterData">The randomized heirs CharacterData</param>
public delegate void ModifyCharacterRandomization_delegate(CharacterData data);

/// <inheritdoc cref="ModifyCharacterRandomization_delegate"/>
Expand All @@ -431,8 +433,11 @@ internal static void ModifyCharacterRandomization_Invoke(CharacterData data) {
}

/// <summary>
///
/// Used to modify character data of generated heirs
/// </summary>
/// <param name="characterData">The generated heirs <see cref="CharacterData" /></param>
/// <param name="classLocked">Whether the heirs class was locked by a Soul Shop ugrade</param>
/// <param name="spellLocked">Whether the heirs spell was locked by a Soul Shop ugrade</param>
public delegate void ModifyCharacterData_delegate(CharacterData data, bool classLocked, bool spellLocked);

/// <inheritdoc cref="ModifyCharacterData_delegate"/>
Expand All @@ -443,8 +448,10 @@ internal static void ModifyCharacterData_Invoke(CharacterData data, bool classLo
}

/// <summary>
///
/// Used to modify look data of generated heirs
/// </summary>
/// <param name="lookData">The generated heirs <see cref="PlayerLookController" /></param>
/// <param name="characterData">The generated heirs <see cref="CharacterData" /></param>
public delegate void ModifyCharacterLook_delegate(PlayerLookController lookData, CharacterData data);

/// <inheritdoc cref="ModifyCharacterLook_delegate"/>
Expand All @@ -461,7 +468,7 @@ internal static void ModifyCharacterLook_Invoke(PlayerLookController lookData, C
public static class Ability
{
/// <summary>
/// Allows modifying ability data
/// Used to modify ability data
/// </summary>
/// <param name="type">The queried ability</param>
/// <param name="data">Returned data of the ability</param>
Expand Down

0 comments on commit 03f91f6

Please sign in to comment.