跳至正文
OpenAgentSkill
浏览已开放 · 目录记录日期 2026-11-21 · 自动更新和账户服务暂时关闭。
开发与测试

roblox-luau

Roblox Luau scripting and code structure: services, Instances, Script vs LocalScript vs ModuleScript, the task library and typed Luau, with selene and luau-lsp checks. Use when a LocalScript does not run, a client gets nil after joining or wait() needs replacing. Not for remotes (`roblox-networking`), saving (`roblox-datastores`) or live-place edits (`roblox-studio-workflow`).

gamedev-skills · 已有静态检查记录

安装与使用

运行命令前先阅读来源与依赖说明。复制命令不会自动安装或执行。

npx skills add gamedev-skills/awesome-gamedev-agent-skills --skill roblox-luau

技能说明


name: roblox-luau description: > Roblox Luau scripting and code structure: services, Instances, Script vs LocalScript vs ModuleScript, the task library and typed Luau, with selene and luau-lsp checks. Use when a LocalScript does not run, a client gets nil after joining or wait() needs replacing. Not for remotes (roblox-networking), saving (roblox-datastores) or live-place edits (roblox-studio-workflow).

Roblox Luau scripting

Write Luau that runs in the right place, cleans up after itself, and passes static checks before anyone presses Play. Remote events appear here only as basic mechanics; contract design and validation belong to roblox-networking.

Workflow

  1. Read the project setup first. Rojo *.project.json, selene.toml, .luaurc, Wally or pesde manifests, and the place's Workspace.SignalBehavior and LuauTypeCheckMode. Follow the existing module layout and naming instead of inventing a new one.
  2. Decide where the code runs (table below). Check RunContext on any Script before assuming it is server code.
  3. Get services with game:GetService("Name") at the top of the file, not by indexing game.
  4. Create Instances deliberately. Set properties, then Parent last, so the Instance replicates once in its final state and change handlers do not fire for every property.
  5. Own every connection. Store what :Connect returns and disconnect it with the object or screen that created it; use :Once for one-shot handlers.
  6. Share code through ModuleScripts. A module runs once per context (server, and each client separately) and require returns the cached result, so module-level state is per context, never shared between server and client.
  7. Check before reporting. Run the project's static tools (below). With the Studio MCP server connected, start_stop_play, exercise the change with execute_luau on the matching datamodel, then read get_console_output and report any new error or warning. Without it, ask the user to press Play and paste the Output, from both the server and client views when both sides changed.

Static checks the agent can run

selene .                                      # root selene.toml needs std = "roblox"
rojo sourcemap default.project.json --output sourcemap.json
luau-lsp analyze --sourcemap=sourcemap.json src   # add Roblox type definitions; see --help

Run only the tools the project already uses. Studio Script Sync projects may not have a sourcemap.

Where code runs

ContainerRunsUse for
ServerScriptServiceserver Scriptsauthoritative logic; never replicated
ServerStoragenot run; server-only storageassets and data clients must not see
ReplicatedStorageScript with RunContext = Client runs here on clientsremotes, shared modules and assets
StarterPlayerScriptsLocalScript, once per playerpersistent client systems
StarterCharacterScriptsLocalScript, once per characterper-character client logic
StarterGuiLocalScript in UI, cloned to PlayerGuiUI behavior

A LocalScript in Workspace (outside the player's character) or ServerScriptService never runs. A Script with RunContext = Client inside a Starter* container runs twice (the original and the clone), so keep those in ReplicatedStorage.

Patterns

Server Script: per-player setup that also covers early joiners

-- ServerScriptService/Leaderboard.server.luau
local Players = game:GetService("Players")

local function onPlayerAdded(player: Player)
    local stats = Instance.new("Folder")
    stats.Name = "leaderstats"          -- this exact name shows on the default leaderboard
    local coins = Instance.new("IntValue")
    coins.Name = "Coins"
    coins.Parent = stats
    stats.Parent = player               -- parent last
end

Players.PlayerAdded:Connect(onPlayerAdded)
for _, player in Players:GetPlayers() do  -- players who joined before this script connected
    task.spawn(onPlayerAdded, player)
end

Connection owned by its object

local touchedOnce: {[Humanoid]: boolean} = {}
local connection = part.Touched:Connect(function(hit: BasePart)
    local humanoid = hit.Parent and hit.Parent:FindFirstChildOfClass("Humanoid")
    if not humanoid or touchedOnce[humanoid] then return end
    touchedOnce[humanoid] = true
    humanoid:TakeDamage(10)
    task.delay(1, function() touchedOnce[humanoid] = nil end)
end)
part.Destroying:Once(function() connection:Disconnect() end)

A single shared debounce boolean blocks every other player while one is touching; key it by the thing being debounced.

Basic remote mechanics

-- LocalScript: request only. The client can send anything.
local ReplicatedStorage = game:GetService("ReplicatedStorage")
local buyItem = ReplicatedStorage:WaitForChild("Remotes"):WaitForChild("BuyItem")
buyButton.Activated:Connect(function() buyItem:FireServer("sword") end)
-- Script: the server looks up the price and decides.
local PRICES = { sword = 100, shield = 75 }
buyItem.OnServerEvent:Connect(function(player: Player, itemId: unknown)
    if type(itemId) ~= "string" then return end
    local price = PRICES[itemId]
    local coins = player:FindFirstChild("leaderstats") and player.leaderstats:FindFirstChild("Coins")
    if not price or not coins or coins.Value < price then return end
    coins.Value -= price
    grantItem(player, itemId)
end)

Rate limits, Instance arguments, yields inside handlers, and multi-client testing: roblox-networking.

Frame loop and shared module

local RunService = game:GetService("RunService")
RunService.Heartbeat:Connect(function(dt: number)   -- after physics, every frame
    spinner.CFrame *= CFrame.Angles(0, math.rad(90) * dt, 0)
end)
-- ReplicatedStorage/Shared/GameConfig (ModuleScript)
local GameConfig = table.freeze({
    MaxHealth = 100,
    Weapo
阅读完整来源 ↗