Lewati ke isi

Task API

Setiap kali sebuah perintah dijalankan, ia membuat satu tugas untuk setiap target. Tugas ini lalu diteruskan ke run, dan bertanggung jawab atas berapa lama perintah itu hidup, networking, pembersihan, dan banyak lagi.

Methods

task:keep Server

task:keep(persistence: Persistence?)

Menjaga tugas tetap hidup setelah run selesai, kalau tidak tugas akan langsung dihancurkan. Pilihanmu adalah "UntilTargetRespawns", "UntilTargetLeaves", "UntilCallerRespawns", "UntilCallerLeaves" dan "Indefinitely". Kalau kamu memanggilnya lebih dari sekali, kondisinya digabung, jadi tugas berakhir saat salah satunya terjadi lebih dulu. Lihat Persistence.


task:getArg Server

task:getArg(nameOrPosition: string | number, ignoreDefault: boolean?): any

Membaca nilai argumen yang sudah divalidasi berdasarkan nama atau posisinya. Nilai ini bisa berasal dari default milik argumennya, nilai tervalidasi yang diberikan pemanggil, nilai tervalidasi yang diubah oleh sebuah prompt, atau nilai yang diatur dengan task:setArg().

Kirim true sebagai argumen kedua untuk mendapatkan nil kalau pemanggil tidak pernah mengisi argumen itu dan nilainya hanya berasal dari default milik argumen. Ini berguna untuk argumen opsional yang ingin kamu tangani dengan perilakumu sendiri, seperti cara ;message menghitung durasi dari panjang teks kecuali durasinya diketik.


task:setArg Server

task:setArg(nameOrPosition: string | number, value: any)

Mengubah nilai argumen berdasarkan nama atau posisinya.


task:buff Server

task:buff(player: Player, group: string, priority: number?, callback: (hasEnded: boolean, original: any) -> any)

Mengubah sebuah properti, menerapkan ulang perubahan itu saat buff dalam grup yang sama berubah, lalu mengembalikan properti ke nilai aslinya saat tugas berakhir. Lihat Buffs.


task:updateBuffs Server

task:updateBuffs(player: Player?, group: string?)

Menjalankan ulang buff untuk pemain dan grup itu. Ini sudah ditangani otomatis di sebagian besar situasi, jadi hanya berguna kalau kamu memang ingin memaksa memperbarui semua yang ada di grup itu.


task:redo Server

task:redo(player: Player?, callback: () -> ())

Menjalankan callback-mu langsung, lalu menjalankannya lagi setiap kali pemain respawn selama tugas masih hidup. Berguna untuk efek yang kalau tidak begitu akan hilang saat respawn.


task:bindPrompt Server

task:bindPrompt(config)

Memberi pemanggil sebuah action prompt yang terhubung ke perintah, seperti slider di ;speed atau warna mata di ;laserEyes:

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,

Config

Key Type What it does
title string Judul prompt, defaultnya nama perintah
text string Teks utama
subtext string Satu baris yang lebih kecil di bawah teks
audience Player Siapa yang melihat prompt, defaultnya task.target
duration number Detik sebelum prompt menutup sendiri. Defaultnya 0, artinya durasi tak terbatas
args table Argumen perintah yang ditampilkan sebagai kontrol, lihat Controls
onChange function function(argName, value), dijalankan setelah sebuah kontrol mengubah argumen
toggle table Satu saklar on/off tambahan yang tidak terhubung ke argumen, {label = "Trails", value = true, onChange = function(isOn) end}
buttons table Tombol aksi sekali pakai, lihat Buttons
deactivate boolean Defaultnya true, yang memberi prompt sebuah saklar untuk menjeda dan melanjutkan perintah, serta tombol Stop yang mengakhirinya. Setel false untuk prompt yang isinya hanya tombol
rerun boolean Menambahkan tombol jalankan ulang yang membersihkan lalu menjalankan perintah lagi. Hanya muncul kalau deactivate bernilai false
endOnClose boolean Secara default, menutup prompt mengakhiri tugas. Kalau diset false, tugas tetap berjalan sampai klien menutupnya

Controls

Supaya sebuah argumen bisa dikontrol lewat action prompt, tambahkan namanya ke args di dalam bindPrompt. Number menjadi slider, Color menjadi pemilih warna, Bool menjadi saklar, dan seterusnya. Setiap kali klien mengubah salah satunya, argumen diperbarui dan onChange-mu dipanggil, jadi cukup panggil task:getArg lagi untuk membaca nilai barunya. Kamu juga tidak perlu memvalidasi apa pun, setiap nilai diperiksa persis seperti kalau diketik di chat:

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,

Buttons

Tombol sama mudahnya. Beri tiap tombol sebuah label dan fungsi onActivate, dan fungsi itu berjalan di server setiap kali klien menekannya. Boleh juga melakukan yield di sini (prompt pembelian, panggilan datastore, dan sebagainya), karena tombolnya hanya menampilkan spinner sampai kamu selesai:

Key Type What it does
label string Teks pada tombol
onActivate function Apa yang terjadi saat tombol ditekan
style string Defaultnya "Primary", atau "Neutral" untuk tampilan abu-abu, cocok untuk Cancel
confirm boolean Menambahkan langkah Confirm? sehingga tombol baru aktif kalau ditekan dua kali, berguna untuk hal yang berdampak besar seperti konfirmasi ban

Sebuah tombol bisa mengakhiri tugasnya sendiri dengan task:destroy(), seperti yang dilakukan prompt perintah sekali pakai semacam ;teleport.


task.client:run Server

task.client:run(player: Player?, ...)
task.client:runAll(...)
task.client:runOthers(originPlayer: Player, ...)
task.client:runNearby(originPlayer: Player?, radius: number, ...)

