Usable informations

Export for use of animation in other resource

RunAnimationById

If you want to get rid of unnecessary animation requesting in another script, you can use the function from vms_anims by specifying the animation ID from the in-game panel and specifying parameters.

-- @param id = number: Animation id displayed on each animation in the menu

-- @param disableCancel = boolean: Ability to cancel animation at any time (true = cannot cancel animation / false = can cancel the animation)

-- @param time = number: Animation duration, if you want infinite animation set -1, otherwise value given in milliseconds

-- @param flag = number: Animation flag: https://docs.fivem.net/natives/?_0xEA47FE3719165B94

-- @param disableAdjusting = boolean: Is the player to be able to adjust the position of the animation with a button or command

-- @param syncedOptions = table: Options for synced animation
--    selecting: Is the player to be able to choose the player
--    force: Will the other player have forced acceptance without choice
--    player: You can specify the ID of the player to be selected for animation

exports['vms_anims']:RunAnimationById(
    id,
    disableCancel,
    time,
    flag,
    disableAdjusting,
    syncedOptions
)

--- Example Usage: Synchronized animation started with cancellation option, player does not have to select the other player and player with id 2 does not have to accept the animation: 
exports['vms_anims']:RunAnimationById(
    649, 
    true, 
    5000, 
    0, 
    true,
    {selecting = false, force = true, player = 2}
)

RunAnimation

If you want to get rid of the unnecessary animation request in another script, you can use the function from vms_anims, specifying the name of the animation and specifying the required parameters.

---@param data = table: The table must contain the same parameters that are in the default animations in animations.lua

---@param disableCancel = boolean: Ability to cancel animation at any time (true = cannot cancel animation / false = can cancel the animation)

---@param time = number: Animation duration, if you want infinite animation set -1, otherwise value given in milliseconds

---@param flag = number: Animation flag: https://docs.fivem.net/natives/?_0xEA47FE3719165B94

exports['vms_anims']:RunAnimation(
    data,
    disableCancel,
    time,
    flag
)

--- Example Usage: Running animations with prop using vms_anims
exports['vms_anims']:RunAnimation(
    {
        AnimDict = "anim@amb@nightclub@lazlow@hi_railing@",
        Anim = "ambclub_09_mi_hi_bellydancer_laz",
        props = {
            prop = "ba_prop_battle_glowstick_01",
            propBone = 28422,
            propPlacement = {0.07, 0.14, 0.0, -80.0, 20.0, 0.0, 0.0},
            propTwo = "ba_prop_battle_glowstick_01",
            propTwoBone = 60309,
            propTwoPlacement = {0.07, 0.09, 0.0, -120.0, -20.0, 0.0, 0.0}
        }
    }, 
    true, 
    5000, 
    0
)

Cancel

If you have run an animation using the RunAnimationById export, and you want to cancel it, you can do so using the Cancel export

exports['vms_anims']:Cancel()