Command API
Bir komutun güvenle kullanabileceği her şey CommandAPI içinde durur:
local CommandAPI = require(script:FindFirstAncestor("HD Admin").Core.CommandAPI)
Yükleme¶
loadCommands Server¶
CommandAPI.loadCommands(details): Commands
Config > Commands altındaki paket modülleri komut setlerini yüklemek, etiketlemek ve değiştirmek için bunu kullanır. Nasıl çalıştığını görmek için oradaki paketlerden herhangi birini aç.
İstemler¶
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
Bir bildirim, mesaj veya kart gösterir. Butonlu aksiyon istemleri için bindPrompt bölümüne bak.
| İstem türü | Ne gösterir |
|---|---|
"info" "success" "warn" "error" |
Ses efektli bir kenar çubuğu bildirimi |
"message" |
Ekranın ortasında gösterilen bir mesaj, örneğin ;message içinde kullanılır |
"hint" |
Ekranın üstünde küçük bir çubuk, örneğin ;hint içinde kullanılır |
"privateMessage" |
Tıklanınca mesajın tamamını açan, ekranda kalan bir kenar çubuğu bildirimi |
"alert" |
Sesi sen susturana kadar tekrarlayan, tıklanınca mesajın tamamını açan, ekranda kalan bir kenar çubuğu bildirimi |
"action" |
Butonları ve kontrolleri olan bir kenar çubuğu bildirimi. Bunları task:bindPrompt ile oluştur |
CommandAPI.prompt("success", task.caller, "Quest complete!", {duration = 5})
İstemi sonlandırmak için connection:Disconnect() ile kesebileceğin bir bağlantı döndürür. Bunları örneğin bir görevin janitor'ına ekleyip komut biter bitmez istemin de bitmesini sağlayabilirsin:
task.janitor:add(CommandAPI.prompt("hint", task.target, "You're frozen until an admin releases you", {duration = 0})) -- 0 means "infinite"
Seçenekler
Hepsi isteğe bağlıdır ve satırda başka bir şey yazmıyorsa her istem türünde çalışır:
| Seçenek | Tür | Ne yapar |
|---|---|---|
title |
string | Metnin üstündeki başlık. privateMessage ve alert kendi başlığını kendisi belirler |
duration |
number | İstemin kendiliğinden kapanmasına kadar geçen saniye. Boş bırakırsan süre metin uzunluğuna göre hesaplanır. 0 istemi kapatılana veya bağlantısı kesilene kadar ekranda tutar |
subtext |
string | Metnin altında daha küçük bir satır |
icon |
string | Bildirimin ikonunun yerine geçen bir rbxassetid:// görseli |
color |
Color3 | Bir hint metninin rengini ayarlar |
dismissable |
boolean | false kapat butonunu gizler, yani istemi yalnızca duration veya handle kaldırabilir |
openPage |
string | Bildirime tıklayınca paneli şu sayfada açar, örneğin "Commands", "Roles", "Settings" veya "About" |
openProfile |
boolean | Bildirime tıklayınca oyuncunun kendi profilini açar |
openImage |
table | {image = "rbxassetid://...", title = "Map", ratio = 16/9}. Bildirime tıklayınca görseli ekranın ortasında açar |
linkButtons |
table | Bildirimin alt kısmında küçük butonlar. {label = "Roles", page = "Roles"} bir sayfa açar, {label = "Profile", profile = true} ise profilini açar. Soluk bir buton için style = "Neutral", basıldıktan sonra bildirimi kapatmak için hideAfterPress = true ekle. Bir LocalScript içinden Client API ile {label = "Shop", onActivate = function() ... end, icon = "rbxassetid://..."} kullanırsan kendi fonksiyonun çalışır |
roleBadges |
table | Başlığın altında rol rozetleri, {{name = "Admin", color = Color3.fromRGB(255, 170, 0)}} |
countdown |
number | Metinde %TIME% geçen her yerde bu kadar saniyeden geriye doğru canlı sayar |
fromUserId |
number | O kullanıcının avatarını, adını ve en yüksek rolünü bir message, privateMessage veya alert göndericisi olarak gösterir |
userText |
boolean | Metni zengin metin etiketleri vb. olmadan, yazıldığı gibi gösterir |
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)}},
})
Butonlu aksiyon istemleri için bindPrompt bölümüne bak.
Karakter¶
getHumanoid Shared¶
CommandAPI.getHumanoid(player: Player?): Humanoid?
Oyuncunun Humanoid'i, karakteri yoksa nil.
getHRP Shared¶
CommandAPI.getHRP(player: Player?): BasePart?
Oyuncunun HumanoidRootPart'ı, yoksa nil.
getHead Shared¶
CommandAPI.getHead(player: Player?): (BasePart?, Model?)
Oyuncunun Head'i ve karakteri, yoksa nil.
getNeck Shared¶
CommandAPI.getNeck(player: Player?): Motor6D?
Oyuncunun boyun eklemi, yoksa nil. Hem R6 hem R15 rig'lerde çalışır.
getTorso Shared¶
CommandAPI.getTorso(player: Player?): Instance?
Oyuncunun gövdesi, yoksa nil. Hem R6 hem R15 rig'lerde çalışır.
loadCharacter Server¶
CommandAPI.loadCharacter(player: Player?)
Oyuncunun karakterini yeniden doğurur. HD Admin'in görevleri yeniden doğmanın bilerek yapıldığını anlasın diye player:LoadCharacter() yerine her zaman bunu kullan.
Oyuncular¶
getUserInfoAsync Shared¶
CommandAPI.getUserInfoAsync(userId: number | string): (boolean, UserInfo | string)
Çevrimdışı olanlar dahil herhangi bir kullanıcı için true ve UserInfo döndürür, olmazsa false ve bir neden döndürür. Sonuçlar önbelleğe alınır, yani tekrarlanan çağrılar bedavadır.
getNameFromUserIdAsync Shared¶
CommandAPI.getNameFromUserIdAsync(userId: number | string): (boolean, string)
true ve kullanıcının adını döndürür, olmazsa false ve bir neden döndürür. Çevrimdışı kullanıcılar için de çalışır.
teleportAsync Server¶
CommandAPI.teleportAsync(player: Player?, cframe: CFrame): (boolean, string)
Oyuncunun karakterini verilen CFrame'e taşır. Koltuğunu da peşinden sürüklemesin diye önce oyuncuyu koltuktan kaldırır.
getAllowedTargets Server¶
CommandAPI.getAllowedTargets(task: Task, options: {players: {Player}?}?): ({Player}, {Player})
Bir komutun etkileyebileceği oyuncular. Varsayılan olarak sunucudaki herkestir, You Settings içinde Block commands açık olanlar hariç.
unequipTools Server¶
CommandAPI.unequipTools(player: Player?): (boolean, string)
Oyuncunun elindeki aleti çantasına geri koyar.
Görevler¶
getTasks Shared¶
CommandAPI.getTasks(commandKey: string?, targetUserId: number?): {Task}
Çalışan görevleri döndürür, istersen komuta ve hedefe göre filtrelenmiş olarak. Bunlar Task API sayfasında anlatılan görev nesneleriyle aynıdır.
getTasksByCallerId Shared¶
CommandAPI.getTasksByCallerId(callerUserId: number): {Task}
Verilen çağıranın başlattığı, çalışmakta olan tüm görevler.
Sohbet¶
systemMessage Shared¶
-- In a server command module
CommandAPI.systemMessage(player: Player, text: string)
-- In a client command module
CommandAPI.systemMessage(text: string)
Oyuncunun sohbetine sistem mesajı biçiminde bir mesaj gönderir.
checkTextLimit Server¶
CommandAPI.checkTextLimit(task: Task, textKind: "Message" | "SurfaceText" | "ChatText" | "Reason"): (boolean, number?)
HD Admin, Roblox'un yaş güvenliği politikaları yüzünden mesajla ilgili özelliklerin gönderilmesini sınırlar. Bu fonksiyon o bekleme süresini görmenin yolunu sağlar.
Metin gösterilebiliyorsa true döndürür, gösterilemiyorsa false ve kalan bekleme süresini döndürür.
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,
| Tür | Paylaşılan özellikler |
|---|---|
"Message" |
Mesajlar, hint'ler, bildirimler, alert'ler, özel mesajlar ve anketler |
"SurfaceText" |
İsimler, başlıklar, takım isimleri ve istatistikler |
"ChatText" |
Sohbet etiketleri ve sohbet isimleri |
"Reason" |
Kick ve ban nedenleri |
forceBubbleChat Shared¶
CommandAPI.forceBubbleChat(target: Player | Model, text: string)
Oyuncunun karakterinin üstünde, ya da onun yerine verdiğin herhangi bir model veya parçanın üstünde bir sohbet balonu gösterir.
Kıyafetler¶
getDescription Server¶
CommandAPI.getDescription(humanoid: Humanoid): HumanoidDescription
Humanoid'in şu anki HumanoidDescription'ı.
applyDescription Server¶
CommandAPI.applyDescription(humanoid: Humanoid?, description: HumanoidDescription?, properties: {[string]: any}?): HumanoidDescription?
HumanoidDescription'ı güvenli şekilde uygular, Roblox ilk denemeyi reddederse tekrar dener. Temel açıklamanın üstüne alan ayarlamak için properties ver.
outfitBuff Server¶
CommandAPI.outfitBuff(target: Player, properties: {[string]: any})
HumanoidDescription özelliklerini, görev bitince kendini geri alan bir buff olarak uygular. Böylece ;wormify gibi komutlar arkalarını kendileri temizler.
setFakeBodyParts Server¶
CommandAPI.setFakeBodyParts(character: Model, info: {[string]: any}): (() -> ())?
Vücut parçalarını komutun yaptığı yedeklerle değiştirir ve orijinalleri geri getiren bir fonksiyon döndürür.
clearFakeBodyParts Server¶
CommandAPI.clearFakeBodyParts(character: Model)
O yedekleri tekrar kaldırır.
runBundleId Server¶
CommandAPI.runBundleId(task: Task, bundleId: number, properties: {[string]: any}?)
Görevin hedefine bir katalog paketi giydirir, görev bitince hedefin kendi kıyafetini geri verir.
Varlıklar¶
registerSound Shared¶
CommandAPI.registerSound(sound: Sound)
Komutunun oluşturduğu her Sound için gereklidir. Böylece oyunun ses ve perde ayarları ona da uygulanır.
setAnchored Shared¶
CommandAPI.setAnchored(instance: Instance, anchored: boolean)
Instance altındaki tüm parçaları sabitler veya sabitlemeyi kaldırır.
setTransparency Shared¶
CommandAPI.setTransparency(instance: Instance, transparency: number)
Instance altındaki tüm parçaları soluklaştırır.
promptPurchaseAsync Server¶
CommandAPI.promptPurchaseAsync(assetId: number, player: Player?, infoType: Enum.InfoType?)
Oyuncuya varlığı satın alma istemi gösterir ve türüne uygun satın alma akışına yönlendirir.
ownsAssetAsync Server¶
CommandAPI.ownsAssetAsync(assetId: number, player: Player?): boolean
Oyuncunun varlığa sahip olup olmadığı.
isTypeAsync Server¶
CommandAPI.isTypeAsync(assetId: number, assetType: Enum.AssetType | Enum.BundleType): (boolean, string?)
Varlığın verilen türde olduğunu doğrular. true döndürür, olmazsa false ve nedenini döndürür.
loadAssetCommand Server¶
CommandAPI.loadAssetCommand(assetType: Enum.AssetType, task: Task, assetId: number, callback: (item: Instance) -> ())
Varlığın verilen türde ve izinli olduğunu doğrular, ekler, sonra yerleştirmen için callback'ine verir. ;gear bununla çalışır.
getToolsInfoAsync Server¶
CommandAPI.getToolsInfoAsync(): (boolean, {ToolInfo} | string)
;give için kullanılabilen her aletin true ve ToolInfo bilgisini döndürür, olmazsa false ve bir neden döndürür.
Yardımcılar¶
getTargets Server¶
CommandAPI.getTargets(targetType: "All" | "Others" | "Nearby" | "OthersNearby", originPlayer: Player?, radius: number?): {Player}
Bir niteleyiciyi o anda kapsadığı oyunculara çevirir. "Nearby" ve "OthersNearby" başlangıç oyuncusundan radius stud ile ölçer (varsayılan 50).
setCameraSubject Client¶
CommandAPI.setCameraSubject(newSubject: Instance)
Yerel oyuncunun kamerasını yeni bir hedefe çevirir, örneğin ;view için başka bir oyuncunun Humanoid'ine.
runPromptCommand Server¶
CommandAPI.runPromptCommand(promptType: PromptType, task: Task, targets: {Player}, text: string, options: PromptOptions?)
;message, ;hint ve benzeri istemlerin arkasındaki motor. Metni filtreler, istemi her hedefe gösterir ve istem süresi dolana kadar görevi canlı tutar.
runEmoteId Server¶
CommandAPI.runEmoteId(task: Task, emoteId: number, speed: number?, looped: boolean?)
Emote animasyonunu görevin hedefinde oynatır ve görev bitince sonlandırır.
createEmoteCommand Server¶
CommandAPI.createEmoteCommand(emoteName: string, emoteId: number, properties: {[string]: any}?): Command
Komut dizine atmaya hazır, eksiksiz bir emote komutu döndürür. properties üretilen komuttaki herhangi bir alanı ezer.
createBundleCommand Server¶
CommandAPI.createBundleCommand(commandName: string, bundleId: number, properties: {[string]: any}?): Command
;ratdance gibi paket komutları için aynı davranış.
bindEmotePrompt Server¶
CommandAPI.bindEmotePrompt(task: Task, target: Player, emoteId: number, emoteName: string?, isLooped: boolean?)
Emote aksiyon kartını göreve bağlar, böylece hedef emote'u favorilerine ekleyebilir veya katalogda görüntüleyebilir.
openProfile Server¶
CommandAPI.openProfile(player: Player?, userId: number)
Verilen kullanıcının profil penceresini oyuncu için açar.
openPage Server¶
CommandAPI.openPage(player: Player?, pageId: string, tabLabel: string?)
Oyuncunun panelini doğrudan verilen sayfada açar, istersen o sayfanın sekmelerinden birinde.
openEmotes Server¶
CommandAPI.openEmotes(player: Player?)
Oyuncu için emote penceresini açar.
colourRoleName Shared¶
CommandAPI.colourRoleName(role): string
Rolün adını, zengin metin için kendi rengine sarılmış olarak döndürür.
isTableEmpty Shared¶
CommandAPI.isTableEmpty(tbl: {[any]: any}): boolean
Tablonun hiç girdisi olup olmadığı, #tbl'nin kaçırdığı anahtarlı girdiler dahil.
round Shared¶
CommandAPI.round(number: number, decimalPlaces: number?): number
Bir sayıyı verilen ondalık basamağa yuvarlar, varsayılan olarak tam sayıya yuvarlar.
Tipler¶
Commands¶
type Commands = {Command}
Bir komut modülünün döndürdüğü dizi.
Command¶
Commands içindeki tek bir komut tablosu (name, args, run vb.). Her alan Custom Commands sayfasında anlatılır.
Task¶
Her run fonksiyonuna geçirilen görev nesnesi, tamamı Task API sayfasında anlatılır.
ClientCommands¶
Commands'in istemci tarafındaki karşılığı, Client modülü tarafından döndürülür.
ClientCommand¶
ClientCommands içindeki tek bir istemci tarafı komut tablosu.
UserInfo¶
type UserInfo = {
userId: number | string,
userName: string,
userImage: string,
userDisplayName: string,
userTopRole: {key: string, name: string, color: Color3}?,
}
userTopRole yalnızca bu sunucudaki oyuncularda bulunur.
ToolInfo¶
type ToolInfo = {
name: string,
textureId: string,
tool: Tool?,
}
PromptType¶
type PromptType = "info" | "success" | "warn" | "error" | "message" | "hint" | "privateMessage" | "alert" | "vote" | "voteResults" | "action"
İstem türü string'leri. Her birinin ne gösterdiği için prompt bölümüne bak.
PromptOptions¶
prompt'un kabul ettiği seçenekler tablosu, tamamı prompt altında listelenir.
PromptHandle¶
prompt'un döndürdüğü handle, istemi handle:Disconnect() ile erken kapatır.