Pl3xMap插件中地图世界加载事件的使用指南

Pl3xMap插件中地图世界加载事件的使用指南

Pl3xMap Pl3xMap is a minimalistic and lightweight world map viewer for Minecraft servers using the vanilla Minecraft rendering style 项目地址: https://gitcode.com/gh_mirrors/pl/Pl3xMap

事件触发时机问题分析

在使用Pl3xMap插件API开发时，开发者可能会遇到一个常见问题：当监听Pl3xMapEnabledEvent事件时，发现WorldRegistry尚未初始化完成，导致无法正常注册地图标记层。这是因为Pl3xMapEnabledEvent是在插件启用初期触发的，此时世界数据还未完全加载。

正确的解决方案

Pl3xMap提供了专门针对世界加载的事件机制，开发者应该使用以下两个事件来处理地图相关的初始化工作：

1. WorldLoadedEvent：当Pl3xMap完成一个世界的加载时触发
2. WorldUnloadedEvent：当Pl3xMap卸载一个世界时触发

实现示例

以下是正确的事件监听实现方式：

public class MapWorldListener implements EventListener {
    
    @EventHandler
    public void onWorldLoad(WorldLoadedEvent event) {
        // 在这里可以安全地访问WorldRegistry
        World world = event.getWorld();
        // 创建并注册标记层
        MarkerLayer layer = new MarkerLayer("custom-layer", "自定义标记层");
        world.getLayerRegistry().register(layer);
        
        // 添加标记到该层
        Marker marker = Marker.builder()
            .position(new Point(0, 0))
            .icon("custom-icon")
            .build();
        layer.addMarker("unique-marker-id", marker);
    }
    
    @EventHandler
    public void onWorldUnload(WorldUnloadedEvent event) {
        // 清理资源
        World world = event.getWorld();
        world.getLayerRegistry().unregister("custom-layer");
    }
}

最佳实践建议

1. 延迟初始化：对于需要在服务器启动时加载的标记数据，建议使用WorldLoadedEvent而非Pl3xMapEnabledEvent

2. 动态处理：考虑到服务器可能动态加载/卸载世界，应该同时监听加载和卸载事件

3. 资源管理：在WorldUnloadedEvent中清理相关资源，避免内存泄漏

4. 错误处理：添加适当的异常处理，确保单个世界的加载失败不会影响其他世界

通过这种方式，开发者可以确保在地图世界完全初始化后才进行相关操作，避免了因时机不当导致的空指针异常或其他问题。

Pl3xMap Pl3xMap is a minimalistic and lightweight world map viewer for Minecraft servers using the vanilla Minecraft rendering style 项目地址: https://gitcode.com/gh_mirrors/pl/Pl3xMap