Menjalankan perintah klien yang cocok di perangkat para pemain, dan meneruskan apa pun tambahannya apa adanya. run menargetkan satu pemain, runAll semua orang, runOthers semua orang kecuali originPlayer, dan runNearby mereka yang berada dalam radius stud. Lihat Networking.


task.client:expose Server

task.client:expose(player: Player, instances: Instance | {Instance})
task.client:exposeAll(instances: Instance | {Instance})

Memastikan instance-nya benar-benar sudah sampai ke pemain sebelum kode kliennmu mencarinya. Streaming bisa menahan sesuatu, jadi semua yang kamu buat di server dan dipakai di klien sebaiknya lewat sini dulu.


task.server:replicate Client

task.server:replicate(...)

Mengirim nilai dari perintah klien kembali ke server, dan nilainya mendarat di tugas yang sama. Atur task.client.replicator di server untuk memilih ke mana nilai itu diteruskan, lalu nilainya tiba di fungsi replication milik perintah itu. Lihat Networking.


task:tween Shared

task:tween(instance: Instance, tweenInfo: TweenInfo, properties: {[string]: any}): Tween

Memainkan tween yang dibersihkan bersama tugas, jadi tidak pernah hidup lebih lama dari perintahnya.


task:createSound Shared

task:createSound(soundType: SoundType?): Sound

Membuat Sound yang dimiliki dan dibersihkan oleh tugas. Volume dan Pitch sound ini lalu bisa diatur oleh semua pemain di YouSettings mereka. SoundType defaultnya "Command" kalau tidak diisi.


task:onEnded Shared

task:onEnded(callback: () -> ())

Menjalankan callback-mu setiap kali tugas berakhir. Ini setara dengan task.janitor:add(callback).


task:onEndedForGood Shared

task:onEndedForGood(callback: () -> ())

Menjalankan callback-mu hanya saat tugas sudah berakhir, DAN tidak ada tugas identik yang dibuat tepat sesudahnya. Ini berguna untuk perintah seperti ;serverLock Admin yang menampilkan pemberitahuan saat perintah dijalankan ("This server has been locked for Admins") dan saat selesai ("This server has been unlocked"). Masalahnya, kalau setelah itu kita menjalankan ;serverLock Mod, kita tidak mau perintah sebelumnya menampilkan pemberitahuan 'selesai', kita hanya mau pemberitahuan 'jalan' yang baru.


task:destroy Shared

task:destroy()

Mengakhiri tugas secara paksa dan membersihkan semua yang dimilikinya. Inilah yang dipanggil ;un di balik layar.


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

Ini adalah pembungkus yang sadar-tugas dari penjadwalan task bawaan Roblox. Ini penting supaya perintah bisa tetap hidup selama aktif, atau dibatalkan otomatis saat tugasnya dibersihkan (misalnya ada yang memanggil undo sebelum tugas berakhir). Pakai saja seperti kamu biasa memakai method task Roblox, dan HD Admin mengurus sisanya di dalam.

Properties

task.target Server

task.target: Player

Pemain yang menjadi sasaran perintah. Kalau argumen pertamamu adalah Player, nilai ini selalu ada, karena HD Admin memecah eksekusi menjadi tugas terpisah untuk setiap pemain yang cocok, jadi kamu bisa memakainya tanpa memeriksa dulu. Perintah yang menerima argumen kolektif Players tidak dipecah seperti ini, jadi nilainya kosong. task.targetUserId menyimpan UserId-nya dan tetap ada walaupun pemainnya sedang offline.


task.qualifiers Server

task.qualifiers: {[string]: {string}}

Siapa yang ditargetkan pemanggil di string perintah aslinya. ;clone others memberimu {others = {}}, sedangkan ;clone saja memberimu table kosong. Nilainya selalu berupa table, jadi aman dibaca langsung.


task.caller Server

task.caller: Player?

Siapa yang menjalankan perintah, atau nil kalau server yang menjalankannya (atau kalau berada di server yang menerima perintah global dan pemanggilnya tidak ada di servermu). task.callerUserId selalu ada, jadi pakai itu kalau kamu butuh UserId-nya.


task.janitor Shared

task.janitor:add(item): typeof(item)

Sebuah objek Janitor yang bisa kamu beri instance, koneksi, dan fungsi untuk membantu pembersihan otomatis. Contohnya:

local fire = task.janitor:add(Instance.new("Fire"))
fire.Parent = targetsHumanoidRootPart


task.config Server

task.config: {[string]: any}

Table config milik perintah itu sendiri, termasuk apa pun yang diubah sebuah paket lewat modify di Config > Commands. Dengan ini sebuah perintah membaca pengaturan yang memang boleh diubah oleh pemilik game, seperti daftar allow dan deny milik ;insert.


task.extra Shared

task.extra: {[string]: any}

Table berisi informasi tambahan yang bisa kamu isi, dan bertahan setelah penonaktifan sampai tugas benar-benar berakhir.


task.isActive Shared

task.isActive: boolean

true selama tugas berjalan, false begitu tugas mulai berakhir. Pakai ini di dalam loop supaya efekmu bisa langsung berhenti kalau, misalnya, tugasnya diakhiri secara paksa.


task.commandKey Shared

task.commandKey: string

Nama perintah yang dijalankan tugas ini, dalam huruf kecil.


task.isReplay Server

task.isReplay: boolean

true saat perintah permanen yang tersimpan dijalankan ulang ketika server mulai, bukan karena seseorang menjalankannya saat itu. Berguna untuk membatasi prompt di perintah permanen yang tidak kita inginkan muncul otomatis lagi ke pemanggil (seperti prompt ;music saat masuk ke setiap server baru).