Difference between revisions of "CommandEquipItem"

From Dragon Age Toolset Wiki
Jump to: navigation, search
m (1 revision: re-import with default parameter value parameters set)
m (looks okay, removing tag)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{Generated}}
 
 
{{dafunction
 
{{dafunction
 
|name=CommandEquipItem
 
|name=CommandEquipItem
Line 23: 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
);
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.