Difference between revisions of "EquipItem"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) (link, defaults, fix param2 desc) |
|||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 5: | Line 5: | ||
|param1name=oObject | |param1name=oObject | ||
|param1desc=The object to have its weapon set switched | |param1desc=The object to have its weapon set switched | ||
| + | |param1default= | ||
|param2type=object | |param2type=object | ||
|param2name=oItem | |param2name=oItem | ||
|param2desc=The item to be equipped. | |param2desc=The item to be equipped. | ||
| + | |param2default= | ||
|param3type=int | |param3type=int | ||
|param3name=nEquipSlot | |param3name=nEquipSlot | ||
| − | |param3desc=The | + | |param3desc=The optinal equip slot number. Use the INVENTORY_SLOT constants to specify a particular slot |
|param3default=INVENTORY_SLOT_INVALID | |param3default=INVENTORY_SLOT_INVALID | ||
|param4type=int | |param4type=int | ||
|param4name=nWeaponSet | |param4name=nWeaponSet | ||
| − | |param4desc=The | + | |param4desc=The optinal weapon set number, it can be 0 or 1 |
|param4default=INVALID_WEAPON_SET | |param4default=INVALID_WEAPON_SET | ||
|returntype=int | |returntype=int | ||
| − | |returndesc= | + | |returndesc= |
|sourcefile=script.ldf | |sourcefile=script.ldf | ||
|sourcemodule= | |sourcemodule= | ||
| Line 24: | Line 26: | ||
== 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. --> | ||
| − | Equips an item from the inventory into the equiped slots. If no equipment slot is given, the item will be equipped where it best fits. If the equip slot is in the weapon set it will be equipped in the weapon set number that is given. If no weapon set number is given the active weapon set will be used. If an incorrect slot is given or an invalid object is given the function will return 0. | + | Equips an item from the inventory into the equiped slots. If no equipment slot is given, the item will be equipped where it best fits. If the equip slot is in the weapon set it will be equipped in the weapon set number that is given. If no weapon set number is given the active weapon set will be used. If an incorrect slot is given or an invalid object is given the function will return 0. |
| − | + | == Remarks == | |
<!-- This section contains additional comments, observations and known issues. --> | <!-- This section contains additional comments, observations and known issues. --> | ||
| + | There is a bug if the item is ITEM_TYPE_AMMO (missing constant, value returned by [[GetItemType]] is 7) and no equipment slot is specified. The ammo fails to equip. If the script also equips a shield, the shield only appears on the inventory screen paper doll, not in game, until weapon sets are swapped in and out. The workaround is to specify INVENTORY_SLOT_RANGEDAMMO and a weapon set when equipping ammo. | ||
<!-- == Examples == --> | <!-- == Examples == --> | ||
Latest revision as of 16:58, 29 December 2010
Equips an item on a creature
int EquipItem(
object oObject,
object oItem,
int nEquipSlot = INVENTORY_SLOT_INVALID,
int nWeaponSet = INVALID_WEAPON_SET
);
object oObject,
object oItem,
int nEquipSlot = INVENTORY_SLOT_INVALID,
int nWeaponSet = INVALID_WEAPON_SET
);
- Parameters:
- oObject
- The object to have its weapon set switched
- oItem
- The item to be equipped.
- nEquipSlot
- The optinal equip slot number. Use the INVENTORY_SLOT constants to specify a particular slot
- nWeaponSet
- The optinal weapon set number, it can be 0 or 1
- Returns:
- [Undocumented]
- Source:
- script.ldf
Description
Equips an item from the inventory into the equiped slots. If no equipment slot is given, the item will be equipped where it best fits. If the equip slot is in the weapon set it will be equipped in the weapon set number that is given. If no weapon set number is given the active weapon set will be used. If an incorrect slot is given or an invalid object is given the function will return 0.
Remarks
There is a bug if the item is ITEM_TYPE_AMMO (missing constant, value returned by GetItemType is 7) and no equipment slot is specified. The ammo fails to equip. If the script also equips a shield, the shield only appears on the inventory screen paper doll, not in game, until weapon sets are swapped in and out. The workaround is to specify INVENTORY_SLOT_RANGEDAMMO and a weapon set when equipping ammo.
