bitsquid_dt/Darktide-Mod-Framework
bitsquid_dt/Darktide-Mod-Framework
2
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
Var Dump: 
dumpVar: only available in dev mode
Mailing List

Add function documentation

Browse source
This commit is contained in:
Lucas Schwiderski 2018-12-11 15:36:29 +01:00
parent 26f52622f6
commit 430fda7912
1 changed files with 29 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
vmf/scripts/mods/vmf/modules/core/packages.lua
View file

@ -4,6 +4,15 @@ local _queued_packages = {}
local _loading_package = nil
local _loaded_packages = {}
-- #####################################################################################################################
-- ##### VMFMod ########################################################################################################
-- #####################################################################################################################
--[[
Loads a mod package.
* package_name [string] : package name. needs to be the full path to the `.package` file without the extension
* callback [function]: (optional) callback for asynchronous loading
--]]
function VMFMod:load_package(package_name, callback)
if vmf.check_wrong_argument_type(self, "load_package", "package_name", package_name, "string") or
vmf.check_wrong_argument_type(self, "load_package", "callback", callback, "function", "nil")
@ -59,6 +68,11 @@ function VMFMod:load_package(package_name, callback)
end
end
--[[
Unlaods a loaded mod package.
* package_name [string]: package name. needs to be the full path to the `.package` file without the extension
--]]
function VMFMod:unload_package(package_name)
if vmf.check_wrong_argument_type(self, "unload_package", "package_name", package_name, "string") then
return
@ -76,6 +90,11 @@ function VMFMod:unload_package(package_name)
_loaded_packages[self][package_name] = nil
end
--[[
Returns whether the mod package is currently being loaded.
* package_name [string]: package name. needs to be the full path to the `.package` file without the extension
--]]
function VMFMod:is_package_loading(package_name)
if vmf.check_wrong_argument_type(self, "is_package_loading", "package_name", package_name, "string") then
return
@ -94,6 +113,11 @@ function VMFMod:is_package_loading(package_name)
return false
end
--[[
Returns whether the mod package has been fully loaded.
* package_name [string]: package name. needs to be the full path to the `.package` file without the extension
--]]
function VMFMod:has_package_loaded(package_name)
if vmf.check_wrong_argument_type(self, "has_package_loaded", "package_name", package_name, "string") then
return
@ -103,6 +127,11 @@ function VMFMod:has_package_loaded(package_name)
return loaded_packages and loaded_packages[package_name] ~= nil
end
-- #####################################################################################################################
-- ##### VMF internal functions and variables ##########################################################################
-- #####################################################################################################################
-- Loads queued packages one at a time
function vmf.update_package_manager()
local loading_package = _loading_package