GameProgress Lua API: Difference between revisions

From Off Grid Wiki
Jump to navigation Jump to search
(Add GameProgress Lua API page)
 
(Update)
Line 1: Line 1:
<!-- This file is auto generated, please don't edit manually! -->
<!-- This file is auto generated, please don't edit manually! -->
= GameProgress =
= GameProgress =
== Description ==
The GameProgress api allows the modder to control and query the state of the players game progress
== Functions ==
== Functions ==
=== GetValue ===
=== GetValue ===
Line 43: Line 45:
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''': 13/09/2017 14:00
'''Docs last hacked together on''': 13/09/2017 14:07

Revision as of 13:07, 13 September 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