Global Command: setWindowTitle - Revision history

EK: EK moved page SetWindowTitle (CMS) to Global Command: setWindowTitle

2023-05-15T22:29:02Z

EK moved page SetWindowTitle (CMS) to Global Command: setWindowTitle

EK at 22:28, 15 May 2023

2023-05-15T22:28:40Z

AFRLme at 20:34, 23 March 2014

2014-03-23T20:34:28Z

AFRLme at 20:30, 23 March 2014

2014-03-23T20:30:30Z

AFRLme: Created page with "
Function History

Available since..."

2014-03-23T20:29:03Z

Created page with "<div class="toccolours mw-collapsible mw-collapsed tbl-ds"> <span class="bold">Function 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">Function History</span>
<div class="mw-collapsible-content">
<div class="alt-bg">Available since v4.0</div>
</div></div>

Allows you to set a custom title in the game application title bar. (only applicable for ''window mode'')

Syntax:
<syntaxhighlight>
setWindowTitle("title")
</syntaxhighlight>

Example 1: basic set window title method
<syntaxhighlight>
setWindowTitle("my new game title")
</syntaxhighlight>

Example 2: set window title based on current users system language
<syntaxhighlight>
sysLang = getProperty("system_language") -- store current os language

-- let's set the window title based on os language
if sysLang == "English" then
setWindowTitle("my new title in english")
elseif sysLang == "German" then
setWindowTitle("mein neue titel auf deutsch")
end
</syntaxhighlight>

Example 3: set window title based on current game language
<syntaxhighlight>
local lang = game:getLink(VGameCurrentLanguage):getName()

if lang == "English" then
setWindowTitle("my new title in english")
elseif lang == "German" then
setWindowTitle("mein neue titel auf deutsch")
end
</syntaxhighlight>

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

<span class="bold">title</span>: "string" <br/>
This should include the text you want to be displayed in the application title bar (window mode)

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

none

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

none

← Older revision	Revision as of 22:29, 15 May 2023
(No difference)

@@ Line 1: / Line 1: @@
-<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
+Set a custom title in the game application title bar. Only applicable, if the game is running in window mode.
-Allows you to set a custom title in the game application title bar. (only applicable for ''window mode'')
+== Syntax ==
+<syntaxhighlight lang="lua">
 setWindowTitle(title)
 </syntaxhighlight>
-Example 1: basic set window title method
+== Parameters ==
-Example 2: set window title based on current users system language
+{| class="ts"
-<syntaxhighlight>
+|-
-sysLang = getProperty("system_language") -- store current os language
+! style="width:15%" | Parameter
-Example 3: set window title based on current game language
+== Return values ==
-if lang == "English" then
+none
-<span class="bold underline">Arguments</span>
+'''Example 1:''' Set the window title based on the user's operating system language.
-<span class="bold">title</span>: "string" <br/>
+if sysLang == "German" then
-This should include the text you want to be displayed in the application title bar (window mode)
+  setWindowTitle("Mein neuer Titel auf Deutsch")
+else
+  setWindowTitle("My new title in English")
-<span class="bold underline">Flags</span>
+end
+</syntaxhighlight>
-none
+{{toc}}