Difference between revisions of "GetItemEquipSlot"

From Dragon Age Toolset Wiki
Jump to: navigation, search
m (1 revision: Importing auto-generated function articles)
m
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Generated}}
 
 
{{dafunction
 
{{dafunction
|name=GetItemEquipSlot
+
|name         = GetItemEquipSlot
|brief=Returns the inventory slot this item is equipped in, or INVENTORY_SLOT_INVALID, if not equipped.
+
|brief       = Returns the [[INVENTORY_SLOT_*]] constant for the inventory slot this item is equipped in, or the [[INVENTORY_SLOT_*|INVENTORY_SLOT_INVALID]] constant, if not equipped.
|param1type=object
+
|param1type   = object
|param1name=oItem
+
|param1name   = oItem
|param1desc=The item in question
+
|param1desc   = the item in question
|returntype=int
+
|returntype   = int
|returndesc=The inventory slot, or INVENTORY_SLOT_INVALID, if not equipped.
+
|returndesc   = an [[INVENTORY_SLOT_*]] constant
|sourcefile=script.ldf
+
|sourcefile   = script.ldf
|sourcemodule=
+
|sourcemodule =
 
}}
 
}}
  
<!-- == Description == -->
+
== Description ==
 
<!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. -->
 
<!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. -->
 +
 +
See [[INVENTORY_SLOT_*]] constants for a list of values this function can return.
  
 
<!-- == Remarks == -->
 
<!-- == Remarks == -->
Line 24: Line 25:
 
<!-- This section contains links to articles, functions or constant groups. -->
 
<!-- This section contains links to articles, functions or constant groups. -->
  
[[Category: Uncategorised function]]
+
[[Category:Items functions]]

Latest revision as of 19:46, 3 August 2011

Returns the INVENTORY_SLOT_* constant for the inventory slot this item is equipped in, or the INVENTORY_SLOT_INVALID constant, if not equipped.

int GetItemEquipSlot(
object oItem
);
Parameters:
oItem
the item in question
Returns:

an INVENTORY_SLOT_* constant

Source:

script.ldf

Description

See INVENTORY_SLOT_* constants for a list of values this function can return.