Resource Loader

Place Resource Loader at the top of your load order

CREDITS

This mod was made possible with manshanko's limn extractor

For mod authors

Get the API:

local resource_loader = get_mod("ResourceLoader")Check compatibility:

if not resource_loader

or not resource_loader.is_api_compatible(1) then

endResolve a resource without loading it:

local resource, err = resource_loader.resolve(

"unit", -- See resource types in index.lua please

"content/example/unit" -- EXAMPLE PATH

)Load the package containing a resource:

local ticket, err = resource_loader.acquire(

"content/example/unit",

function(ticket, resource, err)

if err then

mod:error(err)

-- Package is ready here.

)Keep the returned ticket while the package is needed, then release it:

resource_loader.release(ticket)Release everything owned by your mod when it unloads:

mod.on_unload = function()

resource_loader.release_owner(mod)

endLoad a known package directly:

resource_loader.acquire_package(

"content/example/package",

)Search through resources of a type:

resource_loader.visit(

function(resource_name, package_name)

mod:echo(resource_name)

named_only = true,

loadable_only = true

)Useful functions:

resource_loader.resolve(type, name)

resource_loader.acquire(owner, type, name, callback, options)

resource_loader.acquire_package(owner, package, callback, options)

resource_loader.release(ticket)

resource_loader.release_owner(owner)

resource_loader.status(ticket)

resource_loader.visit(type, callback, options)

resource_loader.list_types()

resource_loader.stats()

resource_loader.trim(type)Not every catalog entry has a loadable package. Updates might break the mod.