GetProperty

getProperty

Available since: v3.7.1

Return the requested property.

Lua Syntax:

getProperty(property)

Arguments

property

"string" - The requested property to retrieve. Currently supported properties: "platform" ("win"/"mac"),

"steam_initialized" (true/false depending if the steam_api was loaded and client is connected, false if the operation failed),

"system_language" Returns English name of system language or "unknown" if language could not be retrieved.

Return Values

property

requested property value.

Examples

Example 1: "platform"

-- if platform equals windows then do some action else if mac do some other action
if getProperty("platform") == "win" then
  getObject("Conditions[win?]"):setValue(VConditionValue, true)
elseif getProperty("platform") == "mac" then
  getObject("Conditions[mac?]"):setValue(VConditionValue, true)
end

Example 2: "steam_initialized"

-- let's check if steam has initialized & set a value based on return value
local steamLoaded = getProperty("steam_initialized")

if steamLoaded then
  getObject("Conditions[steamLoaded?]"):setValue(VConditionValue, true)
else
  getObject("Conditions[steamLoaded?]"):setValue(VConditionValue, false)
end

Example 3: "system_language"

-- set game language to users operating system language
local sysLang = getProperty("system_language")

if sysLang == "English" then
  game:setValue(VGameStandardLanguage, getObject("Languages[English]"))
elseif sysLang == "German" then
  game:setValue(VGameStandardLanguage, getObject("Languages[Deutsch]"))
end