Difference between revisions of "GetEquippedObject"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>DragoonWraith
(GetEquippedObject has the honor of being the first OBSE function in a general category...)
imported>Quetzilla
 
(4 intermediate revisions by 3 users not shown)
Line 2: Line 2:


'''Syntax:'''
'''Syntax:'''
  GetEquippedObject [slot]
  (objectID:ref) reference.GetEquippedObject slot:short


Must be called on a reference. Returns the ObjectID of the object in the selected equipment slot.
Must be called on a reference. Returns the ObjectID of the object in the selected equipment slot.
Line 21: Line 21:


==Notes==
==Notes==
*Prior to OBSE v0006, this function was called '''GetEquipmentSlotType'''.
*Prior to OBSE v0006, this function was called '''GetEquipmentSlotType'''.


[[Category: OBSE Functions]]
<!--[[Category: OBSE Functions]]
[[Category: OBSE Inventory Functions]]
[[Category: OBSE Inventory Functions]]
[[Category: OBSE Reference Functions]]
[[Category: OBSE Reference Functions]]-->
[[Category: Functions (OBSE)]]
[[Category: Inventory Functions]]
[[Category: Inventory Functions (OBSE)]]
[[Category: Record Variable Functions]]
[[Category: Record Variable Functions]]
[[Category: Record Variable Functions (OBSE)]]
[[Category: Record Variable Functions (OBSE)]]

Latest revision as of 21:06, 28 May 2008

A command for Oblivion Script Extender

Syntax:

(objectID:ref) reference.GetEquippedObject slot:short 

Must be called on a reference. Returns the ObjectID of the object in the selected equipment slot.


Example:

ref Weapon
set Weapon to player.GetEquippedObject 16
ref UpperBodyArmor
set UpperBodyArmor to player.GetEquippedObject 2

Sets the reference-variables to the ObjectIDs of the player's weapon resp. cuirass/shirt.



Slot IDs[edit source]

armor/clothing
 0	head
 1	hair
 2	upper body
 3	lower body
 4	hand
 5	foot
 6	right ring
 7	left ring
 8	amulet
 13	shield
 14	torch
 15	tail
 18	lower and upper body
 19	lower and upper and foot
 20	lower, upper, hand and foot
 21	lower, upper, and hand
 22 	upper and hand
 255	no slot

weapon/ammo
 16	weapon
 17	ammo


Special return values are used for getting the Equipment Type (Value Type 3) in GetOV, GetCV, GetEOV and GetECV

Special return values
 18     both lower and upper body (robes)

Reserved values are currently nonfunctional and/or obsolete.

reserved
  9	(weapon)
 10	(back weapon)
 11	(side weapon)
 12	(quiver) 


Notes[edit | edit source]

  • Prior to OBSE v0006, this function was called GetEquipmentSlotType.