Ana içeriğe geç

Server API

Buradaki her şey CoreServerAPI içinde durur ve bir sunucu Script'inden çalışır:

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

Komutlar

requestCommand Server

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

Bir komut mesajını tam olarak sohbete yazılmış gibi çalıştırır. Oyuncu verilmezse çağıranın yerine bir Server User geçer, böylece komutlar oyun kodunun herhangi bir yerinden yetki kontrolü olmadan tetiklenebilir. Oyuncu verirsen onun rolleri, yetkileri ve hız sınırlarının hepsi geçerli olur, çağıran bildirimleri de ona gönderilir. Onaylanıp onaylanmadığını, üretilen bildirimleri ve oluşturduğu görevleri döndürür.

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

Çalışan görevleri döndürür. İki filtre de isteğe bağlıdır. ServerAPI.getTasks() tüm görevleri, ServerAPI.getTasks("fly") tüm fly görevlerini, ServerAPI.getTasks("fly", player) ise sadece o oyuncunun fly görevlerini döndürür.


endTasks Server

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

Eşleşen görevleri sonlandırır ve kaç tanesinin sonlandırıldığını döndürür. Bu, ;unCommand'ın kod karşılığıdır ve getTasks ile aynı isteğe bağlı filtrelere sahiptir.

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

Hedefin rollerinin verilen komutu çalıştırmasına izin verip vermediğini döndürür. true döndürür, ya da false ve sebebini döndürür.


disableCommands Server

ServerAPI.disableCommands(player: Player)

enableCommands çağrılana ya da oyuncu tekrar katılana kadar oyuncunun yeni komut çalıştırmasını engeller. Oyuncu bir minigame turundayken ya da bir ara sahnedeyken işe yarar. Zaten çalışan görevleri devam eder, o yüzden bunların da temizlenmesini istiyorsan endTasks ile birlikte kullan. Doğrudan PlayerAdded içinden çağırmak güvenlidir.


enableCommands Server

ServerAPI.enableCommands(player: Player)

Oyuncunun tekrar komut çalıştırmasına izin verir.


Roller

Rol adları büyük/küçük harfe duyarsız eşleştirilir, yani "VIP" ve "vip" aynı role ulaşır.

giveRoleAsync Server

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

Rolü hedefe verir ve true döndürür, veremezse false ve sebebini döndürür. Kalıcı rol vermeler kaydedilir, sunucular arası yayılır ve çevrimdışı hedefler için de çalışır.

Option What it does
scope "perm" sonsuza kadar kaydeder (varsayılan), "server" sadece bu sunucuda sürer, "expire" duration sonra kendiliğinden kalkar
duration Saniye cinsinden, "expire" kapsamı için zorunlu
reason Verme sebebi
callerUserId Rolü veren kişinin UserId'si, rütbe kontrolü de buna göre yapılır
-- 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?)

Rolü hedeften alır. Diğer sunucularda ya da hedef çevrimdışıyken yapılmış kalıcı rol vermeler de buna dahildir. options, giveRoleAsync ile aynı şekilde scope ("perm" ya da "server") ve callerUserId kabul eder.


getRolesAsync Server

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

true ve hedefin rollerini en yüksek rütbe başta olacak şekilde sıralı döndürür, ya da false ve bir sebep döndürür. Hedef bu sunucuda olmalı.

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 ve hedefin en kıdemli rolünü döndürür (hiç rolü yoksa nil), ya da false ve bir sebep döndürür. Hedef bu sunucuda olmalı.


hasRoleAsync Server

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

Hedefin şu an o role sahip olup olmadığını döndürür. Hedef bu sunucuda olmalı.


getRole Server

ServerAPI.getRole(roleName: string): Role?

Verilen ad için Role döndürür, hiçbir rol eşleşmezse nil döndürür.


getAllRoles Server

ServerAPI.getAllRoles(): {Role}

Oyunun yapılandırmasındaki tüm rolleri döndürür.


Moderasyon

banAsync Server

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

Hedefi oyununa girmekten banlar ve şu an herhangi bir sunucudaysa kick atar. true ve yeni banId döndürür, banlayamazsa false ve sebebini döndürür. Çevrimdışı hedefler için de çalışır.

Option What it does
reason Zorunlu, oyuncu katılmaya çalıştığında ona gösterilir
scope "perm" (varsayılan), sadece bu sunucu için "server", ya da "expire"
duration Saniye cinsinden, "expire" kapsamı için
expiresAt duration değerini geçersiz kılan mutlak bir epoch
banAlts Varsayılan true, alt hesapları Roblox'un BanService'i üzerinden banlar
callerUserId Bana yazılacak ve rütbe kontrolü yapılacak bir UserId. Kısıtlamasız bir sistem bani için boş bırak
-- 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?)

Hedefin banlarını kaldırır ve (success, failReason, totalBansCleared) döndürür. Belirli bir bani kaldırmak için banId ver, hepsini kaldırmak için nil ver. options scope ve callerUserId kabul eder.


getBanAsync Server

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

Hedefin aktif BanRecord'unu ve banId'sini döndürür, çevrimdışı kayıtlara da bakar. Banlı değilse nil döndürür.

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

İstemler

prompt Shared

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

