SuperAPI AI 工具集

roblox-luau-patterns

编程与开发

查看项目

更新于 10-16 09:41

技能介绍

Luau Patterns 是一个面向 Roblox Luau 代码编写与重构的技能,适用于处理模块形态、资源所有权、调度与失败契约的场景。相关资料说明,其语义可参考 roblox-luau-core,类型可参考 roblox-luau-types,启动流程可参考 roblox-architecture。

用途

该技能用于在编写或重构 Roblox Luau 模块时提供参考,包括模块形态选择、对象生命周期、信号、任务调度、pcall 与清理。加载场景为:模块形态、资源所有权、调度与失败契约。

主要能力

在形态选择上,资料给出以下建议:普通函数用于无状态转换或校验的默认选择;带私有状态的模块应有一个明确的子系统所有者,不要仅为命名空间化函数而创建管理器类;带元表的对象用于多个独立值需要共享行为与生命周期的场景;若项目已一致使用既有库抽象,则遵循它,不要为单个调用点添加 Promise、信号、清理或框架依赖。构造器使用 .,实例方法使用 :,可变字段应放在实例上而非类表上。

在所有权可见性上,信号连接、实例与任务都需要清理所有者,应在拆除时断开或取消,并导出带类型的自定义信号负载(Signal<T...>)。应先配置再设置父级以隐藏部分状态;仅在需要祖先关系时才提前设置父级,并说明原因。资料同时说明这并不保证复制顺序。

在失败语义上,示例代码为:

local ok, value = pcall(dataStore.GetAsync, dataStore, key) if not ok then return nil, read failed: {value} end return value, nil -- value may legitimately be nil

资料强调不要将“调用成功并返回 nil”与“调用失败”混为一谈。仅当领域操作可安全重复时才重试。持久化、HTTP、购买与远程调用属于各自领域技能。

在命名与返回契约上,实践惯例包括:将会让出的函数标记为 Async,保持返回数量一致,优先使用具名模块导出。应尊重既有项目契约,细节见 full.md。

在调度上,应审慎使用 task.defer、task.spawn、task.delay 与 task.cancel。避免旧的 wait() 与无正当理由的轮询。优先使用真实的状态变更信号;否则选择并测量明确的节奏。

审阅要点包括:所有者清晰、公共 API 狭窄、无循环 require、无意外并发启动、成功与缺失数据状态保持区分、连接与任务已清理、客户端输入路由至 roblox-networking。

使用方式

该技能以参考资料形式提供,包含 Quick Reference 与审阅清单,详细内容见 references/full.md。

适用场景

适用于 Roblox Luau 模块的编写、重构、代码审阅,以及涉及模块形态、资源所有权、调度与失败契约的设计决策。

限制

资料未提供具体安装命令、收费信息、价格、平台支持范围或效果数据,暂未提供。