Lewati ke isi

Perintah Kustom

Tip

Kamu bisa mencari perintah bonus di sini.

Perintah

Perintah itu sederhananya tabel berisi informasi yang menjelaskan apa perintah itu dan bagaimana ia dijalankan. Perintah dirancang seperti ini karena beberapa alasan penting:

Memori Saat sebuah perintah dijalankan, ia bisa direpresentasikan sebagai 'tugas' yang mudah dilihat dan dibatalkan oleh staf. Tugas membersihkan dirinya sendiri secara otomatis sehingga memori tidak pernah bocor, dan dirancang supaya kamu bahkan tidak perlu menulis fungsi undo terpisah.
Jangkauan Karena tugas tidak lagi bergantung pada pemain tertentu yang menjalankan perintah (yaitu pemanggil), perintah apa pun bisa bekerja dengan modifier apa pun. Artinya perintah yang kamu tulis langsung bisa disiarkan ke semua server.
Keamanan Argumen divalidasi sebelum run dipanggil, jadi argumen Player datang sebagai Player yang asli, argumen Number selalu datang dalam rentang yang diizinkan, dan seterusnya. Kodemu tidak pernah menangani teks mentah, dan pemanggil tidak pernah bisa menjalankan perintah yang tidak diizinkan oleh role mereka.
Antarmuka Halaman Run, saran command bar, dan autocomplete dibuat otomatis dari args milikmu, jadi setiap perintah yang kamu tulis langsung bisa dipakai oleh pemain yang tidak bisa chat.
Bertipe Perintah bertipe penuh, jadi dengan memberi anotasi CommandAPI.Commands pada perintahmu, kamu mendapat autocomplete dan peringatan tipe saat menulis.

Buat sendiri

Di bawah ConfigCommands, cukup perluas module Custom yang sudah ada, atau tambahkan module kamu sendiri dengan tabel perintah sebanyak yang kamu mau:

gambar

--!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

Perintah client

Secara default, kode perintah hanya tersedia dan berjalan di server, padahal kadang kamu butuh perintah itu berjalan di client. Untuk mengatasinya, tambahkan ModuleScript bernama Client di bawah module perintah, berisi tabel perintah dengan nilai name yang sama dengan perintah di server:

gambar

--!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

gambar

--!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

Berisi gambar berkedip. Klik untuk melihat

Info

Kamu tidak perlu mereplikasi apa pun sendiri. Framework mendeteksi module anak bernama Client dan memindahkannya ke pemain secara otomatis.


Field perintah

Semua field selain name bersifat opsional:

