GameProgress Lua API: Difference between revisions

From Off Grid Wiki
Jump to navigation Jump to search
(Add GameProgress Lua API page)
 
No edit summary
 
(9 intermediate revisions by 4 users not shown)
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 6: Line 8:
'''Expected parameter types'''
'''Expected parameter types'''
{| class="wikitable"
{| class="wikitable"
|-
! Name !! Type
|-
|-
| key || string
| key || string
Line 17: Line 21:
'''Expected parameter types'''
'''Expected parameter types'''
{| class="wikitable"
{| class="wikitable"
|-
! Name !! Type
|-
|-
| key || string
| key || string
Line 32: Line 38:
'''Expected parameter types'''
'''Expected parameter types'''
{| class="wikitable"
{| class="wikitable"
|-
! Name !! Type
|-
|-
| key || string
| key || string
Line 43: 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''': 13/09/2017 14:00
'''Docs last hacked together on''': 29/08/2023 16:24
[[Category:Modding]][[Category:LuaAPI]]

Latest revision as of 14:16, 29 August 2023

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: 29/08/2023 16:24