ItemPropertyAttackBonusVsRace(int, int)

Sets an "attack bonus versus race" itemproperty.

itemproperty ItemPropertyAttackBonusVsRace(
    int nRace,
    int nBonus
);

Parameters

nRace

IP_CONST_RACIALTYPE_*

nBonus

Attack bonus; 1 to 20 are valid.

Description

Sets item property Attack bonus vs. racial group, such as Elf or Undead. You must specify the racial group constant (IP_CONST_RACIALTYPE_*) and the attack bonus, which should be an integer between 1 and 20.

Remarks

The itemproperty commands are special constructors - they construct an itemproperty "object" which can then be applied to an item using the AddItemProperty command, much like effects need to be first constructed, then applied with ApplyEffectToObject.

It will often be a good idea to remove similar itemproperties from the item first. There's a command in the "x2_inc_itemprop" include file called IPSafeAddItemProperty which will do that for you. Check IPSafeAddItemProperty for current bug report.

The IP_CONST_RACIALTYPE_* constant can be retrieved off this type of item property using GetItemPropertySubType. The bonus can be retrieved using GetItemPropertCostTableValue.

Version

1.61

Example

#include "x2_inc_itemprop"
//The include is for the IPSafeAddItemProperty function

//Grants the PC speaker's onhand weapon a +10 attack bonus against animals!
void main()
{
object oPC = GetPCSpeaker();
object oItem = GetItemInSlot(INVENTORY_SLOT_RIGHTHAND, oPC);
if (!GetIsObjectValid(oItem)) return;

itemproperty ipAdd = ItemPropertyAttackBonusVsRace(IP_CONST_RACIALTYPE_ANIMAL, 10);

IPSafeAddItemProperty(oItem, ipAdd);
}