Lewati ke isi

Server API

Semua yang ada di sini berada di CoreServerAPI dan dijalankan dari Script server:

local hd = game:GetService("ReplicatedStorage"):WaitForChild("HD Admin")
local ServerAPI = require(hd.Core.ServerAPI)

Perintah

requestCommand Server

ServerAPI.requestCommand(message: string, fromPlayer: Player?): (boolean, {any}, {Task})

Menjalankan pesan perintah persis seperti kalau diketik di chat. Kalau tidak ada pemain yang diberikan, sebuah Server User menggantikan pemanggil, jadi perintah bisa dijalankan dari mana saja di kode game kamu tanpa pengecekan izin. Kalau pemain diberikan, role, izin, dan rate limit miliknya semua berlaku, dan pemberitahuan untuk pemanggil dikirim ke dia. Mengembalikan apakah disetujui, pemberitahuan yang dihasilkan, dan tugas yang dibuat.

-- Run as the server
ServerAPI.requestCommand(";fly all")

-- Or on behalf of a player
ServerAPI.requestCommand(";fly me", player)

getTasks Server

ServerAPI.getTasks(commandName: string?, target: Target?): {Task}

Mengembalikan tugas yang sedang berjalan. Kedua filter bersifat opsional. ServerAPI.getTasks() mengembalikan semua tugas, ServerAPI.getTasks("fly") semua tugas fly, dan ServerAPI.getTasks("fly", player) hanya tugas fly milik pemain itu.


endTasks Server

ServerAPI.endTasks(commandName: string?, target: Target?): number

Mengakhiri tugas yang cocok dan mengembalikan berapa banyak yang diakhiri. Ini versi kode dari ;unCommand, dengan filter opsional yang sama seperti getTasks.

-- End every fly in the server
ServerAPI.endTasks("fly")

-- Clear everything running on one player
ServerAPI.endTasks(nil, player)

canUseCommandAsync Server

ServerAPI.canUseCommandAsync(target: Target, commandName: string): (boolean, string?)

Mengecek apakah role target mengizinkan dia menjalankan perintah tersebut. Mengembalikan true, atau false beserta alasannya.


disableCommands Server

ServerAPI.disableCommands(player: Player)

Memblokir pemain dari menjalankan perintah baru sampai enableCommands dipanggil atau dia masuk lagi. Berguna saat dia sedang berada di ronde minigame atau cutscene. Tugas miliknya yang sudah berjalan tetap lanjut, jadi pasangkan dengan endTasks kalau kamu mau itu juga dibersihkan. Aman dipanggil langsung dari PlayerAdded.


enableCommands Server

ServerAPI.enableCommands(player: Player)

Mengizinkan pemain menjalankan perintah lagi.


Role

Nama role dicocokkan tanpa membedakan huruf besar dan kecil, jadi "VIP" dan "vip" mengarah ke role yang sama.

giveRoleAsync Server

ServerAPI.giveRoleAsync(target: Target, roleName: string, options: ActionOptions?): (boolean, string?)

Memberikan role ke target dan mengembalikan true, atau false beserta alasan kenapa gagal. Pemberian permanen disimpan, berlaku lintas server, dan bisa juga untuk target yang sedang offline.

Opsi Fungsinya
scope "perm" menyimpan selamanya (default), "server" hanya berlaku di server ini, "expire" hilang sendiri setelah duration
duration Dalam detik, wajib untuk scope "expire"
reason Alasan pemberiannya
callerUserId UserId orang yang memberikan, yang juga dipakai untuk cek rank
-- Reward a purchase forever
ServerAPI.giveRoleAsync(player, "VIP")

-- A 24 hour trial, granted by an offline head admin
ServerAPI.giveRoleAsync(player, "Mod", {
    scope = "expire",
    duration = 24 * 3600,
    callerUserId = 1234567,
})

takeRoleAsync Server

ServerAPI.takeRoleAsync(target: Target, roleName: string, options: ActionOptions?): (boolean, string?)

Mencabut role dari target, termasuk pemberian permanen yang dibuat di server lain atau saat dia sedang offline. options menerima scope ("perm" atau "server") dan callerUserId, sama seperti giveRoleAsync.


getRolesAsync Server

ServerAPI.getRolesAsync(target: Target): (boolean, {Role} | string)

Mengembalikan true dan role milik target, diurutkan dari rank tertinggi, atau false beserta alasannya. Target harus ada di server ini.

local success, roles = ServerAPI.getRolesAsync(player)
if success then
    for _, role in roles do
        print(role.name, role.rank)
    end
end

getTopRoleAsync Server

