diff --git a/Leaderboard-System-Documentation---DRAFT.md b/Leaderboard-System-Documentation---DRAFT.md new file mode 100644 index 0000000..eaecb51 --- /dev/null +++ b/Leaderboard-System-Documentation---DRAFT.md @@ -0,0 +1,32 @@ + +# Custom Implementations of the Leaderboard + +## Leaderboard Datatable + +### Type Flags +The type flags are set in the leaderboard datatable and used to indicate the type of tracking the leaderboard completes. + +* `IS_PLAYER_BOARD` – If the board tracks players +* `IS_ENTITY_BOARD` – If the board tracks cities and guilds +* `IS_GCW_BOARD` – If the board tracks factions + +For example, these options can be combined so the overall leaderboard options appear like: + +Tracking Players and Entities: +* Leaderboard Name – Players +* Leaderboard Name – Guilds +* Leaderboard Name – Cities + +Tracking Faction Only: +* Leaderboard Name – Imperial +* Leaderboard Name – Rebel + +Tracking Player, Entity, and GCW Board: +* Leaderboard Name – Players – Rebel +* Leaderboard Name – Players – Imperial +* Leaderboard Name – Cities – Rebel +* Leaderboard Name – Cities – Imperial +* Leaderboard Name – Guilds – Rebel +* Leaderboard Name – Guilds – Imperial + +