ข้ามไปที่เนื้อหา

คำสั่งกำหนดเอง

คำสั่ง

คำสั่งก็คือตารางข้อมูลที่บอกว่าคำสั่งนั้นคืออะไรและต้องรันยังไง ที่ออกแบบมาแบบนี้มีเหตุผลหลักๆ ดังนี้:

หน่วยความจำ เมื่อรันคำสั่ง ระบบจะแปลงเป็น 'งาน' ที่สตาฟดูและยกเลิกได้ง่าย งานจะเก็บกวาดตัวเองอัตโนมัติ หน่วยความจำจึงไม่รั่ว และออกแบบมาให้คุณไม่ต้องเขียนฟังก์ชัน undo แยกเลย
ขอบเขต งานไม่ผูกกับผู้เล่นคนใดคนหนึ่งที่รันคำสั่ง (คือผู้เรียกคำสั่ง) คำสั่งไหนก็ใช้กับตัวปรับแต่งใดก็ได้ ทำให้คำสั่งที่คุณเขียนส่งไปทุกเซิร์ฟเวอร์ได้ทันที
ความปลอดภัย ระบบตรวจอาร์กิวเมนต์ก่อนเรียก run เสมอ อาร์กิวเมนต์ Player จึงมาเป็น Player จริงๆ ส่วน Number จะอยู่ในช่วงที่อนุญาตเสมอ เป็นต้น โค้ดของคุณไม่ต้องรับข้อความดิบ และผู้เรียกจะรันคำสั่งที่บทบาทของตัวเองใช้ไม่ได้ไม่ได้
หน้าตา หน้า Run คำแนะนำในแถบคำสั่ง และการเติมคำอัตโนมัติ สร้างจาก args ของคุณให้เอง คำสั่งที่คุณเขียนทุกอันจึงใช้ได้ทันทีแม้กับผู้เล่นที่แชทไม่ได้
ระบุชนิดข้อมูล คำสั่งระบุชนิดข้อมูลครบ พอใส่ CommandAPI.Commands ให้คำสั่งของคุณ ก็จะได้การเติมคำอัตโนมัติและคำเตือนเรื่องชนิดข้อมูลระหว่างเขียน

สร้างเองได้เลย

ใน ConfigCommands ให้ต่อยอดจากโมดูล Custom ที่มีอยู่ หรือจะเพิ่มโมดูลของคุณเองที่มีตารางคำสั่งกี่อันก็ได้:

รูปภาพ

--!strict
-- LOCAL
local TAGS = {"CoolCommands"}
local StarterPlayer = game:GetService("StarterPlayer")
local CommandAPI = require(script:FindFirstAncestor("HD Admin").Core.CommandAPI)
local getHumanoid = CommandAPI.getHumanoid
local getHRP = CommandAPI.getHRP

-- COMMANDS
local commands: CommandAPI.Commands = {

    --------------------
    {
        name = "Jump",
        args = {"Player"},
        tags = TAGS,
        run = function(task: CommandAPI.Task)
            local target = task.target
            local humanoid = getHumanoid(target)
            if not humanoid then return end
            humanoid.Jump = true
        end,
    },

    --------------------
    {
        name = "Fire",
        args = {"Player"},
        tags = TAGS,
        run = function(task: CommandAPI.Task)
            local target = task.target
            local hrp = getHRP(target)
            if not hrp then return end
            task:keep("UntilTargetRespawns")
            local fire = task.janitor:add(Instance.new("Fire"))
            fire.Parent = hrp
        end,
    },

    --------------------

}

return commands

คำสั่งฝั่งไคลเอนต์

โค้ดคำสั่งโดยปกติมีและรันบนเซิร์ฟเวอร์เท่านั้น แต่บางครั้งเราต้องให้รันบนไคลเอนต์ด้วย วิธีแก้คือเพิ่ม ModuleScript ชื่อ Client ไว้ใต้โมดูลคำสั่ง โดยในนั้นมีตารางคำสั่งที่ค่า name ตรงกับคำสั่งบนเซิร์ฟเวอร์:

รูปภาพ

--!strict
-- LOCAL
local TAGS = {script.Name}
local CommandAPI = require(script:FindFirstAncestor("HD Admin").Core.CommandAPI)

-- COMMANDS
local commands: CommandAPI.Commands = {

    --------------------
    {
        name = "Flash",
        args = {"Player"},
        tags = TAGS,
        run = function(task: CommandAPI.Task)
            local target = task.target
            task.client:run(target)
        end,
    },

    --------------------

}

