DLC - stingray.DLC namespace reference - Stingray Lua API Reference

stingray.DLC namespace reference

Description

The interface to access information about downloaded content (DLC).

Note: The DLC object is a singleton: there is only one instance. Therefore, you do not need to pass any DLC object to the functions in this interface. All the functions operate on the DLC singleton.

Functions

Parameters
This function does not accept any parameters.
Returns

boolean

Returns true if the previously started scan has finished, or false otherwise.

Parameters
This function does not accept any parameters.
Returns
This function does not return any values.

You can check the results using stingray.DLC.scan_done() and stingray.DLC.scan_result().

Parameters
This function does not accept any parameters.
Returns

dlc_info[]

An array of tables, where each entry in the array provides details about one package of downloadable content.

The [] notation indicates that this type is an array: a table in which the keys of the members are sequential integers, and the value of each element is an instance of the type shown.

For example:

{
1 = {
"name" = "The first DLC level",
"package" = "packages/dlc1"
},
2 = {
"name" = "The second DLC level",
"package" = "packages/dlc2"
},
}