Difference between revisions of "GameProgress Lua API"

From Off Grid Wiki
Jump to: navigation, search
Line 51: 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''': 06/09/2018 14:53
+
'''Docs last hacked together on''': 08/03/2019 13:51
 
[[Category:Modding]][[Category:LuaAPI]]
 
[[Category:Modding]][[Category:LuaAPI]]

Revision as of 13:58, 8 March 2019

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: 08/03/2019 13:51