Skins: |
NWN SCRIPTS

- Jump to comments -
Title
Randomized NPC Armor and Clothing
Author
Cayle
Submitted / Updated
10-31-2002 / 11-22-2006
Category
Creature Related
Expansions
Works on all versions
View Code
// "cyl_chestslot"
// Include file for Cayle's Chest Slot Functions
// Copyright 2002
// By David "Cayle" Stocker
// dave-dani@t-online.de


// This function is used to decide whether to use armor or clothing.
int cayleGetChestSlotCategory(object oCreature= OBJECT_SELF ){
    object oArea = GetArea(oCreature);
    int nDefcon = GetLocalInt(oArea, "nDefcon");
    string sEntryLog = "Call cayleGetChestSlotCategory: Area=" + GetTag(oArea) + ", nDefcon=" + IntToString(nDefcon) + ", oCreature=" + GetTag(oCreature);
    WriteTimestampedLogEntry(sEntryLog);
    if(GetIsObjectValid(oCreature)){
    // Determine if oCreature has levels in magic user or monk
        int x;
        int nMagicuserMonk; //boolean in int's clothing
        int nCommoner;  //boolean in int's clothing
        for(x=0;x<3;x++){
            int nCurrentClass = GetClassByPosition(x, oCreature);
            switch(nCurrentClass){
                case CLASS_TYPE_SORCERER:
                case CLASS_TYPE_WIZARD:
                case CLASS_TYPE_MONK:
                    nMagicuserMonk = TRUE;
                    break;
                case CLASS_TYPE_COMMONER:
                    nCommoner = TRUE;
                    break;
                default:
                    break;
            }
        }
        if (nMagicuserMonk == TRUE)
            return 0;   //MU and monk always wear Clothing
        if (nDefcon < 2){
        //nDefcon=1  Weapons and armor are appropriate, no active combat.
        //nDefcon=0  Combat
            int nCommonerHasArmor = Random(10);
            if ((nCommoner == TRUE) && (nCommonerHasArmor > 0))
                return 0;   //Clothing
                // The commonor class may get FEAT_ARMOR_PROFICIENCY_LIGHT for free,
                // but I give commoners only a 10% chance of having any armor.
            else
                return 1;   //Armor
        }
        else
        //nDefcon=2  Weapons and armor are inappropriate.
            return 0;   //Clothing.
    }
    else {
    // This function was called with invalid or no oCreature.
        string sDebugMessage = "Error!  Invalid object oCreature in cayleGetChestSlotCategory call: " + GetTag(oCreature);
        SendMessageToPC(GetFirstPC(), sDebugMessage);
        SendMessageToAllDMs(sDebugMessage);
        WriteTimestampedLogEntry(sDebugMessage);
        return 0;
    }
}



//Determine Heavy/Med/Light armor or which clothing category.
 string cayleGetChestSlotSubCategory(int nCayleChestSlotCategory, object oCreature = OBJECT_SELF){
    string sEntryLog = "Call cayleGetChestSlotSubCategory: " + IntToString(nCayleChestSlotCategory) + ", " + GetTag(oCreature);
    WriteTimestampedLogEntry(sEntryLog);
    if (nCayleChestSlotCategory ==1){
        // Assign armor category.
        // Higher levels tend to have heavier armor.
        // Do not assign an Armor that is too heavy for the Dex modifier.
        // To Do: Check against move silently and hide.
        int nDexModifier = GetAbilityModifier(ABILITY_DEXTERITY, oCreature);
        int nCreatureLevel = GetHitDice(oCreature);
        if ( (GetHasFeat(FEAT_ARMOR_PROFICIENCY_HEAVY) == TRUE) &&
             (nDexModifier < 2) &&
             (Random(10) < nCreatureLevel) )
            return "HEAVY";
        else if ( (GetHasFeat(FEAT_ARMOR_PROFICIENCY_MEDIUM) == TRUE) &&
                  (nDexModifier < 4)  &&
                  (Random(10) < nCreatureLevel) )
            return "MEDIUM";
        else if ( (GetHasFeat(FEAT_ARMOR_PROFICIENCY_LIGHT) == TRUE)&&
                  (nDexModifier < 7))
            return "LIGHT";
        else {
        // Character has no armor feats.  They will be assigned clothing.
            string sDebugMessage = "Creature " + GetTag(oCreature) + "has no armor feats and will be assigned clothing";
            SendMessageToPC(GetFirstPC(), sDebugMessage);
            SendMessageToAllDMs(sDebugMessage);
            WriteTimestampedLogEntry(sDebugMessage);
            return "CLOTHING";
        }
    }
    else
        return "CLOTHING";
}


