Exports

BUPA AnimPos तीन क्लाइंट एक्सपोर्ट प्रदान करता है ताकि अन्य रिसोर्स प्रोग्रामेटिक रूप से इस टूल को नियंत्रित कर सकें। ये सभी bupa-animpos रिसोर्स नाम के तहत चलते हैं।

Open

टूल को खोलता है। यह पूर्ण चेक पाइपलाइन को चलाता है — पहले से उपयोग में होना, कूलडाउन, अनुमति, स्थिति प्रतिबंध और Config.CanUser हुक — ठीक वैसे ही जैसे खिलाड़ी ने कमांड या कीबिंद का उपयोग किया हो। यदि टूल वास्तव में खुल गया है तो true लौटाता है, अन्यथा false लौटाता है।

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

Close

यदि टूल वर्तमान में सक्रिय है तो इसे बंद करने का अनुरोध करता है। यह रद्द करें (cancel) दबाने जैसा है — चरित्र को उसकी शुरुआती स्थिति और दिशा में वापस भेज दिया जाता है।

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

IsActive

एक बुलियन (boolean) लौटाता है जो यह दर्शाता है कि स्थानीय खिलाड़ी के लिए पोजिशनिंग मोड वर्तमान में खुला है या नहीं।

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

एक्सपोर्ट्स के अलावा, Config.CanUse एक क्लाइंट-साइड हुक है जो हर बार खोलने के प्रयास पर चलता है (Open() के माध्यम से भी)। ब्लॉक करने के लिए false लौटाएं और वैकल्पिक रूप से खिलाड़ी को दिखाने के लिए एक संदेश स्ट्रिंग दें। यह सर्वर-विशिष्ट गेटिंग लॉजिक (कॉम्बैट, डैमेज, कस्टम स्टेट्स) के लिए अनुशंसित स्थान है।

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