Difference between revisions of "EquipItem"

From GECK

m (Robot: Automated text replacement (-\[\[Category:(.*?)\(GECK 1.0\)\]\] +Category:\1(GECK 1.1)))
Line 1: Line 1:
=='''Description'''==
+
{{Function
[[EquipItem]] forces an actor to equip an item.  
+
|CSWikiPage = EquipItem
 +
|origin = GECK1
 +
|summary = [[EquipItem]] forces an actor to equip an item.  
 +
|name = EquipItem
 +
|returnType = void
 +
|referenceType = [ActorRefID]
 +
|arguments =
 +
  {{FunctionArgument
 +
  |Name = ObjectID
 +
  |Type = ref
 +
  |Optional = n
 +
  }}{{FunctionArgument
 +
  |Name = NoUnequipFlag
 +
  |Type = int
 +
  |Value = 0, 1
 +
  |Optional = y
 +
  }}{{FunctionArgument
 +
  |Name = HideEquipMessage
 +
  |Type = int
 +
  |Value = 0, 1
 +
  |Optional = y
 +
  }}
 +
|example = Player.EquipItem HuntingRifle 0 1
 +
}}
  
=='''Syntax:'''==
+
==Notes==
[''ActorID''.]EquipItem ObjectID ''NoUnequipFlag'' ''HideEquipMessage''
+
 
+
=='''Parameters'''==
+
 
*If NoUnequipFlag = 1, actor (including the player) will be unable to unequip the item. Once the item is unequipped with the [[UnequipItem]] function, the item can be equipped and unequipped as normal.
 
*If NoUnequipFlag = 1, actor (including the player) will be unable to unequip the item. Once the item is unequipped with the [[UnequipItem]] function, the item can be equipped and unequipped as normal.
 
*If HideEquipMessage = 1, the item equipped message will be hidden from the player.
 
*If HideEquipMessage = 1, the item equipped message will be hidden from the player.
Line 11: Line 31:
  
 
==See Also==
 
==See Also==
[[Force an actor to equip new stuff]]
+
*[[Force an actor to equip new stuff]]
  
 
[[Category:Functions]]
 
[[Category:Functions]]

Revision as of 07:52, 15 January 2011

Link to TES4 Construction Set Wiki: EquipItem.

A function included in the GECK version 1.1.0.36.

Description

EquipItem forces an actor to equip an item.

Syntax

[ActorRefID].EquipItem ObjectID:ref NoUnequipFlag:int{0, 1} HideEquipMessage:int{0, 1}

Example

Player.EquipItem HuntingRifle 0 1

Notes

  • If NoUnequipFlag = 1, actor (including the player) will be unable to unequip the item. Once the item is unequipped with the UnequipItem function, the item can be equipped and unequipped as normal.
  • If HideEquipMessage = 1, the item equipped message will be hidden from the player.
  • In the case that the player has multiples of the specified item, it would appear that the item of lowest condition is the one equipped. If EquipItem is called on the same actor and in the same frame as AddItem or AddItemHealthPercent, however, the last item added is equipped instead.

See Also

Personal tools