Lewati ke isi

Command API

Semua yang aman dipakai oleh sebuah perintah ada di CommandAPI:

local CommandAPI = require(script:FindFirstAncestor("HD Admin").Core.CommandAPI)

Memuat

loadCommands Server

CommandAPI.loadCommands(details): Commands

Ini dipakai oleh modul paket di Config > Commands untuk memuat, memberi tag, dan mengubah kumpulan perintah mereka. Buka salah satu paket di sana untuk melihat cara kerjanya.


Prompt

prompt Shared

-- In a server command module
CommandAPI.prompt(promptType: PromptType, player: Player, text: string, options: PromptOptions?): PromptHandle

-- In a client command module
CommandAPI.prompt(promptType: PromptType, text: string, options: PromptOptions?): PromptHandle

Menampilkan pemberitahuan, pesan, atau kartu. Untuk prompt aksi dengan tombol, lihat bindPrompt.

Jenis prompt Yang ditampilkan
"info" "success" "warn" "error" Pemberitahuan di sisi layar dengan efek suara
"message" Pesan di tengah layar, dipakai misalnya di ;message
"hint" Bar kecil di bagian atas layar, dipakai misalnya di ;hint
"privateMessage" Pemberitahuan di sisi layar yang menetap dan membuka pesan lengkap saat diklik
"alert" Pemberitahuan di sisi layar yang menetap, memutar suara berulang sampai di-mute, dan membuka pesan lengkap saat diklik
"action" Pemberitahuan di sisi layar dengan tombol dan kontrol. Buat dengan task:bindPrompt
CommandAPI.prompt("success", task.caller, "Quest complete!", {duration = 5})

Fungsi ini mengembalikan sebuah koneksi yang bisa kamu putuskan dengan connection:Disconnect() untuk mengakhiri prompt. Kamu bisa menambahkannya, misalnya, ke janitor milik tugas supaya prompt berakhir begitu perintahnya selesai:

task.janitor:add(CommandAPI.prompt("hint", task.target, "You're frozen until an admin releases you", {duration = 0})) -- 0 means "infinite"

Opsi

Semua opsi ini bersifat opsional dan berlaku untuk setiap jenis prompt, kecuali baris itu menyebutkan lain:

Opsi Tipe Fungsinya
title string Judul di atas teks. privateMessage dan alert menentukan sendiri
duration number Detik sebelum prompt menutup sendiri. Kalau dikosongkan, durasi dihitung dari panjang teks. 0 membuatnya tetap di layar sampai ditutup atau koneksinya diputus
subtext string Baris yang lebih kecil di bawah teks
icon string Gambar rbxassetid:// yang menggantikan ikon pemberitahuan
color Color3 Mewarnai teks sebuah hint
dismissable boolean false menyembunyikan tombol tutup, jadi hanya duration atau handle yang bisa menghapusnya
openPage string Mengklik pemberitahuan membuka panel di halaman ini, seperti "Commands", "Roles", "Settings" atau "About"
openProfile boolean Mengklik pemberitahuan membuka profil milik pemain itu sendiri
openImage table {image = "rbxassetid://...", title = "Map", ratio = 16/9}. Mengklik pemberitahuan membuka gambar di tengah layar
linkButtons table Tombol-tombol kecil di bagian bawah pemberitahuan. {label = "Roles", page = "Roles"} membuka sebuah halaman dan {label = "Profile", profile = true} membuka profil mereka. Tambahkan style = "Neutral" untuk tombol yang lebih kalem, dan hideAfterPress = true untuk menutup pemberitahuan setelah ditekan. Dari LocalScript lewat Client API, {label = "Shop", onActivate = function() ... end, icon = "rbxassetid://..."} menjalankan fungsimu sendiri
roleBadges table Badge role di bawah judul, {{name = "Admin", color = Color3.fromRGB(255, 170, 0)}}
countdown number Menghitung mundur secara langsung dari sekian detik di mana pun %TIME% muncul di teks
fromUserId number Menampilkan avatar, nama, dan role teratas pengguna itu sebagai pengirim sebuah message, privateMessage atau alert
userText boolean Menampilkan teks persis seperti yang ditulis, tanpa tag rich text dan sejenisnya
CommandAPI.prompt("info", task.caller, "You've unlocked the VIP role", {
    title = "New role",
    openPage = "Roles",
    roleBadges = {{name = "VIP", color = Color3.fromRGB(255, 170, 0)}},
})

