Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:41:15Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=CharacterSettings}}
Turns sharing of one of the current character's UI profiles on or off.

<pre>
CharacterSettingsSetUiProfileShared(profileName, shared)
</pre>

== Arguments ==
;profileName : <code>wstring</code> – Name of the profile.
;shared : <code>boolean</code> – <code>true</code> to share the profile with other characters, <code>false</code> to stop sharing it.

== Returns ==
Nothing.

== Details ==
* The profile must exist for the current character and be owned by it. Otherwise an error below is logged and nothing changes.
* The new value is stored as the profile's <code>isShared</code> flag and the profile's settings file is written again.
* No event is fired.
* <code>shared</code> must be a real boolean. Passing <code>nil</code> or a number raises an ''Invalid Parameters'' error.
* 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 in function call 'CharacterSettingsSetUiProfileShared': Profile name %s does not exist.</code>
* <code>ERROR in function call 'CharacterSettingsSetUiProfileShared': Profile %s is owned by another character and can not be modified.</code>

== Example ==
From <code>ea_uiprofileswindow/source/manageuiprofileswindow.lua</code>:
<pre>
profileData.isShared = not profileData.isShared

CharacterSettingsSetUiProfileShared( profileData.name, profileData.isShared )
ButtonSetPressedFlag( SystemData.ActiveWindow.name, profileData.isShared )
</pre>

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

API:CharacterSettingsSetUiProfileShared - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)