Graphics::requestStreamedTextureDictAsync

From RAGE Multiplayer Wiki
Revision as of 18:12, 25 December 2024 by Shr0x (talk | contribs) (Created page with "{{ClientsideJsFunction}} {{JSContainer| === Summary === Asynchronously requests a streamed texture dictionary to be loaded. === Syntax === <syntaxhighlight lang="javascript"> mp.game.graphics.requestStreamedTextureDictAsync(name, timeout = 5000); </syntaxhighlight> === Required Parameters === * '''name:''' {{RageType|string}} - The name of the texture dictionary to load. * '''timeout:''' {{RageType|number}} - Optional. Timeout in milliseconds (default: 5000). === Ret...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Client-Side
Function

 JavaScript



JavaScript Syntax


Summary

Asynchronously requests a streamed texture dictionary to be loaded.

Syntax

mp.game.graphics.requestStreamedTextureDictAsync(name, timeout = 5000);

Required Parameters

  • name: string - The name of the texture dictionary to load.
  • timeout: number - Optional. Timeout in milliseconds (default: 5000).

Return Value

  • 'Promise<bool>' - Resolves to `true` if the texture is loaded, or `false` if it times out.

Example

mp.game.graphics.requestStreamedTextureDictAsync("commonmenu", 3000).then(success => {
    if (success) {
        mp.gui.chat.push("Texture dictionary loaded!");
    } else {
        mp.gui.chat.push("Failed to load texture dictionary.");
    }
});


See Also