Endstone.DotNet Loader API 参考¶

以下每个页面都是**从源码生成**的:代码生成器(tools/DocGen)对 Endstone.Loader.dll 做反射,合并 src/csharp 中的 XML 文档注释,然后渲染成这些 Markdown 页面。请勿手工编辑,运行生成器即可。

核心¶

类型	说明
`Server`	包装原生 endstone::Server 单例的托管对象,是访问服务器信息、广播、玩家、地图、boss 血条与世界的入口。
`PluginBase`	所有 .NET 插件的基类。继承并在主类上添加 [Plugin] 特性;重写 OnLoad/OnEnable/OnDisable 生命周期方法,通过 Command()/RegisterEvent()/Scheduler/ServiceManager 使用服务器功能。
`PluginAttribute`	插件声明特性:标记插件主类,并提供名称、版本、描述与作者信息。
`Logger`	插件日志记录器,输出到服务器的插件日志。Trace 级别默认被过滤,Info 及以上可见。
`Scheduler`	插件作用域的调度器外壳,封装原生 endstone Scheduler。任务归属于插件,插件停用时自动全部取消。
`ScheduledTask`	排队到原生 endstone 调度器的任务句柄。同步任务在服务器线程执行,异步任务在工作线程执行。
`Service`	与服务器的服务管理器注册的服务的基类(对应 endstone::Service)。服务是标记式接口:提供者继承本类并实现自己的方法即可。
`ServiceManager`	插件作用域的服务管理器外壳(对应 endstone::ServiceManager)。注册的提供者关联到本插件,插件停用时自动注销。
`CommandSender`	命令发送者的抽象,既可以是玩家也可以是控制台。通过 AsPlayer() 可判断并转型。
`CommandBuilder`	命令的流式构建器:配置描述、用法、别名、权限,并绑定命令处理函数。

类型	说明
`Actor`	包装原生 endstone::Actor 的托管对象。实体是世界中可移动、可交互的对象(玩家、生物、掉落物等)。
`Player`	包装原生 endstone::Player 的托管对象(继承 Actor),提供消息、操作、物品、模式、飞行、传送等玩家功能。
`Mob`	包装原生 endstone::Mob 的托管对象(继承 Actor),提供生命值等生物专属属性。
`DamageSource`	伤害来源信息:伤害类型、直接/间接伤害者。
`Enchantment`	包装原生 endstone::Enchantment 的托管对象。通过 Enchantment.Get(键) 或静态常量(如 Sharpness)获取,并提供常用附魔的静态属性。
`ItemEnchantment`	物品上的一条附魔记录(附魔 + 等级)。

类型	说明
`Level`	包装原生 endstone::Level 的托管对象,表示服务器世界。可读写时间、获取种子、查询维度与实体。
`Dimension`	包装原生 endstone::Dimension 的托管对象,表示一个维度(主世界、下界、末地等)。
`Chunk`	包装原生 endstone::Chunk 的托管对象,表示一个区块 (16 x 16 x 384)。
`Block`	包装原生 endstone::Block 的托管对象,表示世界中的方块实例。
`BlockState`	方块状态的快照,可独立修改再更新到世界中,用于实现原子化的方块改动。
`Location`	三维坐标 + 视角(yaw/pitch)的值类型,用于表示实体/方块/生成位置。

类型	说明
`ItemStack`	包装原生 endstone::ItemStack 的托管对象。使用 ItemStack.Create("minecraft:diamond", 数量) 创建,可读写附魔、显示名与 lore。
`Inventory`	包装原生 endstone::Inventory 的托管对象,提供物品的读取、添加、移除与容量查询。
`PlayerInventory`	玩家的背包(继承 Inventory),提供主手/副手与护甲槽的快速访问。

类型	说明
`FormBase`1`	三种表单(MessageForm/ActionForm/ModalForm)的流式基类。Send() 把所有权交给原生侧,提交/关闭时自动注销回调;发送后不可复用构建器。
`MessageForm`	带标题、内容与两个按钮的简单表单。
`ActionForm`	动作表单:标题 + 内容 + 任意数量的带图标按钮。
`ModalForm`	模态表单:标题 + 内容 + 多个控件(下拉、滑动条、文本输入、开关等),提交结果为 JSON 负载。
`BossBar`	包装原生 endstone::BossBar 的托管对象。Boss 血条可以添加进度的文字说明与颜色/分段样式,并绑定到多个玩家。
`MapView`	包装原生 endstone::MapView 的托管对象。服务器通过 CreateMap 创建地图视图,可调整缩放、中心与跟踪设置,并添加渲染器。
`MapCanvas`	地图画布:通过 SetPixel/SetPixelColor 逐像素绘制地图渲染内容。
`MapCursor`	地图上的游标对象(坐标、方向、类型、可见性)。
`MapColor`	地图画布像素使用的 RGBA 颜色值类型。
`MapRenderer`	地图渲染器基类:重写 Render() 在 MapCanvas 上绘制,通过 MapView.AddRenderer 添加。

类型	说明
`Bootstrap`	原生 C++ 加载器 (dotnet_loader) 调用的托管入口点。包含宿主初始化、插件装配、事件/表单/调度/地图渲染等回调转发逻辑。

页面	内容
事件	派生自 `Event` 的 55 个事件类
枚举	19 个公开枚举