Server API
Wszystko tutaj znajduje się w CoreServerAPI i działa ze skryptu serwera Script:
local hd = game:GetService("ReplicatedStorage"):WaitForChild("HD Admin")
local ServerAPI = require(hd.Core.ServerAPI)
Komendy¶
requestCommand Server¶
ServerAPI.requestCommand(message: string, fromPlayer: Player?): (boolean, {any}, {Task})
Uruchamia komendę dokładnie tak, jakby została wpisana na czacie. Gdy nie podasz gracza, jego miejsce zajmuje Server User, więc komendy możesz odpalać z dowolnego miejsca w kodzie gry bez sprawdzania uprawnień. Gdy podasz gracza, obowiązują jego role, uprawnienia i limity, a powiadomienia dla wywołującego trafiają do niego. Zwraca, czy komenda została zatwierdzona, wygenerowane powiadomienia i utworzone zadania.
-- 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}
Zwraca działające zadania. Oba filtry są opcjonalne. ServerAPI.getTasks() zwraca każde zadanie, ServerAPI.getTasks("fly") każde zadanie fly, a ServerAPI.getTasks("fly", player) tylko zadania fly tego gracza.
endTasks Server¶
ServerAPI.endTasks(commandName: string?, target: Target?): number
Kończy pasujące zadania i zwraca, ile ich zakończono. To odpowiednik ;unCommand w kodzie, z tymi samymi opcjonalnymi filtrami co 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?)
Sprawdza, czy role celu pozwalają mu użyć danej komendy. Zwraca true, albo false i powód.
disableCommands Server¶
ServerAPI.disableCommands(player: Player)
Blokuje graczowi użycie jakichkolwiek nowych komend, dopóki nie wywołasz enableCommands albo gracz nie dołączy ponownie. Przydaje się, gdy gracz jest w rundzie minigry albo w przerywniku filmowym. Jego już działające zadania trwają dalej, więc jeśli chcesz je też wyczyścić, użyj razem z endTasks. Możesz to spokojnie wywołać wprost z PlayerAdded.
enableCommands Server¶
ServerAPI.enableCommands(player: Player)
Pozwala graczowi znowu używać komend.
Zarządzanie rolami¶
Nazwy ról są dopasowywane bez rozróżniania wielkości liter, więc "VIP" i "vip" trafiają w tę samą rolę.
giveRoleAsync Server¶
ServerAPI.giveRoleAsync(target: Target, roleName: string, options: ActionOptions?): (boolean, string?)
Nadaje cel rolę i zwraca true, albo false i powód, dlaczego się nie udało. Stałe nadania zapisują się, działają cross-server i działają też dla graczy offline.
| Opcja | Co robi |
|---|---|
scope |
"perm" zapisuje na zawsze (domyślnie), "server" trwa tylko na tym serwerze, "expire" sama się usuwa po duration |
duration |
Sekundy, wymagane dla scope "expire" |
reason |
Powód nadania |
callerUserId |
UserId osoby, która nadała rolę i względem której sprawdzana jest ranga |
-- 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?)
Zabiera cel rolę, łącznie ze stałymi nadaniami zrobionymi na innych serwerach albo gdy gracz był offline. options przyjmuje scope ("perm" lub "server") i callerUserId, tak samo jak giveRoleAsync.
getRolesAsync Server¶
ServerAPI.getRolesAsync(target: Target): (boolean, {Role} | string)
Zwraca true i role celu uporządkowane od najwyższej rangi, albo false i powód. Cel musi być na tym serwerze.
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)?)
Zwraca true i najwyższą rolę celu (nil, jeśli nie ma żadnej), albo false i powód. Cel musi być na tym serwerze.
hasRoleAsync Server¶
ServerAPI.hasRoleAsync(target: Target, roleName: string): boolean
Sprawdza, czy cel aktualnie ma daną rolę. Cel musi być na tym serwerze.
getRole Server¶
ServerAPI.getRole(roleName: string): Role?
Zwraca Role dla podanej nazwy, albo nil, jeśli żadna rola nie pasuje.
getAllRoles Server¶
ServerAPI.getAllRoles(): {Role}
Zwraca każdą rolę z konfiguracji gry.
Moderacja¶
banAsync Server¶
ServerAPI.banAsync(target: Target, options: BanOptions): (boolean, string?)
Banuje cel w twojej grze i wyrzuca go, jeśli jest teraz na którymkolwiek serwerze. Zwraca true i nowe banId, albo false i powód, dlaczego się nie udało. Działa też dla graczy offline.
| Opcja | Co robi |
|---|---|
reason |
Wymagany, widoczny dla gracza, gdy próbuje wejść do gry |
scope |
"perm" (domyślnie), "server" tylko dla tego serwera albo "expire" |
duration |
Sekundy, dla scope "expire" |
expiresAt |
Bezwzględny czas epoch, który ma pierwszeństwo przed duration |
banAlts |
Domyślnie true, banuje alternatywne konta przez BanService Robloxa |
callerUserId |
UserId, któremu przypisujesz ban i względem którego sprawdzana jest ranga. Pomiń go, żeby dać ban systemowy bez ograniczeń |
-- 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?)
Czyści bany celu i zwraca (success, failReason, totalBansCleared). Podaj banId, żeby wyczyścić jeden konkretny ban, albo nil, żeby wyczyścić wszystkie. options przyjmuje scope i callerUserId.
getBanAsync Server¶
ServerAPI.getBanAsync(target: Target): (BanRecord?, string?)
Zwraca aktywny BanRecord celu i jego banId, sprawdzając też zapisy offline, albo nil, jeśli cel nie jest zbanowany.
local ban, banId = ServerAPI.getBanAsync(userId)
if ban then
print(`Banned for '{ban.reason}' by {ban.bannedBy}`)
end
Monity¶
prompt Shared¶
ServerAPI.prompt(promptType: PromptType, player: Player, text: string, options: PromptOptions?): PromptHandle
Pokazuje graczowi powiadomienie, wiadomość albo kartę w interfejsie HD Admin, z dowolnego skryptu Script na serwerze. To ta sama funkcja co prompt z Command API, gdzie znajdziesz wszystkie typy monitów, pełną listę opcji oraz karty akcji z przyciskami i suwakami.
ServerAPI.prompt("success", player, "Quest complete!", {duration = 5})
Tekst¶
filterTextAsync Server¶
ServerAPI.filterTextAsync(text: string, author: Target, viewer: Target?): (boolean, string)
Przepuszcza tekst przez filtr Robloxa i zwraca true i przefiltrowany tekst, albo false i powód. Pomiń viewer, żeby filtrować dla wszystkich, co jest dobre dla wszystkiego, co widzi każdy gracz, i dla tekstu, który zapisujesz. Podaj viewer, żeby filtrować tylko dla tego jednego gracza. Autor musi być na tym serwerze, bo filtr Robloxa odmawia działania dla kogoś, kogo tu nie ma. Tekst, który wraca jako same hashe, jest traktowany jak błąd, dzięki czemu nigdy nie wyświetlisz pustego wyniku.
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
Zwraca wartość ustawienia gry, na przykład ServerAPI.getSetting("Prefix"). Podaj gracza, żeby uwzględnić też jego własne You Settings, dzięki czemu dostaniesz dokładnie tę wartość, którą widzi ten gracz.
getVersion Shared¶
ServerAPI.getVersion(): string
Działająca wersja HD Admin, na przykład "v2.0.0".
Izolacja¶
isolateServer Server¶
ServerAPI.isolateServer()
Odcina ten serwer od zapisywania danych i wysyłania czegokolwiek do innych serwerów. Wszystko nadal będzie wyglądać, jakby działało normalnie, na przykład stałe bany, edycje ról, ustawienia gry, komendy globalne i głosowania globalne, tylko że nic się naprawdę nie zapisuje ani nie dociera do innych serwerów, więc to wszystko znika, gdy serwer się zamknie. Zapisane dane są nadal odczytywane normalnie, więc serwer startuje z twoimi prawdziwymi rolami, banami, ustawieniami itd. Własne preferencje każdego gracza, takie jak jego You Settings i ulubione emotki, nadal się zapisują, bo dotyczą tylko tego gracza.
Przydaje się to na serwerach prywatnych albo zarezerwowanych, gdy chcesz komuś nadać "Owner" bez żadnego wpływu na resztę twojego uniwersum.
local hd = game:GetService("ReplicatedStorage"):WaitForChild("HD Admin")
local ServerAPI = require(hd:WaitForChild("Core"):WaitForChild("ServerAPI"))
ServerAPI.isolateServer()
isServerIsolated Server¶
ServerAPI.isServerIsolated(): boolean
Zwraca true, gdy na tym serwerze wywołano już isolateServer.
Ograniczanie¶
restrictServer Server¶
ServerAPI.restrictServer(options: RestrictOptions?)
Ogranicza wszystkie funkcje obejmujące całą grę, w tym ustawienia gry, edycje ról, stałe role, stałe bany i unbany, weryfikację, zapisane zadania oraz modyfikatory perm, global i join. Ograniczone są też komendy należące do ról z commandsInRoles albo wymienione w commands. W panelu wszystko nadal wygląda normalnie, aż do użycia danej funkcji albo komendy, i wtedy wyświetla się powiadomienie o błędzie. Każdy, kto ma rolę z bypassRoles, omija wszystkie ograniczenia.
W przeciwieństwie do isolateServer dane nadal się zapisują i nadal docierają do innych serwerów. HD Admin Hub używa tego na przykład, żeby dać każdemu graczowi "Dev" i pokazać panel admina, ale ogranicza wiele komend i funkcji nadających się do nadużyć, żeby nikt nie zniszczył serwerów.
| Opcja | Co robi |
|---|---|
commandsInRoles |
Nazwy lub klucze ról, których komendy są odrzucane |
commands |
Nazwy lub klucze komend odrzucanych dodatkowo |
bypassRoles |
Nazwy lub klucze ról, które omijają wszystkie ograniczenia |
warning |
Zastępuje "This is restricted in this game", czyli powiadomienie pokazywane za każdym razem, gdy coś jest odrzucone |
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
Zwraca true, gdy na tym serwerze wywołano już restrictServer.
Emotki¶
getEmoteById Server¶
ServerAPI.getEmoteById(emoteId: number): Emote?
Zwraca zarejestrowaną Emote o podanym id, albo nil.
getEmoteByName Server¶
ServerAPI.getEmoteByName(emoteName: string, matchLength: boolean?): Emote?
Zwraca zarejestrowaną Emote pasującą do podanej nazwy, albo nil.
getRandomEmote Server¶
ServerAPI.getRandomEmote(): Emote?
addEmoteAsync Server¶
ServerAPI.addEmoteAsync(emote: IncompleteEmote, dontRegister: boolean?): (boolean, Emote | string)
Rejestruje nową emotkę z assetu animacji emotki, żeby można ją było odtworzyć przez ;emote i żeby pojawiła się w menu emotek. Wymagane jest tylko emoteId, a brakujące dane zostaną pobrane za ciebie. Zwraca true i gotową Emote, albo false i powód, dlaczego się nie udało.
Typy¶
Role¶
Pełna tabela konfiguracji roli, dokładnie taka, jak zdefiniowana w ConfigRoles. Zobacz 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 nie jest częścią samego zapisu, więc getBanAsync zwraca je jako drugą wartość.
Task¶
Zobacz Task API.
Emote¶
type Emote = {
name: string,
originalName: string?,
order: number,
animationId: number,
emoteId: number,
}