GetProperty

From The Official Visionaire Studio: Adventure Game Engine Wiki
Revision as of 15:50, 12 March 2013 by AFRLme (talk)

Command History

Available since v3.7
system_language property added to v3.8


Return the requested property.


Syntax:

getProperty(property)


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" (I'm not sure if this example is correct without testing!)

-- let's check the current users operating system language & store it in a variable!
local sysLang == getProperty("system_language")

if sysLang == "English" then
 Game.GameStandardLanguage:setValue(VValueString, "English") -- fix
elseif sysLang == "German" then
 Game.GameStandardLanguage:setValue(VValueString, "Deutsch") -- fix
end


Arguments

property: "string"

  • "platform" (returns "win" or "mac" depending on users operating system)
  • "steam_initialized" (true/false depending if the steam_api is successfully loaded & client is connected)
  • "system_language" (returns users system language in english; english, german, spanish etc)


Flags

none


Return

property
The requested property value