Difference between revisions of "IsObjectFavorited - Game"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Icecreamassassin
(Created page with "Syntax Game.IsObjectFavorited([Form])")
 
imported>Pickysaurus
 
(4 intermediate revisions by 4 users not shown)
Line 1: Line 1:
Syntax
[[Category:Scripting]]
[[Category:Papyrus]]
'''Member of:''' [[Game Script]] (Requires SKSE)


Game.IsObjectFavorited([Form])
== Syntax ==
<source lang=papyrus>
bool Function IsObjectFavorited(Form form) global native
</source>
 
== Return value ==
*Returns rather the base form is favorited by the player or not.
 
== Examples ==
 
<source lang=papyrus>
Game.IsObjectFavorited(IronSword) == True
; Passes if the player has favorited the IronSword.
</source>
 
== Notes ==
*This function can only check a specific form. Passing a FormList will return false.
 
== See Also ==
*[[Game Script]]

Latest revision as of 08:00, 21 September 2019

Member of: Game Script (Requires SKSE)

Syntax[edit | edit source]

bool Function IsObjectFavorited(Form form) global native

Return value[edit | edit source]

  • Returns rather the base form is favorited by the player or 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.

See Also[edit | edit source]