https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3ACharacterSettingsGetDataAPI:CharacterSettingsGetData - Revision history2026-10-18T06:58:45ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:CharacterSettingsGetData&diff=30220&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:41:08Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=CharacterSettings}}<br />
Returns the current character's UI profile settings: the active profile and the list of profiles the character can use.<br />
<br />
<pre><br />
characterSettings = CharacterSettingsGetData()<br />
</pre><br />
<br />
== Arguments ==<br />
None.<br />
<br />
== Returns ==<br />
;characterSettings : <code>table</code> – A table with these fields:<br />
<br />
{| class="wikitable"<br />
! Key !! Type !! Meaning<br />
|-<br />
| <code>activeUiProfile</code> || <code>wstring</code> || Name of the active UI profile. <code>L""</code> when no profile is active.<br />
|-<br />
| <code>isRunningDefaultUi</code> || <code>boolean</code> || The "running the default UI" flag. [[API:CharacterSettingsClearRunningDefaultUiFlag|CharacterSettingsClearRunningDefaultUiFlag]] clears it.<br />
|-<br />
| <code>uiProfiles</code> || <code>table</code> || Array of profile tables, indexed from 1.<br />
|}<br />
<br />
Each profile table has these fields:<br />
{| class="wikitable"<br />
! Key !! Type !! Meaning<br />
|-<br />
| <code>server</code> || <code>wstring</code> || Server name of the character that owns the profile.<br />
|-<br />
| <code>character</code> || <code>wstring</code> || Name of the character that owns the profile.<br />
|-<br />
| <code>name</code> || <code>wstring</code> || Profile name.<br />
|-<br />
| <code>path</code> || <code>wstring</code> || Folder of the profile's files. The stock UI passes it to [[API:CharacterSettingsImportUiProfile|CharacterSettingsImportUiProfile]] and [[API:CharacterSettingsSetActiveUiProfile|CharacterSettingsSetActiveUiProfile]].<br />
|-<br />
| <code>isShared</code> || <code>boolean</code> || <code>true</code> if the profile is shared with other characters. See [[API:CharacterSettingsSetUiProfileShared|CharacterSettingsSetUiProfileShared]].<br />
|-<br />
| <code>isOwnedByActiveCharacter</code> || <code>boolean</code> || <code>true</code> if the current character owns the profile. Only owned profiles can be renamed, removed, exported or imported into.<br />
|-<br />
| <code>lastUpdated</code> || <code>table</code> || Last update time of the profile, with the number fields <code>year</code>, <code>month</code>, <code>day</code>, <code>hour</code> and <code>minute</code>.<br />
|}<br />
<br />
== Details ==<br />
* A new table is built on every call.<br />
* The <code>uiProfiles</code> list contains the profiles known to the current character's settings. That includes shared profiles of other characters. [[API:CharacterSettingsGetAllUiProfiles|CharacterSettingsGetAllUiProfiles]] lists the profiles of all characters instead.<br />
* While a character deletion is being handled (see [[API:CharacterSettingsHandleDeletedCharacter|CharacterSettingsHandleDeletedCharacter]]), the data is that of the character being deleted.<br />
<br />
== Errors ==<br />
None.<br />
<br />
== Example ==<br />
From <code>ea_uiprofileswindow/source/characterdeletedhandler.lua</code>:<br />
<pre><br />
local characterSettings = CharacterSettingsGetData()<br />
<br />
-- Examine the Profiles data<br />
for _, profileData in ipairs( characterSettings.uiProfiles )<br />
do<br />
if( profileData.isShared )<br />
then<br />
-- ...<br />
</pre><br />
<br />
== See also ==<br />
* [[API:CharacterSettingsGetAllUiProfiles|CharacterSettingsGetAllUiProfiles]]<br />
* [[API:CharacterSettingsSetActiveUiProfile|CharacterSettingsSetActiveUiProfile]]<br />
* [[API:CharacterSettingsClearRunningDefaultUiFlag|CharacterSettingsClearRunningDefaultUiFlag]]</div>Maintenance script