UnequipItem - Actor
Revision as of 10:49, 4 March 2012 by imported>DreamKing (Added notes section, and noted that abPreventEquip seems not to work as described.)
Member of: Actor Script
Forces this actor to unequip the specified item, preventing equipping if requested. Updated to remove the item from the left hand weapon slot too.
Syntax
Function UnequipItem(Form akItem, bool abPreventEquip = false, bool abSilent = false) native
Parameters
- akItem: The item the actor should unequip.
- abPreventEquip: If true, prevents the actor (or player) from equipping the item.
- Default: False
- abSilent: Should the unequip message be silenced?
- Default: False
Return Value
None.
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)
Notes
- abPreventEquip does not seem to work as described when used on NPCs. They seem fully capable of re-equipping items unequipped with this flag set to true. More testing is needed.