Untuk prompt aksi dengan tombol, lihat bindPrompt.


Karakter

getHumanoid Shared

CommandAPI.getHumanoid(player: Player?): Humanoid?

Humanoid milik pemain, atau nil kalau karakternya tidak ada.


getHRP Shared

CommandAPI.getHRP(player: Player?): BasePart?

HumanoidRootPart milik pemain, atau nil.


getHead Shared

CommandAPI.getHead(player: Player?): (BasePart?, Model?)

Head milik pemain beserta karakternya, atau nil.


getNeck Shared

CommandAPI.getNeck(player: Player?): Motor6D?

Sendi leher pemain, atau nil. Bisa dipakai untuk rig R6 maupun R15.


getTorso Shared

CommandAPI.getTorso(player: Player?): Instance?

Torso pemain, atau nil. Bisa dipakai untuk rig R6 maupun R15.


loadCharacter Server

CommandAPI.loadCharacter(player: Player?)

Me-respawn karakter pemain. Selalu pakai ini dan jangan player:LoadCharacter(), supaya tugas HD Admin tahu bahwa respawn-nya disengaja.


Pemain

getUserInfoAsync Shared

CommandAPI.getUserInfoAsync(userId: number | string): (boolean, UserInfo | string)

Mengembalikan true dan UserInfo untuk pengguna mana pun, bahkan yang sedang offline, atau false beserta alasannya. Hasilnya di-cache, jadi pemanggilan berulang tidak membebani apa pun.


getNameFromUserIdAsync Shared

CommandAPI.getNameFromUserIdAsync(userId: number | string): (boolean, string)

Mengembalikan true dan nama pengguna, atau false beserta alasannya. Bisa dipakai untuk pengguna yang offline.


teleportAsync Server

CommandAPI.teleportAsync(player: Player?, cframe: CFrame): (boolean, string)

Memindahkan karakter pemain ke CFrame yang diberikan. Pemain dilepas dari kursinya dulu supaya kursinya tidak ikut terseret.


getAllowedTargets Server

CommandAPI.getAllowedTargets(task: Task, options: {players: {Player}?}?): ({Player}, {Player})

Pemain yang bisa dikenai sebuah perintah. Secara default ini semua orang di server kecuali yang mengaktifkan Block commands di You Settings mereka.


unequipTools Server

CommandAPI.unequipTools(player: Player?): (boolean, string)

Mengembalikan tool yang sedang dipegang pemain ke backpack-nya.


Tugas

getTasks Shared

CommandAPI.getTasks(commandKey: string?, targetUserId: number?): {Task}

Mengembalikan tugas yang sedang berjalan, bisa difilter berdasarkan perintah dan target. Ini objek tugas yang sama dengan yang dijelaskan di Task API.


getTasksByCallerId Shared

CommandAPI.getTasksByCallerId(callerUserId: number): {Task}

Semua tugas yang sedang berjalan yang dimulai oleh caller tersebut.


Chat

systemMessage Shared

-- In a server command module
CommandAPI.systemMessage(player: Player, text: string)

-- In a client command module
CommandAPI.systemMessage(text: string)

Mengirim pesan bergaya sistem ke chat pemain.


checkTextLimit Server

CommandAPI.checkTextLimit(task: Task, textKind: "Message" | "SurfaceText" | "ChatText" | "Reason"): (boolean, number?)

HD Admin membatasi pengiriman fitur yang berkaitan dengan pesan karena kebijakan keamanan usia Roblox, jadi fungsi ini memberi cara untuk melihat cooldown tersebut.

Fungsi ini mengembalikan true kalau teks boleh ditampilkan, kalau tidak false beserta sisa waktu cooldown.

