X2 inc itemprop

From NWN Lexicon
Jump to: navigation, search



x2_inc_itemprop

Library for item property and item modification specific code.
 
If you are looking for anything specific to item properties, your chances are good to find it in here.

Constants

Name Value Brief Description
X2_IP_ADDRPOP_2DA des_crft_props 2da for the AddProperty ItemProperty.
X2_IP_ADDPROP_POLICY_KEEP_EXISTING 1 Policy constant for IPSafeAddItemProperty().
X2_IP_ADDPROP_POLICY_IGNORE_EXISTING 2 Policy constant for IPSafeAddItemProperty().
X2_IP_ADDPROP_POLICY_REPLACE_EXISTING 0 Policy constant for IPSafeAddItemProperty().
X2_IP_ARMORAPPEARANCE_2DA des_crft_appear 2da for armor appearance.
X2_IP_ARMORPARTS_2DA des_crft_aparts 2da for armor parts.
X2_IP_ARMORTYPE_NEXT 0 Used with the armor modification system.
X2_IP_ARMORTYPE_PREV 1 Used with the armor modification system.
X2_IP_ARMORTYPE_RANDOM 2 Used with the armor modification system.
XP_IP_ITEMMODCONVERSATION_CTOKENBASE 12220 Base custom token for item modification conversations.
X2_IP_ITEMMODCONVERSATION_MODE_CRAFT 1 Base custom token for item modification conversations.
X2_IP_ITEMMODCONVERSATION_MODE_TAILOR 0 Base custom token for item modification conversations.
X2_IP_MAX_ITEM_PROPERTIES 8 Number of maximum item properties allowed on most items.
X2_IP_POISONWEAPON_2DA des_crft_poison 2da for the Poison Weapon Itemproperty.
X2_IP_WEAPONTYPE_NEXT 0 Used with the armor modification system.
X2_IP_WEAPONTYPE_PREV 1 Used with the armor modification system.
X2_IP_WEAPONTYPE_RANDOM 2 Used with the armor modification system.
X2_IP_WORK_CONTAINER_TAG x2_plc_ipbox The tag of the ip work container, a placeable which has to be set into each module that is using any of the crafting functions.


Functions

Name Brief Description

IPCopyItemProperties

Internal function. Copies all permanent item properties from one object to another.

IPCreateAndModifyArmorRobe

Internal function. Copies an armor object and changes its appearance.

IPCreateProficiencyFeatItemOnCreature

Internal function. Gives a creature all available proficiency feats.

IPDyeArmor

Changes the color of an armor.

IPGetArmorAppearanceType

Internal function. Returns an armor appearance type for the specified armor model.

IPGetDamageBonusConstantFromNumber

Converts a number into a damage bonus itemproperty constant.

IPGetDamagePowerConstantFromNumber

Converts a number to a damage power constant

IPGetHasItemPropertyByConst

Internal function. Returns whether an item has an itemproperty.

IPGetHasItemPropertyOnCharacter

Returns whether a character has an item with a certain itemproperty type equipped.

IPGetHasUseLimitation

Internal function. Returns whether an item has any usage limitations.

IPGetIPConstCastSpellFromSpellID

Returns a spell's corresponding itemproperty constant.

IPGetIPWorkContainer

Returns the container used for item property and appearance modifications in the module

IPGetIsBludgeoningWeapon

Checks if an item is a bludgeoning weapon.

IPGetIsIntelligentWeapon

Returns whether an item has the intelligent itemproperty.

IPGetIsItemEquipable

Checks if an item can be equipped.

IPGetIsMeleeWeapon

Checks if an item is a melee weapon.

IPGetIsProjectile

Checks if an item is a projectile.

IPGetIsRangedWeapon

Checks if an item is a ranged weapon.

IPGetItemHasItemOnHitPropertySubType

Checks if an item has a specified onhit subtype itemproperty.

IPGetItemHasProperty

Checks if an item has a matching itemproperty.

IPGetItemPropertyByID

Returns an itemproperty.

IPGetItemSequencerProperty

Checks the sequencer property of an item.

IPGetModifiedArmor

Copies and modifies an armor and returns it as an object.

IPGetModifiedWeapon

Internal function. Returns a copy of a weapon with the appearance of one weapon part modified.

IPGetNextArmorAppearanceType

Returns the next valid appearance type for an armor.

IPGetNumberOfAppearances

Returns the number of armor part variations for the specified part.

Does not work. Function is prototyped but not implemented.

IPGetNumberOfArmorAppearances

Internal function. Returns the number of possible appearance types for the specified armor model (armor part).

IPGetNumberOfItemProperties

Returns the number of item properties present on an item.

IPGetPrevArmorAppearanceType

Returns the armor's previous valid appearance type for the specified part.

IPGetRandomArmorAppearanceType

Returns a random valid armor appearance type of the appropriate part.

IPGetTargetedOrEquippedArmor

Internal function. Returns the equipped armor or shield of a spell target.

IPGetTargetedOrEquippedMeleeWeapon

Internal function. Returns the equipped melee weapon of a spell target.

IPGetWeaponAppearanceType

Internal function. Returns a weapon appearance type for the specified weapon part.

IPGetWeaponEnhancementBonus

Returns a weapon's enhancement bonus.

IPRemoveAllItemProperties

Removes all itemproperties from an item.

IPRemoveMatchingItemProperties

Removes itemproperties of a given type, duration, and subtype from an item.

IPSafeAddItemProperty

Safely add an itemproperty to an item.

IPSetWeaponEnhancementBonus

Sets an enhancement bonus on a weapon.

IPUpgradeWeaponEnhancementBonus

Upgrades a weapon's enhancement bonus.

IPWildShapeCopyItemProperties

Copies itemproperties from one item to another.



 author: Charles Feduke, editors: Mistress, Kolyana, contributor: motu99