Skip to content

Return of Reckoning

Wiki

RoR Wiki

API:CharacterSettingsGetAllUiProfiles

From RoR Wiki

Returns every UI profile found in the user settings folder, for all servers and characters.

profiles = CharacterSettingsGetAllUiProfiles()

Arguments

None.

Returns

profiles
table – Array of profile tables, indexed from 1.

Each profile table has these fields:

Key Type Meaning
server wstring Server name of the character that owns the profile.
character wstring Name of the character that owns the profile.
name wstring Profile name.
path wstring Folder of the profile's files. The stock UI passes it to CharacterSettingsImportUiProfile.
isShared boolean –
isOwnedByActiveCharacter boolean –
lastUpdated table Last update time of the profile, with the number fields year, month, day, hour and minute.

Details

  • The client walks the user settings folder three levels deep: server folders, character folders inside them, and profile folders inside those. Every profile folder becomes one entry.
  • The field names are the same as in the uiProfiles list of CharacterSettingsGetData.
  • The folders are read on every call.

Errors

None.

Example

From ea_uiprofileswindow/source/introdialoguiprofilewindow.lua:

-- Only show the intro dialog when there is more than just our current UI profile.
local availProfiles = CharacterSettingsGetAllUiProfiles()
if( availProfiles[2] == nil )
then
    return
end

See also