API:CharacterSettingsClearRunningDefaultUiFlag

UI Lua API · CharacterSettings functions
Version: WAR 1.4.8

Clears the current character's "running the default UI" flag.

CharacterSettingsClearRunningDefaultUiFlag()

Arguments

None.

Returns

Nothing.

Details

• Afterwards the isRunningDefaultUi field of CharacterSettingsGetData is false.
• The client then fires SystemData.Events.CHARACTER_SETTINGS_UPDATED.
• The stock UI shows its UI profile intro dialog while the flag is set and clears it when the dialog closes, so that the dialog does not come back.

Errors

None.

Example

From ea_uiprofileswindow/source/introdialoguiprofilewindow.lua:

function EA_Window_UiProfileIntroDialog.End()

    if( not DoesWindowExist( WINDOWNAME ) )
    then
        return
    end

    -- Clear the 'New Character' flag to prevent the dialog from reappearing.
    CharacterSettingsClearRunningDefaultUiFlag()

    -- Destroy the Window
    DestroyWindow( WINDOWNAME )
end

See also

• CharacterSettingsGetData