forked from GeyserMC/Geyser
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add custom skull render distance (GeyserMC#2751)
* Add player skull render distance * Improve updateVisibleSkulls a bit Avoid rechecking visibility on small movements * Periodically despawn unused skull entities * Don't hide skull entity for position/rotation changes Prevents flickering for skulls that are rotating * Update visible skulls when a skull is removed * Only update on removal if an entity is assigned * No need to check for skull in ChunkUtils Update copyright year * Avoid rechecking all skulls when a skull is added/removed * Allow skull render distance and number to be configured Renamed some fields to better match their values * Compare texture property directly from GameProfile * Remove unnecessary blockState field from SkullPlayerEntity * Use binarySearch for insertion Wait for player movement before loading skulls * Allow culling to be disabled by setting max-visible-custom-skulls to -1 * Only remove skulls in inRangeSkulls when culling is enabled * Add suggestions from review * Merge the for loops in updateVisibleSkulls * Fix skulls being leaked on chunk unload
- Loading branch information
Showing
12 changed files
with
306 additions
and
82 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
211 changes: 211 additions & 0 deletions
211
core/src/main/java/org/geysermc/geyser/session/cache/SkullCache.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,211 @@ | ||
| /* | ||
| * Copyright (c) 2019-2022 GeyserMC. http://geysermc.org | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| * of this software and associated documentation files (the "Software"), to deal | ||
| * in the Software without restriction, including without limitation the rights | ||
| * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| * copies of the Software, and to permit persons to whom the Software is | ||
| * furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in | ||
| * all copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| * THE SOFTWARE. | ||
| * | ||
| * @author GeyserMC | ||
| * @link https://github.com/GeyserMC/Geyser | ||
| */ | ||
|
|
||
| package org.geysermc.geyser.session.cache; | ||
|
|
||
| import com.nukkitx.math.vector.Vector3f; | ||
| import com.nukkitx.math.vector.Vector3i; | ||
| import it.unimi.dsi.fastutil.objects.Object2ObjectOpenHashMap; | ||
| import lombok.Data; | ||
| import lombok.Getter; | ||
| import lombok.RequiredArgsConstructor; | ||
| import org.geysermc.geyser.entity.type.player.SkullPlayerEntity; | ||
| import org.geysermc.geyser.session.GeyserSession; | ||
|
|
||
| import java.util.*; | ||
|
|
||
| public class SkullCache { | ||
| private final int maxVisibleSkulls; | ||
| private final boolean cullingEnabled; | ||
|
|
||
| private final int skullRenderDistanceSquared; | ||
|
|
||
| /** | ||
| * The time in milliseconds before unused skull entities are despawned | ||
| */ | ||
| private static final long CLEANUP_PERIOD = 10000; | ||
|
|
||
| @Getter | ||
| private final Map<Vector3i, Skull> skulls = new Object2ObjectOpenHashMap<>(); | ||
|
|
||
| private final List<Skull> inRangeSkulls = new ArrayList<>(); | ||
|
|
||
| private final Deque<SkullPlayerEntity> unusedSkullEntities = new ArrayDeque<>(); | ||
| private int totalSkullEntities = 0; | ||
|
|
||
| private final GeyserSession session; | ||
|
|
||
| private Vector3f lastPlayerPosition; | ||
|
|
||
| private long lastCleanup = System.currentTimeMillis(); | ||
|
|
||
| public SkullCache(GeyserSession session) { | ||
| this.session = session; | ||
| this.maxVisibleSkulls = session.getGeyser().getConfig().getMaxVisibleCustomSkulls(); | ||
| this.cullingEnabled = this.maxVisibleSkulls != -1; | ||
|
|
||
| // Normal skulls are not rendered beyond 64 blocks | ||
| int distance = Math.min(session.getGeyser().getConfig().getCustomSkullRenderDistance(), 64); | ||
| this.skullRenderDistanceSquared = distance * distance; | ||
| } | ||
|
|
||
| public void putSkull(Vector3i position, String texturesProperty, int blockState) { | ||
| Skull skull = skulls.computeIfAbsent(position, Skull::new); | ||
| skull.texturesProperty = texturesProperty; | ||
| skull.blockState = blockState; | ||
|
|
||
| if (skull.entity != null) { | ||
| skull.entity.updateSkull(skull); | ||
| } else { | ||
| if (!cullingEnabled) { | ||
| assignSkullEntity(skull); | ||
| return; | ||
| } | ||
| if (lastPlayerPosition == null) { | ||
| return; | ||
| } | ||
| skull.distanceSquared = position.distanceSquared(lastPlayerPosition.getX(), lastPlayerPosition.getY(), lastPlayerPosition.getZ()); | ||
| if (skull.distanceSquared < skullRenderDistanceSquared) { | ||
| // Keep list in order | ||
| int i = Collections.binarySearch(inRangeSkulls, skull, Comparator.comparingInt(Skull::getDistanceSquared)); | ||
| if (i < 0) { // skull.distanceSquared is a new distance value | ||
| i = -i - 1; | ||
| } | ||
| inRangeSkulls.add(i, skull); | ||
|
|
||
| if (i < maxVisibleSkulls) { | ||
| // Reassign entity from the farthest skull to this one | ||
| if (inRangeSkulls.size() > maxVisibleSkulls) { | ||
| freeSkullEntity(inRangeSkulls.get(maxVisibleSkulls)); | ||
| } | ||
| assignSkullEntity(skull); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| public void removeSkull(Vector3i position) { | ||
| Skull skull = skulls.remove(position); | ||
| if (skull != null) { | ||
| boolean hadEntity = skull.entity != null; | ||
| freeSkullEntity(skull); | ||
|
|
||
| if (cullingEnabled) { | ||
| inRangeSkulls.remove(skull); | ||
| if (hadEntity && inRangeSkulls.size() >= maxVisibleSkulls) { | ||
| // Reassign entity to the closest skull without an entity | ||
| assignSkullEntity(inRangeSkulls.get(maxVisibleSkulls - 1)); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| public void updateVisibleSkulls() { | ||
| if (cullingEnabled) { | ||
| // No need to recheck skull visibility for small movements | ||
| if (lastPlayerPosition != null && session.getPlayerEntity().getPosition().distanceSquared(lastPlayerPosition) < 4) { | ||
| return; | ||
| } | ||
| lastPlayerPosition = session.getPlayerEntity().getPosition(); | ||
|
|
||
| inRangeSkulls.clear(); | ||
| for (Skull skull : skulls.values()) { | ||
| skull.distanceSquared = skull.position.distanceSquared(lastPlayerPosition.getX(), lastPlayerPosition.getY(), lastPlayerPosition.getZ()); | ||
| if (skull.distanceSquared > skullRenderDistanceSquared) { | ||
| freeSkullEntity(skull); | ||
| } else { | ||
| inRangeSkulls.add(skull); | ||
| } | ||
| } | ||
| inRangeSkulls.sort(Comparator.comparingInt(Skull::getDistanceSquared)); | ||
|
|
||
| for (int i = inRangeSkulls.size() - 1; i >= 0; i--) { | ||
| if (i < maxVisibleSkulls) { | ||
| assignSkullEntity(inRangeSkulls.get(i)); | ||
| } else { | ||
| freeSkullEntity(inRangeSkulls.get(i)); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Occasionally clean up unused entities as we want to keep skull | ||
| // entities around for later use, to reduce "player" pop-in | ||
| if ((System.currentTimeMillis() - lastCleanup) > CLEANUP_PERIOD) { | ||
| lastCleanup = System.currentTimeMillis(); | ||
| for (SkullPlayerEntity entity : unusedSkullEntities) { | ||
| entity.despawnEntity(); | ||
| totalSkullEntities--; | ||
| } | ||
| unusedSkullEntities.clear(); | ||
| } | ||
| } | ||
|
|
||
| private void assignSkullEntity(Skull skull) { | ||
| if (skull.entity != null) { | ||
| return; | ||
| } | ||
| if (unusedSkullEntities.isEmpty()) { | ||
| if (!cullingEnabled || totalSkullEntities < maxVisibleSkulls) { | ||
| // Create a new entity | ||
| long geyserId = session.getEntityCache().getNextEntityId().incrementAndGet(); | ||
| skull.entity = new SkullPlayerEntity(session, geyserId); | ||
| skull.entity.spawnEntity(); | ||
| skull.entity.updateSkull(skull); | ||
| totalSkullEntities++; | ||
| } | ||
| } else { | ||
| // Reuse an entity | ||
| skull.entity = unusedSkullEntities.removeFirst(); | ||
| skull.entity.updateSkull(skull); | ||
| } | ||
| } | ||
|
|
||
| private void freeSkullEntity(Skull skull) { | ||
| if (skull.entity != null) { | ||
| skull.entity.free(); | ||
| unusedSkullEntities.addFirst(skull.entity); | ||
| skull.entity = null; | ||
| } | ||
| } | ||
|
|
||
| public void clear() { | ||
| skulls.clear(); | ||
| inRangeSkulls.clear(); | ||
| unusedSkullEntities.clear(); | ||
| totalSkullEntities = 0; | ||
| lastPlayerPosition = null; | ||
| } | ||
|
|
||
| @RequiredArgsConstructor | ||
| @Data | ||
| public static class Skull { | ||
| private String texturesProperty; | ||
| private int blockState; | ||
| private SkullPlayerEntity entity; | ||
|
|
||
| private final Vector3i position; | ||
| private int distanceSquared; | ||
| } | ||
| } |
Oops, something went wrong.