//Get the actual item type.
// The resource reference will ultimately look like ("ResRefItemBase" + "two digit numerical index".  E.g. ocayleaasplint21.
// Some return values have a zero at the end and some do not.  This is simply an inconsistiency in toolset usage.
// Aurora will self index if the number at the end has three digits, but I will not go to the effort to switch everything to the 0xx schema.
//
// NOTE: If this function is called directly and the dex modifier is more than highest possible with that armor type,
//  the creature will be equiped with the lightest armor in that class.  *** Be carefull with direct calls of this function! ***
string cayleGetResRefItemBase(string sCayleChestSlotSubCategory = "CLOTHING", object oCreature = OBJECT_SELF){
    string sEntryLog = "Call cayleGetResRefItemBase: " + sCayleChestSlotSubCategory + ", " + GetTag(oCreature);
    WriteTimestampedLogEntry(sEntryLog);
    string sResRefItemBase;
    if (sCayleChestSlotSubCategory == "HEAVY"){
        // The choice of heavy Armor is based on level.
        if (Random(20) < GetHitDice(oCreature))
            sResRefItemBase = "ocayleaafp0";   // Full Plate
        else if (Random(15) < GetHitDice(oCreature))
            sResRefItemBase = "ocayleaahp0";   // Half Plate
        else if (Random(10) < GetHitDice(oCreature))
            sResRefItemBase = "ocayleaasplint";    // Splint
        else
            sResRefItemBase = "ocayleaabandml";  // Banded, Default
    }
    else if (sCayleChestSlotSubCategory == "MEDIUM"){
        // The choice of medium armor is based on level and dex modifier.  There is also a pure random element.
        if (Random(10) < GetHitDice(oCreature) && (GetAbilityModifier(ABILITY_DEXTERITY, oCreature) < 3)){
            int nRandomChoice = Random(2);
            switch(nRandomChoice){
                case 0:
                    sResRefItemBase = "ocayleaabp";    //Breast Plate
                    break;
                case 1:
                default:
                    sResRefItemBase = "ocayleaachain"; //Chain Mail
                    break;
            }
        }
        else {
            int nRandomChoice = Random(2);
            switch(nRandomChoice){
                case 0:
                    sResRefItemBase = "ocayleaascale"; //Scale Mail
                    break;
                case 1:
                default:
                    sResRefItemBase = "ocayleaacshrt0";    //Chain Shirt
                    break;
            }
        }
    }
    else if (sCayleChestSlotSubCategory == "LIGHT"){
        // The choice of light armor is based on level and dex modifier.  There is also a pure random element.
        // I did not include padded and hide as I do not use them very often.
        if (Random(5) < GetHitDice(oCreature) && (GetAbilityModifier(ABILITY_DEXTERITY, oCreature) < 5))
            sResRefItemBase = "ocayleaastlth0";    //Studded Leather
        else
            sResRefItemBase = "ocayleaalthr0";   //Leather
    }
    else if (sCayleChestSlotSubCategory == "CLOTHING"){
        // For Clothing:
        //Assignment based on Class, Faction and Level.  Ranger, Druid and Barbarian
        // always wear "Simple" category clothing. Otherwise, high level NPCs wear "Fine",
        // and low level NPCs wear "Simple".
        // "ocayleclothsp" = Simple and "ocayleclothno"=Fine
        //string sCreatureFaction = "DEFENDER";
        int x;
        int nwaldlaufer;    //boolean in int's clothing
        for(x=0;x<3;x++){
            int current_class = GetClassByPosition(x, oCreature);
            switch(current_class){
                case CLASS_TYPE_BARBARIAN:
                case CLASS_TYPE_DRUID:
                case CLASS_TYPE_RANGER:
                    nwaldlaufer = TRUE;
                    break;
                default:
                    break;
            }
        }
        if (nwaldlaufer == TRUE)
            sResRefItemBase = "ocayleclothsp0";
        else{
            if (Random(10) < GetHitDice(oCreature))
                sResRefItemBase = "ocayleclothno0";
            else  sResRefItemBase = "ocayleclothsp0";
        }
    }
    else {
    // An unsupported sCayleChestSlotSubCategory has been chesen
        string sDebugMessage = "Error!  Creature " + GetTag(oCreature) + "has an unsupported sCayleChestSlotSubCategory.  Default to Simple Tunic.";
        SendMessageToPC(GetFirstPC(), sDebugMessage);
        SendMessageToAllDMs(sDebugMessage);
        WriteTimestampedLogEntry(sDebugMessage);
        sResRefItemBase = "ocayleclothsp0";  //Default
    }
    return sResRefItemBase;
    SendMessageToPC(GetFirstPC(), sResRefItemBase);
}


