Exports

BUPA AnimPos menyediakan tiga client export agar resource lain dapat menjalankan tool ini secara terprogram. Semuanya berjalan di bawah nama resource bupa-animpos.

Open

Membuka tool. Ini menjalankan pipeline pengecekan penuh — sudah digunakan, cooldown, izin, pembatasan state, dan hook Config.CanCheck — persis seperti saat pemain menggunakan command atau keybind. Mengembalikan nilai true jika tool benar-benar terbuka, dan false jika tidak.

local opened = exports['bupa-animpos']:Open()
if opened then
    print('Positioning mode started')
end

Close

Meminta tool untuk ditutup jika sedang aktif. Ini berperan seperti menekan tombol batal — karakter akan dikembalikan ke posisi dan arah awalnya.

exports['bupa-animpos']:Close()

IsActive

Mengembalikan nilai boolean yang menunjukkan apakah mode pemosisian sedang terbuka untuk pemain lokal.

if exports['bupa-animpos']:IsActive() then
    -- e.g. block another interaction while the tool is open
end

Example — pair with an emote menu

-- After playing an emote, let the player nudge it into place
RegisterCommand('fixpos', function()
    if not exports['bupa-animpos']:IsActive() then
        exports['bupa-animpos']:Open()
    end
end)

Related — the CanUse config hook

Selain export, Config.CanUse adalah hook di sisi client yang berjalan pada setiap percobaan pembukaan (termasuk melalui Open()). Kembalikan nilai false untuk memblokir dan secara opsional sertakan string pesan untuk ditampilkan kepada pemain. Ini adalah tempat yang disarankan untuk logika pembatasan khusus server (pertarungan, damage, state kustom).

Config.CanUse = function()
    -- return false, 'You cannot do this right now!'
    return true
end