Difference between revisions of "ShowGiftMenu - Actor"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>KKuhlmann
imported>Cipscis
m (→‎See Also: Fixed link formatting)
 
(One intermediate revision by one other user not shown)
Line 40: Line 40:
== See Also ==
== See Also ==
*[[Actor Script]]
*[[Actor Script]]
*[[OpenInventory - Actor]]

Latest revision as of 00:15, 17 September 2012

Member of: Actor Script

Shows the gift menu for this actor.


Syntax[edit | edit source]

int Function ShowGiftMenu(bool abGiving, FormList apFilterList = None, bool abShowStolenItems = false, bool abUseFavorPoints = true) native

Parameters[edit | edit source]

  • abGiving: True if we're giving items; false if we're taking items
  • apFilterList: Filter list. If present, only items that match keywords and objects in the list will be shown
    • Default: None
  • abShowStolenItems: If true, stolen items are shown in the menu.
    • Default: False
  • abUseFavorPoints : If true, favor points are added / subtracted with each transaction. False, favor points aren't used at all.
    • Default: True

Return Value[edit | edit source]

Total favor points spent / gained while in the menu. If no points were spent / gained, return value is 0. Return value is always non-negative.

Examples[edit | edit source]

; Shows the give gift menu for Bob, filtering for food
Bob.ShowGiftMenu(true, OnlyFoodList)


; Shows the give gift menu for Bob with no filtering
Bob.ShowGiftMenu(true)

Notes[edit | edit source]

This is a latent function and will not exit until the menu is closed.

See Also[edit | edit source]