string cayleGetChestSlotEquipment(string sCayleResRefItemBase, int nCayleRoll = 1){
    string sEntryLog = "Call cayleGetChestSlotEquipment: " + sCayleResRefItemBase + ", " + IntToString(nCayleRoll);
    WriteTimestampedLogEntry(sEntryLog);
    if (GetStringLength(sCayleResRefItemBase) > 0){
        if ( nCayleRoll < 10)
            sCayleResRefItemBase = sCayleResRefItemBase + "0";
        string sCayleResRefChest = sCayleResRefItemBase +IntToString(nCayleRoll);
        return sCayleResRefChest;
    }
    else{
    // cayleGetChestSlotEquipment called without sCayleResRefItemBase param.  Leather Armor used as badger.  To be changed to plain clothing later.
        string sDebugMessage = "Error!   cayleGetChestSlotEquipment called with invalid parameter: " + sCayleResRefItemBase +".  Default value -ocayleaalthr0- will be used.";
        SendMessageToPC(GetFirstPC(), sDebugMessage);
        SendMessageToAllDMs(sDebugMessage);
        WriteTimestampedLogEntry(sDebugMessage);
        string sCayleResRefChest = "ocayleaalthr0" + IntToString(nCayleRoll);
        return sCayleResRefChest;
    }
}

int cayleGetResRefArraySize(string sCayleResRefItemBase){
    string sEntryLog = "Call cayleGetResRefArraySize: " + sCayleResRefItemBase;
    WriteTimestampedLogEntry(sEntryLog);
    if (sCayleResRefItemBase == "ocayleclothsp0")
        return 55;
    else if (sCayleResRefItemBase == "ocayleclothno0")
        return 50;
    else if ((sCayleResRefItemBase == "ocayleaafp0")||
            (sCayleResRefItemBase == "ocayleaahp0")||
            (sCayleResRefItemBase == "ocayleaasplint")||
            (sCayleResRefItemBase == "ocayleaabandml")||
            (sCayleResRefItemBase == "ocayleaachain")||
            (sCayleResRefItemBase == "ocayleaascale")||
            (sCayleResRefItemBase == "ocayleaacshrt0")||
            (sCayleResRefItemBase == "ocayleaabp")||
            (sCayleResRefItemBase == "ocayleaastlth0")||
            (sCayleResRefItemBase == "ocayleaalthr0"))
        return 35;
    else if (sCayleResRefItemBase == "ocaylehlm0")
        return 27;
    else {
        // An unsupported or no sCayleResRefItemBase has been chosen
        string sDebugMessage;
        if (GetStringLength(sCayleResRefItemBase) > 0)
            sDebugMessage = "Error!  cayleGetResRefArraySize called with unsupported sCayleResRefItemBase: " + sCayleResRefItemBase ;
        else  sDebugMessage = "Error!   cayleGetResRefArraySize called with no sCayleResRefItemBase";
        SendMessageToPC(GetFirstPC(), sDebugMessage);
        SendMessageToAllDMs(sDebugMessage);
        WriteTimestampedLogEntry(sDebugMessage);
        return 1;   //Default
    }
}

