Streaming::hasAnimDictLoaded: Difference between revisions

From RAGE Multiplayer Wiki
(yay)
 
No edit summary
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__NOTOC__
{{ClientsideJsFunction}}
Checks to see if the animation dictionary has loaded.


{{JSContainer|
==Syntax==
==Syntax==
<syntaxhighlight lang="javascript">streaming.hasAnimDictLoaded(animDict);</syntaxhighlight>
<pre>
mp.game.streaming.hasAnimDictLoaded(animDict);
</pre>
 
=== Required Arguments ===
=== Required Arguments ===
*'''animDict:''' String
*'''animDict:''' {{RageType|String}}
 
===Return value===
===Return value===
*'''Boolean'''
*'''Boolean'''
==Example==
 
<syntaxhighlight lang="javascript">
==Example #1==  
todo
{{ClientsideCode|
</syntaxhighlight>
<pre>
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);
 
    // Used so you don't get stuck in an infinite loop if it never loads.
    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.");
}
</pre>
}}
}}
 
==See also==
==See also==
{{Streaming_function_c}}
{{Streaming_functions_c}}
[[Category:Clientside API]]
[[Category:Clientside API]]
[[Category:TODO: Example]]

Latest revision as of 01:47, 25 April 2021

Client-Side
Function

 JavaScript



Checks to see if the animation dictionary has loaded.

JavaScript Syntax

Syntax

mp.game.streaming.hasAnimDictLoaded(animDict);

Required Arguments

  • animDict: String

Return value

  • Boolean

Example #1

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

    // Used so you don't get stuck in an infinite loop if it never loads.
    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