Background for Starfield
Member of the Actor script
voidfunctionUnequipItem(FormakItem, boolabPreventEquip=false, boolabSilent=false)Native

Description

Wiki Description

Forces this actor to unequip the specified item, preventing equipping if requested.

Documentation Comment

Unequips the specified item from this actor


Parameters

  1. FormakItem

    CK Wiki Description

    The item the actor should unequip.

  2. boolabPreventEquip=false

    CK Wiki Description

    If true, prevents the actor (or player) from equipping the item.

    • Default:False
  3. boolabSilent=false

    CK Wiki Description

    Should the unequip message be silenced?

    • Default:False

Examples

; Force the player to unequip the tutu - but they can equip it
Game.GetPlayer().UnequipItem(TutuProperty)
; Force Sally to unequip the dress - but they can't equip it
Sally.UnequipItem(DressProperty, true)

Auto-Generated Example

Form myForm__akItem
bool myBool__abPreventEquip
bool myBool__abSilent

myActor__toCallFunctionOn.UnequipItem(myForm__akItem, myBool__abPreventEquip, myBool__abSilent)

Related Pages


Additional References

View this function’s page on the Fallout 4 Creation Kit Wiki

Some data provided by the Fallout 4 Creation Kit Wiki. Licensed under the Creative Commons Attribution-Share Alike 4.0 license.