A base item type definition. More...

Public Member Functions
bool	IsPartUsingEnvMap (int partIndex)
	Gets if the specified part is using environment mapping.

Static Public Member Functions
static ? NwBaseItem	FromItemId (int itemId)
	Resolves a NwBaseItem from a base item id.

static ? NwBaseItem	FromItemType (BaseItemType itemType)
	Resolves a NwBaseItem from a BaseItemType.

static implicit	operator NwBaseItem? (BaseItemType itemType)

Properties
ACBonus	ACBonusType `[get]`
	The type of armor class bonus granted, if this item grants one.

BaseItemAmmunitionType	AmmunitionType `[get]`
	If this item is a ranged weapon, gets the ammunition type used.

byte	AnimSlashL `[get]`
	Gets the chance (expressed as a percentage) that a character wielding this weapon (item) will be animated as making a slash from the left during an attack.

byte	AnimSlashR `[get]`
	Gets the chance (expressed as a percentage) that a character wielding this weapon (item) will be animated as making a slash from the right during an attack.

byte	AnimSlashS `[get]`
	Gets the chance (expressed as a percentage) that a character wielding this weapon (item) will be animated as making a straight slash (from the center) during an attack.

byte	ArcaneSpellFailure `[get]`
	Gets the percentage this item adds to the chance for arcane spell failure. Not used for armor which uses armor.2da.

sbyte	ArmorCheckPenalty `[get]`
	Gets the armor check penalty inherent to this item. Not used for armor which uses armor.2da.

byte	BaseAC `[get]`
	Gets the armor class value of this shield (before enchantments). Not used for armor.

float	BaseCost `[get]`
	Gets the base value (in gold pieces) of an unenchanted item of this type.

StrRef	BaseItemStatsText `[get]`
	Gets the string containing basic statistics of this item. This is displayed under the description when an item is examined in the game.

bool	CanRotateIcon `[get]`
	Gets if the inventory icon for this item may be rotated 90 degrees clockwise, such as when placed on a player's quickbar.

BaseItemCategory	Category `[get]`

float	CostMultiplier `[get]`
	Gets the cost multiplier of the item. Used in the cost calculation of magical items, see itemprops.2da, itempropdef.2da, iprp_costtable.2da and iprp_paramtable.2da.

byte	CritMultiplier `[get]`
	The critical multiplier for this weapon (item).

byte	CritThreat `[get]`
	Gets the chance (out of 20) that this weapon (item) will threaten a critical hit. For example, "2" would mean two chances out of 20, for a threat range of 19-20.

string?	DefaultIcon `[get]`
	Gets the ResRef of the default icon that is used when the item's icon doesn't exist.

string?	DefaultModel `[get]`
	Gets the default model used when the item is lying on the ground.

StrRef	Description `[get]`
	Gets the default description for this item type. This is also used in game for items that lack specific descriptions.

byte	DieToRoll `[get]`
	Gets the number of sides of the dice rolled for this weapon's (item's) damage.

NwFeat?	EpicDevastatingCriticalFeat `[get]`
	Gets the character feat that allows devastating criticals to be performed with this item.

NwFeat?	EpicOverwhelmingCriticalFeat `[get]`
	Gets the character feat that allows overwhelming criticals to be performed with this item.

NwFeat?	EpicWeaponFocusFeat `[get]`
	Gets the character feat that provides epic weapon focus for this item.

NwFeat?	EpicWeaponSpecializationFeat `[get]`
	Gets the character feat that provides epic weapon specialization for this item.

EquipmentSlots	EquipmentSlots `[get]`
	Gets the inventory slots that this item may be equipped in.

uint	Id `[get]`
	Gets the id of this base item.

byte	ILRStackSize `[get]`
	Gets the stack size used when calculating this item's value in regards to item level restrictions.

NwFeat?	ImprovedCriticalFeat `[get]`
	Gets the character feat that allows improved criticals to be performed with this item.

Vector2Int	InventorySlotSize `[get]`
	Gets the size/number of inventory slots that this base item occupies.

byte	InvSoundTypeIndex `[get]`
	Gets the index in inventorysnds.2da indicating the sound used when this item is placed (or moved) in a character's inventory.

bool	IsContainer `[get]`
	Gets if this item is considered a container, and can contain other items, like a bag.

bool	IsGenderSpecific `[get]`
	Gets if the item changes appearance based on the gender of the possessor.

bool	IsMonkWeapon `[get]`
	Gets if this base item is a monk weapon.

bool	IsRangedWeapon `[get]`
	Gets if this base item is a ranged weapon.

