Command API
Wszystko, do czego komenda może bezpiecznie się odwoływać, znajduje się w CommandAPI:
local CommandAPI = require(script:FindFirstAncestor("HD Admin").Core.CommandAPI)
Ładowanie¶
loadCommands Server¶
CommandAPI.loadCommands(details): Commands
Tego używają moduły pakietów w Config > Commands, żeby ładować, tagować i modyfikować swoje zestawy komend. Otwórz dowolny z tamtejszych pakietów, żeby zobaczyć, jak to działa.
Monity¶
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
Pokazuje powiadomienie, wiadomość albo kartę. Monity akcji z przyciskami znajdziesz w bindPrompt.
| Typ monitu | Co pokazuje |
|---|---|
"info" "success" "warn" "error" |
Powiadomienie na pasku bocznym z efektem dźwiękowym |
"message" |
Wiadomość na środku ekranu, używana na przykład w ;message |
"hint" |
Mały pasek u góry ekranu, używany na przykład w ;hint |
"privateMessage" |
Przypięte powiadomienie na pasku bocznym, które po kliknięciu otwiera pełną wiadomość |
"alert" |
Przypięte powiadomienie na pasku bocznym, które zapętla dźwięk, dopóki ktoś go nie wyciszy, a po kliknięciu otwiera pełną wiadomość |
"action" |
Powiadomienie na pasku bocznym z przyciskami i kontrolkami. Tworzysz je przez task:bindPrompt |
CommandAPI.prompt("success", task.caller, "Quest complete!", {duration = 5})
Zwraca połączenie, które możesz rozłączyć przez connection:Disconnect(), żeby zakończyć monit. Możesz na przykład dodać je do janitora zadania, żeby monit znikał razem z komendą:
task.janitor:add(CommandAPI.prompt("hint", task.target, "You're frozen until an admin releases you", {duration = 0})) -- 0 means "infinite"
Opcje
Wszystkie są opcjonalne i działają dla każdego typu monitu, chyba że wiersz mówi inaczej:
| Opcja | Typ | Co robi |
|---|---|---|
title |
string | Nagłówek nad tekstem. privateMessage i alert ustawiają własny |
duration |
number | Liczba sekund, po których monit sam znika. Jeśli ją pominiesz, czas zostanie obliczony na podstawie długości tekstu. 0 zostawia monit na ekranie, dopóki ktoś go nie zamknie albo nie rozłączysz go w kodzie |
subtext |
string | Mniejsza linijka pod tekstem |
icon |
string | Obraz rbxassetid://, który zastępuje ikonę powiadomienia |
color |
Color3 | Zabarwia tekst hint |
dismissable |
boolean | false ukrywa przycisk zamykania, więc monit usunie tylko duration albo uchwyt |
openPage |
string | Kliknięcie powiadomienia otwiera panel na tej stronie, na przykład "Commands", "Roles", "Settings" albo "About" |
openProfile |
boolean | Kliknięcie powiadomienia otwiera profil samego gracza |
openImage |
table | {image = "rbxassetid://...", title = "Map", ratio = 16/9}. Kliknięcie powiadomienia otwiera obraz na środku ekranu |
linkButtons |
table | Małe przyciski na dole powiadomienia. {label = "Roles", page = "Roles"} otwiera stronę, a {label = "Profile", profile = true} otwiera profil. Dodaj style = "Neutral", żeby przycisk był przygaszony, i hideAfterPress = true, żeby zamknąć powiadomienie po kliknięciu. Z LocalScript przez Client API możesz użyć {label = "Shop", onActivate = function() ... end, icon = "rbxassetid://..."}, który uruchamia twoją własną funkcję |
roleBadges |
table | Odznaki ról pod tytułem, {{name = "Admin", color = Color3.fromRGB(255, 170, 0)}} |
countdown |
number | Odlicza na żywo od tylu sekund wszędzie tam, gdzie w tekście stoi %TIME% |
fromUserId |
number | Pokazuje awatar, nazwę i najwyższą rolę tego użytkownika jako nadawcy message, privateMessage lub alert |
userText |
boolean | Pokazuje tekst dokładnie tak, jak go napisano, bez znaczników rich text itp. |
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)}},
})
Monity akcji z przyciskami znajdziesz w bindPrompt.
Postać¶
getHumanoid Shared¶
CommandAPI.getHumanoid(player: Player?): Humanoid?
Humanoid gracza albo nil, jeśli jego postać nie istnieje.
getHRP Shared¶
CommandAPI.getHRP(player: Player?): BasePart?
HumanoidRootPart gracza albo nil.
getHead Shared¶
CommandAPI.getHead(player: Player?): (BasePart?, Model?)
Head gracza i jego postać albo nil.
getNeck Shared¶
CommandAPI.getNeck(player: Player?): Motor6D?
Staw szyi gracza albo nil. Działa zarówno dla rigów R6, jak i R15.
getTorso Shared¶
CommandAPI.getTorso(player: Player?): Instance?
Tors gracza albo nil. Działa zarówno dla rigów R6, jak i R15.
loadCharacter Server¶
CommandAPI.loadCharacter(player: Player?)
Odradza postać gracza. Zawsze używaj tego zamiast player:LoadCharacter(), żeby zadania HD Admin wiedziały, że odrodzenie było zamierzone.
Gracze¶
getUserInfoAsync Shared¶
CommandAPI.getUserInfoAsync(userId: number | string): (boolean, UserInfo | string)
Zwraca true i UserInfo dla dowolnego użytkownika, także offline, albo false i powód. Wyniki są zapisywane w pamięci podręcznej, więc powtórne wywołania nic nie kosztują.
getNameFromUserIdAsync Shared¶
CommandAPI.getNameFromUserIdAsync(userId: number | string): (boolean, string)
Zwraca true i nazwę użytkownika albo false i powód. Działa też dla użytkowników offline.
teleportAsync Server¶
CommandAPI.teleportAsync(player: Player?, cframe: CFrame): (boolean, string)
Przenosi postać gracza na podany CFrame, najpierw go wysadzając z siedzenia, żeby nie ciągnął go ze sobą.
getAllowedTargets Server¶
CommandAPI.getAllowedTargets(task: Task, options: {players: {Player}?}?): ({Player}, {Player})
Gracze, na których komenda może działać. Domyślnie są to wszyscy na serwerze oprócz tych, którzy mają włączone Block commands w swoich You Settings.
unequipTools Server¶
CommandAPI.unequipTools(player: Player?): (boolean, string)
Przenosi trzymane narzędzie gracza z powrotem do jego plecaka.
Zadania¶
getTasks Shared¶
CommandAPI.getTasks(commandKey: string?, targetUserId: number?): {Task}
Zwraca działające zadania, opcjonalnie przefiltrowane po komendzie i celu. To te same obiekty zadań, które opisuje Task API.
getTasksByCallerId Shared¶
CommandAPI.getTasksByCallerId(callerUserId: number): {Task}
Wszystkie działające zadania uruchomione przez danego wywołującego.
Czat¶
systemMessage Shared¶
-- In a server command module
CommandAPI.systemMessage(player: Player, text: string)
-- In a client command module
CommandAPI.systemMessage(text: string)
Wysyła na czat gracza wiadomość w stylu systemowym.
checkTextLimit Server¶
CommandAPI.checkTextLimit(task: Task, textKind: "Message" | "SurfaceText" | "ChatText" | "Reason"): (boolean, number?)
HD Admin ogranicza wysyłanie funkcji związanych z wiadomościami ze względu na zasady bezpieczeństwa wiekowego Roblox, więc ta funkcja pozwala sprawdzić, ile jeszcze trwa ten czas oczekiwania.
Zwraca true, gdy tekst można pokazać, a w przeciwnym razie false wraz z pozostałym czasem oczekiwania.
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,
| Rodzaj | Wspólny limit dla |
|---|---|
"Message" |
Wiadomości, hintów, powiadomień, alertów, prywatnych wiadomości i ankiet |
"SurfaceText" |
Nazw, tytułów, nazw drużyn i statystyk |
"ChatText" |
Tagów czatu i nazw na czacie |
"Reason" |
Powodów kicka i banu |
forceBubbleChat Shared¶
CommandAPI.forceBubbleChat(target: Player | Model, text: string)
Pokazuje dymek czatu nad postacią gracza albo nad dowolnym modelem lub częścią, które podasz zamiast niego.
Stroje¶
getDescription Server¶
CommandAPI.getDescription(humanoid: Humanoid): HumanoidDescription
Aktualny HumanoidDescription danego humanoida.
applyDescription Server¶
CommandAPI.applyDescription(humanoid: Humanoid?, description: HumanoidDescription?, properties: {[string]: any}?): HumanoidDescription?
Bezpiecznie stosuje HumanoidDescription i ponawia próbę, gdy Roblox odrzuci pierwszą. Przekaż properties, żeby zmienić pola na wierzchu bazowego opisu.
outfitBuff Server¶
CommandAPI.outfitBuff(target: Player, properties: {[string]: any})
Stosuje właściwości HumanoidDescription jako buff, który sam się cofa, gdy zadanie się kończy, więc komendy takie jak ;wormify same po sobie sprzątają.
setFakeBodyParts Server¶
CommandAPI.setFakeBodyParts(character: Model, info: {[string]: any}): (() -> ())?
Podmienia części ciała na atrapy stworzone przez komendę i zwraca funkcję, która przywraca oryginały.
clearFakeBodyParts Server¶
CommandAPI.clearFakeBodyParts(character: Model)
Znowu usuwa te atrapy.
runBundleId Server¶
CommandAPI.runBundleId(task: Task, bundleId: number, properties: {[string]: any}?)
Ubiera cel zadania w bundle z katalogu, a gdy zadanie się kończy, przywraca jego własny strój.
Zasoby¶
registerSound Shared¶
CommandAPI.registerSound(sound: Sound)
Wymagane dla każdego Sound tworzonego przez twoją komendę, żeby obowiązywały go ustawienia głośności i wysokości dźwięku w grze.
setAnchored Shared¶
CommandAPI.setAnchored(instance: Instance, anchored: boolean)
Zakotwicza albo odkotwicza każdą część pod daną instancją.
setTransparency Shared¶
CommandAPI.setTransparency(instance: Instance, transparency: number)
Przezroczystość każdej części pod daną instancją.
promptPurchaseAsync Server¶
CommandAPI.promptPurchaseAsync(assetId: number, player: Player?, infoType: Enum.InfoType?)
Wyświetla graczowi monit o zakup zasobu, kierując do właściwego procesu zakupu dla jego typu.
ownsAssetAsync Server¶
CommandAPI.ownsAssetAsync(assetId: number, player: Player?): boolean
Sprawdza, czy gracz posiada dany zasób.
isTypeAsync Server¶
CommandAPI.isTypeAsync(assetId: number, assetType: Enum.AssetType | Enum.BundleType): (boolean, string?)
Sprawdza, czy zasób jest danego typu. Zwraca true albo false wraz z powodem.
loadAssetCommand Server¶
CommandAPI.loadAssetCommand(assetType: Enum.AssetType, task: Task, assetId: number, callback: (item: Instance) -> ())
Sprawdza, czy zasób jest danego typu i czy jest dozwolony, wstawia go, a potem przekazuje do twojego callbacku, żebyś go umieścił. To na tym działa ;gear.
getToolsInfoAsync Server¶
CommandAPI.getToolsInfoAsync(): (boolean, {ToolInfo} | string)
Zwraca true i ToolInfo każdego narzędzia dostępnego dla ;give albo false i powód.
Narzędzia pomocnicze¶
getTargets Server¶
CommandAPI.getTargets(targetType: "All" | "Others" | "Nearby" | "OthersNearby", originPlayer: Player?, radius: number?): {Player}
Zamienia kwalifikator na graczy, których aktualnie obejmuje. "Nearby" i "OthersNearby" mierzą odległość od gracza początkowego, w promieniu radius studów (domyślnie 50).
setCameraSubject Client¶
CommandAPI.setCameraSubject(newSubject: Instance)
Kieruje kamerę lokalnego gracza na nowy obiekt, na przykład na Humanoid innego gracza w ;view.
runPromptCommand Server¶
CommandAPI.runPromptCommand(promptType: PromptType, task: Task, targets: {Player}, text: string, options: PromptOptions?)
Silnik stojący za ;message, ;hint i podobnymi monitami. Filtruje tekst, pokazuje monit każdemu celowi i utrzymuje zadanie przy życiu, dopóki monit nie wygaśnie.
runEmoteId Server¶
CommandAPI.runEmoteId(task: Task, emoteId: number, speed: number?, looped: boolean?)
Odtwarza animację emotki na celu zadania i kończy ją, gdy zadanie się kończy.
createEmoteCommand Server¶
CommandAPI.createEmoteCommand(emoteName: string, emoteId: number, properties: {[string]: any}?): Command
Zwraca kompletną komendę emotki, gotową do wrzucenia do twojej tablicy komend. properties nadpisuje dowolne pole wygenerowanej komendy.
createBundleCommand Server¶
CommandAPI.createBundleCommand(commandName: string, bundleId: number, properties: {[string]: any}?): Command
To samo zachowanie dla komend bundle, takich jak ;ratdance.
bindEmotePrompt Server¶
CommandAPI.bindEmotePrompt(task: Task, target: Player, emoteId: number, emoteName: string?, isLooped: boolean?)
Podpina do zadania kartę akcji emotki, żeby cel mógł dodać emotkę do ulubionych albo obejrzeć ją w katalogu.
openProfile Server¶
CommandAPI.openProfile(player: Player?, userId: number)
Otwiera graczowi okienko z profilem danego użytkownika.
openPage Server¶
CommandAPI.openPage(player: Player?, pageId: string, tabLabel: string?)
Otwiera panel gracza od razu na danej stronie, opcjonalnie na jednej z jej kart.
openEmotes Server¶
CommandAPI.openEmotes(player: Player?)
Otwiera graczowi okienko z emotkami.
colourRoleName Shared¶
CommandAPI.colourRoleName(role): string
Nazwa roli owinięta w jej kolor, do rich text.
isTableEmpty Shared¶
CommandAPI.isTableEmpty(tbl: {[any]: any}): boolean
Sprawdza, czy tabela w ogóle nie ma wpisów, także tych z kluczami, których #tbl nie widzi.
round Shared¶
CommandAPI.round(number: number, decimalPlaces: number?): number
Zaokrągla liczbę do podanej liczby miejsc po przecinku, a domyślnie do liczby całkowitej.
Typy¶
Commands¶
type Commands = {Command}
Tablica, którą zwraca moduł komend.
Command¶
Jedna tabela komendy w Commands (name, args, run i tak dalej). Wszystkie pola opisuje Custom Commands.
Task¶
Obiekt zadania przekazywany do każdej funkcji run, w pełni opisany w Task API.
ClientCommands¶
Odpowiednik Commands po stronie klienta, zwracany przez moduł Client.
ClientCommand¶
Jedna tabela komendy po stronie klienta w ClientCommands.
UserInfo¶
type UserInfo = {
userId: number | string,
userName: string,
userImage: string,
userDisplayName: string,
userTopRole: {key: string, name: string, color: Color3}?,
}
userTopRole występuje tylko u graczy na tym serwerze.
ToolInfo¶
type ToolInfo = {
name: string,
textureId: string,
tool: Tool?,
}
PromptType¶
type PromptType = "info" | "success" | "warn" | "error" | "message" | "hint" | "privateMessage" | "alert" | "vote" | "voteResults" | "action"
Łańcuchy znaków z typami monitów. To, co pokazuje każdy z nich, opisuje prompt.
PromptOptions¶
Tabela opcji, którą przyjmuje prompt, w pełni opisana w prompt.
PromptHandle¶
Uchwyt zwracany przez prompt, który wcześniej zamyka monit przez handle:Disconnect().