Skip to content

WorldMapTracker

Package: com.hypixel.hytale.server.core.universe.world

public class WorldMapTracker implements Tickable

Per-player tracker that manages world map state: loading/unloading map chunk images in a spiral pattern around the player, tracking zone discoveries with title/sound notifications, managing map markers, and handling pending reload chunks. Uses a read-write lock for thread-safe access to the loaded chunk set. Sends UpdateWorldMap, ClearWorldMap, and UpdateWorldMapSettings packets to the player.

FieldTypeValueDescription
UPDATE_SPEEDfloat1.0FSeconds between map update ticks.
RADIUS_MAXint512Maximum map view radius in chunks.
MAX_IMAGE_GENERATIONint20Maximum map images generated per tick.
MAX_FRAMEint2621440Maximum packet frame size.
MethodReturn TypeDescription
tick(float)voidTick handler: updates compass markers and loads/unloads map images.
updateCurrentZoneAndBiome(Ref, ZoneDiscoveryInfo, String, ComponentAccessor)voidUpdates the player’s current zone and biome; fires zone discovery events.
discoverZone(World, String)booleanRecords a zone as discovered and refreshes settings. Returns true if newly discovered.
undiscoverZone(World, String)booleanRemoves a zone from the discovered set.
discoverZones(World, Set<String>)booleanBatch-discovers multiple zones.
clear()voidClears all loaded map data and markers.
clearChunks(LongSet)voidQueues specific chunks for reload.
sendSettings(World)voidSends map settings (teleport permissions, marker creation, etc.) to the client.
setViewRadiusOverride(Integer)voidOverrides the map view radius (null restores default).
getPlayer()PlayerReturns the owning player.
getSentMarkers()Map<String, MapMarker>Returns markers currently sent to the client.
copyFrom(WorldMapTracker)voidCopies loaded chunk and marker state from another tracker.

Immutable data class for zone discovery events.

FieldTypeDescription
zoneNameStringZone identifier.
regionNameStringParent region identifier.
displaybooleanWhether to display the discovery title.
discoverySoundEventIdStringSound event to play, or null.
iconStringDiscovery icon identifier, or null.
majorbooleanWhether this is a major zone discovery.
durationfloatTitle display duration.
fadeInDurationfloatTitle fade-in duration.
fadeOutDurationfloatTitle fade-out duration.
Hydex is an independent community resource. Hytale is a trademark of Hypixel Studios. Hydex is not affiliated with or endorsed by Hypixel Studios.