Task API
Bir komut her çalıştığında, her hedef için bir görev oluşturur. Bu görev run fonksiyonuna aktarılır ve komutun ne kadar süre yaşayacağından ağ iletişimine, temizliğe ve daha fazlasına kadar her şeyden sorumludur.
Metotlar¶
task:keep Server¶
task:keep(persistence: Persistence?)
run döndükten sonra görevi canlı tutar, yoksa görev hemen yok edilir. Seçeneklerin "UntilTargetRespawns", "UntilTargetLeaves", "UntilCallerRespawns", "UntilCallerLeaves" ve "Indefinitely". Birden fazla kez çağırırsan koşullar birleşir, yani görev hangisi önce olursa onunla biter. Bkz. Kalıcılık.
task:getArg Server¶
task:getArg(nameOrPosition: string | number, ignoreDefault: boolean?): any
Verilen argüman adının ya da konumunun doğrulanmış değerini okur. Bu değer argümanın default değerinden, çağıranın verdiği doğrulanmış değerden, bir istemin değiştirdiği doğrulanmış değerden ya da task:setArg() ile ayarlanan bir değerden gelebilir.
Çağıran argümanı hiç vermediyse ve değeri yalnızca argümanın default değerinden geldiyse nil almak için ikinci argüman olarak true ver. Kendi davranışına geri dönmek istediğin isteğe bağlı argümanlarda işe yarar, ;message komutunun süre yazılmadıkça süreyi metin uzunluğundan hesaplaması gibi.
task:setArg Server¶
task:setArg(nameOrPosition: string | number, value: any)
Verilen argüman adının ya da konumunun değerini değiştirir.
task:buff Server¶
task:buff(player: Player, group: string, priority: number?, callback: (hasEnded: boolean, original: any) -> any)
Bir özelliği değiştirir, aynı gruptaki buff'lar değiştiğinde o özelliğe yapılan değişiklikleri yeniden uygular, görev bittiğinde de özelliği ilk değerine geri döndürür. Bkz. Buffs.
task:updateBuffs Server¶
task:updateBuffs(player: Player?, group: string?)
O oyuncu ve grup için buff'ları yeniden çalıştırır. Bu çoğu durumda otomatik halledilir, yani yalnızca o gruptaki her şeyi zorla güncellemek istediğinde işe yarar.
task:redo Server¶
task:redo(player: Player?, callback: () -> ())
Callback'ini hemen çalıştırır, ardından görev canlıyken oyuncu her yeniden doğduğunda tekrar çalıştırır. Yeniden doğunca kaybolacak efektler için kullanışlıdır.
task:bindPrompt Server¶
task:bindPrompt(config)
Çağırana komuta bağlı bir eylem istemi verir, ;speed üzerindeki kaydırıcı ya da ;laserEyes üzerindeki göz rengi gibi:
run = function(task: CommandAPI.Task)
task:keep("UntilCallerLeaves")
task:bindPrompt({
title = "Dangerous Script",
text = "This script uses HttpService, are you sure you want to load it?",
audience = task.caller,
duration = 20,
deactivate = false,
endOnClose = true,
buttons = {
{
label = "Load",
onActivate = function()
--loadScript()
task:destroy()
end,
},
{
label = "Cancel",
style = "Neutral",
onActivate = function()
task:destroy()
end,
},
},
})
end,
Yapılandırma
| Key | Type | What it does |
|---|---|---|
title |
string | İstemin başlığı, varsayılan olarak komutun adıdır |
text |
string | Gövde metni |
subtext |
string | Metnin altında daha küçük bir satır |
audience |
Player | İstemi kimin gördüğü, varsayılan olarak task.target |
duration |
number | İstemin kendiliğinden kapanmasına kalan saniye. Varsayılan 0 sonsuz süre demektir |
args |
table | Kontrol olarak sunulacak komut argümanları, bkz. Kontroller |
onChange |
function | function(argName, value), bir kontrol argümanı değiştirdikten sonra çalışır |
toggle |
table | Bir argümana bağlı olmayan ekstra bir açma/kapama anahtarı, {label = "Trails", value = true, onChange = function(isOn) end} |
buttons |
table | Tek seferlik eylem düğmeleri, bkz. Düğmeler |
deactivate |
boolean | Varsayılan true, istemin komutu duraklatıp devam ettiren bir anahtarı ve onu bitiren bir Stop düğmesi olur. Yalnızca düğmelerden oluşan bir istem için false yap |
rerun |
boolean | Temizleyip komutu yeniden çalıştıran bir tekrar çalıştır düğmesi ekler. Yalnızca deactivate false iken görünür |
endOnClose |
boolean | İstemi kapatmak varsayılan olarak görevi bitirir. Bunu false yaparsan istemci kapatana kadar çalışmaya devam eder |
Kontroller
Bir argümanı eylem istemiyle kontrol edilebilir yapmak için adını bindPrompt içindeki args alanına ekle. Number kaydırıcı, Color renk seçici, Bool açma/kapama anahtarı olur, vb. İstemci birini her değiştirdiğinde argüman güncellenir ve onChange tetiklenir, yani yeni değeri okumak için task:getArg fonksiyonunu tekrar çağırman yeter. Bir şeyi doğrulamana da gerek yok, her değer sohbete elle yazılmış gibi kontrol edilir:
run = function(task: CommandAPI.Task)
local function applySpinSpeed()
local speed = task:getArg("Number")
-- spin the character at this speed
end
applySpinSpeed()
task:bindPrompt({
args = {"Number"},
onChange = applySpinSpeed,
})
end,
Düğmeler de aynı derecede kolay. Her birine bir label ve bir onActivate fonksiyonu ver, istemci düğmeye bastığında o fonksiyon sunucuda çalışır. Burada beklemek de sorun değil (satın alma istemi, datastore çağrısı vb.), düğme sen bitirene kadar bir yükleniyor simgesi gösterir:
| Key | Type | What it does |
|---|---|---|
label |
string | Düğmenin üzerindeki metin |
onActivate |
function | Düğmeye basılınca ne olacağı |
style |
string | Varsayılan "Primary", ya da soluk gri görünüm için "Neutral", Cancel için ideal |
confirm |
boolean | Yalnızca iki kez basılınca tetiklenmesi için bir Confirm? adımı ekler, ban onayı gibi güçlü şeyler için kullanışlıdır |
Bir düğme task:destroy() ile kendi görevini bitirebilir, ;teleport gibi tek kullanımlık komut istemlerinin yaptığı da budur.
task.client:run Server¶
task.client:run(player: Player?, ...)
task.client:runAll(...)
task.client:runOthers(originPlayer: Player, ...)
task.client:runNearby(originPlayer: Player?, radius: number, ...)
Eşleşen istemci komutunu oyuncuların cihazlarında çalıştırır, ekstra verdiğin her şeyi olduğu gibi iletir. run tek bir oyuncuyu, runAll herkesi, runOthers originPlayer dışındaki herkesi, runNearby ise radius stud içindekileri hedefler. Bkz. Networking.
task.client:expose Server¶
task.client:expose(player: Player, instances: Instance | {Instance})
task.client:exposeAll(instances: Instance | {Instance})
İstemci kodun onları aramaya çıkmadan önce instance'ların gerçekten oyuncuya ulaştığından emin olur. Streaming bazı şeyleri geride tutabilir, bu yüzden sunucuda oluşturup istemcide kullandığın her şey önce buradan geçmeli.
task.server:replicate Client¶
task.server:replicate(...)
Bir istemci komutundan değerleri sunucuya geri gönderir, aynı görevin üzerine düşerler. Sunucuda task.client.replicator değerini ayarlayarak bunların kime ileteceğini seçersin, ardından o komutun replication fonksiyonuna ulaşırlar. Bkz. Networking.
task:tween Shared¶
task:tween(instance: Instance, tweenInfo: TweenInfo, properties: {[string]: any}): Tween
Görevle birlikte temizlenen bir tween oynatır, yani komuttan asla daha uzun yaşamaz.
task:createSound Shared¶
task:createSound(soundType: SoundType?): Sound
Görevin sahip olduğu ve temizlediği bir Sound oluşturur. Bu sesin Volume ve Pitch değerlerini tüm oyuncular YouSettings altından ayarlayabilir. SoundType ayarlanmazsa varsayılan olarak "Command" olur.
task:onEnded Shared¶
task:onEnded(callback: () -> ())
Görev her bittiğinde callback'ini çalıştırır. Bu, task.janitor:add(callback) yapmaya denktir.
task:onEndedForGood Shared¶
task:onEndedForGood(callback: () -> ())
Callback'ini yalnızca görev bittiğinde VE hemen ardından özdeş bir görev oluşturulmazsa çalıştırır. Bu, ;serverLock Admin gibi komutlar için kullanışlıdır: komut çalıştığında bir bildirim gösterir ("This server has been locked for Admins") ve bittiğinde de gösterir ("This server has been unlocked"). Ama ardından ;serverLock Mod çalıştırırsak, önceki komutun bitiş bildirimini göstermesini istemeyiz, yalnızca yeni çalıştırma bildiriminin görünmesini isteriz.
task:destroy Shared¶
task:destroy()
Görevi zorla bitirir ve sahip olduğu her şeyi temizler. ;un komutu arka planda bunu çağırır.
Scheduling Shared¶
task.spawn(callback: () -> ())
task.defer(callback: () -> ())
task.delay(seconds: number, callback: (() -> ())?)
task.wait(seconds: number?)
task.iterate(count: number, callback: (index: number) -> ())
task.loop(callback: (stop: () -> (), index: number) -> ())
Bunlar Roblox'un kendi task zamanlama fonksiyonlarının göreve duyarlı sürümleridir. Komutun aktifken canlı kalması ya da görevi temizlendiğinde (mesela görev bitmeden biri undo çalıştırdığında) otomatik iptal edilmesi için şarttırlar. Roblox'un task metotlarını normalde nasıl kullanıyorsan öyle kullan, gerisini HD Admin içeride halleder.
Özellikler¶
task.target Server¶
task.target: Player
Komutun üzerinde çalıştığı oyuncu. İlk argümanın Player ise her zaman biri vardır, çünkü HD Admin çalıştırmayı eşleşen her oyuncu için ayrı bir göreve böler, yani kontrol etmeden kullanabilirsin. Toplu bir Players argümanı alan komutlar böyle bölünmez, bu yüzden değer boş kalır. task.targetUserId onların UserId değerini tutar ve oyuncu çevrimdışıyken bile vardır.
task.qualifiers Server¶
task.qualifiers: {[string]: {string}}
Çağıranın orijinal komut metninde kimi hedeflediği. ;clone others sana {others = {}} verir, çıplak bir ;clone ise boş bir tablo verir. Her zaman bir tablodur, yani doğrudan okumak güvenlidir.
task.caller Server¶
task.caller: Player?
Komutu kim çalıştırdıysa o, ya da sunucu çalıştırdıysa nil (veya çağıranın senin sunucunda olmadığı, global bir komutu alan bir sunucuda). task.callerUserId her zaman vardır, bu yüzden onların UserId değerine ihtiyacın varsa bunu kullan.
task.janitor Shared¶
task.janitor:add(item): typeof(item)
Instance'ları, bağlantıları ve fonksiyonları otomatik temizlenmeleri için verebileceğin bir Janitor nesnesi. Örneğin:
local fire = task.janitor:add(Instance.new("Fire"))
fire.Parent = targetsHumanoidRootPart
task.config Server¶
task.config: {[string]: any}
Komutun kendi config tablosu, bir paketin Config > Commands içinde modify ile değiştirdiği her şey dahil. Bir komut, oyunun sahibinin değiştirebilmesi gereken bir ayarı bu şekilde okur, ;insert komutunun izin ve engel listeleri gibi.
task.extra Shared¶
task.extra: {[string]: any}
Ekleyebileceğin ek bilgilerin tablosu. Devre dışı bırakmadan sonra da, görev tamamen bitene kadar yaşar.
task.isActive Shared¶
task.isActive: boolean
Görev çalışırken true, bitmeye başlayınca false. Efektin, örneğin zorla bitirildiğinde hemen durabilmesi için bunu döngülerin içinde kullan.
task.commandKey Shared¶
task.commandKey: string
Bu görevin çalıştırdığı komutun küçük harfli adı.
task.isReplay Server¶
task.isReplay: boolean
Kaydedilmiş kalıcı bir komut, biri onu şu an çalıştırmak yerine sunucu başlarken yeniden oynatılıyorsa true. Çağıranın otomatik olarak tekrar görmesini istemediğimiz istemleri perm komutlarda sınırlamak için kullanışlıdır (her yeni sunucuya girişte ;music isteminin çıkması gibi).