Skip to content

Commit

Permalink
[Merge] - PR#12
Browse files Browse the repository at this point in the history 
[Addition] - Pre 1.0.0 missing documentation - issue
  • Loading branch information
@TacoConKvass
TacoConKvass authored Oct 13, 2024
2 parents 85a6e09 + 03f91f6 commit 8333d9d
Showing 1 changed file with 59 additions and 52 deletions.
111 changes: 59 additions & 52 deletions RL2.API/APIEndpoints/Player.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,9 @@ public static class Stats
{
#region Resolve
/// <summary>
///
/// Used to change Resolve by a flat amount, by adding to the provided parameter
/// </summary>
/// <param name="additive"></param>
/// <param name="additive">The current stat value, before applying stat scaling</param>
public delegate void ResolveFlat_delegate(ref float additive);

/// <inheritdoc cref="ResolveFlat_delegate"/>
Expand All @@ -85,9 +85,9 @@ internal static void ResolveFlat_Invoke(ref float additive) {
}

/// <summary>
///
/// Used to change Resolve scaling, by modifying the provided parameter
/// </summary>
/// <param name="multiplier"></param>
/// <param name="multiplier">The current stat scaling value</param>
public delegate void ResolveMultiplier_delegate(ref float multiplier);

/// <inheritdoc cref="ResolveMultiplier_delegate"/>
Expand All @@ -100,9 +100,9 @@ internal static void ResolveMultiplier_Invoke(ref float multiplier) {

#region Dexterity
/// <summary>
///
/// Used to change Dexterity by a flat amount, by adding to the provided parameter
/// </summary>
/// <param name="additive"></param>
/// <param name="additive">The current stat value, before applying stat scaling</param>
public delegate void DexterityFlat_delegate(ref float additive);

/// <inheritdoc cref="DexterityFlat_delegate"/>
Expand All @@ -113,9 +113,9 @@ internal static void DexterityFlat_Invoke(ref float additive) {
}

/// <summary>
///
/// Used to change Dexterity scaling, by modifying the provided parameter
/// </summary>
/// <param name="multiplier"></param>
/// <param name="multiplier">The current stat scaling value</param>
public delegate void DexterityMultiplier_delegate(ref float multiplier);

/// <inheritdoc cref="DexterityMultiplier_delegate"/>
Expand All @@ -128,9 +128,9 @@ internal static void DexterityMultiplier_Invoke(ref float multiplier) {

#region CritChance
/// <summary>
///
/// Used to change CritChance by a flat amount, by adding to the provided parameter
/// </summary>
/// <param name="additive"></param>
/// <param name="additive">The current stat value, before applying stat scaling</param>
public delegate void CritChance_delegate(ref float additive);

/// <inheritdoc cref="CritChance_delegate"/>
Expand All @@ -143,9 +143,9 @@ internal static void CritChance_Invoke(ref float additive) {

#region CritDamage
/// <summary>
///
/// Used to change CritDamage by a flat amount, by adding to the provided parameter
/// </summary>
/// <param name="additive"></param>
/// <param name="additive">The current stat value, before applying stat scaling</param>
public delegate void CritDamage_delegate(ref float additive);

/// <inheritdoc cref="CritDamage_delegate"/>
Expand All @@ -158,9 +158,9 @@ internal static void CritDamage_Invoke(ref float additive) {

#region Focus
/// <summary>
///
/// Used to change Focus by a flat amount, by adding to the provided parameter
/// </summary>
/// <param name="additive"></param>
/// <param name="additive">The current stat value, before applying stat scaling</param>
public delegate void FocusFlat_delegate(ref float additive);

/// <inheritdoc cref="FocusFlat_delegate"/>
Expand All @@ -171,9 +171,9 @@ internal static void FocusFlat_Invoke(ref float additive) {
}

/// <summary>
///
/// Used to change Focus scaling, by modifying the provided parameter
/// </summary>
/// <param name="multiplier"></param>
/// <param name="multiplier">The current stat scaling value</param>
public delegate void FocusMultiplier_delegate(ref float multiplier);

/// <inheritdoc cref="FocusMultiplier_delegate"/>
Expand All @@ -186,9 +186,9 @@ internal static void FocusMultiplier_Invoke(ref float multiplier) {

#region MagicCritChance
/// <summary>
///
/// Used to change MagicCritChance by a flat amount, by adding to the provided parameter
/// </summary>
/// <param name="additive"></param>
/// <param name="additive">The current stat value, before applying stat scaling</param>
public delegate void MagicCritChance_delegate(ref float additive);

/// <inheritdoc cref="MagicCritChance_delegate"/>
Expand All @@ -201,9 +201,9 @@ internal static void MagicCritChance_Invoke(ref float additive) {

#region MagicCritDamage
/// <summary>
///
/// Used to change MagicCritDamage by a flat amount, by adding to the provided parameter
/// </summary>
/// <param name="additive"></param>
/// <param name="additive">The current stat value, before applying stat scaling</param>
public delegate void MagicCritDamage_delegate(ref float additive);

/// <inheritdoc cref="MagicCritDamage_delegate"/>
Expand All @@ -216,9 +216,9 @@ internal static void MagicCritDamage_Invoke(ref float additive) {

#region Armor
/// <summary>
///
/// Used to change Armor by a flat amount, by adding to the provided parameter
/// </summary>
/// <param name="additive"></param>
/// <param name="additive">The current stat value, before applying stat scaling</param>
public delegate void ArmorFlat_delegate(ref int additive);

/// <inheritdoc cref="ArmorFlat_delegate"/>
Expand All @@ -229,9 +229,9 @@ internal static void ArmorFlat_Invoke(ref int additive) {
}

/// <summary>
///
/// Used to change Armor scaling, by modifying the provided parameter
/// </summary>
/// <param name="multiplier"></param>
/// <param name="multiplier">The current stat scaling value</param>
public delegate void ArmorMultiplier_delegate(ref float multiplier);

/// <inheritdoc cref="ArmorMultiplier_delegate"/>
Expand All @@ -244,9 +244,9 @@ internal static void ArmorMultiplier_Invoke(ref float multiplier) {

#region Strength
/// <summary>
///
/// Used to change Strength by a flat amount, by adding to the provided parameter
/// </summary>
/// <param name="additive"></param>
/// <param name="additive">The current stat value, before applying stat scaling</param>
public delegate void StrengthFlat_delegate(ref float additive);

/// <inheritdoc cref="StrengthFlat_delegate"/>
Expand All @@ -257,9 +257,9 @@ internal static void StrengthFlat_Invoke(ref float additive) {
}

/// <summary>
///
/// Used to change Strength scaling, by modifying the provided parameter
/// </summary>
/// <param name="multiplier"></param>
/// <param name="multiplier">The current stat scaling value</param>
public delegate void StrengthMultiplier_delegate(ref float multiplier);

/// <inheritdoc cref="StrengthMultiplier_delegate"/>
Expand All @@ -272,9 +272,9 @@ internal static void StrengthMultiplier_Invoke(ref float multiplier) {

#region Intelligence
/// <summary>
///
/// Used to change Intelligence by a flat amount, by adding to the provided parameter
/// </summary>
/// <param name="additive"></param>
/// <param name="additive">The current stat value, before applying stat scaling</param>
public delegate void IntelligenceFlat_delegate(ref float additive);

/// <inheritdoc cref="IntelligenceFlat_delegate"/>
Expand All @@ -285,9 +285,9 @@ internal static void IntelligenceFlat_Invoke(ref float additive) {
}

/// <summary>
///
/// Used to change Intelligence scaling, by modifying the provided parameter
/// </summary>
/// <param name="multiplier"></param>
/// <param name="multiplier">The current stat scaling value</param>
public delegate void IntelligenceMultiplier_delegate(ref float multiplier);

/// <inheritdoc cref="IntelligenceMultiplier_delegate"/>
Expand All @@ -300,9 +300,9 @@ internal static void IntelligenceMultiplier_Invoke(ref float multiplier) {

#region Vitality
/// <summary>
///
/// Used to change Vitality by a flat amount, by adding to the provided parameter
/// </summary>
/// <param name="additive"></param>
/// <param name="additive">The current stat value, before applying stat scaling</param>
public delegate void VitalityFlat_delegate(ref int additive);

/// <inheritdoc cref="VitalityFlat_delegate"/>
Expand All @@ -313,9 +313,9 @@ internal static void VitalityFlat_Invoke(ref int additive) {
}

/// <summary>
///
/// Used to change Vitality scaling, by modifying the provided parameter
/// </summary>
/// <param name="multiplier"></param>
/// <param name="multiplier">The current stat scaling value</param>
public delegate void VitalityMultiplier_delegate(ref float multiplier);

/// <inheritdoc cref="VitalityMultiplier_delegate"/>
Expand All @@ -328,9 +328,9 @@ internal static void VitalityMultiplier_Invoke(ref float multiplier) {

#region MaxHealth
/// <summary>
///
/// Used to change max Health by a flat amount, by adding to the provided parameter
/// </summary>
/// <param name="additive"></param>
/// <param name="additive">The current stat value, before applying stat scaling</param>
public delegate void MaxHealthFlat_delegate(ref int additive);

/// <inheritdoc cref="MaxHealthFlat_delegate"/>
Expand All @@ -341,9 +341,9 @@ internal static void MaxHealthFlat_Invoke(ref int additive) {
}

/// <summary>
///
/// Used to change MaxHealth scaling, by modifying the provided parameter
/// </summary>
/// <param name="multiplier"></param>
/// <param name="multiplier">The current stat scaling value</param>
public delegate void MaxHealthMultiplier_delegate(ref float multiplier);

/// <inheritdoc cref="MaxHealthMultiplier_delegate"/>
Expand All @@ -356,9 +356,9 @@ internal static void MaxHealthMultiplier_Invoke(ref float multiplier) {

#region MaxMana
/// <summary>
///
/// Used to change max Mana by a flat amount, by adding to the provided parameter
/// </summary>
/// <param name="additive"></param>
/// <param name="additive">The current stat value, before applying stat scaling</param>
public delegate void MaxManaFlat_delegate(ref int additive);

/// <inheritdoc cref="MaxManaFlat_delegate"/>
Expand All @@ -369,9 +369,9 @@ internal static void MaxManaFlat_Invoke(ref int additive) {
}

/// <summary>
///
/// Used to change MaxMana scaling, by modifying the provided parameter
/// </summary>
/// <param name="multiplier"></param>
/// <param name="multiplier">The current stat scaling value</param>
public delegate void MaxManaMultiplier_delegate(ref float multiplier);

/// <inheritdoc cref="MaxManaMultiplier_delegate"/>
Expand All @@ -384,9 +384,9 @@ internal static void MaxManaMultiplier_Invoke(ref float multiplier) {

#region RuneWeight
/// <summary>
///
/// Used to change Rune weight by a flat amount, by adding to the provided parameter
/// </summary>
/// <param name="additive"></param>
/// <param name="additive">The current stat value, before applying stat scaling</param>
public delegate void RuneWeight_delegate(ref int additive);

/// <inheritdoc cref="RuneWeight_delegate"/>
Expand All @@ -399,9 +399,9 @@ internal static void RuneWeight_Invoke(ref int additive) {

#region EquipmentWeight
/// <summary>
///
/// Used to change Equipment weight by a flat amount, by adding to the provided parameter
/// </summary>
/// <param name="additive"></param>
/// <param name="additive">The current stat value, before applying stat scaling</param>
public delegate void EquipmentWeight_delegate(ref int additive);

/// <inheritdoc cref="EquipmentWeight_delegate"/>
Expand All @@ -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 8333d9d

Please sign in to comment.