GetInventoryDisturbType
GetInventoryDisturbType()
Determines the type of disturbance of an inventory.
Description
Returns the type of disturbance (INVENTORY_DISTURB_TYPE_*) that caused the caller's OnInventoryDisturbed script to fire.
Remarks
This function only applies to creatures and placeables.
On creatures, it seems only the stolen disturbance type will fire. Placeables cannot have items stolen from them, so they should only return one of the other two values.
Known Bugs
It has been previously noted that the event OnDisturbed does not fire when the item being disturbed is gold. There's still something odd going on with that function. I made this little script and put OnDisturbed of a container:
{
object oPC = GetLastDisturbed();
object oDisturb = GetInventoryDisturbItem();
SendMessageToPC(oPC, "this: " + GetName(oDisturb));
}
When I put gold into the container, I get a message telling me "this: Gold piece", so it does fire for gold. When I take it back from the container, I get the message "this:".
I tested it, and when removing gold from a container, GetInventoryDisturbItem() returns OBJECT_INVALID.
Also, there's a bug with stackable items. If a stackable item is added to another stack in either the giver's or receiver's inventory, the OnDisturbed event never fires (except for gold pieces, apparently).
Version
1.30
Example
// removes an item from the container, they'll be charged
// that item's value for it... Lilac Soul
void main()
{
object oItem = GetInventoryDisturbItem();
object oPC = GetLastDisturbed();
int nType = GetInventoryDisturbType();
switch (nType)
{
case INVENTORY_DISTURB_TYPE_REMOVED:
case INVENTORY_DISTURB_TYPE_STOLEN:
int nAmount = GetGoldPieceValue(oItem);
AssignCommand(oPC, TakeGoldFromCreature(nAmount, oPC, TRUE));
SendMessageToPC(oPC, "Stealing is wrong. Give me your money!");
break;
}
}
See Also
| functions: | |
| constants: | |
| events: |
author: Tom Cassiotis, editor: Jasperre, additional contributor(s): Max Aller, Lilac Soul
