Core Module - Store - Adds an easy way to store and watch for updates to a value
-- The data store module is designed to be an alterative way to store data in the global table
-- each piece of data is stored at a location and optional key of that location
-- it is recomented that you use a local varible to store the location
local scenario_difficuly = Store.uid_location()
local team_scores = 'team-scores'
-- Setting and getting data is then as simple as
-- note that when storing a table you must use Store.update
Store.set(scenario_difficuly,'Hard')
Store.set(team_scores,game.player.force.name,20)
Store.get(scenario_difficuly) -- returns 'Hard'
Store.get(team_scores,game.player.force.name) -- returns 20
Store.update(team_scores,game.player.force.name,function(value,key)
return value + 10 -- add 10 to the score
end)
-- The reason for using stores over global is the abilty to watch for updates
-- for stores to work you must register them, often at the end of the file
Store.register(scenario_difficuly,function(value)
game.print('Scenario difficulty has been set to: '..value)
end)
Store.register(team_scores,function(value,key)
game.print('Team '..key..' now has a score of '..value)
end)
-- This can be very powerful when working with data that can be changed for a number of locations
-- with this module you can enable any location to output its changes to a file
-- say we wanted team scores to be synced across servers or between saves
-- although you will need to set up a method of storing the data outside the game
Store.register(team_scores,true,function(value,key)
game.print('Team '..key..' now has a score of '..value)
end)| utils.global |
| utils.event |
| expcore.common |
| utils.token |
| register([location][, synced=false][, callback]) | Registers a new location with an update callback which is triggered when the value updates |
| get(location[, key]) | Gets the value stored at a location, this location must be registered |
| set(location[, key], value[, from_sync=false][, from_internal=false]) | Sets the value at a location, this location must be registered |
| update(location[, key][, update_callback]) | Allows for updating a value based on the current value; only valid way to change tables in a store |
| update_all(location[, update_callback]) | Allows for updating all values at a location based on the current value; only valid way to change tables in a store |
| clear(location[, key][, from_sync=false]) | Sets the value at a location to nil, this location must be registered |
| get_keys(location) | Gets all non nil keys at a location, keys can be added and removed during runtime this is similar to Store.get but will always return a table even if it is empty |
| is_registered(location) | Check for if a location is registered |
| uid_location() | Returns a unique name that can be used for a store |
Registers a new location with an update callback which is triggered when the value updates
Parameters:Gets the value stored at a location, this location must be registered
Parameters:Sets the value at a location, this location must be registered
Parameters:Allows for updating a value based on the current value; only valid way to change tables in a store
Parameters:Allows for updating all values at a location based on the current value; only valid way to change tables in a store
Parameters:Sets the value at a location to nil, this location must be registered
Parameters:Gets all non nil keys at a location, keys can be added and removed during runtime this is similar to Store.get but will always return a table even if it is empty
Parameters: