Background for Skyrim SE
Member of the Actor script
intfunctionShowGiftMenu(boolabGivingGift, FormListapFilterList=NONE, boolabShowStolenItems=false, boolabUseFavorPoints=true)Native

Description

Wiki Description

Shows the gift menu for this actor.

Documentation Comment

Opens the Gift menu
Params:

  • abGivingGift: True if we're giving a gift to this Actor, false if the player is taking a gift from this Actor
  • apFilterList: OPTIONAL (Def=None) -- If present, this form list is used to filter the item list. Only items
    that match keywords / items in the list will get shown
  • abShowStolenItems: OPTIONAL (Def=false) -- If true, stolen items are shown
  • abUseFavorPoints: OPTIONAL (Def=true) -- If true, favor points are added / subtracted with each transaction. If false, FPs aren't used at all.
    Returns: The number of favor points spent / gained while in the menu.

Caveats

CK Wiki - Notes

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


Parameters

  1. boolabGivingGift

    CK Wiki Description

    True if we're giving items; false if we're taking items

  2. FormListapFilterList=NONE

    CK Wiki Description

    Filter list. If present, only items that match keywords and objects in the list will be shown

    • Default:None
  3. boolabShowStolenItems=false

    CK Wiki Description

    If true, stolen items are shown in the menu.

    • Default:False
  4. boolabUseFavorPoints=true

    CK Wiki Description

    If true, favor points are added / subtracted with each transaction. False, favor points aren't used at all.

    • Default:True

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)

Auto-Generated Example

bool myBool__abGivingGift
FormList myFormList__apFilterList
bool myBool__abShowStolenItems
bool myBool__abUseFavorPoints

int returnedValue = myActor__toCallFunctionOn.ShowGiftMenu(myBool__abGivingGift, myFormList__apFilterList, myBool__abShowStolenItems, myBool__abUseFavorPoints)

Related Pages


Additional References

View this function’s page on the Skyrim Creation Kit Wiki

Some data provided by the Skyrim Creation Kit Wiki. Licensed under the Creative Commons Attribution-ShareAlike license.