From b5a9699bd8a7b2eac433b2410d975a79a2414e89 Mon Sep 17 00:00:00 2001 From: bi Date: Tue, 19 Jun 2018 17:38:17 +0300 Subject: [PATCH] VMF Mod Data: changed several comments --- vmf/scripts/mods/vmf/modules/vmf_mod_data.lua | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/vmf/scripts/mods/vmf/modules/vmf_mod_data.lua b/vmf/scripts/mods/vmf/modules/vmf_mod_data.lua index f905601..90401bb 100644 --- a/vmf/scripts/mods/vmf/modules/vmf_mod_data.lua +++ b/vmf/scripts/mods/vmf/modules/vmf_mod_data.lua @@ -1,7 +1,7 @@ -- Defining VMFMod class. VMFMod = class(VMFMod) --- Creating mod data table when object of vmf mod is instantiated. +-- Creating mod data table when object of VMFMod class is created. function VMFMod:init(mod_name) self._data = {} setmetatable(self._data, { @@ -21,9 +21,18 @@ end -- ##################################################################################################################### --[[ - Universal function for getting any internal mod data. Returned table values shouldn't be modified, because it lead to - unexpected VMF behaviour. + Universal function for retrieving any internal mod data. Returned table values shouldn't be modified, because it can + lead to unexpected VMF behaviour. * key [string]: data entry name + + Possible entry names: + - name (system mod name) + - readable_name (readable mod name) + - description (mod description) + - is_togglable (if the mod can be disabled/enabled) + - is_enabled (if the mod is curently enabled) + - is_mutator (if the mod is mutator) + - mutator_config (mutator config) --]] function VMFMod:get_internal_data(key) return self._data[key] @@ -31,7 +40,7 @@ end --[[ - Predefined functions for getting specific internal mod data. + Predefined functions for retrieving specific internal mod data. --]] function VMFMod:get_name() return self._data.name