Skins: |

NWN SCRIPTS

- Jump to comments -

Title

Describe Item

Author

Mhzentul Lafarius

Submitted / Updated

05-16-2004 / 11-22-2006

Category

Inventory Item

Expansions

HOTU-1.62

View Code

/* describeItem : Fully Describe the properties of an Item
 *
 * by Mhzentul Lafarius (mhzentul@yahoo.com)
 * Visit us at www.dormaeglinunderdark.com
*/

string describeItem(object oItem, string sDelim = "\n")
{
    string sD; // Description

    if (!GetIsObjectValid(oItem)) return "";

    // AC
    int nACValue = GetItemACValue(oItem);
    if (nACValue)
    {
        sD = sD + "AC: " + IntToString(nACValue) + sDelim;
    }

    itemproperty iProp = GetFirstItemProperty(oItem);
    while (GetIsItemPropertyValid(iProp))
    {
        // Get Property Text
        int nProp       = GetItemPropertyType(iProp);
        int nSub        = GetItemPropertySubType(iProp);
        int nParam      = GetItemPropertyParam1(iProp);
        int nParamValue = GetItemPropertyParam1Value(iProp);
        int nCost       = GetItemPropertyCostTable(iProp);
        int nCostValue  = GetItemPropertyCostTableValue(iProp);

        // Debug
        //sD = sD + IntToString(nProp) + " " + IntToString(nSub) + " " + IntToString(nParam) + " " + IntToString(nParamValue) + " " + IntToString(nCost)+ " " + IntToString(nCostValue);
        //sD = sD + "/n";

        // Property Name
        int nStrRef = StringToInt(Get2DAString("itemprops","StringRef",nProp));
        sD = sD + GetStringByStrRef(nStrRef);

        if (nProp > -1)
        {
            string sSub2DA = Get2DAString("itempropdef","SubTypeResRef",nProp);
            if (sSub2DA != "")
            {
                int nStrRef = StringToInt(Get2DAString(sSub2DA,"Name",nSub));
                sD = sD + " " + GetStringByStrRef(nStrRef);
            }
        }

        // Cost
        if (nCost)
        {
            string sCost2DA = Get2DAString("iprp_costtable","Name",nCost);
            if (sCost2DA != "")
            {
                int nStrRef = StringToInt(Get2DAString(sCost2DA,"Name",nCostValue));
                sD = sD + " " +  GetStringByStrRef(nStrRef) ;
            }
        }

        // Parameters
        if (nParam != 255)
        {
            string sParam2DA = Get2DAString("iprp_paramtable","TableResRef",nParam);
            if (sParam2DA != "")
            {
                int nStrRef = StringToInt(Get2DAString(sParam2DA,"Name",nParamValue));
                sD = sD + " " +  GetStringByStrRef(nStrRef) ;
            }
        }

        sD = sD + sDelim;
        iProp = GetNextItemProperty(oItem);
    }


    return sD;
}

/* Notes from the Lexicon...

The 2da file you find info for the return values of this
function is the iprop_costtable.2da file. In that file,
you can then use the "Name" field to know which .2da file
the GetItemPropertyCostTableValue for this particular
itemproperty refers to.

A return value of -1 means that the itemproperty doesn't
have a cost table number, or that the itemproperty isn't valid.

The 2da file you find info for the return values of this
function depends on the output of the GetItemPropertyCostTable
function.

Look at the individual ItemProperty functions to see what
(if anything) this function will return for that particular
itemproperty.

A return value of -1 means that the itemproperty has no
cost table value, or that the itemproperty isn't valid.

For instance, you may have a call to GetItemPropertyCostTable,
which returns 1. Looking in iprp_costtable.2da, you'll see
that this is the iprp_bonuscost.2da file. Then, the call
to GetItemPropertyCostTableValue might return 5.
Looking in your iprp_bonuscost.2da file,
you'll see that this means a bonus of 5.
A call to GetItemPropertySubType returns 1,
which is an ability. You thus know, from the above,
that you're dealing with an ability bonus of 5.

The 2da file you find info for the return values of this function
is the iprp_paramtable.2da file.

In that file, you can then use the "TableResRef" field to know
which .2da file the GetItemPropertyParam1Value for this particular
itemproperty refers to.

A return value of -1 occurs if the itemproperty has no param1
number, or if ipProp isn't a valid itemproperty.

For instance, you may have a call to GetItemPropertyParam1,
which returns 1. Looking in iprp_paramtable.2da, you'll see
that this is the iprp_onhitdur.2da file. Then, the call to
GetItemPropertyParam1Value might return 0. Looking in your
iprp_onhitdur.2da file, you'll see that this means 5 effect
change, 5 rounds duration.
*/

Select All Text | View Code in separate window

Format

Code Only

Type

Type - Other

Includes

BioWare Standard

Description

I wanted a quick way to provide the full properties in game of an item. I couldn't find anything so I coded this up. In our case we have a merchant describe an item they can make using a recipe, so the script creates the item in a blocked area, provides a full description to the player, and then destroys the item. The player can decide to proceed with the recipe based on the description of the item.