Oyuncuya HD Admin'in kendi arayüzüyle, herhangi bir sunucu Script'inden bir bildirim, mesaj ya da kart gösterir. Bu, Command API'nin prompt'u ile aynı fonksiyondur. Orada tüm istem türlerini, seçeneklerin tam listesini ve düğmeli, kaydırıcılı aksiyon kartlarını bulabilirsin.

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

Metin

filterTextAsync Server

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

Metni Roblox'un filtresinden geçirir ve true ile filtrelenmiş metni döndürür, olmazsa false ve sebebini döndürür. Herkes için filtrelemek istiyorsan viewer verme. Bu, her oyuncunun görebileceği her şey ve kaydettiğin metinler için doğru olandır. Sadece tek bir oyuncu için filtrelemek istiyorsan viewer ver. Yazar bu sunucuda olmalı, çünkü Roblox'un filtresi sunucuda olmayan biri için çalışmayı reddeder. Sadece hashtag'lerden oluşan bir metin başarısızlık sayılır, böylece boş bir sonuç hiç gösterilmez.

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

Bilgi

getSetting Shared

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

Bir oyun ayarının değerini döndürür, örneğin ServerAPI.getSetting("Prefix"). Oyuncunun kendi You Settings ayarlarının da uygulanması için bir oyuncu ver, böylece o oyuncunun deneyimlediği tam değeri alırsın.


getVersion Shared

ServerAPI.getVersion(): string

Çalışan HD Admin sürümü, örneğin "v2.0.0".


İzolasyon

isolateServer Server

ServerAPI.isolateServer()

Bu sunucunun veri kaydetmesini ve diğer sunuculara herhangi bir şey göndermesini keser. Her şey yine normal çalışıyormuş gibi görünür, örneğin kalıcı banlar, rol düzenlemeleri, oyun ayarları, global komutlar ve global oylamalar. Ama hiçbiri gerçekte kaydedilmez ya da diğer sunuculara ulaşmaz, bu yüzden sunucu kapanınca hepsi kaybolur. Kayıtlı veriler yine normal okunur, yani sunucu gerçek rollerin, banların, ayarların vb. ile başlar. Her oyuncunun kendi tercihleri, örneğin You ayarları ve favori emote'ları, yine kaydedilir çünkü sadece o oyuncuyu etkilerler.

Bu, özel sunucular ya da ayrılmış sunucular için kullanışlıdır. Evrenindeki geri kalan şeyi etkilemeden birine "Owner" vermek istediğinde işe yarar.

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

isServerIsolated Server

ServerAPI.isServerIsolated(): boolean

Bu sunucuda isolateServer çağrıldıysa true döndürür.


Kısıtlama

restrictServer Server

ServerAPI.restrictServer(options: RestrictOptions?)

Bu, oyun genelindeki tüm özellikleri kısıtlar: oyun ayarları, rol düzenlemeleri, kalıcı roller, kalıcı banlar ve ban kaldırmalar, vetting, kayıtlı görevler, kalıcı, global ve katılma değiştiricileri. commandsInRoles içindeki rollere ait komutlar ya da commands içinde adı geçen komutlar da kısıtlanır. Her şey panelde yine normal görünür, ama gerçek özellik ya da komut kullanılınca bunun yerine bir hata bildirimi gösterilir. bypassRoles içindeki bir role sahip olan herkes tüm kısıtlamaları atlar.

isolateServer'dan farklı olarak veriler yine kaydedilir ve diğer sunuculara yine ulaşır. HD Admin Hub bunu örneğin admin panelini göstermek için her oyuncuya "Dev" vermekte kullanır, ama sunucuların yok edilmesini önlemek için kötüye kullanılabilecek komut ve özelliklerin çoğunu kısıtlar.

Option What it does
commandsInRoles Komutları reddedilecek rol adları ya da anahtarları
commands Bunların üstüne reddedilecek komut adları ya da anahtarları
bypassRoles Tüm kısıtlamaları atlayan rol adları ya da anahtarları
warning Bir şey reddedildiğinde gösterilen "This is restricted in this game" bildiriminin yerine geçer
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

Bu sunucuda restrictServer çağrıldıysa true döndürür.


Emote'lar

getEmoteById Server

ServerAPI.getEmoteById(emoteId: number): Emote?

Verilen id'ye sahip kayıtlı Emote'u döndürür, yoksa nil döndürür.


getEmoteByName Server

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

Verilen adla eşleşen kayıtlı Emote'u döndürür, yoksa nil döndürür.


getRandomEmote Server

ServerAPI.getRandomEmote(): Emote?

addEmoteAsync Server

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

Bir emote animasyon asset'inden yeni bir emote kaydeder, böylece ;emote ile oynatılabilir ve emote menüsünde görünür. Sadece emoteId zorunludur, eksik detaylar senin yerine çekilir. true ve tamamlanmış Emote'u döndürür, olmazsa false ve sebebini döndürür.


Türler

Role

ConfigRoles altında tanımlandığı haliyle tam rol yapılandırma tablosu. Bkz. Roller.


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 kaydın kendisinin parçası değildir, bu yüzden getBanAsync onu sana ikinci dönüş değeri olarak verir.


Task

Bkz. Task API.


Emote

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