From 39ce2e46999154e3bf3892bd2182e52d7c648fd6 Mon Sep 17 00:00:00 2001 From: TacoConKvass Date: Sun, 13 Oct 2024 14:53:22 +0200 Subject: [PATCH 1/2] [Addition] - Player.Stats.X documentation --- RL2.API/APIEndpoints/Player.cs | 96 +++++++++++++++++----------------- 1 file changed, 48 insertions(+), 48 deletions(-) diff --git a/RL2.API/APIEndpoints/Player.cs b/RL2.API/APIEndpoints/Player.cs index 1c5a231..ae3cced 100644 --- a/RL2.API/APIEndpoints/Player.cs +++ b/RL2.API/APIEndpoints/Player.cs @@ -72,9 +72,9 @@ public static class Stats { #region Resolve /// - /// + /// Used to change Resolve by a flat amount, by adding to the provided parameter /// - /// + /// The current stat value, before applying stat scaling public delegate void ResolveFlat_delegate(ref float additive); /// @@ -85,9 +85,9 @@ internal static void ResolveFlat_Invoke(ref float additive) { } /// - /// + /// Used to change Resolve scaling, by modifying the provided parameter /// - /// + /// The current stat scaling value public delegate void ResolveMultiplier_delegate(ref float multiplier); /// @@ -100,9 +100,9 @@ internal static void ResolveMultiplier_Invoke(ref float multiplier) { #region Dexterity /// - /// + /// Used to change Dexterity by a flat amount, by adding to the provided parameter /// - /// + /// The current stat value, before applying stat scaling public delegate void DexterityFlat_delegate(ref float additive); /// @@ -113,9 +113,9 @@ internal static void DexterityFlat_Invoke(ref float additive) { } /// - /// + /// Used to change Dexterity scaling, by modifying the provided parameter /// - /// + /// The current stat scaling value public delegate void DexterityMultiplier_delegate(ref float multiplier); /// @@ -128,9 +128,9 @@ internal static void DexterityMultiplier_Invoke(ref float multiplier) { #region CritChance /// - /// + /// Used to change CritChance by a flat amount, by adding to the provided parameter /// - /// + /// The current stat value, before applying stat scaling public delegate void CritChance_delegate(ref float additive); /// @@ -143,9 +143,9 @@ internal static void CritChance_Invoke(ref float additive) { #region CritDamage /// - /// + /// Used to change CritDamage by a flat amount, by adding to the provided parameter /// - /// + /// The current stat value, before applying stat scaling public delegate void CritDamage_delegate(ref float additive); /// @@ -158,9 +158,9 @@ internal static void CritDamage_Invoke(ref float additive) { #region Focus /// - /// + /// Used to change Focus by a flat amount, by adding to the provided parameter /// - /// + /// The current stat value, before applying stat scaling public delegate void FocusFlat_delegate(ref float additive); /// @@ -171,9 +171,9 @@ internal static void FocusFlat_Invoke(ref float additive) { } /// - /// + /// Used to change Focus scaling, by modifying the provided parameter /// - /// + /// The current stat scaling value public delegate void FocusMultiplier_delegate(ref float multiplier); /// @@ -186,9 +186,9 @@ internal static void FocusMultiplier_Invoke(ref float multiplier) { #region MagicCritChance /// - /// + /// Used to change MagicCritChance by a flat amount, by adding to the provided parameter /// - /// + /// The current stat value, before applying stat scaling public delegate void MagicCritChance_delegate(ref float additive); /// @@ -201,9 +201,9 @@ internal static void MagicCritChance_Invoke(ref float additive) { #region MagicCritDamage /// - /// + /// Used to change MagicCritDamage by a flat amount, by adding to the provided parameter /// - /// + /// The current stat value, before applying stat scaling public delegate void MagicCritDamage_delegate(ref float additive); /// @@ -216,9 +216,9 @@ internal static void MagicCritDamage_Invoke(ref float additive) { #region Armor /// - /// + /// Used to change Armor by a flat amount, by adding to the provided parameter /// - /// + /// The current stat value, before applying stat scaling public delegate void ArmorFlat_delegate(ref int additive); /// @@ -229,9 +229,9 @@ internal static void ArmorFlat_Invoke(ref int additive) { } /// - /// + /// Used to change Armor scaling, by modifying the provided parameter /// - /// + /// The current stat scaling value public delegate void ArmorMultiplier_delegate(ref float multiplier); /// @@ -244,9 +244,9 @@ internal static void ArmorMultiplier_Invoke(ref float multiplier) { #region Strength /// - /// + /// Used to change Strength by a flat amount, by adding to the provided parameter /// - /// + /// The current stat value, before applying stat scaling public delegate void StrengthFlat_delegate(ref float additive); /// @@ -257,9 +257,9 @@ internal static void StrengthFlat_Invoke(ref float additive) { } /// - /// + /// Used to change Strength scaling, by modifying the provided parameter /// - /// + /// The current stat scaling value public delegate void StrengthMultiplier_delegate(ref float multiplier); /// @@ -272,9 +272,9 @@ internal static void StrengthMultiplier_Invoke(ref float multiplier) { #region Intelligence /// - /// + /// Used to change Intelligence by a flat amount, by adding to the provided parameter /// - /// + /// The current stat value, before applying stat scaling public delegate void IntelligenceFlat_delegate(ref float additive); /// @@ -285,9 +285,9 @@ internal static void IntelligenceFlat_Invoke(ref float additive) { } /// - /// + /// Used to change Intelligence scaling, by modifying the provided parameter /// - /// + /// The current stat scaling value public delegate void IntelligenceMultiplier_delegate(ref float multiplier); /// @@ -300,9 +300,9 @@ internal static void IntelligenceMultiplier_Invoke(ref float multiplier) { #region Vitality /// - /// + /// Used to change Vitality by a flat amount, by adding to the provided parameter /// - /// + /// The current stat value, before applying stat scaling public delegate void VitalityFlat_delegate(ref int additive); /// @@ -313,9 +313,9 @@ internal static void VitalityFlat_Invoke(ref int additive) { } /// - /// + /// Used to change Vitality scaling, by modifying the provided parameter /// - /// + /// The current stat scaling value public delegate void VitalityMultiplier_delegate(ref float multiplier); /// @@ -328,9 +328,9 @@ internal static void VitalityMultiplier_Invoke(ref float multiplier) { #region MaxHealth /// - /// + /// Used to change max Health by a flat amount, by adding to the provided parameter /// - /// + /// The current stat value, before applying stat scaling public delegate void MaxHealthFlat_delegate(ref int additive); /// @@ -341,9 +341,9 @@ internal static void MaxHealthFlat_Invoke(ref int additive) { } /// - /// + /// Used to change MaxHealth scaling, by modifying the provided parameter /// - /// + /// The current stat scaling value public delegate void MaxHealthMultiplier_delegate(ref float multiplier); /// @@ -356,9 +356,9 @@ internal static void MaxHealthMultiplier_Invoke(ref float multiplier) { #region MaxMana /// - /// + /// Used to change max Mana by a flat amount, by adding to the provided parameter /// - /// + /// The current stat value, before applying stat scaling public delegate void MaxManaFlat_delegate(ref int additive); /// @@ -369,9 +369,9 @@ internal static void MaxManaFlat_Invoke(ref int additive) { } /// - /// + /// Used to change MaxMana scaling, by modifying the provided parameter /// - /// + /// The current stat scaling value public delegate void MaxManaMultiplier_delegate(ref float multiplier); /// @@ -384,9 +384,9 @@ internal static void MaxManaMultiplier_Invoke(ref float multiplier) { #region RuneWeight /// - /// + /// Used to change Rune weight by a flat amount, by adding to the provided parameter /// - /// + /// The current stat value, before applying stat scaling public delegate void RuneWeight_delegate(ref int additive); /// @@ -399,9 +399,9 @@ internal static void RuneWeight_Invoke(ref int additive) { #region EquipmentWeight /// - /// + /// Used to change Equipment weight by a flat amount, by adding to the provided parameter /// - /// + /// The current stat value, before applying stat scaling public delegate void EquipmentWeight_delegate(ref int additive); /// From 03f91f6019623d6f167471f81e68a14f2cdd95ad Mon Sep 17 00:00:00 2001 From: TacoConKvass Date: Sun, 13 Oct 2024 14:57:13 +0200 Subject: [PATCH 2/2] [Addition] - Player.HeirGeneration.X documentation --- RL2.API/APIEndpoints/Player.cs | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/RL2.API/APIEndpoints/Player.cs b/RL2.API/APIEndpoints/Player.cs index ae3cced..cbfb237 100644 --- a/RL2.API/APIEndpoints/Player.cs +++ b/RL2.API/APIEndpoints/Player.cs @@ -419,8 +419,10 @@ internal static void EquipmentWeight_Invoke(ref int additive) { public static class HeirGeneration { /// - /// + /// Used to modify character data after character randomization by either the Contrarian trait or by the use of the Transmogrifier

+ /// Ran at the end of /// + /// The randomized heirs CharacterData public delegate void ModifyCharacterRandomization_delegate(CharacterData data); /// @@ -431,8 +433,11 @@ internal static void ModifyCharacterRandomization_Invoke(CharacterData data) { } /// - /// + /// Used to modify character data of generated heirs /// + /// The generated heirs + /// Whether the heirs class was locked by a Soul Shop ugrade + /// Whether the heirs spell was locked by a Soul Shop ugrade public delegate void ModifyCharacterData_delegate(CharacterData data, bool classLocked, bool spellLocked); /// @@ -443,8 +448,10 @@ internal static void ModifyCharacterData_Invoke(CharacterData data, bool classLo } /// - /// + /// Used to modify look data of generated heirs /// + /// The generated heirs + /// The generated heirs public delegate void ModifyCharacterLook_delegate(PlayerLookController lookData, CharacterData data); /// @@ -461,7 +468,7 @@ internal static void ModifyCharacterLook_Invoke(PlayerLookController lookData, C public static class Ability { /// - /// Allows modifying ability data + /// Used to modify ability data /// /// The queried ability /// Returned data of the ability