Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:41:05Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=CharacterSettings}}
Creates a new UI profile for the current character.

<pre>
CharacterSettingsCreateUiProfile(profileName)
</pre>

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

== Returns ==
Nothing.

== Details ==
* The new profile is added to the current character's profile list, and the client fires <code>SystemData.Events.CHARACTER_SETTINGS_UPDATED</code>.
* If a profile with this name already exists, the error below is logged, but the call goes on and creates the profile anyway. Check the name first, as the stock UI does with its own <code>IsProfileNameInUse</code> helper.
* The stock UI fills a new profile from a template with [[API:CharacterSettingsImportUiProfile|CharacterSettingsImportUiProfile]] right after creating it.
* Passing an ordinary Lua string raises an ''Invalid Parameters'' error.

== Errors ==
Logged; the call does not stop:
* <code>ERROR Creating UI Profile '%s'. Profile name is already in use.</code>

== Example ==
From <code>ea_uiprofileswindow/source/createuiprofilewindow.lua</code>:
<pre>
local profileName = EA_Window_UiProfileCreateEditBox.Text

-- Create the New Profile
CharacterSettingsCreateUiProfile( profileName )

-- Import if a template is specified.
if( m_template.name ~= nil )
then
CharacterSettingsImportUiProfile( profileName, m_template.path )
end
</pre>

== See also ==
* [[API:CharacterSettingsRemoveUiProfile|CharacterSettingsRemoveUiProfile]]
* [[API:CharacterSettingsRenameUiProfile|CharacterSettingsRenameUiProfile]]
* [[API:CharacterSettingsImportUiProfile|CharacterSettingsImportUiProfile]]

API:CharacterSettingsCreateUiProfile - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)