return commands

รูปภาพ

--!strict
-- LOCAL
local CommandAPI = require(script:FindFirstAncestor("HD Admin").Core.CommandAPI)
local Players = game:GetService("Players")
local TweenService = game:GetService("TweenService")

-- COMMANDS
local clientCommands: CommandAPI.ClientCommands = {

    --------------------
    {
        name = "Flash",
        run = function(task: CommandAPI.Task)
            local localPlayer = Players.LocalPlayer
            local playerGui = localPlayer:FindFirstChildOfClass("PlayerGui")
            if not playerGui then
                return
            end
            local screenGui = Instance.new("ScreenGui")
            screenGui.Name = "HDCustomFlash"
            screenGui.IgnoreGuiInset = true
            screenGui.DisplayOrder = 999
            local frame = Instance.new("Frame")
            frame.BackgroundColor3 = Color3.new(1, 1, 1)
            frame.Size = UDim2.fromScale(1, 1)
            frame.Parent = screenGui
            screenGui.Parent = playerGui
            local tween = TweenService:Create(frame, TweenInfo.new(1), {BackgroundTransparency = 1})
            tween.Completed:Once(function()
                screenGui:Destroy()
            end)
            tween:Play()
        end,
    },

    --------------------

}

return clientCommands

มีภาพกะพริบ กดเพื่อดู

Info

คุณไม่ต้องทำให้อะไรถูกส่งไปยังไคลเอนต์เอง เฟรมเวิร์กจะหาโมดูลลูกที่ชื่อ Client เจอและย้ายไปให้ผู้เล่นอัตโนมัติ


ฟิลด์ของคำสั่ง

ทุกฟิลด์ยกเว้น name ไม่บังคับใส่:

