Skip to content

Return of Reckoning

Wiki

RoR Wiki

API:CharacterSettingsRemoveUiProfile

From RoR Wiki

Deletes one of the current character's UI profiles, including its folder on disk.

CharacterSettingsRemoveUiProfile(profileName)

Arguments

profileName
wstring – 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 SystemData.Events.CHARACTER_SETTINGS_UPDATED.
  • The stock UI first asks 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:

  • ERROR Removing UI Profile '%s'. Profile does not exist for this character.
  • ERROR Removing UI Profile '%s'. You may not remove your active profile.
  • ERROR Removing UI Profile '%s'. You may not remove a profile owned by another character.

Example

From ea_uiprofileswindow/source/deleteuiprofilewindow.lua:

CharacterSettingsRemoveUiProfile( m_selectedProfileName )

See also