GameProgress Lua API: Difference between revisions
Jump to navigation
Jump to search
(Update) |
No edit summary |
||
| Line 46: | Line 46: | ||
'''Docs last hacked together on''': 13/09/2017 14:07 | '''Docs last hacked together on''': 13/09/2017 14:07 | ||
[[Category:Modding]] | |||
[[Category:LuaAPI]] | |||
Revision as of 10:14, 3 November 2017
GameProgress
Description
The GameProgress api allows the modder to control and query the state of the players game progress
Functions
GetValue
GameProgress.GetValue(key)
Expected parameter types
| key | string |
Description: Returns a value from the game progress by key, empty string if it doesn't exist
Returns: string
SetValue
GameProgress.SetValue(key, value, overwrite)
Expected parameter types
| key | string |
| value | string |
| overwrite | bool (optional) |
Description: Sets a value in the game progress
Returns: Nothing
HasKey
GameProgress.HasKey(key)
Expected parameter types
| key | string |
Description: Does the specified key exist?
Returns: bool
This file is auto generated, please don't edit manually!
Docs last hacked together on: 13/09/2017 14:07