การตั้งชื่อ
name Shared ชื่อคำสั่งที่แสดง และสิ่งที่ผู้เล่นพิมพ์ต่อจากคำนำหน้า ใช้เป็นชื่อสำหรับยกเลิกด้วย เช่น ;speed จบด้วย ;unspeed
aliases Server ชื่อเรียกแทนอื่นๆ ที่เรียกคำสั่งนี้ได้``
undoAliases Server ชื่อที่ใช้ยกเลิกคำสั่งแทนที่จะรัน (เช่น NoClip ใช้ {"Clip"})
description Server ประโยคที่แสดงใต้คำสั่งในหน้า Run ของคำสั่งนั้น
credit Server ผู้ที่ควรได้รับเครดิตของคำสั่ง (เช่น {"GigsD4X"})
การรัน
args Server อาร์กิวเมนต์ที่คำสั่งรับ (เช่น "Player", "Text", "Number" ฯลฯ ดูรายการทั้งหมดได้ที่ MainModuleValueModulesParserArgs
run Shared โค้ดของคำสั่ง บนเซิร์ฟเวอร์จะได้รับงานและอาร์กิวเมนต์ที่ตรวจแล้ว ส่วนบนไคลเอนต์จะได้รับงานตามด้วยสิ่งที่เซิร์ฟเวอร์ส่งมาใน task.client:run
replication Client ฟังก์ชันที่รับข้อมูลซึ่งส่งกลับมาจากเซิร์ฟเวอร์ ไคลเอนต์ของคุณเรียก task.server:replicate จากนั้น task.client.replicator ของเซิร์ฟเวอร์จะเลือกว่าใครรับ แล้วฟังก์ชันนี้จะรันบนไคลเอนต์ของคนเหล่านั้น
config Server ค่าเริ่มต้นที่ผู้สร้างเกมแก้ได้ผ่าน modify ตอนโหลดคำสั่งภายใน
cooldown Server จำนวนวินาทีที่ต้องรอหลังคำสั่งจบ ก่อนจะรันซ้ำได้
stackable Server ปกติแต่ละผู้เล่นหรือเซิร์ฟเวอร์มีคำสั่งเดียวกันทำงานได้ทีละอัน แต่ถ้าตั้งเป็น true จะทำงานพร้อมกันหลายอันได้
groups Server คำสั่งที่อยู่กลุ่มเดียวกันจะยกเลิกกันเองบนผู้เล่นคนเดียวกัน (เช่น Fly กับ NoClip อยู่กลุ่ม "Flight" ดังนั้นเริ่มอันหนึ่งอีกอันจะหยุด) และใช้ cooldown ร่วมกัน มีสองกลุ่มที่มีความหมายพิเศษ: "Prompt" ใช้กับคำสั่งแนวข้อความ ซึ่งใช้โควตาข้อความนาทีละครั้งแม้ไม่ได้พิมพ์อะไร และถูกกรองด้วยการตั้งค่า Block prompts ส่วน "Map" ใช้กับคำสั่งที่แก้แมป คำสั่งแรกที่รันจะเก็บสำเนาไว้เงียบๆ สำหรับ ;clearmap
ขอบเขต
tags Server แท็กที่คำสั่งนี้รับสืบมา ซึ่งบทบาทจะใช้ตัดสินว่าสืบคำสั่งไหนไป
disableModifiers Server ไม่ให้ใช้ตัวปรับแต่งกับคำสั่งนี้
disableGlobalModifiers Server ไม่ให้ใช้ตัวปรับแต่งส่วนกลาง (เช่น global, perm, join ฯลฯ) กับคำสั่งนี้
หน้าตา
order Server ตำแหน่งของคำสั่งในหน้า Commands ตัวเลขน้อยอยู่ก่อน
hide Server ซ่อนคำสั่งจากหน้า Commands
autoPreview Server เมื่อรันคำสั่งผ่านแชทหรือปุ่มดูตัวอย่างด่วน จะเปิดหน้า Run แทนที่จะรันเลย (เช่น Ban ใช้ตัวนี้เพื่อให้ยืนยันรายละเอียดก่อน)

อาร์กิวเมนต์แบบกำหนดเอง

อาร์กิวเมนต์ที่มีมาให้ (ใน MainModuleValueModulesParserArgs) ครอบคลุมเกือบทุกอย่างที่คุณต้องใช้ แต่ถ้าอยากสร้างเอง ทำได้ที่ Config > Args:

รูปภาพ

return function(Args)
    return {

        ["Radius"] = Args.createAliasOf("Number", {
            display = "Radius",
            min = 0,
            max = 500,
            step = 1,
            default = 50,
        }),

    }
end

Warning

อย่าตั้งชื่อซ้ำกับอาร์กิวเมนต์ที่มีมาใน HD Admin ไม่อย่างนั้นจะมีคำเตือนตอนเริ่มระบบ และอันใดอันหนึ่งจะถูกใช้แทนอีกอัน

ถ้าอยากปรับอาร์กิวเมนต์ของคำสั่งเดียว คุณเปลี่ยนชื่ออาร์กิวเมนต์เป็นตารางอาร์กิวเมนต์แทนได้:

args = {
    "Player",
    {arg = "Number", display = "Speed", default = 50, min = 0, max = 1000, step = 1, logarithmic = true},
},
args = {
    "Player",
    "Number",
},

Tip

วิธีนี้มีประโยชน์เมื่อคุณอยากแก้ข้อจำกัดของอาร์กิวเมนต์ โดยไม่ต้องเปลี่ยนพฤติกรรมของมันทั้งหมด: รูปภาพ

ข้อความที่ผู้เล่นคนอื่นเห็น

นโยบายความปลอดภัยตามอายุของ Roblox จำกัดให้ผู้เล่นแสดงข้อความให้คนอื่นเห็นได้นาทีละครั้ง HD Admin กรองอาร์กิวเมนต์ข้อความทุกตัว และใช้โควตาหนึ่งนาทีตามประเภทของมัน ซึ่งทุกคำสั่งประเภทเดียวกันใช้ร่วมกัน:

อาร์กิวเมนต์ ใช้สำหรับ
"Text" อะไรก็ตามที่แสดงเป็นข้อความ คำใบ้ การแจ้งเตือน ประกาศ หรือโพล
"SurfaceText" ชื่อ หัวข้อ และป้ายที่แสดงเหนือผู้เล่นหรือในโลกของเกม
"ChatText" แท็กแชทและชื่อในแชท
"Reason" เหตุผลของการเตะและแบน

ถ้าอยากเลือกประเภทเอง ให้เพิ่ม textSurface ในตารางอาร์กิวเมนต์ เช่น {arg = "Text", textSurface = "SurfaceText"} ใช้ "None" กับข้อความที่แสดงให้คนอื่นเห็นแค่บางครั้ง แล้วเรียก checkTextLimit ตอนที่มันแสดงจริง


อาร์กิวเมนต์

ถ้าจะดึงอาร์กิวเมนต์ของคำสั่ง ให้ใช้ task:getArg() แล้วระบุชื่อหรือลำดับ:

args = {"Player", "Number"},
run = function(task: CommandAPI.Task)
    local target = task:getArg("Player")
    local number = task:getArg("Number")
    -- ...
end
args = {"Player", "Number"},
run = function(task: CommandAPI.Task)
    local target = task:getArg(1)
    local number = task:getArg(2)
    -- ...
end

Note

ต้องดึงอาร์กิวเมนต์ด้วยลำดับเมื่อคำสั่งมีอาร์กิวเมนต์ชนิดเดียวกันตั้งแต่สองตัวขึ้นไป: {"Player", "Number", "Number"}

เมื่อใช้ "Player" เป็นอาร์กิวเมนต์แรก คำสั่งจะรันแยกกันกับผู้เล่นทุกคนที่ถูกเลือก ในกรณีนี้คุณใช้ task.target เพื่ออ้างถึง "Player" ได้:

args = {"Player", "Number"},
run = function(task: CommandAPI.Task)
    local target = task.target
    local number = task:getArg("Number")
    -- ...
end

การคงอยู่

งานจะถูกทำลายทันทีที่ run ทำงานจบ แบบนี้ไม่มีปัญหากับคำสั่งอย่าง ;jump ที่จบในทันที... แต่ไม่เหมาะกับคำสั่งอย่าง music ที่ต้องการให้ผลคงอยู่ ดังนั้นคำสั่งไหนที่ต้องการให้ทำงานต่อ ต้องผ่าน task:keep:

task:keep("UntilTargetRespawns")
การคงอยู่ งานจะจบเมื่อ
"UntilTargetRespawns" เป้าหมายเกิดใหม่หรือออกจากเกม
"UntilTargetLeaves" เป้าหมายออกจากเกม
"UntilCallerRespawns" คนที่รันคำสั่งเกิดใหม่หรือออกจากเกม
"UntilCallerLeaves" คนที่รันคำสั่งออกจากเกม
"Indefinitely" มีคนจบมันด้วย ;un หรือผู้เล่นออกจากเกม

Tip

คุณรวมหลาย 'keep' เข้าด้วยกันได้ เช่น ใช้ task:keep("UntilTargetLeaves") กับ task:keep("UntilCallerLeaves") คำสั่งจะจบเมื่อคนรันหรือเป้าหมายคนใดคนหนึ่งออกจากเซิร์ฟเวอร์


บัฟ

การเปลี่ยนพร็อพเพอร์ตี้ เช่น WalkSpeed ของฮิวมานอยด์ ปกติเป็นเรื่องง่าย แค่ตั้งค่าที่ต้องการก็เสร็จ แต่จะซับซ้อนขึ้นนิดหน่อยเมื่อมีหลายคำสั่งเกี่ยวข้อง

สมมติว่าเลือดของคุณคือ 100 แล้วคุณรัน ;health me 500 ตามด้วย ;god me ตอนแรก ;health ตั้งเลือดเป็น 500 จากนั้น ;god เปลี่ยนเป็น 99999 แบบนี้ยังไม่มีปัญหา... แต่ถ้าคุณอยากเอางาน god ออกแต่ให้ health ยังอยู่ล่ะ ระบบแอดมินหลายแห่งจะรีเซ็ตเลือดกลับเป็น 100 ตอนยกเลิก god โดยไม่สนว่างาน health ยังทำงานอยู่ ซึ่งไม่ใช่สิ่งที่เราต้องการ และนี่คือจุดที่บัฟมีประโยชน์:

task:buff(target, "WalkSpeed", function(hasEnded: boolean, original: any)
    local humanoid = getHumanoid(target)
    local before = if humanoid then humanoid.WalkSpeed else StarterPlayer.CharacterWalkSpeed
    if humanoid then
        humanoid.WalkSpeed = if hasEnded then original else task:getArg("Number")
    end
    return before
end)

บัฟคือโค้ดของคุณบวกกับกลุ่มที่มันอยู่ (เช่น "WalkSpeed" ในตัวอย่างนี้) ทุกครั้งที่งานในกลุ่มนั้นเริ่มหรือจบ บัฟทั้งหมดของกลุ่มจะถูกรันใหม่ตามลำดับ พร็อพเพอร์ตี้ของคุณจึงลงเอยที่ค่าที่คำสั่งสุดท้ายต้องการเสมอ

คุณยังส่งค่าเดิมกลับได้ด้วย คือค่าที่บัฟแรกสุดของกลุ่มจำไว้ เมื่อบัฟสุดท้ายถูกเอาออก พร็อพเพอร์ตี้ของคุณจะถูกตั้งกลับเป็นค่าเดิมนี้ได้ เลือดของคุณจึงกลับไปเป็น 100 แทนที่จะเป็นค่าที่คำสั่งก่อนหน้าทิ้งไว้


การเชื่อมต่อเครือข่าย

ถ้าจะเรียกคำสั่งฝั่งไคลเอนต์จากเซิร์ฟเวอร์ ให้ใช้ task.client:

local part = Instance.new("Part")
task.client:expose(target, part)
task.client:run(target, part , "Hello this is a part from the server")
run = function(task: CommandAPI.Task, part, message)
    print("part, message =", part, message)
end

Important

ต้องใช้ task:expose กับอินสแตนซ์หรือโมเดลที่เพิ่งสร้างบนเซิร์ฟเวอร์และอยากแชร์ให้ไคลเอนต์ ไม่อย่างนั้นไคลเอนต์อาจไม่ได้รับ

บางครั้งไคลเอนต์ก็อยากส่งข้อมูลกลับไปให้เซิร์ฟเวอร์ หรือแม้แต่ไคลเอนต์อื่น เช่น ตอนใช้ ;laserEyes เราอยากให้ไคลเอนต์คนอื่นเห็นลำแสงเลเซอร์และจุดที่เรากำลังเล็ง วิธีทำคือใช้ task.server:

-- The client's device knows something that others don't
task.server:replicate(targetCFrame, lookCFrame)
-- Your chance to pick who sees it, and to throw out anything dodgy
task.client.replicator = function(replicateTo, targetCFrame, lookCFrame)
    if typeof(targetCFrame) ~= "CFrame" or typeof(lookCFrame) ~= "CFrame" then
        return
    end
    for _, player in getTargets("OthersNearby", target, 100) do
        replicateTo(player, target, targetCFrame, lookCFrame)
    end
end
-- Runs on every client the server chose in the same client module
replication = function(target: Player, targetCFrame: CFrame, lookCFrame: CFrame)
    -- Show it happening on their screen
end,

Important

ต้องตรวจเสมอว่าค่าใน replicator เป็นสิ่งที่คุณคาดไว้ เพราะไคลเอนต์ส่งค่าที่เป็นอันตรายหรือผิดปกติมาได้เสมอ

Info

จะไม่มีอะไรถึงผู้เล่นคนอื่นถ้า replicator ของคุณไม่ส่งให้ ไคลเอนต์จึงแอบกระจายอะไรก็ได้ตามใจไม่ได้ จำนวนคำขอ replicate ยังถูกจำกัดไว้ภายใน และได้คำนึงถึงการใช้ในทางที่ผิดจากไคลเอนต์ไว้แล้ว


พรอมต์

การรันคำสั่งเป็นเรื่องหนึ่ง... แต่การปรับคำสั่งระหว่างที่มันทำงานอยู่ยิ่งดีกว่า ตรงนี้ใช้ task:bindPrompt เพื่อให้ผู้เรียกคำสั่งได้การ์ดที่ปรับค่าได้:

local function applyLaserColour()
    local colour = task:getArg("Color")
    -- set the beam colours, eye colours, etc
end

applyLaserColour()
task:bindPrompt({
    args = {"Color"},
    onChange = applyLaserColour,
})

คุณยังเพิ่ม buttons สำหรับการกระทำครั้งเดียวได้ด้วย:

task:bindPrompt({
    title = "Teleport",
    text = `Click to teleport to '{placeName}'`,
    deactivate = false,
    endOnClose = true, -- dismissing the card ends its task
    buttons = {
        {
            label = "Teleport",
            onActivate = onActivate,
        },
    },
})

คีย์ทั้งหมดที่การ์ดรับ รวมถึงปุ่ม confirm สวิตช์เพิ่มเติม และปุ่ม Re-run อยู่ในหัวข้อ task:bindPrompt ส่วนการแจ้งเตือนและข้อความธรรมดาดูได้ที่ prompt

คุณดูรายละเอียดเพิ่มเติมของงานและเมธอดที่ใช้ได้ที่ Task API