Skins: |

NWN2 SCRIPTS

- Jump to comments -

Name

Item Level Restriction

Author

Kaldor Silverwand / Brendan Bellina

Submitted / Updated

09-14-2009 / 11-20-2009

Category

Scripting routines

Forum Thread

Link

Type

Type - Other

Format

Code Only

ShowCode

// k_bb_mod_player_equip (based on k_mod_player_equip from SoZ)
/*
    Module equip item script
    gets the tag of the item and calls:
    "i_<tag>_eq"
*/
// ChazM 3/1/05
// BMA-OEI 9/26/05 moved concat below string trim
// ChazM 10/20/05 - hook back in to the x2_mod_def* script
// ChazM 6/18/07 - Okku can't equip items
// ChazM 6/19/07 - Golem Ally can't equip items
// ChazM 6/21/07 - OneOfMany added to the evergrowing list of those who can't equip items
// ChazM 7/13/07 - Okku allowed to wear rings and amulets	
// ChazM 8/15/07 - send message indicating item can't be equipped.
// ChazM 8/16/07 - Okku Right Ring fix.
// TDE 6/20/08 - Adapted script for NX2

// Brendan Bellina aka "Kaldor Silverwand"
// 5/09 - commented out co_zarl check from SoZ;
// 9/09 - added support for Item Level Restrictions using module integer variables:
//       BB_ILR_NWN - Set to 1 to enforce Item Level Restriction for all equippable items using the NWN item value method
//       BB_ILR_NWN_ADJ - Value adjustment (positive or negative) to item value when calculating ILR when using BB_ILR_NWN
//       BB_ILR_NWN_DIV - Divide the required level by this number when using BB_ILR_NWN (0 is treated as 1)
//       BB_ILR_ENHBONUS - Set to 1 to turn on Item Level Restriction for weapons with an Enhancement Bonus
//       BB_ILR_ENHBONUS_MULT2 - instead of enh bonus plus 2, set to 1 to require enh bonus times 2 levels to equip weapons
//       BB_ILR_ACBONUS - Set to 1 to turn on Item Level Restriction for Armor and Shields with Armor Class Bonus
//       BB_ILR_ACBONUS_MULT2 - instead of AC bonus plus 2, set to 1 to require AC bonus times 2 levels to equip armor/shields
// 9/09 - added support for Item integer variables to also control Item Level Restrictions
//       BB_ILR - Set to level required to use a particular item. Overrides any module level ILR settings. Set to 1 for no ILR.

#include "ginc_item"

const int STR_REF_NOT_ALLOWED	= 210757;
const int NWN2_LEVEL_CAP		= 30; // This is the level cap in NWN2

//
// Function Prototypes
//

int GetLevelRequiredByValue (int nItemVal, int nAdjustment = 0);

//
// Functions
//

// Determine level required to equip an item based on the item cost.
// The level returned is based on the NWN table documented at <http://nwn.wikia.com/wiki/Item_level_restriction>.
// These values are also in the NWN2 2da file itemvalue.2da
// by Brendan Bellina, Sept, 2009
// - int nItemVal: the value of the item in gp
// - int nAdjustment: an optional positive or negative adjustment to the value 
int GetLevelRequiredByValue (int nItemVal, int nAdjustment = 0)
{
	int nRqdLevel = 0;
	nItemVal += nAdjustment;
	if (nItemVal <= 1000) nRqdLevel = 1;
	else if (nItemVal <= 1500) nRqdLevel = 2;
	else if (nItemVal <= 2500) nRqdLevel = 3;
	else if (nItemVal <= 3500) nRqdLevel = 4;
	else if (nItemVal <= 5000) nRqdLevel = 5;
	else if (nItemVal <= 6500) nRqdLevel = 6;
	else if (nItemVal <= 9000) nRqdLevel = 7;
	else if (nItemVal <= 12000) nRqdLevel = 8;
	else if (nItemVal <= 15000) nRqdLevel = 9;
	else if (nItemVal <= 19500) nRqdLevel = 10;
	else if (nItemVal <= 25000) nRqdLevel = 11;
	else if (nItemVal <= 30000) nRqdLevel = 12;
	else if (nItemVal <= 35000) nRqdLevel = 13;
	else if (nItemVal <= 40000) nRqdLevel = 14;
	else if (nItemVal <= 50000) nRqdLevel = 15;
	else if (nItemVal <= 65000) nRqdLevel = 16;
	else if (nItemVal <= 75000) nRqdLevel = 17;
	else if (nItemVal <= 90000) nRqdLevel = 18;
	else if (nItemVal <= 110000) nRqdLevel = 19;
	else if (nItemVal <= 130000) nRqdLevel = 20;
	else if (nItemVal <= 250000) nRqdLevel = 21;
	else if (nItemVal <= 500000) nRqdLevel = 22;
	else if (nItemVal <= 750000) nRqdLevel = 23;
	else if (nItemVal <= 1000000) nRqdLevel = 24;
	else nRqdLevel = (20 + nItemVal / 200000);
	if (nRqdLevel > 60) nRqdLevel = 60;

	return nRqdLevel;
}

