ShowGiftMenu - Actor

From the CreationKit Wiki
Revision as of 13:53, 11 November 2011 by imported>Scornett (Reverted edits by Scornett-Bot (talk) to last revision by Rhavlovick)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Member of: Actor Script

Shows the gift menu for this actor.


Syntax

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

Parameters

  • 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

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

; 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

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

See Also