From 4989e2b69b8ce23dbe01b8a6786267e6a0ed6ea2 Mon Sep 17 00:00:00 2001
From: Aireil <33433913+Aireil@users.noreply.github.com>
Date: Mon, 18 Sep 2023 03:55:43 +0200
Subject: [PATCH] refactor: rename fly text kind members
---
Dalamud/Game/Gui/FlyText/FlyTextKind.cs | 144 +++++++++++++-----------
1 file changed, 76 insertions(+), 68 deletions(-)
diff --git a/Dalamud/Game/Gui/FlyText/FlyTextKind.cs b/Dalamud/Game/Gui/FlyText/FlyTextKind.cs
index 68650fb5c..3727fd0f8 100644
--- a/Dalamud/Game/Gui/FlyText/FlyTextKind.cs
+++ b/Dalamud/Game/Gui/FlyText/FlyTextKind.cs
@@ -1,57 +1,58 @@
namespace Dalamud.Game.Gui.FlyText;
///
-/// Enum of FlyTextKind values. Members suffixed with
-/// a number seem to be a duplicate, or perform duplicate behavior.
+/// Enum of FlyTextKind values.
///
public enum FlyTextKind : int
{
///
/// Val1 in serif font, Text2 in sans-serif as subtitle.
- /// Used for autos and incoming DoTs.
///
- AutoAttack = 0,
+ AutoAttackOrDot = 0,
///
/// Val1 in serif font, Text2 in sans-serif as subtitle.
/// Does a bounce effect on appearance.
///
- DirectHit = 1,
+ AutoAttackOrDotDh = 1,
///
/// Val1 in larger serif font with exclamation, with Text2 in sans-serif as subtitle.
/// Does a bigger bounce effect on appearance.
///
- CriticalHit = 2,
+ AutoAttackOrDotCrit = 2,
///
- /// Val1 in even larger serif font with 2 exclamations, Text2 in
- /// sans-serif as subtitle. Does a large bounce effect on appearance.
- /// Does not scroll up or down the screen.
+ /// Val1 in even larger serif font with 2 exclamations, Text2 in sans-serif as subtitle.
+ /// Does a large bounce effect on appearance. Does not scroll up or down the screen.
///
- CriticalDirectHit = 3,
+ AutoAttackOrDotCritDh = 3,
///
- /// AutoAttack with sans-serif Text1 to the left of the Val1.
+ /// Val1 in serif font, Text2 in sans-serif as subtitle with sans-serif Text1 to the left of the Val1.
///
- NamedAttack = 4,
+ Damage = 4,
///
- /// DirectHit with sans-serif Text1 to the left of the Val1.
+ /// Val1 in serif font, Text2 in sans-serif as subtitle with sans-serif Text1 to the left of the Val1.
+ /// Does a bounce effect on appearance.
///
- NamedDirectHit = 5,
+ DamageDh = 5,
///
- /// CriticalHit with sans-serif Text1 to the left of the Val1.
+ /// Val1 in larger serif font with exclamation, with Text2 in sans-serif as subtitle with sans-serif Text1 to the left of the Val1.
+ /// Does a bigger bounce effect on appearance.
///
- NamedCriticalHit = 6,
+ DamageCrit = 6,
///
- /// CriticalDirectHit with sans-serif Text1 to the left of the Val1.
+ /// Val1 in even larger serif font with 2 exclamations, Text2 in sans-serif as subtitle with sans-serif Text1 to the left of the Val1.
+ /// Does a large bounce effect on appearance. Does not scroll up or down the screen.
///
- NamedCriticalDirectHit = 7,
+ DamageCritDh = 7,
///
+ /// The text changes to DODGE under certain circumstances.
/// All caps, serif MISS.
///
Miss = 8,
@@ -74,12 +75,12 @@ public enum FlyTextKind : int
///
/// Icon next to sans-serif Text1.
///
- NamedIcon = 12,
+ Buff = 12,
///
- /// Icon next to sans-serif Text1 (2).
+ /// Icon next to sans-serif Text1.
///
- NamedIcon2 = 13,
+ Debuff = 13,
///
/// Serif Val1 with all caps condensed font EXP with Text2 in sans-serif as subtitle.
@@ -94,42 +95,44 @@ public enum FlyTextKind : int
///
/// Sans-serif Text1 next to serif Val1 with all caps condensed font MP with Text2 in sans-serif as subtitle.
///
- NamedMp = 16,
+ MpDrain = 16,
///
+ /// Currently not used by the game.
/// Sans-serif Text1 next to serif Val1 with all caps condensed font TP with Text2 in sans-serif as subtitle.
///
NamedTp = 17,
///
- /// AutoAttack with sans-serif Text1 to the left of the Val1 (2).
+ /// Val1 in serif font, Text2 in sans-serif as subtitle with sans-serif Text1 to the left of the Val1.
///
- NamedAttack2 = 18,
+ Healing = 18,
///
- /// Sans-serif Text1 next to serif Val1 with all caps condensed font MP with Text2 in sans-serif as subtitle (2).
+ /// Sans-serif Text1 next to serif Val1 with all caps condensed font MP with Text2 in sans-serif as subtitle.
///
- NamedMp2 = 19,
+ MpRegen = 19,
///
- /// Sans-serif Text1 next to serif Val1 with all caps condensed font TP with Text2 in sans-serif as subtitle (2).
+ /// Currently not used by the game.
+ /// Sans-serif Text1 next to serif Val1 with all caps condensed font TP with Text2 in sans-serif as subtitle.
///
NamedTp2 = 20,
///
/// Sans-serif Text1 next to serif Val1 with all caps condensed font EP with Text2 in sans-serif as subtitle.
///
- NamedEp = 21,
+ EpRegen = 21,
///
/// Sans-serif Text1 next to serif Val1 with all caps condensed font CP with Text2 in sans-serif as subtitle.
///
- NamedCp = 22,
+ CpRegen = 22,
///
/// Sans-serif Text1 next to serif Val1 with all caps condensed font GP with Text2 in sans-serif as subtitle.
///
- NamedGp = 23,
+ GpRegen = 23,
///
/// Displays nothing.
@@ -149,57 +152,59 @@ public enum FlyTextKind : int
Interrupted = 26,
///
- /// AutoAttack with no Text2.
+ /// Val1 in serif font.
///
- AutoAttackNoText = 27,
+ CraftingProgress = 27,
///
- /// AutoAttack with no Text2 (2).
+ /// Val1 in serif font.
///
- AutoAttackNoText2 = 28,
+ CraftingQuality = 28,
///
- /// Val1 in larger serif font with exclamation, with Text2 in sans-serif as subtitle. Does a bigger bounce effect on appearance (2).
+ /// Val1 in larger serif font with exclamation, with Text2 in sans-serif as subtitle. Does a bigger bounce effect on appearance.
///
- CriticalHit2 = 29,
+ CraftingQualityCrit = 29,
///
- /// AutoAttack with no Text2 (3).
+ /// Currently not used by the game.
+ /// Val1 in serif font.
///
AutoAttackNoText3 = 30,
///
/// CriticalHit with sans-serif Text1 to the left of the Val1 (2).
///
- NamedCriticalHit2 = 31,
+ HealingCrit = 31,
///
- /// Same as NamedCriticalHit with a green (cannot change) MP in condensed font to the right of Val1.
+ /// Currently not used by the game.
+ /// Same as DamageCrit with a MP in condensed font to the right of Val1.
/// Does a jiggle effect to the right on appearance.
///
NamedCriticalHitWithMp = 32,
///
- /// Same as NamedCriticalHit with a yellow (cannot change) TP in condensed font to the right of Val1.
+ /// Currently not used by the game.
+ /// Same as DamageCrit with a TP in condensed font to the right of Val1.
/// Does a jiggle effect to the right on appearance.
///
NamedCriticalHitWithTp = 33,
///
- /// Same as NamedIcon with sans-serif "has no effect!" to the right.
+ /// Icon next to sans-serif Text1 with sans-serif "has no effect!" to the right.
///
- NamedIconHasNoEffect = 34,
+ DebuffNoEffect = 34,
///
- /// Same as NamedIcon but Text1 is slightly faded. Used for buff expiration.
+ /// Icon next to sans-serif slightly faded Text1.
///
- NamedIconFaded = 35,
+ BuffFading = 35,
///
- /// Same as NamedIcon but Text1 is slightly faded (2).
- /// Used for buff expiration.
+ /// Icon next to sans-serif slightly faded Text1.
///
- NamedIconFaded2 = 36,
+ DebuffFading = 36,
///
/// Text1 in sans-serif font.
@@ -207,9 +212,9 @@ public enum FlyTextKind : int
Named = 37,
///
- /// Same as NamedIcon with sans-serif "(fully resisted)" to the right.
+ /// Icon next to sans-serif Text1 with sans-serif "(fully resisted)" to the right.
///
- NamedIconFullyResisted = 38,
+ DebuffResisted = 38,
///
/// All caps serif 'INCAPACITATED!'.
@@ -219,32 +224,34 @@ public enum FlyTextKind : int
///
/// Text1 with sans-serif "(fully resisted)" to the right.
///
- NamedFullyResisted = 40,
+ FullyResisted = 40,
///
/// Text1 with sans-serif "has no effect!" to the right.
///
- NamedHasNoEffect = 41,
+ HasNoEffect = 41,
///
- /// AutoAttack with sans-serif Text1 to the left of the Val1 (3).
+ /// Val1 in serif font, Text2 in sans-serif as subtitle with sans-serif Text1 to the left of the Val1.
///
- NamedAttack3 = 42,
+ HpDrain = 42,
///
- /// Sans-serif Text1 next to serif Val1 with all caps condensed font MP with Text2 in sans-serif as subtitle (3).
+ /// Currently not used by the game.
+ /// Sans-serif Text1 next to serif Val1 with all caps condensed font MP with Text2 in sans-serif as subtitle.
///
NamedMp3 = 43,
///
- /// Sans-serif Text1 next to serif Val1 with all caps condensed font TP with Text2 in sans-serif as subtitle (3).
+ /// Currently not used by the game.
+ /// Sans-serif Text1 next to serif Val1 with all caps condensed font TP with Text2 in sans-serif as subtitle.
///
NamedTp3 = 44,
///
- /// Same as NamedIcon with serif "INVULNERABLE!" beneath the Text1.
+ /// Icon next to sans-serif Text1 with serif "INVULNERABLE!" beneath the Text1.
///
- NamedIconInvulnerable = 45,
+ DebuffInvulnerable = 45,
///
/// All caps serif RESIST.
@@ -252,20 +259,20 @@ public enum FlyTextKind : int
Resist = 46,
///
- /// Same as NamedIcon but places the given icon in the item icon outline.
+ /// Icon with an item icon outline next to sans-serif Text1.
///
- NamedIconWithItemOutline = 47,
+ LootedItem = 47,
///
- /// AutoAttack with no Text2 (4).
+ /// Val1 in serif font.
///
- AutoAttackNoText4 = 48,
+ Collectability = 48,
///
- /// Val1 in larger serif font with exclamation, with Text2 in sans-serif as subtitle (3).
+ /// Val1 in larger serif font with exclamation, with Text2 in sans-serif as subtitle.
/// Does a bigger bounce effect on appearance.
///
- CriticalHit3 = 49,
+ CollectabilityCrit = 49,
///
/// All caps serif REFLECT.
@@ -278,20 +285,21 @@ public enum FlyTextKind : int
Reflected = 51,
///
- /// Val1 in serif font, Text2 in sans-serif as subtitle (2).
+ /// Val1 in serif font, Text2 in sans-serif as subtitle.
/// Does a bounce effect on appearance.
///
- DirectHit2 = 52,
+ CraftingQualityDh = 52,
///
- /// Val1 in larger serif font with exclamation, with Text2 in sans-serif as subtitle (4).
+ /// Currently not used by the game.
+ /// Val1 in larger serif font with exclamation, with Text2 in sans-serif as subtitle.
/// Does a bigger bounce effect on appearance.
///
CriticalHit4 = 53,
///
- /// Val1 in even larger serif font with 2 exclamations, Text2 in sans-serif as subtitle (2).
+ /// Val1 in even larger serif font with 2 exclamations, Text2 in sans-serif as subtitle.
/// Does a large bounce effect on appearance. Does not scroll up or down the screen.
///
- CriticalDirectHit2 = 54,
+ CraftingQualityCritDh = 54,
}