Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:41:12Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=CharacterSettings}}
Deletes one of the current character's UI profiles, including its folder on disk.

<pre>
CharacterSettingsRemoveUiProfile(profileName)
</pre>

== Arguments ==
;profileName : <code>wstring</code> – Name of the profile. It must be a wide string.

== Returns ==
Nothing.

== Details ==
* The profile must be in the current character's profile list, must not be the active profile, and must be owned by the current character. Otherwise one of the errors below is logged and nothing is removed.
* If all checks pass, the profile's folder is deleted, the profile is taken out of the list, and the client fires <code>SystemData.Events.CHARACTER_SETTINGS_UPDATED</code>.
* The stock UI first asks [[API:CharacterSettingsGetOtherCharactersUsingProfile|CharacterSettingsGetOtherCharactersUsingProfile]] whether other characters still use the profile.
* Passing an ordinary Lua string raises an ''Invalid Parameters'' error.

== Errors ==
Logged; the call does not raise a Lua error:
* <code>ERROR Removing UI Profile '%s'. Profile does not exist for this character.</code>
* <code>ERROR Removing UI Profile '%s'. You may not remove your active profile.</code>
* <code>ERROR Removing UI Profile '%s'. You may not remove a profile owned by another character.</code>

== Example ==
From <code>ea_uiprofileswindow/source/deleteuiprofilewindow.lua</code>:
<pre>
CharacterSettingsRemoveUiProfile( m_selectedProfileName )
</pre>

== See also ==
* [[API:CharacterSettingsCreateUiProfile|CharacterSettingsCreateUiProfile]]
* [[API:CharacterSettingsGetOtherCharactersUsingProfile|CharacterSettingsGetOtherCharactersUsingProfile]]

API:CharacterSettingsRemoveUiProfile - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)