implement show hidden players in sidebar option, closes #88

adds `settings.hide.show-hidden-players-in-sidebar` option to PlayersLayer config

This includes some changes to the webmap files. If you made any changes to them, please back them up and set `settings.web-directory.read-only` to `false` in the config to allow for the new changes to take effect.

Author: granny

core/src/main/java/net/pl3x/map/core/configuration/PlayersLayerConfig.java

@@ -34,6 +34,11 @@ public final class PlayersLayerConfig extends AbstractConfig {
             Show online players on the map and sidebar.""")
     public static boolean ENABLED = true;
 
+    @Key("settings.hide.show-hidden-players-in-sidebar")
+    @Comment("""
+            Should hidden players be shown in the sidebar.""")
+    public static boolean SHOW_HIDDEN_PLAYERS_IN_SIDEBAR = false;
+
     @Key("settings.hide.invisible")
     @Comment("""
             Should invisible players be hidden from the map.""")

core/src/main/java/net/pl3x/map/core/player/PlayerRegistry.java

@@ -105,13 +105,18 @@ public List<Object> parsePlayers() {
         List<Object> players = new ArrayList<>();
         forEach(player -> {
             // do not expose hidden players in the json
+            boolean isHidden = false;
             if (player.isHidden() || player.isNPC()) {
-                return;
+                isHidden = true;
             }
             if (PlayersLayerConfig.HIDE_SPECTATORS && player.isSpectator()) {
-                return;
+                isHidden = true;
             }
             if (PlayersLayerConfig.HIDE_INVISIBLE && player.isInvisible()) {
+                isHidden = true;
+            }
+
+            if (isHidden && !PlayersLayerConfig.SHOW_HIDDEN_PLAYERS_IN_SIDEBAR) {
                 return;
             }
 
@@ -120,8 +125,11 @@ public List<Object> parsePlayers() {
             playerEntry.put("name", player.getDecoratedName());
             playerEntry.put("uuid", player.getUUID().toString());
             playerEntry.put("displayName", player.getDecoratedName());
-            playerEntry.put("world", player.getWorld().getName());
-            playerEntry.put("position", player.getPosition());
+
+            if (!isHidden) {
+                playerEntry.put("world", player.getWorld().getName());
+                playerEntry.put("position", player.getPosition());
+            }
 
             players.add(playerEntry);
         });

webmap/src/index.d.ts

@@ -17,6 +17,7 @@ declare global {
         overlayremoved: CustomEvent<MarkerLayer>;
         playeradded: CustomEvent<Player>;
         playerremoved: CustomEvent<Player>;
+        playerupdate: CustomEvent<Player>;
         rendererselected: CustomEvent<World>;
         worldadded: CustomEvent<World>;
         worldremoved: CustomEvent<World>;

webmap/src/player/PlayerManager.ts

@@ -18,10 +18,15 @@ export class PlayerManager {
 
     public update(players: Player[]): void {
         const toRemove: Set<string> = new Set(this._players.keys());
+        const toUpdate: Set<string> = new Set();
 
         players.forEach((data: Player): void => {
             const existing: Player | undefined = this._players.get(data.uuid);
             if (existing) {
+                if (existing.position === undefined && data.position !== undefined) {
+                   toUpdate.add(data.uuid);
+                }
+
                 // update existing
                 existing.displayName = data.displayName;
                 existing.world = data.world;
@@ -46,6 +51,13 @@ export class PlayerManager {
             fireCustomEvent('playerremoved', player);
         });
 
+        toUpdate.forEach((uuid: string): void => {
+           // remove players not in updated settings file
+           const player: Player | undefined = this._players.get(uuid);
+           fireCustomEvent('playerupdate', player);
+        });
+
+
         // follow
         this.updateFollow();
     }

webmap/src/sidebar/PlayersTab.ts

@@ -59,6 +59,27 @@ export default class PlayersTab extends BaseTab {
                 item.input.checked = player === e.detail;
             });
         });
+        addEventListener('playerupdate', (e: CustomEvent<Player>): void => {
+            const listItem: PlayerListItem | undefined = this._players.get(e.detail);
+            if (listItem === undefined) {
+                return;
+            }
+            let wasDisabled: boolean = listItem.input.disabled;
+            let isDisabled: boolean = e.detail.position === undefined;
+            listItem.input.disabled = isDisabled;
+            if (isDisabled) {
+                listItem.label.setAttribute('disabled', "");
+            } else {
+                listItem.label.removeAttribute('disabled');
+            }
+            if (wasDisabled && !isDisabled) {
+                const manager: PlayerManager = this._pl3xmap.playerManager;
+                if (e.detail === manager.follow) {
+                    manager.follow = undefined;
+                    manager.updateFollow();
+                }
+            }
+        });
 
         this._list.addEventListener('keydown', (e: KeyboardEvent) =>
             handleKeyboardEvent(e, Array.from(this._list.elements) as HTMLElement[]))
@@ -92,6 +113,9 @@ export default class PlayersTab extends BaseTab {
         input.addEventListener('click', async (): Promise<void> => {
             const manager: PlayerManager = this._pl3xmap.playerManager;
             const player: Player | undefined = manager.players.get(input.id);
+            if (player !== undefined && player.position === undefined) {
+                return;
+            }
             if (player === manager.follow) {
                 manager.follow = undefined;
             } else {