GetFavorites - FavoritesManager

From Creation Kit
Jump to: navigation, search

Member of: FavoritesManager Script
Requires F4SE version 0.6.5 or higher.

Returns all 12 favorites which may contain none entries.

Syntax

Form[] Function GetFavorites() Global Native

Return Value

Returns a Form array of all 12 favorited slots. Empty favorite slots will be returned as none entries.

Examples

{For each favorite form}
Form[] favorites = FavoritesManager.GetFavorites()
If (favorites)
    int index = 0
    While (index < favorites.Length)
        Debug.Trace("Favorited item at index " + index + " is " + favorites[index])
        index += 1
    EndWhile
Else
    Debug.Trace("There are no favorite items.")
EndIf

Notes

None

See Also