args = {"Player", "Leaderstat", {arg = "String", textSurface = "None"}},
run = function(task)
    local stat = task:getArg("Leaderstat")
    local text = task:getArg("String")
    if stat:IsA("StringValue") then
        if not CommandAPI.checkTextLimit(task, "SurfaceText") then
            return
        end
    end
    stat.Value = text
end,
Jenis Dipakai bersama oleh
"Message" Pesan, hint, pemberitahuan, alert, pesan pribadi, dan polling
"SurfaceText" Nama, judul, nama tim, dan stat
"ChatText" Tag chat dan nama chat
"Reason" Alasan kick dan ban

forceBubbleChat Shared

CommandAPI.forceBubbleChat(target: Player | Model, text: string)

Menampilkan gelembung chat di atas karakter pemain, atau di atas model atau part apa pun yang kamu berikan.


Outfit

getDescription Server

CommandAPI.getDescription(humanoid: Humanoid): HumanoidDescription

HumanoidDescription humanoid itu saat ini.


applyDescription Server

CommandAPI.applyDescription(humanoid: Humanoid?, description: HumanoidDescription?, properties: {[string]: any}?): HumanoidDescription?

Menerapkan HumanoidDescription dengan aman, dan mencoba lagi kalau Roblox menolak percobaan pertama. Isi properties untuk mengubah beberapa field di atas description dasarnya.


outfitBuff Server

CommandAPI.outfitBuff(target: Player, properties: {[string]: any})

Menerapkan properti HumanoidDescription sebagai buff yang membatalkan dirinya sendiri saat tugas berakhir, jadi perintah seperti ;wormify membereskan sendiri.


setFakeBodyParts Server

CommandAPI.setFakeBodyParts(character: Model, info: {[string]: any}): (() -> ())?

Mengganti bagian tubuh dengan pengganti buatan perintah, dan mengembalikan fungsi yang memulihkan aslinya.


clearFakeBodyParts Server

CommandAPI.clearFakeBodyParts(character: Model)

Menghapus pengganti itu lagi.


runBundleId Server

CommandAPI.runBundleId(task: Task, bundleId: number, properties: {[string]: any}?)

Mendandani target tugas dengan bundle katalog, lalu mengembalikan outfit aslinya saat tugas berakhir.


Aset

registerSound Shared

CommandAPI.registerSound(sound: Sound)

Wajib dipakai untuk setiap Sound yang dibuat perintahmu, supaya pengaturan volume dan pitch game berlaku untuknya.


setAnchored Shared

CommandAPI.setAnchored(instance: Instance, anchored: boolean)

Meng-anchor atau melepas anchor semua part di bawah instance itu.


setTransparency Shared

CommandAPI.setTransparency(instance: Instance, transparency: number)

Memudarkan semua part di bawah instance itu.


promptPurchaseAsync Server

CommandAPI.promptPurchaseAsync(assetId: number, player: Player?, infoType: Enum.InfoType?)

Menampilkan prompt pembelian aset kepada pemain, dan mengarahkan ke alur pembelian yang sesuai dengan tipenya.


ownsAssetAsync Server

CommandAPI.ownsAssetAsync(assetId: number, player: Player?): boolean

Apakah pemain memiliki aset itu.


isTypeAsync Server

CommandAPI.isTypeAsync(assetId: number, assetType: Enum.AssetType | Enum.BundleType): (boolean, string?)

Memastikan aset itu bertipe yang diberikan. Mengembalikan true, atau false beserta alasannya.


loadAssetCommand Server

CommandAPI.loadAssetCommand(assetType: Enum.AssetType, task: Task, assetId: number, callback: (item: Instance) -> ())

Memastikan aset itu bertipe yang diberikan dan diizinkan, memasukkannya, lalu menyerahkannya ke callback-mu untuk ditempatkan. Inilah yang menjalankan ;gear.


getToolsInfoAsync Server

CommandAPI.getToolsInfoAsync(): (boolean, {ToolInfo} | string)

Mengembalikan true dan ToolInfo dari setiap tool yang tersedia untuk ;give, atau false beserta alasannya.


Utilitas

getTargets Server

CommandAPI.getTargets(targetType: "All" | "Others" | "Nearby" | "OthersNearby", originPlayer: Player?, radius: number?): {Player}

