Skip to main content

ContentProviderUtils

Utility functions to ensure that content is preloaded (wrapping calls in promises)

Functions​

promisePreload​

</>
ContentProviderUtils.promisePreload(contentIdList: {Instance | string}) → Promise

Preloads assets

NOTE

If strings are passed in, it only preloads textures, and will preload meshes, but only to http client.

Show raw api
{
    "functions": [
        {
            "name": "promisePreload",
            "desc": "Preloads assets\n:::note\nIf strings are passed in, it only preloads textures, and will preload meshes, but only to http client.\n:::",
            "params": [
                {
                    "name": "contentIdList",
                    "desc": "",
                    "lua_type": "{ Instance | string }"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 23,
                "path": "src/contentproviderutils/src/Client/ContentProviderUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "ContentProviderUtils",
    "desc": "Utility functions to ensure that content is preloaded (wrapping calls in promises)",
    "source": {
        "line": 5,
        "path": "src/contentproviderutils/src/Client/ContentProviderUtils.lua"
    }
}