void main()
{
    object oPC      = GetPCItemLastEquippedBy();
   	object oItem 	= GetPCItemLastEquipped();
		
	int bEquipForbidden = FALSE;

	// If Item has int variable BB_ILR then must be that level to equip, ignore any other ILR settings
	// Use this if you:
	//   - are not using an ILR system, but want a particular item to have an ILR
	//   - are using the BB_ILR_NWN system, but want a particular item to have a unique ILR (or set to 1 for no ILR)
	//   - are using the BB_ILR_ENHBONUS system, but want a particular enhanced weapon to have a unique ILR (or set to 1 for no ILR)
	//   - are using the BB_ILR_ACBONUS system, but want a particular armor suit or shield to have a unique ILR (or set to 1 for no ILR)
	if (!bEquipForbidden && GetLocalInt(oItem, "BB_ILR") > 0)
	{
		int nRqdLevel = GetLocalInt(oItem, "BB_ILR");
		if (nRqdLevel > NWN2_LEVEL_CAP) nRqdLevel = NWN2_LEVEL_CAP;
		int nLevel = GetTotalLevels(oPC, FALSE); // Do not include negative levels
		if (nLevel < nRqdLevel)
		{
			bEquipForbidden = TRUE;
			AssignCommand(oPC, ActionSpeakString(IntToString(nRqdLevel) + " levels are required to equip this item."));
		}
	}
	else
	{
		// If module has int variable BB_ILR_NWN == 1 or Item has int variable BB_ILR_NWN == 1 then use
		//  value to determine level requirement to equip.
		// Module int variable BB_ILR_NWN_ADJ can be used to adjust the value of the items.
		if (!bEquipForbidden && (GetLocalInt(GetModule(), "BB_ILR_NWN") == 1 || GetLocalInt(oItem, "BB_ILR_NWN") == 1))
		{
			// If BB_ILR_NWN module setting or Item setting then mimic the Item Level Restriction feature of NWN based on item cost.
			// Costs taken from <http://nwn.wikia.com/wiki/Item_level_restriction>.
			// The tag-based equip script will be executed after this only if the item can be equipped.
			int nItemValue = GetGoldPieceValue(oItem);
			int nRqdLevel = GetLevelRequiredByValue(nItemValue, GetLocalInt(GetModule(), "BB_ILR_NWN_ADJ"));
			int nILRDiv = GetLocalInt(GetModule(), "BB_ILR_NWN_DIV");
			if (nILRDiv != 0) nRqdLevel /= nILRDiv;
			if (nRqdLevel > NWN2_LEVEL_CAP) nRqdLevel = NWN2_LEVEL_CAP;
			int nLevel = GetTotalLevels(oPC, FALSE); // Do not include negative levels
			if (nLevel < nRqdLevel)
			{
				bEquipForbidden = TRUE;
				AssignCommand(oPC, ActionSpeakString(IntToString(nRqdLevel) + " levels are required to equip this item."));
			}
		}		
		
		// If module has int variable BB_ILR_ENHBONUS == 1 or Item has int variable BB_ILR_ENHBONUS == 1 then determine required level based on enhancement bonus.
		// Module int variable BB_ILR_ENHBONUS_MULT2 to use enh bonus times 2 instead of enh bonus plus 2.
		// This applies to handheld weapons only.
		if (!bEquipForbidden && (GetLocalInt(GetModule(), "BB_ILR_ENHBONUS") == 1 || GetLocalInt(oItem, "BB_ILR_ENHBONUS") == 1))
		{
			// If BB_ILR_ENHBONUS then only allow a player to equip an enhanced weapon in their hands
			// if they have enough levels of experience. By default they must have 2 levels more than the
			// weapon enhancement. If module variable BB_ILR_ENHBONUS_MULT2 is set to 1 then the required level
			// is instead two times the enhancement bonus.
			// The tag-based equip script will be executed after this only if the item can be equipped.
						
			if (GetItemHasItemProperty(oItem, ITEM_PROPERTY_ENHANCEMENT_BONUS))
			{
				int nSlot = GetSlotOfEquippedItem(oItem, oPC);
				if (nSlot == INVENTORY_SLOT_LEFTHAND || nSlot == INVENTORY_SLOT_RIGHTHAND)
				{
					int nLevel = GetTotalLevels(oPC, FALSE); // Do not include negative levels
					int nEnhBonus = IPGetWeaponEnhancementBonus(oItem);
					int nRqdLevel = 2 + nEnhBonus;
					if (GetLocalInt(GetModule(), "BB_ILR_ENHBONUS_MULT2") == 1)
						nRqdLevel = 2 * nEnhBonus;
					if (nRqdLevel > NWN2_LEVEL_CAP) nRqdLevel = NWN2_LEVEL_CAP;
					if (nLevel < nRqdLevel)
					{
						bEquipForbidden = TRUE;
						AssignCommand(oPC, ActionSpeakString(IntToString(nRqdLevel) + " levels are required to equip this +" + IntToString(nEnhBonus) + " item."));
					}
				}
			}	
		}

		// If module has int variable BB_ILR_ACBONUS == 1 or Item has int variable BB_ILR_ACBONUS == 1 then determine required level based on AC bonus.
		// Module int variable BB_ILR_ACBONUS_MULT2 to use AC bonus times 2 instead of enh bonus plus 2.
		// This applies to shields and armor (chest) only.
		if (!bEquipForbidden && (GetLocalInt(GetModule(), "BB_ILR_ACBONUS") == 1 || GetLocalInt(oItem, "BB_ILR_ACBONUS") == 1))
		{
			// If BB_ILR_ACBONUS then only allow a player to equip a shield or armor
			// if they have enough levels of experience. By default they must have 2 levels more than the
			// AC Bonus. If module variable BB_ILR_ACBONUS_MULT2 is set to 1 then the required level
			// is instead two times the AC bonus.
			// The tag-based equip script will be executed after this only if the item can be equipped.
						
			if (GetItemHasItemProperty(oItem, ITEM_PROPERTY_AC_BONUS))
			{
				int nBaseItemType = GetBaseItemType(oItem);
				if (nBaseItemType == BASE_ITEM_ARMOR || nBaseItemType == BASE_ITEM_LARGESHIELD ||
					nBaseItemType == BASE_ITEM_SMALLSHIELD || nBaseItemType == BASE_ITEM_TOWERSHIELD)
				{
					int nLevel = GetTotalLevels(oPC, FALSE); // Do not include negative levels
					int nACBonus = IPGetWeaponEnhancementBonus(oItem, ITEM_PROPERTY_AC_BONUS);
					int nRqdLevel = 2 + nACBonus;
					if (GetLocalInt(GetModule(), "BB_ILR_ACBONUS_MULT2") == 1)
						nRqdLevel = 2 * nACBonus;
					if (nRqdLevel > NWN2_LEVEL_CAP) nRqdLevel = NWN2_LEVEL_CAP;
					if (nLevel < nRqdLevel)
					{
						bEquipForbidden = TRUE;
						AssignCommand(oPC, ActionSpeakString(IntToString(nRqdLevel) + " levels are required to equip this +" + IntToString(nACBonus) + " item."));
					}
				}
			}	
		}
	}
	
	if (bEquipForbidden == TRUE)
	{
		AssignCommand(oPC, ActionUnequipItem(oItem));
		SendMessageToPCByStrRef(oPC, STR_REF_NOT_ALLOWED);
		return;
	}
	
	ExecuteScript("x2_mod_def_equ", OBJECT_SELF);
}

Select All Text | View Code in separate window

Patch

1.23

NWN2Game

All

Description

This module on equip script can be used to implement customizable Item Level Restrictions.

ILR can be implemented using the NWN system based on item values, or based on the enhancement and AC Bonus values of weapons, shields, and armor. The combination of module variables and item variables used allows for a great deal of customizability and special handling for exceptional items.

All variables are explained in the comment block at the top of the script.

Files

Name	Type	Size	Downloads
NO FILES

SCORE OUT OF 10

N/A
Cast Your Vote!
Voting FAQ

PORTFOLIO

Add this entry to your portfolio so you can track it

Manage your existing portfolios or create a new one.

SCREENS

No Images

You Must Be Logged In to Participate.

Comments (0):

You must be Logged In to post comments in this section.

NWN2 Voting Standards

10 - A Masterpiece, Genuinely Groundbreaking
9 - Outstanding, a Must Have
8 - Excellent, Recommended to Anyone
7 - Very Good, Deserves a Look
6 - Good, Qualified Recommendation
5 - Fair, Solid yet Unremarkable
4 - Some Merit, Requires Improvements
3 - Poor Execution, Potential Unrealized
2 - Very Little Appeal
1 - Not Recommended to Anyone