Mengubah sebuah qualifier menjadi pemain yang tercakup olehnya saat ini. "Nearby" dan "OthersNearby" mengukur dari pemain asal, dengan radius dalam stud (default 50).


setCameraSubject Client

CommandAPI.setCameraSubject(newSubject: Instance)

Mengarahkan kamera pemain lokal ke subjek baru, seperti Humanoid pemain lain untuk ;view.


runPromptCommand Server

CommandAPI.runPromptCommand(promptType: PromptType, task: Task, targets: {Player}, text: string, options: PromptOptions?)

Mesin di balik ;message, ;hint, dan prompt serupa. Fungsi ini memfilter teks, menampilkan prompt ke setiap target, dan menjaga tugas tetap hidup sampai prompt-nya habis.


runEmoteId Server

CommandAPI.runEmoteId(task: Task, emoteId: number, speed: number?, looped: boolean?)

Memutar animasi emote pada target tugas, dan menghentikannya saat tugas berakhir.


createEmoteCommand Server

CommandAPI.createEmoteCommand(emoteName: string, emoteId: number, properties: {[string]: any}?): Command

Mengembalikan perintah emote yang lengkap, siap dimasukkan ke array perintahmu. properties menimpa field mana pun pada perintah yang dihasilkan.


createBundleCommand Server

CommandAPI.createBundleCommand(commandName: string, bundleId: number, properties: {[string]: any}?): Command

Perilaku yang sama untuk perintah bundle seperti ;ratdance.


bindEmotePrompt Server

CommandAPI.bindEmotePrompt(task: Task, target: Player, emoteId: number, emoteName: string?, isLooped: boolean?)

Mengikat kartu aksi emote ke tugas, supaya target bisa memfavoritkan emote itu atau melihatnya di katalog.


openProfile Server

CommandAPI.openProfile(player: Player?, userId: number)

Membuka popup profil pengguna yang diberikan untuk pemain.


openPage Server

CommandAPI.openPage(player: Player?, pageId: string, tabLabel: string?)

Membuka panel pemain langsung ke halaman yang diberikan, bisa juga langsung ke salah satu tab-nya.


openEmotes Server

CommandAPI.openEmotes(player: Player?)

Membuka popup emote untuk pemain.


colourRoleName Shared

CommandAPI.colourRoleName(role): string

Nama role yang dibungkus dengan warnanya, untuk rich text.


isTableEmpty Shared

CommandAPI.isTableEmpty(tbl: {[any]: any}): boolean

Apakah table itu sama sekali tidak punya entri, termasuk entri berkunci yang terlewat oleh #tbl.


round Shared

CommandAPI.round(number: number, decimalPlaces: number?): number

Membulatkan angka ke jumlah desimal yang diberikan, atau ke bilangan bulat secara default.


Tipe

Commands

type Commands = {Command}

Array yang dikembalikan sebuah modul perintah.


Command

Satu table perintah di dalam Commands (name, args, run, dan seterusnya). Custom Commands membahas setiap field-nya.


Task

Objek tugas yang dikirim ke setiap fungsi run, dibahas lengkap di Task API.


ClientCommands

Padanan sisi client dari Commands, dikembalikan oleh modul Client.


ClientCommand

Satu table perintah sisi client di dalam ClientCommands.


UserInfo

type UserInfo = {
    userId: number | string,
    userName: string,
    userImage: string,
    userDisplayName: string,
    userTopRole: {key: string, name: string, color: Color3}?,
}

userTopRole hanya ada untuk pemain di server ini.


ToolInfo

type ToolInfo = {
    name: string,
    textureId: string,
    tool: Tool?,
}

PromptType

type PromptType = "info" | "success" | "warn" | "error" | "message" | "hint" | "privateMessage" | "alert" | "vote" | "voteResults" | "action"

String jenis prompt. Lihat prompt untuk apa yang ditampilkan masing-masing.


PromptOptions

Table opsi yang diterima prompt, tercantum lengkap di prompt.


PromptHandle

Handle yang dikembalikan prompt, yang menutup prompt lebih awal dengan handle:Disconnect().