IsObjectFavorited - Game

From the CreationKit Wiki
Jump to navigation Jump to search

Member of: Game Script (Requires SKSE)

Returns whether the form is favorited by the player or not.

Syntax[edit | edit source]

bool Function IsObjectFavorited(Form form) global native

Return value[edit | edit source]

  • true if this form is favorited by the player; false if not

Examples[edit | edit source]

Game.IsObjectFavorited(IronSword) == True
; Passes if the player has favorited the IronSword.

Notes[edit | edit source]

  • This function can only check a specific form. Passing a FormList will return false.
  • It is worth testing how this function behaves when passed an ObjectReference value. This page should be updated with the results of such a test.

See Also[edit | edit source]