bool	IsStackable `[get]`
	Gets if this item type can be stacked.

string	ItemClass `[get]`
	Gets the ResRef of the item's model, or the base part of the resref. This property is dependent on ModelType. See https://nwn.wiki/display/NWN1/baseitems.2da for more info.

byte	ItemPropertiesMax `[get]`
	Gets the maximum number of "cast spell" properties items of this type can be given when designed in the Toolset.

byte	ItemPropertiesMin `[get]`
	Gets the minimum number of "cast spell" properties items of this type must be given when designed in the Toolset.

byte	ItemPropertyColumnId `[get]`

BaseItemType	ItemType `[get]`
	Gets the associated BaseItemType for this base item.

int	MaxStackSize `[get]`
	Gets the maximum stack size for this base item.

float	ModelRangeMax `[get]`
	Gets the maximum allowed number of models of this type.

float	ModelRangeMin `[get]`
	Gets the minimum number of models of this type.

BaseItemModelType	ModelType `[get]`
	Gets a value indicating how much the look of this item can be customized.

StrRef	Name `[get]`
	Gets the base name of this item. Used for unidentified items.

byte	NumDamageDice `[get]`
	Gets the number of dice rolled for this weapon's (item's) damage.

float	PreferredAttackDistance `[get, set]`
	Gets or sets the preferred attack distance for this base item.

IEnumerable< NwFeat >	PrerequisiteFeats `[get]`
	Gets a list of feats that grants proficiency with this item. A character must be proficient with an item in order to equip or use it.

BaseItemQBBehaviour	QBBehaviour `[get]`
	Gets the behaviour when this property appears on the player's quick bar.

BaseItemRotation	RotateOnGround `[get]`
	Gets the rotation of the item model when laid on the ground.

byte	StartingCharges `[get]`
	Gets the starting number of charges this item has by default.

StoreCategory	StoreCategory `[get]`
	Gets where this item can be found in a store.

byte	StoreSortOrder `[get]`
	Gets a number indicating the order in which this item will be listed in a store.

CreatureSize	WeaponFinesseMinimumCreatureSize `[get]`
	Gets the minimum creature size required for this weapon (item) to be considered a finesse weapon, for the Feat.WeaponFinesse feat.

NwFeat?	WeaponFocusFeat `[get]`
	Gets the character feat that provides weapon focus for this item.

byte	WeaponMaterialTypeIndex `[get]`
	Gets an index into weaponsounds.2da indicating what sounds this weapon (item) makes when it hits an opponent.

NwFeat?	WeaponOfChoiceFeat `[get]`
	Gets the character feat that identifies this item as a weapon of choice.

BaseItemWeaponSize	WeaponSize `[get]`
	Gets the WeaponSize of this base item if the item is a weapon.

NwFeat?	WeaponSpecializationFeat `[get]`
	Gets the character feat that provides weapon specialization for this item.

IEnumerable< DamageType >	WeaponType `[get]`
	Gets the type/s of damage inflicted by this weapon (item).

BaseItemWeaponWieldType	WeaponWieldType `[get]`
	Gets the animation set is used when this item is wielded (equipped) in one of the weapon slots. May also affect which slots it can work in (eg; double sided weapons take both slots, and small creatures wielding larger weapons do so two handed).

decimal	Weight `[get]`
	Gets the base weight of this item in pounds.

Detailed Description

A base item type definition.

Member Function Documentation

◆ FromItemId()

static ? NwBaseItem Anvil.API.NwBaseItem.FromItemId ( int itemId )

inlinestatic

Resolves a NwBaseItem from a base item id.

Parameters

itemId The item id to resolve.

Returns: The associated NwBaseItem instance. Null if the base item id is invalid.

◆ FromItemType()

static ? NwBaseItem Anvil.API.NwBaseItem.FromItemType ( BaseItemType itemType )

inlinestatic

Resolves a NwBaseItem from a BaseItemType.

Parameters

itemType The item type to resolve.

Returns: The associated NwBaseItem instance. Null if the base item type is invalid.

◆ IsPartUsingEnvMap()

bool Anvil.API.NwBaseItem.IsPartUsingEnvMap ( int partIndex )

inline

Gets if the specified part is using environment mapping.

Parameters

partIndex The part index to query, 0, 1 or 2)

Returns: True if the specified part uses environment mapping, false if it does not and uses transparency instead.

The documentation for this class was generated from the following file:

NWN.Anvil/src/main/API/Ruleset/NwBaseItem.cs

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ FromItemId()

◆ FromItemType()

◆ IsPartUsingEnvMap()