Penamaan
name Shared Judul perintah yang ditampilkan, dan apa yang diketik pemain setelah prefix mereka. Ini juga berfungsi sebagai nama undo, jadi ;speed diakhiri dengan ;unspeed
aliases Server Nama lain yang memicu perintah ini``
undoAliases Server Nama yang membatalkan perintah, bukan menjalankannya (misalnya NoClip memakai {"Clip"})
description Server Satu kalimat yang ditampilkan di bawah perintah pada halaman Run-nya
credit Server Siapa yang diberi kredit untuk perintah ini (misalnya {"GigsD4X"})
Menjalankan
args Server Argumen yang diterima perintahmu (misalnya "Player", "Text", "Number", dan seterusnya. Daftar lengkapnya ada di MainModuleValueModulesParserArgs
run Shared Kode perintahmu. Di server, ia diberi sebuah tugas dan argumen yang sudah divalidasi, sedangkan di client ia diberi sebuah tugas lalu apa yang dikirim server lewat task.client:run
replication Client Fungsi tempat data yang dikembalikan dari server mendarat. Client kamu memanggil task.server:replicate, task.client.replicator di server memilih siapa yang menerimanya, lalu fungsi ini berjalan di client mereka
config Server Nilai default yang bisa diubah kreator game lewat modify saat memuat perintah internal
cooldown Server Detik yang harus ditunggu setelah perintah selesai sebelum bisa dijalankan lagi
stackable Server Biasanya hanya satu perintah yang bisa aktif pada satu pemain/server sekaligus, tapi kalau ini true, beberapa perintah bisa aktif bersamaan
groups Server Perintah yang berbagi grup saling membatalkan pada pemain yang sama (misalnya Fly dan NoClip sama-sama ada di grup "Flight", jadi memulai salah satunya mengakhiri yang lain) dan berbagi cooldown. Dua grup punya arti tambahan: "Prompt" menandai perintah bergaya pesan, yang memakai jatah batas teks satu kali per menit bahkan saat tidak ada yang diketik dan disaring oleh pengaturan Block prompts, dan "Map" menandai perintah yang mengedit map, sehingga perintah pertama yang berjalan diam-diam menyimpan salinan untuk ;clearmap
Jangkauan
tags Server Tag yang diwarisi perintah ini, yang kemudian dipakai role untuk menentukan perintah apa yang diwarisi
disableModifiers Server Mencegah Modifiers dipakai pada perintah
disableGlobalModifiers Server Mencegah modifier global (misalnya global, perm, join, dan seterusnya) dipakai pada perintah
Antarmuka
order Server Posisinya di halaman perintah. Angka yang lebih kecil muncul lebih dulu
hide Server Menyembunyikan perintah dari halaman Commands
autoPreview Server Saat perintah dijalankan lewat chat atau tombol pratinjau cepat, ia membuka halaman Run, bukan langsung menjalankan perintah (misalnya Ban memakai ini untuk mengonfirmasi detailnya dulu)

Argumen kustom

Argumen bawaan (di MainModuleValueModulesParserArgs) sudah mencakup sebagian besar argumen yang kamu butuhkan, tapi kalau kamu mau membuat sendiri, kamu bisa melakukannya di Config > Args:

gambar

return function(Args)
    return {

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

    }
end

Warning

Pastikan nama yang kamu pilih tidak sama dengan argumen bawaan HD Admin, kalau tidak, akan muncul peringatan saat startup dan salah satunya akan menang atas yang lain.

Kalau kamu hanya ingin mengubah argumen dari satu perintah, kamu bisa mengganti nama argumennya dengan tabel argumen:

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

Tip

Ini berguna saat kamu ingin memperbarui batasan sebuah argumen tanpa mengganti perilakunya sepenuhnya: gambar

Teks yang dilihat pemain lain

Kebijakan keamanan usia Roblox membatasi teks yang ditampilkan pemain kepada orang lain menjadi satu kali per menit. HD Admin menyaring setiap argumen teks dan memakai jatah batas satu menit untuk tipenya, yang dipakai bersama oleh semua perintah bertipe itu:

Arg Pakai untuk
"Text" Apa pun yang ditampilkan sebagai pesan, petunjuk, pemberitahuan, peringatan, atau polling
"SurfaceText" Nama, judul, dan label yang ditampilkan di atas pemain atau di dunia game
"ChatText" Tag chat dan nama chat
"Reason" Alasan kick dan ban

Untuk memilih tipenya sendiri, tambahkan textSurface ke tabel argumen, seperti {arg = "Text", textSurface = "SurfaceText"}. Pakai "None" untuk teks yang hanya kadang ditampilkan ke orang lain, lalu panggil checkTextLimit tepat saat teks itu ditampilkan.


Args

Untuk mengambil argumen sebuah perintah, pakai task:getArg() dan sebutkan nama atau indeksnya:

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

Mengambil argumen lewat indeksnya wajib dilakukan saat sebuah perintah punya dua argumen atau lebih yang sama: {"Player", "Number", "Number"}

Saat "Player" dipakai sebagai argumen pertama, perintahnya dijalankan secara terpisah pada setiap pemain yang ditarget. Dalam kasus ini, kamu bisa memakai task.target untuk merujuk ke "Player":

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

Persistensi

Sebuah tugas dihancurkan begitu run selesai. Ini tidak masalah untuk perintah seperti ;jump yang selesai seketika... tapi kurang cocok untuk perintah seperti music yang efeknya ingin tetap ada. Karena itu, setiap perintah yang ingin kita pertahankan harus lewat task:keep:

task:keep("UntilTargetRespawns")
Persistensi Tugas berakhir saat
"UntilTargetRespawns" target respawn atau keluar
"UntilTargetLeaves" target keluar
"UntilCallerRespawns" pemain yang menjalankan perintah respawn atau keluar
"UntilCallerLeaves" pemain yang menjalankan perintah keluar
"Indefinitely" seseorang mengakhirinya dengan ;un, atau pemainnya keluar

Tip

Kamu bisa menggabungkan beberapa 'keep' sekaligus. Misalnya, memakai task:keep("UntilTargetLeaves") dan task:keep("UntilCallerLeaves") akan mengakhiri perintah saat pemanggil atau targetnya keluar dari server.


Buff

Mengubah properti, seperti WalkSpeed pada humanoid, biasanya pekerjaan yang mudah. Kamu tinggal mengatur propertinya ke nilai yang kamu mau, selesai. Ini jadi sedikit lebih rumit saat beberapa perintah terlibat.

Bayangkan health kamu 100, lalu kamu menjalankan ;health me 500 kemudian ;god me. ;health awalnya mengatur health kamu ke 500, lalu ;god mengubahnya ke 99999. Ini berjalan baik... tapi bagaimana kalau kamu lalu ingin menghapus tugas god sambil mempertahankan health? Di banyak sistem admin, membatalkan god akan langsung mengembalikan health kamu ke 100, mengabaikan tugas health yang masih aktif. Ini tidak diinginkan, dan di sinilah buff berguna:

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)

