Skip to content

Commit 38c17ef

Browse files
committed
Refactor schema files to improve formatting and add detailed documentation for Achievement type
- Adjusted indentation in schema-dynamic.mjs for consistency. - Expanded schema-static.mjs to include comprehensive descriptions for the Achievement type fields, enhancing clarity and usability for developers.
1 parent fa17f5f commit 38c17ef

File tree

2 files changed

+39
-2
lines changed

2 files changed

+39
-2
lines changed

schema-dynamic.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ enum HandbookCategoryName {
1414
${handbookCategories}
1515
}
1616
enum LanguageCode {
17-
${languageCodes}
17+
${languageCodes}
1818
}
1919
`;
2020
};

schema-static.mjs

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,51 @@
11
export default `
2+
"""
3+
**In-game achievements players can earn by completing specific objectives.**
4+
5+
- Fields with '!' (e.g., String!) are required (non-nullable).
6+
- Fields without '!' (e.g., String) are optional (nullable).
7+
This follows standard GraphQL notation.
8+
"""
29
type Achievement {
10+
"""
11+
A unique 24-character hexadecimal identifier for the achievement. Follows a consistent format across all achievements.
12+
"""
313
id: ID!
14+
"""
15+
The display name of the achievement (e.g., "Welcome to Tarkov", "The Kappa Path").
16+
"""
417
name: String!
18+
"""
19+
Text describing the conditions required to unlock the achievement (e.g., "Neutralize Killa 15 times while playing as a PMC").
20+
"""
521
description: String
22+
"""
23+
Whether the achievement is hidden from players until unlocked (true) or visible from the start (false).
24+
"""
625
hidden: Boolean!
26+
"""
27+
Raw percentage of all players who have completed this achievement (e.g., 0.06, 43.48).
28+
"""
729
playersCompletedPercent: Float!
30+
"""
31+
Statistically adjusted percentage that accounts for active players, providing a more representative completion rate.
32+
"""
833
adjustedPlayersCompletedPercent: Float
34+
"""
35+
The game faction or player type this achievement is associated with. Values include "PMC", "All", or "Scavs".
36+
"""
937
side: String
38+
"""
39+
Lowercase, standardized version of the side field used for consistent sorting and filtering (e.g., "pmc", "all", "scavs").
40+
"""
1041
normalizedSide: String
42+
"""
43+
The difficulty/rarity tier of the achievement. Values include "Common", "Rare", or "Legendary".
44+
"""
1145
rarity: String
46+
"""
47+
Lowercase, standardized version of the rarity field used for consistent sorting and filtering (e.g., "common", "rare", "legendary").
48+
"""
1249
normalizedRarity: String
1350
}
1451
@@ -1500,4 +1537,4 @@ type TraderResetTime {
15001537
name: String @deprecated(reason: "Use Trader.name type instead.")
15011538
resetTimestamp: String @deprecated(reason: "Use Trader.resetTime type instead.")
15021539
}
1503-
`;
1540+
`

0 commit comments

Comments
 (0)