Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:41:13Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=CharacterSettings}}
Renames one of the current character's UI profiles.

<pre>
CharacterSettingsRenameUiProfile(oldName, newName)
</pre>

== Arguments ==
;oldName : <code>wstring</code> – Current name of the profile.
;newName : <code>wstring</code> – New name.

== Returns ==
Nothing.

== Details ==
* The profile must exist for the current character and be owned by it. Otherwise an error below is logged and nothing is renamed.
* If another profile already uses <code>newName</code>, an error is logged, but the call goes on and renames the profile anyway. Check the name first, as the stock UI does.
* The profile's folder is renamed and the profile list is updated.
* If the profile is the active one, the client updates its active profile path and name and saves the character settings.
* The client then fires <code>SystemData.Events.CHARACTER_SETTINGS_UPDATED</code>.
* Both arguments must be wide strings. The function needs at least two arguments and only reads the last two.

== Errors ==
Logged; the call does not raise a Lua error:
* <code>ERROR Renaming UI Profile '%s'. Profile does not exist for this character.</code>
* <code>ERROR Renaming UI Profile '%s' to '%s'. New Profile name is already in use.</code> (the call continues)
* <code>ERROR Removing UI Profile '%s'. You may not remove a profile owned by another character.</code> (the rename uses the message of [[API:CharacterSettingsRemoveUiProfile|CharacterSettingsRemoveUiProfile]])

== Example ==
From <code>ea_uiprofileswindow/source/renameuiprofilewindow.lua</code>:
<pre>
CharacterSettingsRenameUiProfile( m_selectedProfileName, profileName )
</pre>

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

API:CharacterSettingsRenameUiProfile - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)