Global Command: getProperty - Revision history

EK at 16:31, 25 November 2024

2024-11-25T16:31:59Z

EK at 11:06, 19 May 2023

2023-05-19T11:06:42Z

EK: EK moved page GetProperty (CMS) to Global Command: getProperty

2023-05-02T16:45:34Z

EK moved page GetProperty (CMS) to Global Command: getProperty

EK at 16:45, 2 May 2023

2023-05-02T16:45:09Z

Show changes

David Stoffel at 15:26, 22 March 2014

2014-03-22T15:26:25Z

AFRLme at 14:48, 21 March 2014

2014-03-21T14:48:51Z

AFRLme at 18:35, 19 March 2014

2014-03-19T18:35:28Z

AFRLme at 18:33, 19 March 2014

2014-03-19T18:33:41Z

AFRLme: Created page with "
Command History

Available since ..."

2014-03-19T18:25:25Z

Created page with "<div class="toccolours mw-collapsible mw-collapsed tbl-ds"> <span class="bold">Command History</span> <div class="mw-collapsible-content"> <div class="alt-bg">Available since ..."

New page

<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
<span class="bold">Command History</span>
<div class="mw-collapsible-content">
<div class="alt-bg">Available since v3.7</div>
<div>system_language property added to v3.8</div>
</div></div>

Return the requested property.

Syntax:
<syntaxhighlight>
getProperty(property)
</syntaxhighlight>

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: "system_language"
<syntaxhighlight>
-- 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[Deutsch]"))
end
</syntaxhighlight>

<span class="bold underline">Arguments</span>

<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)
* "system_language" (returns users system language in english; english, german, spanish etc)

<span class="bold underline">Flags</span>

none

<span class="bold underline">Return</span>

<span class="bold">property</span> <br/>
The requested property value
{{i18n|GetProperty}}

@@ Line 65: / Line 65: @@
 * ps4
 * xbox1
 * html5
 |-
@@ Line 106: / Line 107: @@
 elseif userPlatform == "ios" or userPlatform == "android" then
    print("This is mobile.")
-elseif userPlatform == "ps4" or userPlatform == "xbox1" then
+elseif userPlatform == "ps4" or userPlatform == "xbox1" or userPlatform == "nx" then
    print("It's a console.")
 elseif userPlatform == "html5" then

← Older revision		Revision as of 11:06, 19 May 2023
Line 1:		Line 1:
	Get the requested game property.		Get the requested game property.
		+
		+	{\| class="ts"
		+	\|-
		+	\| style="width:15%" \| Related functions
		+	\| [[Global Command: getGameClientAchievement\|getGameClientAchievement]] \| [[Global Command: getGameClientStat\|getGameClientStat]] \| [[Global Command: initGameClient\|initGameClient]] \| [[Global Command: resetGameClientStats\|resetGameClientStats]] \| [[Global Command: setGameClientAchievement\|setGameClientAchievement]] \| [[Global Command: setGameClientStat\|setGameClientStat]]
		+	\|}

← Older revision		Revision as of 15:26, 22 March 2014
Line 75:		Line 75:
	<span class="bold">property</span> <br/>		<span class="bold">property</span> <br/>
	The requested property value		The requested property value
−	~~{{i18n\|GetProperty_(CMS)}}~~

← Older revision	Revision as of 16:45, 2 May 2023
(No difference)

@@ Line 1: / Line 1: @@
 <div class="toccolours mw-collapsible mw-collapsed tbl-ds">
-<span class="bold">Command History</span>
+<span class="bold">Function History</span>
 <div class="mw-collapsible-content">
 <div class="alt-bg">Available since v3.7</div>

@@ Line 61: / Line 61: @@
 <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)
 * "system_language" (returns users system language in english; english, german, spanish etc)

@@ Line 18: / Line 18: @@
 Example 1: "platform"
 <syntaxhighlight>
--- if platform equals windows then do some action else if mac do some other action!
+-- if platform = windows then do some action else if ...
 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>
@@ Line 28: / Line 34: @@
 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")
 if steamLoaded then
-  getObject("Conditions[steamLoaded?]"):setValue(VConditionValue, true)
+  getObject("Conditions[steamInit]"):setValue(VConditionValue, true)
 else
-  getObject("Conditions[steamLoaded?]"):setValue(VConditionValue, false)
+  getObject("Conditions[steamInit]"):setValue(VConditionValue, false)
 end
 </syntaxhighlight>
@@ Line 40: / Line 46: @@
 Example 3: "system_language"
 <syntaxhighlight>
--- let's check the current users operating system language & store it in a variable!
+-- let's check the current users operating system language & store it in a variable
 local sysLang == getProperty("system_language")
@@ Line 46: / Line 52: @@
   game:setValue(VGameStandardLanguage, getObject("Languages[English]"))
 elseif sysLang == "German" then
-  game:setValue(VGameStandardLanguage, getObject("Languages[Deutsch]"))
+  game:setValue(VGameStandardLanguage, getObject("Languages[German]"))
 end
 </syntaxhighlight>
@@ Line 69: / Line 75: @@
 <span class="bold">property</span> <br/>
 The requested property value
-{{i18n|GetProperty}}
+{{i18n|GetProperty_(CMS)}}