Skip to content

Commit 869aaf3

Browse files
committed
Add comment on intended use of Order and DiscriminatorPriority properties
1 parent b0f0794 commit 869aaf3

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

sources/Core/Core/Annotations/NameAffixAttribute.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,10 @@ public NameAffixAttribute(string type, string affix, int order, int discriminato
5050
/// Affixes with the same order have ties broken using the order they are declared on the identifier.
5151
/// First declared are applied first.
5252
/// </summary>
53+
/// <remarks>
54+
/// SilkTouch mods setting this property should use either -1, 0, or a value specified through the mod's configuration.
55+
/// This is to reduce the hardcoding of values and to make the mods more applicable to different sets of bindings.
56+
/// </remarks>
5357
public int Order { get; }
5458

5559
/// <summary>
@@ -62,5 +66,9 @@ public NameAffixAttribute(string type, string affix, int order, int discriminato
6266
/// <para/>
6367
/// Affixes with the same priority are applied together as a group.
6468
/// </summary>
69+
/// <remarks>
70+
/// SilkTouch mods setting this property should use either -1, 0, or a value specified through the mod's configuration.
71+
/// This is to reduce the hardcoding of values and to make the mods more applicable to different sets of bindings.
72+
/// </remarks>
6573
public int DiscriminatorPriority { get; }
6674
}

0 commit comments

Comments
 (0)