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

Server API

ทุกอย่างในหน้านี้อยู่ใน CoreServerAPI และรันได้จาก Script ฝั่งเซิร์ฟเวอร์เท่านั้น:

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

คำสั่ง

requestCommand Server

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

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

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

คืนค่างานที่กำลังรันอยู่ ตัวกรองทั้งสองอย่างจะใส่หรือไม่ใส่ก็ได้ ServerAPI.getTasks() คืนทุกงาน ServerAPI.getTasks("fly") คืนทุกงาน fly และ ServerAPI.getTasks("fly", player) คืนเฉพาะงาน fly ของผู้เล่นคนนั้น


endTasks Server

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

จบงานที่ตรงกับตัวกรองและคืนจำนวนงานที่จบไป ก็คือ ;unCommand ในรูปแบบโค้ด และใช้ตัวกรองแบบใส่หรือไม่ใส่ก็ได้เหมือนกับ 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?)

เช็กว่าบทบาทของเป้าหมายอนุญาตให้ใช้คำสั่งที่ระบุหรือไม่ คืนค่า true หรือ false พร้อมเหตุผล


disableCommands Server

ServerAPI.disableCommands(player: Player)

ห้ามผู้เล่นรันคำสั่งใหม่ จนกว่าจะเรียก enableCommands หรือผู้เล่นเข้าเกมใหม่ มีประโยชน์ตอนที่ผู้เล่นอยู่ในรอบมินิเกมหรือคัตซีน งานที่รันอยู่แล้วจะทำงานต่อ ถ้าอยากเคลียร์งานพวกนั้นด้วยให้ใช้คู่กับ endTasks เรียกจาก PlayerAdded ได้เลยอย่างปลอดภัย


enableCommands Server

ServerAPI.enableCommands(player: Player)

ให้ผู้เล่นรันคำสั่งได้อีกครั้ง


บทบาท

ชื่อบทบาทไม่สนตัวพิมพ์เล็กใหญ่ ดังนั้น "VIP" กับ "vip" จะได้บทบาทเดียวกัน

giveRoleAsync Server

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

ให้บทบาทแก่เป้าหมายและคืนค่า true หรือคืน false พร้อมเหตุผลที่ให้ไม่ได้ ถ้าให้แบบถาวรจะบันทึกไว้ ส่งต่อข้ามเซิร์ฟเวอร์ และใช้กับเป้าหมายที่ออฟไลน์อยู่ได้ด้วย

Option What it does
scope "perm" บันทึกถาวร (ค่าเริ่มต้น), "server" อยู่แค่เซิร์ฟเวอร์นี้, "expire" หมดอายุเองหลังจาก duration
duration หน่วยเป็นวินาที ต้องใส่เมื่อใช้ scope "expire"
reason เหตุผลที่ให้
callerUserId UserId ของคนที่ให้ และใช้เช็กยศเทียบด้วย
-- 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?)

ริบบทบาทจากเป้าหมาย รวมถึงบทบาทถาวรที่ให้ไว้จากเซิร์ฟเวอร์อื่นหรือตอนที่เขาออฟไลน์ options รับ scope ("perm" หรือ "server") และ callerUserId เหมือนกับ giveRoleAsync


getRolesAsync Server

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

คืนค่า true พร้อมบทบาทของเป้าหมายเรียงจากยศสูงสุดก่อน หรือคืน false พร้อมเหตุผล เป้าหมายต้องอยู่ในเซิร์ฟเวอร์นี้

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)?)

คืนค่า true พร้อมบทบาทที่อาวุโสสุดของเป้าหมาย (เป็น nil ถ้าไม่มีบทบาทเลย) หรือคืน false พร้อมเหตุผล เป้าหมายต้องอยู่ในเซิร์ฟเวอร์นี้


hasRoleAsync Server

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

เช็กว่าตอนนี้เป้าหมายมีบทบาทนี้อยู่หรือไม่ เป้าหมายต้องอยู่ในเซิร์ฟเวอร์นี้


getRole Server

ServerAPI.getRole(roleName: string): Role?

คืนค่า Role ของชื่อที่ระบุ หรือ nil ถ้าไม่มีบทบาทที่ตรงกัน


getAllRoles Server

ServerAPI.getAllRoles(): {Role}

คืนค่าทุกบทบาทที่อยู่ในการตั้งค่าของเกม


การดูแลผู้เล่น

banAsync Server

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

แบนเป้าหมายไม่ให้เข้าเกมของคุณ และเตะออกถ้าตอนนี้อยู่ในเซิร์ฟเวอร์ไหนก็ตาม คืนค่า true พร้อม banId ใหม่ หรือ false พร้อมเหตุผลที่แบนไม่ได้ ใช้กับเป้าหมายที่ออฟไลน์ได้ด้วย

Option What it does
reason ต้องใส่ และจะแสดงให้ผู้เล่นเห็นตอนพยายามเข้าเกม
scope "perm" (ค่าเริ่มต้น), "server" เฉพาะเซิร์ฟเวอร์นี้ หรือ "expire"
duration หน่วยเป็นวินาที สำหรับ scope "expire"
expiresAt เวลา epoch แบบระบุตรงๆ ซึ่งจะใช้แทน duration
banAlts ค่าเริ่มต้นคือ true แบนบัญชีสำรองผ่าน BanService ของ Roblox
callerUserId UserId ที่จะระบุว่าเป็นคนแบน และใช้เช็กยศเทียบด้วย ถ้าไม่ใส่จะเป็นการแบนโดยระบบที่ไม่มีข้อจำกัด
-- 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?)

ล้างการแบนของเป้าหมายและคืนค่า (success, failReason, totalBansCleared) ใส่ banId เพื่อล้างการแบนเฉพาะอันนั้น หรือใส่ nil เพื่อล้างทั้งหมด options รับ scope และ callerUserId


