Difference between revisions of "CommandEquipItem"
From Dragon Age Toolset Wiki
(Generated by Sunjammer's Dragon Age Script Paser) |
BryanDerksen (Talk | contribs) m (looks okay, removing tag) |
||
(3 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | |||
{{dafunction | {{dafunction | ||
|name=CommandEquipItem | |name=CommandEquipItem | ||
Line 6: | Line 5: | ||
|param1name=oItem | |param1name=oItem | ||
|param1desc=the item that the object should equip | |param1desc=the item that the object should equip | ||
+ | |param1default= | ||
|param2type=int | |param2type=int | ||
|param2name=nEquipSlot | |param2name=nEquipSlot | ||
|param2desc=The optinal equip slot number. Use the INVENTORY_SLOT constants to specify a particular slot | |param2desc=The optinal equip slot number. Use the INVENTORY_SLOT constants to specify a particular slot | ||
+ | |param2default=INVENTORY_SLOT_INVALID | ||
|param3type=int | |param3type=int | ||
|param3name=nWeaponSet | |param3name=nWeaponSet | ||
|param3desc=The optinal weapon set number, it can be 0 or 1 | |param3desc=The optinal weapon set number, it can be 0 or 1 | ||
+ | |param3default=INVALID_WEAPON_SET | ||
|returntype=command | |returntype=command | ||
|returndesc=a valid command | |returndesc=a valid command | ||
Line 20: | Line 22: | ||
== 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. --> | ||
− | This function is an equip item command constructor. | + | This function is an equip item command constructor. It creates an equip item command which can then be added to any object's command queue. This command, when processed will attempt to equip the specified item on the object. |
− | It creates an equip item command which can then be added to any | + | |
− | object's command queue. This command, when processed will attempt | + | |
− | to equip the specified item on the object. | + | |
<!-- == Remarks == --> | <!-- == Remarks == --> |
Latest revision as of 18:04, 24 February 2010
This function is an equip item command constructor.
command CommandEquipItem(
object oItem,
int nEquipSlot = INVENTORY_SLOT_INVALID,
int nWeaponSet = INVALID_WEAPON_SET
);
object oItem,
int nEquipSlot = INVENTORY_SLOT_INVALID,
int nWeaponSet = INVALID_WEAPON_SET
);
- Parameters:
- oItem
- the item that the object should equip
- 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:
- a valid command
- Source:
- script.ldf
Description
This function is an equip item command constructor. It creates an equip item command which can then be added to any object's command queue. This command, when processed will attempt to equip the specified item on the object.