Skip to content

Commit 8333d9d

Browse files
TacoConKvassTacoConKvass
authored
[Merge] - PR#12
[Addition] - Pre 1.0.0 missing documentation - issue
2 parents 85a6e09 + 03f91f6 commit 8333d9d

File tree

1 file changed

+59
-52
lines changed

1 file changed

+59
-52
lines changed

‎RL2.API/APIEndpoints/Player.cs‎

Lines changed: 59 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,9 @@ public static class Stats
7272
{
7373
#region Resolve
7474
/// <summary>
75-
///
75+
/// Used to change Resolve by a flat amount, by adding to the provided parameter
7676
/// </summary>
77-
/// <param name="additive"></param>
77+
/// <param name="additive">The current stat value, before applying stat scaling</param>
7878
public delegate void ResolveFlat_delegate(ref float additive);
7979

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

407407
/// <inheritdoc cref="EquipmentWeight_delegate"/>
@@ -419,8 +419,10 @@ internal static void EquipmentWeight_Invoke(ref int additive) {
419419
public static class HeirGeneration
420420
{
421421
/// <summary>
422-
///
422+
/// Used to modify character data after character randomization by either the Contrarian trait or by the use of the Transmogrifier<br></br>
423+
/// Ran at the end of <see cref="CharacterCreator.ApplyRandomizeKitTrait"/>
423424
/// </summary>
425+
/// <param name="characterData">The randomized heirs CharacterData</param>
424426
public delegate void ModifyCharacterRandomization_delegate(CharacterData data);
425427

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

433435
/// <summary>
434-
///
436+
/// Used to modify character data of generated heirs
435437
/// </summary>
438+
/// <param name="characterData">The generated heirs <see cref="CharacterData" /></param>
439+
/// <param name="classLocked">Whether the heirs class was locked by a Soul Shop ugrade</param>
440+
/// <param name="spellLocked">Whether the heirs spell was locked by a Soul Shop ugrade</param>
436441
public delegate void ModifyCharacterData_delegate(CharacterData data, bool classLocked, bool spellLocked);
437442

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

445450
/// <summary>
446-
///
451+
/// Used to modify look data of generated heirs
447452
/// </summary>
453+
/// <param name="lookData">The generated heirs <see cref="PlayerLookController" /></param>
454+
/// <param name="characterData">The generated heirs <see cref="CharacterData" /></param>
448455
public delegate void ModifyCharacterLook_delegate(PlayerLookController lookData, CharacterData data);
449456

450457
/// <inheritdoc cref="ModifyCharacterLook_delegate"/>
@@ -461,7 +468,7 @@ internal static void ModifyCharacterLook_Invoke(PlayerLookController lookData, C
461468
public static class Ability
462469
{
463470
/// <summary>
464-
/// Allows modifying ability data
471+
/// Used to modify ability data
465472
/// </summary>
466473
/// <param name="type">The queried ability</param>
467474
/// <param name="data">Returned data of the ability</param>

0 commit comments

Comments
 (0)