aperx/factorio-scenario-ExpCluster
1
0
Fork 0
mirror of https://github.com/PHIDIAS0303/ExpCluster.git synced 2025-12-27 11:35:22 +09:00
Code Issues Packages Projects Releases Wiki Activity

Added comments to store

Browse Source
This commit is contained in:
Cooldude2606
2019-05-04 13:31:52 +01:00
parent bd93c703d5
commit 1f7f9e5515
1 changed files with 10 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
expcore/store.lua
View File

@@ -43,6 +43,10 @@ function Store.register_location(location,store_type,update_callback)
end
--- Sets a new value for a location, will trigger the update callback
-- @tparam location string the location to set the data at, must be registed
-- @tparam[opt] sub_location string a second location value that can be a player's name force name etc
-- @tparam value any the value to be stored, passed via sublocation if sub_location is not required
-- @tparam[opt] ... any any more values that you want to pass to the update callback
function Store.set_location(location,sub_location,value,...)
if not Store.locations[location] then
return error('Invalid store location: '..location,2)
@@ -57,9 +61,13 @@ function Store.set_location(location,sub_location,value,...)
end
--- Gets the value for a location
function Store.get_location(location,sub_location)
-- @tparam location string the location to set the data at, must be registed
-- @tparam[opt] sub_location string a second location value that can be a player's name force name etc
-- @tparam[opt=false] allow_invalid_location boolean when true will not error when location is invalid
-- @treturn any the value found at that location
function Store.get_location(location,sub_location,allow_invalid_location)
if not Store.locations[location] then
return error('Invalid store location: '..location,2)
return not allow_invalid_location and error('Invalid store location: '..location,2) or nil
end
location = Store.locations[location]
if location.type == Store.types.game then