GetProperty - Revision history

EK: Redirected page to Global Command: getProperty

2023-05-19T11:25:20Z

Redirected page to Global Command: getProperty

Vis apiuser at 20:41, 30 April 2015

2015-04-30T20:41:21Z

Vis apiuser at 20:27, 30 September 2014

2014-09-30T20:27:48Z

Vis apiuser at 13:56, 26 November 2013

2013-11-26T13:56:30Z

Vis apiuser at 16:11, 22 November 2013

2013-11-22T16:11:51Z

AFRLme at 12:16, 4 April 2013

2013-04-04T12:16:31Z

AFRLme at 15:39, 2 April 2013

2013-04-02T15:39:21Z

AFRLme at 21:10, 13 March 2013

2013-03-13T21:10:22Z

AFRLme at 14:50, 12 March 2013

2013-03-12T14:50:06Z

AFRLme at 14:49, 12 March 2013

2013-03-12T14:49:13Z

← Older revision		Revision as of 11:25, 19 May 2023
Line 1:		Line 1:
−	~~==getProperty==~~	+	#REDIRECT [[Global Command: getProperty]]
−
−	~~<div class="command-min-version-info">Available since: <span class="command-min-version">v4.1</span></div>~~
−
−	~~<div class="command-doc">Return the requested property.</div>~~
−
−	~~Lua Syntax:~~
−	~~<pre class="command-syntax">getProperty(property)</pre>~~
−	~~===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),~~
−	~~:"galaxy_initialized" (true/false depending if the gog galaxy_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.~~
−	~~===Flags===~~
−	~~===Return Values===~~
−	~~;property~~
−	~~:requested property value.~~
−	~~===Examples===~~
−	~~Example 1: "platform"~~
−	~~<syntaxhighlight>~~
−	~~-- 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~~
−	~~</syntaxhighlight>~~
−	~~Example 2~~: ~~"steam_initialized"~~
−	~~<syntaxhighlight>~~
−	~~-- 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~~
−	~~</syntaxhighlight>~~
−	~~Example 3: "galaxy_initialized"~~
−	~~<syntaxhighlight>~~
−	~~-- let's check if gog galaxy has initialized & set a value based on return value~~
−	~~local galaxyLoaded = getProperty("galaxy_initialized")~~
−
−	~~if galaxyLoaded then~~
−	~~getObject("Conditions[galaxyLoaded?]"):setValue(VConditionValue, true)~~
−	~~else~~
−	~~getObject("Conditions[galaxyLoaded?]"):setValue(VConditionValue, false)~~
−	~~end~~
−	~~</syntaxhighlight>~~
−	~~Example 4: "system_language"~~
−	~~<syntaxhighlight>~~
−	~~-- 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~~
−	~~</syntaxhighlight>~~

@@ Line 1: / Line 1: @@
 ==getProperty==
-<div class="command-min-version-info">Available since: <span class="command-min-version">v3.7.1</span></div>
+<div class="command-min-version-info">Available since: <span class="command-min-version">v4.1</span></div>
 <div class="command-doc">Return the requested property.</div>
@@ Line 11: / Line 11: @@
 :'''"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.
 ===Flags===
@@ Line 37: / Line 38: @@
 end
 </syntaxhighlight>
-Example 3: "system_language"
+Example 3: "galaxy_initialized"
 <syntaxhighlight>
 -- set game language to users operating system language

← Older revision		Revision as of 20:27, 30 September 2014
Line 48:		Line 48:
	end		end
	</syntaxhighlight>		</syntaxhighlight>
−	~~[[Category:Player Commands]]~~

← Older revision		Revision as of 13:56, 26 November 2013
Line 48:		Line 48:
	end		end
	</syntaxhighlight>		</syntaxhighlight>
		+	[[Category:Player Commands]]

@@ Line 1: / Line 1: @@
-<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
+==getProperty==
-Return the requested property.
+<div class="command-doc">Return the requested property.</div>
 Example 1: "platform"
 <syntaxhighlight>
--- if platform equals windows then do some action else if mac do some other action!
+-- 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)
+  getObject("Conditions[win?]"):setValue(VConditionValue, true)
 elseif getProperty("platform") == "mac" then
- getObject("Conditions[mac?]"):setValue(VConditionValue, true)
+  getObject("Conditions[mac?]"):setValue(VConditionValue, true)
 end
 </syntaxhighlight>
 Example 2: "steam_initialized"
 <syntaxhighlight>
--- let's check if steam has initialized & set a value based on return value!
+-- let's check if steam has initialized & set a value based on return value
-local steamLoaded == getProperty("steam_initialized")
+local steamLoaded = getProperty("steam_initialized")
 if steamLoaded then
- getObject("Conditions[steamLoaded?]"):setValue(VConditionValue, true)
+  getObject("Conditions[steamLoaded?]"):setValue(VConditionValue, true)
 else
- getObject("Conditions[steamLoaded?]"):setValue(VConditionValue, false)
+  getObject("Conditions[steamLoaded?]"):setValue(VConditionValue, false)
 end
 </syntaxhighlight>
 Example 3: "system_language"
 <syntaxhighlight>
--- let's check the current users operating system language & store it in a variable!
+-- set game language to users operating system language
-local sysLang == getProperty("system_language")
+local sysLang = getProperty("system_language")
 if sysLang == "English" then
- game:setValue(VGameStandardLanguage, getObject("Languages[English]"))
+  game:setValue(VGameStandardLanguage, getObject("Languages[English]"))
 elseif sysLang == "German" then
- game:setValue(VGameStandardLanguage, getObject("Languages[Deutsch]"))
+  game:setValue(VGameStandardLanguage, getObject("Languages[Deutsch]"))
 end
 </syntaxhighlight>

@@ Line 1: / Line 1: @@
-<div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%">
+<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
-<b>Command History</b>
+<span class="bold">Command History</span>
 <div class="mw-collapsible-content">
-<div style="background:#ebebeb" width="100%">Available since <span style="color:orange">v3.7</span></div>
+<div class="alt-bg">Available since v3.7</div>
-<div>system_language property added to <span style="color:orange">v3.8</span></div>
+<div>system_language property added to v3.8</div>
 </div></div>
@@ Line 44: / Line 44: @@
 if sysLang == "English" then
-  game:setValue(VGameStandardLanguage, English) -- correct?
+  game:setValue(VGameStandardLanguage, getObject("Languages[English]"))
 elseif sysLang == "German" then
-  game:setValue(VGameStandardLanguage, Deutsch) -- correct?
+  game:setValue(VGameStandardLanguage, getObject("Languages[Deutsch]"))
 end
 </syntaxhighlight>
@@ Line 52: / Line 52: @@
-<b><u>Arguments</u></b>
+<span class="bold underline">Arguments</span>
-<b>property</b>: "string" <br/>
+<span class="bold">property</span>: "string" <br/>
 * "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)
@@ Line 60: / Line 60: @@
-<b><u>Flags</u></b>
+<span class="bold underline">Flags</span>
 none
-<b><u>Return</u></b>
+<span class="bold underline">Return</span>
-<b>property</b> <br/>
+<span class="bold">property</span> <br/>
 The requested property value
 {{i18n|GetProperty}}