Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:41:10Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=CharacterSettings}}
Finishes the UI settings part of a character deletion, optionally deleting the character's UI settings folder.

<pre>
CharacterSettingsHandleDeletedCharacter(deleteFiles)
</pre>

== Arguments ==
;deleteFiles : <code>boolean</code> – <code>true</code> to delete the deleted character's UI settings folder, <code>false</code> to keep it.

== Returns ==
Nothing.

== Details ==
* When a character is deleted on the character select screen, the client loads that character's UI settings and fires <code>SystemData.Events.CHARACTER_SETTINGS_ON_CHARACTER_DELETED</code>. This function ends that state.
* It only has an effect while that state is active. Otherwise it does nothing.
* With <code>deleteFiles = true</code> the deleted character's settings folder is deleted with everything in it. In both cases the loaded settings of the deleted character are unloaded.
* <code>deleteFiles</code> must be a real boolean. Passing <code>nil</code> or a number raises an ''Invalid Parameters'' error.

== Errors ==
None besides the generic ''Invalid Parameters'' message when the argument is not a boolean.

== Example ==
From <code>ea_uiprofileswindow/source/characterdeletedhandler.lua</code>, after asking the player:
<pre>
function EA_UiProfilesCharacterDeleteHandler.OnDeleteUIDataYes()

-- End handling and delete the data.
CharacterSettingsHandleDeletedCharacter( true )

DestroyWindow( "EA_Window_UiProfilePopupScreen" )
end

function EA_UiProfilesCharacterDeleteHandler.OnDeleteUIDataNo()

-- End handling and don't delete the data.
CharacterSettingsHandleDeletedCharacter( false )

DestroyWindow( "EA_Window_UiProfilePopupScreen" )
end
</pre>

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

API:CharacterSettingsHandleDeletedCharacter - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)