ServerAPI.getTopRoleAsync(target: Target): (boolean, (Role | string)?)

Mengembalikan true dan role paling senior milik target (nil kalau dia tidak punya role), atau false beserta alasannya. Target harus ada di server ini.


hasRoleAsync Server

ServerAPI.hasRoleAsync(target: Target, roleName: string): boolean

Mengecek apakah target saat ini memegang role itu. Target harus ada di server ini.


getRole Server

ServerAPI.getRole(roleName: string): Role?

Mengembalikan Role untuk nama yang diberikan, atau nil kalau tidak ada role yang cocok.


getAllRoles Server

ServerAPI.getAllRoles(): {Role}

Mengembalikan semua role di konfigurasi game.


Moderasi

banAsync Server

ServerAPI.banAsync(target: Target, options: BanOptions): (boolean, string?)

Me-ban target agar tidak bisa masuk ke game kamu, dan men-kick dia kalau dia sedang berada di server mana pun. Mengembalikan true dan banId yang baru, atau false beserta alasan kenapa gagal. Target yang sedang offline juga bisa.

Opsi Fungsinya
reason Wajib, ditampilkan ke pemain saat dia mencoba masuk
scope "perm" (default), "server" untuk server ini saja, atau "expire"
duration Dalam detik, untuk scope "expire"
expiresAt Epoch absolut yang menggantikan duration
banAlts Default true, me-ban akun alt lewat BanService milik Roblox
callerUserId UserId yang dicatat sebagai pemberi ban dan dipakai untuk cek rank. Kosongkan untuk ban sistem tanpa pembatasan
-- A 7 day ban issued by your own anti-cheat
ServerAPI.banAsync(player, {
    reason = "Exploiting",
    scope = "expire",
    duration = 7 * 24 * 3600,
})

unbanAsync Server

ServerAPI.unbanAsync(target: Target, banId: string?, options: UnbanOptions?): (boolean, string?, number?)

Menghapus ban milik target dan mengembalikan (success, failReason, totalBansCleared). Berikan banId untuk menghapus satu ban tertentu, atau nil untuk menghapus semuanya. options menerima scope dan callerUserId.


getBanAsync Server

ServerAPI.getBanAsync(target: Target): (BanRecord?, string?)

Mengembalikan BanRecord aktif milik target beserta banId-nya, dengan mengecek data offline juga, atau nil kalau dia tidak di-ban.

local ban, banId = ServerAPI.getBanAsync(userId)
if ban then
    print(`Banned for '{ban.reason}' by {ban.bannedBy}`)
end

Prompt

prompt Shared

ServerAPI.prompt(promptType: PromptType, player: Player, text: string, options: PromptOptions?): PromptHandle

Menampilkan pemberitahuan, pesan, atau kartu ke pemain memakai UI bawaan HD Admin, dari Script server mana pun. Ini fungsi yang sama dengan prompt di Command API, yang membahas semua tipe prompt, daftar lengkap opsi, dan kartu aksi dengan tombol dan slider.

ServerAPI.prompt("success", player, "Quest complete!", {duration = 5})

Teks

filterTextAsync Server

ServerAPI.filterTextAsync(text: string, author: Target, viewer: Target?): (boolean, string)

Menjalankan teks lewat filter Roblox dan mengembalikan true beserta teks yang sudah difilter, atau false beserta alasannya. Kosongkan viewer untuk memfilter bagi semua orang, yang tepat untuk apa pun yang bisa dilihat semua pemain dan untuk teks yang kamu simpan. Isi viewer untuk memfilter bagi satu pemain itu saja. Penulis harus ada di server ini, karena filter Roblox menolak berjalan untuk siapa pun yang tidak ada. Teks yang hasilnya hanya tanda pagar dianggap gagal, jadi kamu tidak pernah menampilkan hasil kosong.

local success, result = ServerAPI.filterTextAsync(petName, player)
if success then
    nameLabel.Text = result
else
    ServerAPI.prompt("warn", player, "That name can't be used")
end

Info

getSetting Shared

ServerAPI.getSetting(settingName: string, player: Player?): any

Mengembalikan nilai sebuah pengaturan game, misalnya ServerAPI.getSetting("Prefix"). Berikan pemain untuk ikut menerapkan You Settings miliknya, jadi kamu mendapat nilai persis seperti yang dialami pemain itu.


getVersion Shared

ServerAPI.getVersion(): string

Versi HD Admin yang sedang berjalan, misalnya "v2.0.0".


Isolasi

isolateServer Server

ServerAPI.isolateServer()