// This function generates a random number between 1 and nCayleResRefArraySize
int cayleGetRoll(int nCayleResRefArraySize = 1){
    string sEntryLog = "Call cayleGetRoll: " + IntToString(nCayleResRefArraySize);
    WriteTimestampedLogEntry(sEntryLog);
    if (nCayleResRefArraySize > 0){
        int nRoll = Random(nCayleResRefArraySize);
        nRoll++;    // Random() generates a number between 0 and n-1, we want a number between 1 and n.
        return nRoll;
    }
    else{
    // Someone called cayleGetRoll(0) or cayleGetRoll("something weird").
        string sDebugMessage = "Error!   cayleGetRoll called with invalid parameter: " + IntToString(nCayleResRefArraySize) +".  Default value -One- will be returned.";
        SendMessageToPC(GetFirstPC(), sDebugMessage);
        SendMessageToAllDMs(sDebugMessage);
        WriteTimestampedLogEntry(sDebugMessage);
        return 1;   //Default
    }
}


//Will we be creating a helm?
// This function can determine if an NPC should be spawned with a helmet.
// The logic is that the likeliehood of wearing a helm is a function of how heavy the armor of the NPC is.
// The heavier the armor, the greater the likelihood of wearing a helm.
// With Leather, the likelihood is also a function of class.
// If Defcon is set to 2, no helmet will be made.
// Returns TRUE or FALSE.
int cayleGetHelmFlag(string sCayleChestSlotSubCategory = "CLOTHING", object oCreature = OBJECT_SELF){
    object oArea = GetArea(oCreature);
    int nDefcon = GetLocalInt(oArea, "nDefcon");
    string sEntryLog = "Call cayleGetHelmFlag: "+ IntToString(nDefcon) + ", " + sCayleChestSlotSubCategory + ", " + GetTag(oCreature);
    WriteTimestampedLogEntry(sEntryLog);
    int nHelmFlag = FALSE;
    if (nDefcon < 2){
        if ((sCayleChestSlotSubCategory == "HEAVY") && (Random(10) > 0))
            // 90% chance for characters with heavy armor.
            nHelmFlag = TRUE;
        else if ((sCayleChestSlotSubCategory == "MEDIUM") && (Random(10) > 4))
            // 50% chance for characters with heavy armor.
            nHelmFlag = TRUE;
        else if (sCayleChestSlotSubCategory == "LIGHT"){
            int x;
            for(x=0;x<3;x++){
                int nCurrentClass = GetClassByPosition(x, oCreature);
                if (( (nCurrentClass == CLASS_TYPE_BARBARIAN)||
                      (nCurrentClass == CLASS_TYPE_FIGHTER)||
                      (nCurrentClass == CLASS_TYPE_PALADIN)||
                      (nCurrentClass == CLASS_TYPE_CLERIC)) && (Random(10) < 4))
                    // 50% Chance if NPC is a heavy weapon class.
                    nHelmFlag = TRUE;
                 else if ((nCurrentClass == CLASS_TYPE_COMMONER) && (Random(10) < 2))
                    // 10% Chance if NPC is a commoner.
                    nHelmFlag = TRUE;
                 else if (Random(100) < 0)
                    // 1% Chance if the NPC is another class (e.g. Druid, Ranger, Theif)
                    // which does not normally wear a helm because of stealth, etc.
                    nHelmFlag = TRUE;
             }
        }
    }
    // nHelmFlag = "FALSE" by default.
    return nHelmFlag;
}