Buff itu hanyalah kodemu ditambah grup tempat ia berada (seperti "WalkSpeed" pada contoh ini). Setiap kali sebuah tugas dalam grup itu dimulai atau berakhir, semua buff-nya dijalankan ulang secara berurutan, sehingga propertimu selalu mendarat di nilai yang diinginkan perintah terakhir.

Kamu juga bisa mengembalikan nilai asli, yaitu nilai yang diingat oleh buff paling awal dalam grup. Saat buff terakhir dihapus, propertimu bisa dikembalikan ke nilai asli ini, jadi health kamu kembali ke 100, bukan nilai apa pun yang kebetulan ditinggalkan perintah sebelumnya.


Jaringan

Untuk menjangkau perintah client dari server, kita memakai 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

Memakai task:expose penting untuk instance/model yang baru dibuat di server dan ingin kita bagikan ke client, kalau tidak, ada kemungkinan mereka tidak menerimanya

Sering kali client juga ingin membagikan informasi ke server, atau bahkan ke client lain. Misalnya, saat memakai ;laserEyes, kita ingin client lain melihat sinar laser kita dan ke mana kita mengarahkannya. Untuk melakukannya, kita memakai 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

Penting kamu memeriksa bahwa nilai di dalam replicator sesuai dengan yang kamu harapkan, karena client selalu bisa mengirim nilai yang berbahaya atau berbeda

Info

Tidak ada yang sampai ke pemain lain kecuali replicator kamu mengirimkannya, jadi client tidak bisa diam-diam menyiarkan apa pun sesukanya. Jumlah permintaan replikasi juga dibatasi secara internal, dan potensi penyalahgunaan dari client sudah diperhitungkan


Prompt

Menjalankan perintah itu satu hal... tapi menyesuaikannya saat sedang berjalan lebih menyenangkan lagi. Di sinilah kamu bisa memakai task:bindPrompt untuk memberi pemanggil sebuah kartu yang bisa mereka atur:

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

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

Kamu juga bisa menambahkan buttons untuk aksi sekali pakai:

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,
        },
    },
})

Semua key yang diterima kartu ini, termasuk tombol confirm, toggle tambahan, dan tombol Re-run, dicantumkan di task:bindPrompt. Untuk pemberitahuan dan pesan biasa, lihat prompt.

Kamu bisa mempelajari detail lebih lanjut tentang tugas dan metodenya di Task API.