ItemPropertyFreeAction()

Sets a free action (freedom of movement) itemproperty.

itemproperty ItemPropertyFreeAction();

Description

Sets item property Free action, which can be applied to an item to grant Freedom of movement.

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.

[NT-ed.]

Version

1.61

Example

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

//Makes the PC speaker's amulet grant freedom of movement
void main()
{
object oPC = GetPCSpeaker();
object oItem = GetItemInSlot(INVENTORY_SLOT_NECK, oPC);
if (!GetIsObjectValid(oItem)) return;

itemproperty ipAdd = ItemPropertyFreeAction();

IPSafeAddItemProperty(oItem, ipAdd);
}

See Also

functions:	AddItemProperty | IPSafeAddItemProperty
categories:	Item Creation Functions

---

 author: Lilac Soul, editor: Peter Busby