Difference between revisions of "Global Command: getProperty"

From The Official Visionaire Studio: Adventure Game Engine Wiki
Line 61: Line 61:
  
 
<span class="bold">property</span>: "string" <br/>
 
<span class="bold">property</span>: "string" <br/>
* "platform" (returns "win" or "mac" depending on users operating system)
+
* "platform" (returns ''win'', ''mac'', ''linux'', ''ios'', or ''android''; depending on users operating system)
 
* "steam_initialized" (true/false depending if the steam_api is successfully loaded & client is connected)
 
* "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)
 
* "system_language" (returns users system language in english; english, german, spanish etc)

Revision as of 19:35, 19 March 2014

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 = windows then do some action else if ...
if getProperty("platform") == "win" then 
 getObject("Conditions[win]"):setValue(VConditionValue, true)
elseif getProperty("platform") == "mac" then
 getObject("Conditions[mac]"):setValue(VConditionValue, true)
elseif getProperty("platform") == "linux" then
 getObject("Conditions[linux]"):setValue(VConditionValue, true)
elseif getProperty("platform") == "ios" then
 getObject("Conditions[ios]"):setValue(VConditionValue, true)
elseif getProperty("platform") == "android" then 
 getObject("Conditions[win]"):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[steamInit]"):setValue(VConditionValue, true)
else
 getObject("Conditions[steamInit]"):setValue(VConditionValue, false)
end

Example 3: "system_language"

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

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


Arguments

property: "string"

  • "platform" (returns win, mac, linux, ios, or android; 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