//Determine Helmet Type.  No error checking is done.  If this function is called, it will retrun a ocaylehelm0xx resref.
string cayleGetHelmetEquipment(string sCayleResRefItemBase){
    string sEntryLog = "Call cayleGetHelmetEquipment: " + sCayleResRefItemBase;
    WriteTimestampedLogEntry(sEntryLog);
    SendMessageToPC(GetFirstPC(), sEntryLog);
    string sHelmBase = "ocaylehlm0";
    int ResRefArraySize = cayleGetResRefArraySize(sHelmBase);
    int nHelmRoll = 0;
    if ( (sCayleResRefItemBase == "ocayleaafp0")||
         (sCayleResRefItemBase == "ocayleaahp0")||
         (sCayleResRefItemBase == "ocayleaasplint")||
         (sCayleResRefItemBase == "ocayleaabandml")) {
        while ( (nHelmRoll == 0) || (nHelmRoll == 3) || (nHelmRoll == 6) ||
                (nHelmRoll == 9) || (nHelmRoll == 12) || (nHelmRoll == 13) ||
                (nHelmRoll == 14) || (nHelmRoll == 18) || (nHelmRoll == 23) ){
            nHelmRoll = cayleGetRoll(ResRefArraySize);
        }
     }
    else if ( (sCayleResRefItemBase == "ocayleaachain")||
               (sCayleResRefItemBase == "ocayleaabp")||
               (sCayleResRefItemBase == "ocayleaascale")||
               (sCayleResRefItemBase == "ocayleaacshrt0")) {
        while ( (nHelmRoll < 3) || (nHelmRoll == 4) || (nHelmRoll == 5) ||
                (nHelmRoll == 7) || (nHelmRoll == 8) || (nHelmRoll == 10) ||
                (nHelmRoll == 11) || (nHelmRoll == 17) || (nHelmRoll == 19) ||
                (nHelmRoll == 20) || (nHelmRoll == 21) || (nHelmRoll == 22) ||
                (nHelmRoll > 23)){
            nHelmRoll = cayleGetRoll(ResRefArraySize);
        }
     }
    else if ( (sCayleResRefItemBase == "ocayleaastlth0")||
               (sCayleResRefItemBase == "ocayleaalthr0")) {
        while ( (nHelmRoll < 3) || (nHelmRoll == 4) || (nHelmRoll == 5) ||
                (nHelmRoll == 7) || (nHelmRoll == 8) || (nHelmRoll == 10) ||
                (nHelmRoll == 11) || (nHelmRoll == 17) || (nHelmRoll > 19)){
            nHelmRoll = cayleGetRoll(ResRefArraySize);
        }
    }
    else {
    // An unsupported or no sCayleResRefItemBase has been chosen
        string sDebugMessage;
        if (GetStringLength(sCayleResRefItemBase) > 0)
            sDebugMessage = "Error!  cayleGetHelmetEquipment called with unsupported sCayleResRefItemBase: " + sCayleResRefItemBase ;
        else
            sDebugMessage = "Error!   cayleGetHelmetEquipment called with no sCayleResRefItemBase";
        SendMessageToPC(GetFirstPC(), sDebugMessage);
        SendMessageToAllDMs(sDebugMessage);
        WriteTimestampedLogEntry(sDebugMessage);
        // Pick the number extension any of the possible helms.  They may not match the armor.
        nHelmRoll = 16;   // This is the only helm that is used with all armor types.

    }
    string sHelm = sHelmBase + IntToString(nHelmRoll);
    return sHelm;
}

/*********************************************
**   Combined Dress/Armor Functions
**   These functions call the utilities above.
*********************************************/
// Equip as appropriate for the type chosen (HEAVY, MEDIUM, LIGHT or CLOTHING)
void ActionDressOrArmorBySubCategory(string sChestSlotSubCategory, object oCreature = OBJECT_SELF){
    object oArea = GetArea(oCreature);
    int nDefcon = GetLocalInt(oArea, "nDefcon");
    string sResRefItemBase = cayleGetResRefItemBase(sChestSlotSubCategory,oCreature);
    int ResRefArraySize = cayleGetResRefArraySize(sResRefItemBase);
    int Roll = cayleGetRoll(ResRefArraySize);
    string sNewArmor = cayleGetChestSlotEquipment(sResRefItemBase, Roll);
    object oNewArmor = CreateItemOnObject( sNewArmor, oCreature);
    AssignCommand(oCreature, ActionEquipItem(oNewArmor,INVENTORY_SLOT_CHEST));
    string sMessage = sNewArmor + "  ResRefArraySize=" + IntToString(ResRefArraySize) + "  Roll=" + IntToString(Roll);
    int nGetHelmFlag = cayleGetHelmFlag(sChestSlotSubCategory, oCreature);
    if (nGetHelmFlag == TRUE){
        SendMessageToPC(GetFirstPC(), "nGetHelmFlag set");
        ResRefArraySize = cayleGetResRefArraySize("ocaylehlm0");
        Roll = cayleGetRoll(ResRefArraySize);
        string sNewHelm = cayleGetHelmetEquipment(sResRefItemBase);
        object oNewHelm = CreateItemOnObject(sNewHelm, oCreature);
        if (nDefcon < 1)  {
            AssignCommand(oCreature, ActionEquipItem(oNewHelm,INVENTORY_SLOT_HEAD));
        }
    }
}

