Streaming::requestAnimDict

From RAGE Multiplayer Wiki

Client-Side
Function

 JavaScript



Requests and loads the animation dictionary required to play an animation.

JavaScript Syntax

Syntax

mp.game.streaming.requestAnimDict(animDict);

Required Arguments

  • animDict: String

Example

A function to load the animation dictionary used for the lucky wheel spin animations.

Client-Side
async function loadLuckyWheelAnimLib(){
    if(mp.players.local.model === mp.game.joaat("mp_m_freemode_01")){
        animationLib = "anim_casino_a@amb@casino@games@lucky7wheel@male"
    } else if(mp.players.local.model === mp.game.joaat("mp_f_freemode_01")) {
        animationLib = "anim_casino_a@amb@casino@games@lucky7wheel@female"
    } else {
        return mp.gui.chat.push("You must be using a freemode character model");
    }

    mp.game.streaming.requestAnimDict(animationLib);

    for(let i = 0; mp.game.streaming.hasAnimDictLoaded(animationLib) === 0 && i < 15; i++){
        if(i === 14) return mp.game.graphics.notify('~r~Error loading Lucky Wheel spin animation.');
        mp.gui.chat.push("Loading wheel spin animation...");
        await mp.game.waitAsync(100);
    }

    mp.gui.chat.push("Anim loaded.")
}


See also