@sunlight_xlz/y3-lualib-types 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 sunlight_xlz
+
+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.

package/README.md

@@ -0,0 +1,47 @@
+# @sunlight_xlz/y3-lualib-types
+
+从 [y3-editor/y3-lualib](https://github.com/y3-editor/y3-lualib) 自动生成的 Y3 Lua API
+TypeScript 声明，适用于 TypeScriptToLua。
+
+```sh
+yarn add -D @sunlight_xlz/y3-lualib-types
+```
+
+在 `tsconfig.json` 配置：
+
+```json
+{
+  "compilerOptions": {
+    "strict": true,
+    "allowUmdGlobalAccess": true,
+    "types": ["@sunlight_xlz/y3-lualib-types"]
+  },
+  "tstl": { "luaTarget": "5.4" }
+}
+```
+
+```ts
+const point: y3.Point = y3.point.create(100, 200);
+const player = y3.player.get_by_id(1);
+const unit = y3.unit.create_unit(player, 10001, point, 0);
+y3.timer.wait(1, (timer) => {
+  const name: string = unit.get_name();
+  timer.remove();
+});
+```
+
+这是纯声明包，不包含 Lua 运行库。请在地图中另外安装并初始化 `y3-lualib`，
+不要运行时 import 此包。类型通过全局 `y3` 命名空间提供；点调用、冒号调用和多返回值
+分别匹配原始 Lua API。模块文件中使用全局 y3 需要 `allowUmdGlobalAccess`。
+
+上游的嵌套类型名转换为下划线，例如 `y3.Const.UnitAttr` → `y3.Const_UnitAttr`。
+运行时属性名保持原样，例如 `y3.const.UnitAttr`。
+
+`generation.json` 包含精确上游 SHA、生成范围、外部未定义类型及注释精度诊断。
+声明逐成员保留中文文档和对应版本的源码链接。
+未注解参数使用 `any`；未注解返回值和上游外部未定义类型使用 `unknown`。
+泛型表使用 `LuaTable`，多返回值使用 `LuaMultiReturn`。
+这些声明经过 TypeScript 严格检查和代表性 TypeScriptToLua 编译验证，
+不代表所有 API 已在 Y3 游戏环境中逐一运行验收。
+
+MIT 许可证；上游许可证见 `UPSTREAM-LICENSE`。

package/UPSTREAM-LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 y3-editor
+
+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.