// Choose between clothing or armor and equip
void ActionDressOrArmorNPC(object oCreature = OBJECT_SELF){
    object oArea = GetArea(oCreature);
    int nDefcon = GetLocalInt(oArea, "nDefcon");
    int nChestSlotCategory = cayleGetChestSlotCategory(oCreature);
    string sChestSlotSubCategory = cayleGetChestSlotSubCategory(nChestSlotCategory, oCreature);
    ActionDressOrArmorBySubCategory(sChestSlotSubCategory,oCreature);
}

// Equip by type (Resource Ref base), e.g "ocayleaabp"
// This will not auto equip a helmet.
void ActionDressOrArmorByType(string sResRefItemBase, object oCreature = OBJECT_SELF){
    int ResRefArraySize = cayleGetResRefArraySize(sResRefItemBase);
    int Roll = cayleGetRoll(ResRefArraySize);
    string sNewArmor = cayleGetChestSlotEquipment(sResRefItemBase, Roll);
    object oNewArmor = CreateItemOnObject( sNewArmor, oCreature);
    AssignCommand(oCreature, ActionEquipItem(oNewArmor,INVENTORY_SLOT_CHEST));
    string sMessage = sNewArmor + "  ResRefArraySize=" + IntToString(ResRefArraySize) + "  Roll=" + IntToString(Roll);
    SendMessageToPC(GetFirstPC(), sMessage);
}

// This is a cut down version used just to clothe the NPC.
// It eliminates the Defcon checking, does not call the helmet functions
// and sChestSlotSubCategory is hardcoded as "CLOTHING".
void ActionDressNPC(object oCreature = OBJECT_SELF){
    string sChestSlotSubCategory = "CLOTHING";
    string sResRefItemBase = cayleGetResRefItemBase(sChestSlotSubCategory,oCreature);
    ActionDressOrArmorByType(sResRefItemBase, oCreature);
}
Select All Text | View Code in separate window
Format
Module and Code
Type
Type - Appearance
Includes
None
Description
This is an include file with scripts to randomize NPC appearance (with regard to armor and clothing) and two item erfs design to work with the scripts. There is a small demo mod showing how it all comes together.
Files

Name	Type	Size	Downloads
ChestSlot.zipChestSlot.zip Submitted: 10-31-2002 / Last Updated: 10-31-2002	zip	429.79Kb	733
--
SCORE OUT OF 10
9.5
3 votes
View Stats
Cast Your Vote!
PORTFOLIO
Add this entry to your portfolio so you can track it
Manage your existing portfolios or create a new one.
SCREENS
You Must Be Logged In to Participate.
Comments (3):
Posted by yoid at 2007-02-28 05:02:58 Voted 10.00 on 02/28/07
Very useful !
Posted by diavlen at 2006-02-17 21:47:59 Voted 9.50 on 02/17/06
This is a nice script. It's easy to use. The only set back is that it requires the builder to import a bunch of customized items. It would be nice to have one item that could be customized randomly. However, this isn't a bad solution at all.
_________________________
Borgo Pass PW
Link
Posted by Old_Scores_Transfered at 2004-02-20 10:29:22 Voted 9.00 on 02/20/04
This is a compilation of the old system into a single score. There were 1 that made this score of 9 then rounded to 9.
You must be Logged In to post comments in this section.