Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:41:09Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=CharacterSettings}}
Returns the other characters that use one of the current character's shared UI profiles.

<pre>
characters = CharacterSettingsGetOtherCharactersUsingProfile(profileName)
</pre>

== Arguments ==
;profileName : <code>wstring</code> – Name of a profile owned by the current character.

== Returns ==
;characters : <code>table</code> – Array of character tables, indexed from 1. Nothing is returned when an error is logged (see below).

Each character table has these fields:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>serverName</code> || <code>wstring</code> || Server of the character.
|-
| <code>characterName</code> || <code>wstring</code> || Name of the character.
|}

== Details ==
* The profile must exist for the current character and be owned by it. Otherwise an error below is logged and the function returns nothing.
* If the profile is not shared, the result is an empty table.
* For a shared profile, the client reads the other characters' settings files and lists those that use the profile.
* Passing an ordinary Lua string raises an ''Invalid Parameters'' error.

== Errors ==
Logged; both name a different function, <code>CharacterSettingsSetUiProfileShared</code>:
* <code>ERROR in function call 'CharacterSettingsSetUiProfileShared': Profile name %s does not exist.</code>
* <code>ERROR in function call 'CharacterSettingsSetUiProfileShared': Profile %s is owned by another character.</code>

== Example ==
From <code>ea_uiprofileswindow/source/characterdeletedhandler.lua</code>:
<pre>
-- If other characters are using this profile, we will need to export it.
local othersUsing = CharacterSettingsGetOtherCharactersUsingProfile( profileData.name )
if( othersUsing and othersUsing[1] )
then
table.insert( m_profilesToExport, { data=profileData, exportChars=othersUsing } )
end
</pre>

== See also ==
* [[API:CharacterSettingsSetUiProfileShared|CharacterSettingsSetUiProfileShared]]
* [[API:CharacterSettingsExportUiProfile|CharacterSettingsExportUiProfile]]
* [[API:CharacterSettingsRemoveUiProfile|CharacterSettingsRemoveUiProfile]]

API:CharacterSettingsGetOtherCharactersUsingProfile - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)