WoW:API CursorCanGoInSlot: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Added notes for CursorCanGoInSlot)
 
(boilerplate)
Line 1: Line 1:
{{wowapi}} __NOTOC__
{{wowapi}} __NOTOC__
<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->
Determines if the item in the cursor can be equipped in the specified inventory slot.  Always returns 1 for bank bag slots.
Determines if the item in the cursor can be equipped in the specified inventory slot.  Always returns 1 for bank bag slots.
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
  fitsInSlot = CursorCanGoInSlot(invSlot)
  isTrue = CursorCanGoInSlot([[inventorySlotId|invSlot]])
 


== Arguments ==
== Arguments ==
<!-- List each argument, together with its type -->
; invSlot : Number ([[inventorySlotId]]) - Inventory slot to query
:([[inventorySlotId|invSlot]])
 
:;arg1 : Number - [[inventorySlotId|Inventory Slot]]
 


== Returns ==
== Returns ==
<!-- List each return value, together with its type -->
; fitsInSlot : Flag - 1 if the thing currently on the cursor can go into the specified slot, nil otherwise.
:;isTrue : Boolean - 1 if true, nil otherwise

Revision as of 12:34, 4 April 2010

WoW API < CursorCanGoInSlot

Determines if the item in the cursor can be equipped in the specified inventory slot. Always returns 1 for bank bag slots.

fitsInSlot = CursorCanGoInSlot(invSlot)

Arguments

invSlot
Number (inventorySlotId) - Inventory slot to query

Returns

fitsInSlot
Flag - 1 if the thing currently on the cursor can go into the specified slot, nil otherwise.