Memutus server ini dari penyimpanan data dan dari pengiriman apa pun ke server lain. Semuanya masih akan terlihat berjalan seperti biasa, misalnya ban permanen, perubahan role, pengaturan game, perintah global, dan voting global, tapi tidak ada yang benar-benar tersimpan atau sampai ke server lain, jadi semuanya hilang saat server berakhir. Data yang tersimpan tetap dibaca seperti biasa, jadi server mulai dengan role, ban, pengaturan, dan lainnya yang asli. Preferensi pribadi tiap pemain, seperti You settings dan emote favoritnya, tetap tersimpan karena hanya memengaruhi pemain itu.

Ini berguna untuk server privat atau reserved server saat kamu mau memberi seseorang "Owner" tanpa berdampak ke bagian lain dari universe kamu.

local hd = game:GetService("ReplicatedStorage"):WaitForChild("HD Admin")
local ServerAPI = require(hd:WaitForChild("Core"):WaitForChild("ServerAPI"))
ServerAPI.isolateServer()

isServerIsolated Server

ServerAPI.isServerIsolated(): boolean

Mengembalikan true setelah isolateServer dipanggil di server ini.


Pembatasan

restrictServer Server

ServerAPI.restrictServer(options: RestrictOptions?)

Ini membatasi semua fitur tingkat game, termasuk pengaturan game, perubahan role, role permanen, ban dan unban permanen, vetting, tugas tersimpan, dan modifier perm, global, dan join. Perintah milik role di commandsInRoles atau yang disebut di commands juga dibatasi. Semuanya tetap terlihat normal di panel sampai fitur atau perintahnya benar-benar dipakai, dan saat itu pemberitahuan error ditampilkan. Siapa pun yang memegang role di bypassRoles melewati semua pembatasan.

Berbeda dengan isolateServer, data tetap tersimpan dan tetap sampai ke server lain. HD Admin Hub memakainya, misalnya, untuk memberi setiap pemain "Dev" supaya bisa mencoba panel admin, tapi membatasi banyak perintah dan fitur yang rawan disalahgunakan supaya server tidak dirusak.

Opsi Fungsinya
commandsInRoles Nama atau key role yang perintahnya ditolak
commands Nama atau key perintah yang ditolak selain yang di atas
bypassRoles Nama atau key role yang melewati semua pembatasan
warning Menggantikan "This is restricted in this game", pemberitahuan yang tampil setiap kali sesuatu ditolak
local hd = game:GetService("ReplicatedStorage"):WaitForChild("HD Admin")
local ServerAPI = require(hd:WaitForChild("Core"):WaitForChild("ServerAPI"))
ServerAPI.restrictServer({
    commandsInRoles = {"Dev", "Owner"},
    commands = {"BuildingTools", "Music"},
    bypassRoles = {"Owner"},
    warning = "This is restricted in this demo",
})

isServerRestricted Server

ServerAPI.isServerRestricted(): boolean

Mengembalikan true setelah restrictServer dipanggil di server ini.


Emote

getEmoteById Server

ServerAPI.getEmoteById(emoteId: number): Emote?

Mengembalikan Emote terdaftar dengan id yang diberikan, atau nil.


getEmoteByName Server

ServerAPI.getEmoteByName(emoteName: string, matchLength: boolean?): Emote?

Mengembalikan Emote terdaftar yang cocok dengan nama yang diberikan, atau nil.


getRandomEmote Server

ServerAPI.getRandomEmote(): Emote?

addEmoteAsync Server

ServerAPI.addEmoteAsync(emote: IncompleteEmote, dontRegister: boolean?): (boolean, Emote | string)

Mendaftarkan emote baru dari asset animasi emote, sehingga bisa dimainkan lewat ;emote dan muncul di menu emote. Hanya emoteId yang wajib, detail yang kurang diambilkan otomatis. Mengembalikan true dan Emote yang sudah lengkap, atau false beserta alasan kenapa gagal.


Tipe

Role

Tabel konfigurasi role yang lengkap, persis seperti yang didefinisikan di ConfigRoles. Lihat halaman role.


BanRecord

type BanRecord = {
    type: "perm" | "expire" | "server",
    source: "admin" | "loader",
    bannedBy: number | string,
    bannedAt: number,
    expiresAt: number?,
    grantedOnJobId: string?, -- only present on server-scope bans
    reason: string,
    banAlts: boolean,
}

banId bukan bagian dari record itu sendiri, jadi getBanAsync memberikannya sebagai nilai kembalian kedua.


Task

Lihat Task API.


Emote

type Emote = {
    name: string,
    originalName: string?,
    order: number,
    animationId: number,
    emoteId: number,
}