getBanAsync Server

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

คืนค่า BanRecord ที่ยังมีผลของเป้าหมายพร้อม banId โดยเช็กข้อมูลของคนที่ออฟไลน์ด้วย หรือคืน nil ถ้าไม่ได้ถูกแบน

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

พรอมต์

prompt Shared

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

แสดงการแจ้งเตือน ข้อความ หรือการ์ดให้ผู้เล่นด้วย UI ของ HD Admin เอง จาก Script ฝั่งเซิร์ฟเวอร์ตัวไหนก็ได้ ฟังก์ชันนี้เป็นตัวเดียวกับพรอมต์ของ Command API ซึ่งอธิบายพรอมต์ทุกประเภท ตัวเลือกทั้งหมด และการ์ดแอ็กชันที่มีปุ่มกับแถบเลื่อน

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

ข้อความ

filterTextAsync Server

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

ส่งข้อความผ่านตัวกรองของ Roblox แล้วคืนค่า true พร้อมข้อความที่กรองแล้ว หรือ false พร้อมเหตุผล ถ้าไม่ใส่ viewer จะกรองสำหรับทุกคน ซึ่งเหมาะกับทุกอย่างที่ผู้เล่นทุกคนเห็นและข้อความที่จะบันทึกไว้ ถ้าใส่ viewer จะกรองสำหรับผู้เล่นคนนั้นคนเดียว ผู้เขียนต้องอยู่ในเซิร์ฟเวอร์นี้ เพราะตัวกรองของ Roblox ไม่ยอมทำงานให้คนที่ไม่ได้อยู่ในเซิร์ฟเวอร์ ข้อความที่กลับมาเป็นแค่เครื่องหมายแฮชแท็กล้วนๆ จะนับว่าล้มเหลว คุณเลยไม่ต้องแสดงผลที่ว่างเปล่า

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

ข้อมูล

getSetting Shared

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

คืนค่าของการตั้งค่าของเกม เช่น ServerAPI.getSetting("Prefix") ถ้าใส่ผู้เล่นด้วย จะนำ You Settings ของผู้เล่นคนนั้นมาใช้ด้วย คุณเลยได้ค่าตรงกับที่ผู้เล่นคนนั้นเจอจริงๆ


getVersion Shared

ServerAPI.getVersion(): string

เวอร์ชันของ HD Admin ที่กำลังรันอยู่ เช่น "v2.0.0"


การแยกเซิร์ฟเวอร์

isolateServer Server

ServerAPI.isolateServer()

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

เหมาะกับเซิร์ฟเวอร์ส่วนตัวหรือเซิร์ฟเวอร์ที่จองไว้ ที่อยากให้ใครสักคนเป็น "Owner" โดยไม่กระทบส่วนอื่นของจักรวาลเกมของคุณ

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

isServerIsolated Server

ServerAPI.isServerIsolated(): boolean

คืนค่า true เมื่อมีการเรียก isolateServer ในเซิร์ฟเวอร์นี้แล้ว


การจำกัด

restrictServer Server

ServerAPI.restrictServer(options: RestrictOptions?)

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

ต่างจาก isolateServer ตรงที่ข้อมูลยังบันทึกและยังไปถึงเซิร์ฟเวอร์อื่นอยู่ ตัวอย่างคือ HD Admin Hub ใช้ฟังก์ชันนี้ให้ผู้เล่นทุกคนได้บทบาท "Dev" เพื่อโชว์แผงควบคุมของแอดมิน แต่จำกัดคำสั่งและฟีเจอร์ที่เอาไปป่วนได้หลายอย่าง เพื่อไม่ให้เซิร์ฟเวอร์พัง

Option What it does
commandsInRoles ชื่อหรือคีย์ของบทบาทที่คำสั่งจะถูกปฏิเสธ
commands ชื่อหรือคีย์ของคำสั่งที่ถูกปฏิเสธเพิ่มจากนั้น
bypassRoles ชื่อหรือคีย์ของบทบาทที่ข้ามข้อจำกัดทั้งหมด
warning แทนที่ "This is restricted in this game" ซึ่งเป็นการแจ้งเตือนที่ขึ้นทุกครั้งที่มีการปฏิเสธ
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

คืนค่า true เมื่อมีการเรียก restrictServer ในเซิร์ฟเวอร์นี้แล้ว


อีโมต

getEmoteById Server

ServerAPI.getEmoteById(emoteId: number): Emote?

คืนค่า Emote ที่ลงทะเบียนไว้และมี id ตามที่ระบุ หรือ nil


getEmoteByName Server

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

คืนค่า Emote ที่ลงทะเบียนไว้และชื่อตรงกับที่ระบุ หรือ nil


getRandomEmote Server

ServerAPI.getRandomEmote(): Emote?

addEmoteAsync Server

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

ลงทะเบียนอีโมตใหม่จากแอสเซ็ตอนิเมชันอีโมต เพื่อให้เล่นได้ด้วย ;emote และขึ้นในเมนูอีโมต ต้องใส่แค่ emoteId ส่วนรายละเอียดที่ขาดจะดึงมาให้เอง คืนค่า true พร้อม Emote ที่ครบถ้วน หรือ false พร้อมเหตุผลที่ลงทะเบียนไม่ได้


ชนิดข้อมูล

Role

ตารางการตั้งค่าบทบาทแบบเต็ม ตรงตามที่กำหนดไว้ใน ConfigRoles ดู บทบาท


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 ไม่ได้เป็นส่วนหนึ่งของเรคอร์ดนี้ getBanAsync จึงส่งให้เป็นค่าที่คืนตัวที่สอง


Task

ดู Task API


Emote

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