GameProgress Lua API: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 8: | Line 8: | ||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |||
! Name !! Type | |||
|- | |- | ||
| key || string | | key || string | ||
Line 19: | Line 21: | ||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |||
! Name !! Type | |||
|- | |- | ||
| key || string | | key || string | ||
Line 34: | Line 38: | ||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |||
! Name !! Type | |||
|- | |- | ||
| key || string | | key || string | ||
Line 45: | Line 51: | ||
This file is auto generated, please don't edit manually! | This file is auto generated, please don't edit manually! | ||
'''Docs last hacked together on''': | '''Docs last hacked together on''': 10/11/2017 11:07 | ||
[[Catagory:Modding]][[Catagory:LuaAPI]] | |||
[[ | |||
[[ |
Revision as of 11:50, 10 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
Name | Type |
---|---|
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
Name | Type |
---|---|
key | string |
value | string |
overwrite | bool (optional) |
Description: Sets a value in the game progress
Returns: Nothing
HasKey
GameProgress.HasKey(key)
Expected parameter types
Name | Type |
---|---|
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: 10/11/2017 11:07 Catagory:ModdingCatagory:LuaAPI