- Found in:
- SKSE
Description
Wiki Description
Returns whether the form is favorited by the player or not.
Documentation Comment
Returns if base form is favorited by the player
Caveats
CK Wiki - Notes
- 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.
Parameters
Formform
Examples
Game.IsObjectFavorited(IronSword) == True
; Passes if the player has favorited the IronSword.Auto-Generated Example
Form myForm__form
bool returnedValue = Game.IsObjectFavorited(myForm__form)