Xordac: 1 revision imported

2017-10-23T23:23:21Z

1 revision imported

New page

=Inventory Function Category=

Functions that deal with a character's inventory.

 

====Functions====

{| border="1" cellpadding="5"
! Name
! Brief Description
|-
|
[[ActionEquipItem | ActionEquipItem ]]
| Puts an item in possesion into an inventory slot.
|-
|
[[ActionEquipMostEffectiveArmor | ActionEquipMostEffectiveArmor ]]
| Causes the calling creature to equip the best armor in its inventory.
|-
|
[[ActionGiveItem | ActionGiveItem ]]
| Gives a specified item to a target creature.
|-
|
[[ActionPickUpItem | ActionPickUpItem ]]
| Causes subject to run to an item and place it in inventory.
|-
|
[[ActionPutDownItem | ActionPutDownItem ]]
| Causes the subject to place an item on the ground at it's feet.
|-
|
[[ActionTakeItem | ActionTakeItem ]]
| Takes an item from an object
|-
|
[[ActionUnequipItem | ActionUnequipItem ]]
| Makes the executing creature unequip an object and place it in their inventory.
|-
|
[[CheckPartyForItem | CheckPartyForItem ]]
| Check party for possession of an item.
|-
|
[[CopyObject | CopyObject ]]
| Duplicates the object specified.
|-
|
[[CreateItemOnObject | CreateItemOnObject ]]
| Create a specific item in an objects inventory
|-
|
[[GetBackpackMatch | GetBackpackMatch ]]
| Determines if the PC carries the proper items to create a new item.
|-
|
[[GetDroppableFlag | GetDroppableFlag ]]
| Determines if an item can be dropped.
|-
|
[[GetFirstItemInInventory | GetFirstItemInInventory ]]
| Determines the first item in an object's inventory.
|-
|
[[GetHasInventory | GetHasInventory ]]
| Determine whether an object has an inventory.
|-
|
[[GetInventoryDisturbItem | GetInventoryDisturbItem ]]
| Returns the disturbing item in an inventory OnDisturbed event.
|-
|
[[GetInventoryDisturbType | GetInventoryDisturbType ]]
| Determines the type of disturbance of an inventory.
|-
|
[[GetIsItemPossessedByParty | GetIsItemPossessedByParty ]]
| Check to see if any character in the party has the specified item.
|-
|
[[GetItemInSlot | GetItemInSlot ]]
| Retrieve the item in a given inventory slot of a creature.
|-
|
[[GetItemPossessedBy | GetItemPossessedBy ]]
| Get an item with a specific tag in a given creature or placeable's inventory.
|-
|
[[GetItemPossessedByParty | GetItemPossessedByParty ]]
| Check to see if the specified item belongs to anyone in the party.
|-
|
[[GetItemPossessor | GetItemPossessor ]]
| Get the creature or object who possesses a specified item.
|-
|
[[GetItemStackSize | GetItemStackSize ]]
| Determines the number of stacked items contained within an inventory object.
|-
|
[[GetLastDisturbed | GetLastDisturbed ]]
| Determine who last disturbed the inventory of an object or creature.
|-
|
[[GetLastOpener | GetLastOpener ]]
| Gets the creature that last opened or destroyed the container calling this script.
|-
|
[[GetLootable | GetLootable ]]
| Returns the lootable state of a creature
|-
|
[[GetModuleItemAcquired | GetModuleItemAcquired ]]
| Get the item acquired on an OnAcquiredItem event.
|-
|
[[GetModuleItemAcquiredBy | GetModuleItemAcquiredBy ]]
| Retrieves an object that acquired a module item.
|-
|
[[GetModuleItemAcquiredFrom | GetModuleItemAcquiredFrom ]]
| Get the last owner of the item acquired on an OnAcquiredItem event.
|-
|
[[GetModuleItemAcquiredStackSize | GetModuleItemAcquiredStackSize ]]
| Determines the stack size of an item belonging to a module that was just acquired.
|-
|
[[GetModuleItemLost | GetModuleItemLost ]]
| Get the object that was dropped on an OnUnAcquiredItem event.
|-
|
[[GetModuleItemLostBy | GetModuleItemLostBy ]]
| Get the creature that lost the item on an OnUnAcquiredItem event.
|-
|
[[GetNextItemInInventory | GetNextItemInInventory ]]
| Determines the first item in an object's inventory.
|-
|
[[GetNumItems | GetNumItems ]]
| Gets the number of the item that the target carries.
|-
|
[[GetNumStackedItems | GetNumStackedItems ]]
| Determines the number of stacked items contained within an inventory object.
|-
|
[[GetPCItemLastEquipped | GetPCItemLastEquipped ]]
| Returns the last equipped item
|-
|
[[GetPCItemLastEquippedBy | GetPCItemLastEquippedBy ]]
| Returns the PC that last equipped an item
|-
|
[[GetPCItemLastUnequipped | GetPCItemLastUnequipped ]]
| Returns the last unequipped item
|-
|
[[GetPCItemLastUnequippedBy | GetPCItemLastUnequippedBy ]]
| Get the PC who last unequipped an item
|-
|
[[GetPickpocketableFlag | GetPickpocketableFlag ]]
| Determines if the item can be pickpocketed.
|-
|
[[GetStolenFlag | GetStolenFlag ]]
| Determine if an item has been stolen.
|-
|
[[GetWeight | GetWeight ]]
| Retrieves the weight of an individual item, or the weight of all objects carried by a single creature.
|-
|
[[GiveNumItems | GiveNumItems ]]
| Gives the target the number of items specified.
|-
|
[[HasAnyItemOfBaseType | HasAnyItemOfBaseType ]]
| Cycles through the players inventory looking for any item that has a certain Base Item Type. If the Base Item Type is Armor, make sure the AC matches.
|-
|
[[HasGold | HasGold ]]
| Determines if a player has more than a certain amount of gold on them.
|-
|
[[HasItem | HasItem ]]
| Determines if a creature possesses an item.
|-
|
[[LootInventory | LootInventory ]]
| Strip everything droppable in the regular, non-equipped, inventory.
|-
|
[[LootInventorySlots | LootInventorySlots ]]
| Loot all the droppable items from the inventory slots of the victim into the inventory of the corpse object.
|-
|
[[OpenInventory | OpenInventory ]]
| Opens a player's inventory panel.
|-
|
[[RemoveItemFromParty | RemoveItemFromParty ]]
| Removes the specified item from whichever member of the party has it.
|-
|
[[SetItemCharges | SetItemCharges ]]
| Sets the number of charges left on a given item.
|-
|
[[SetItemStackSize | SetItemStackSize ]]
| Set the number of items in a given stack.
|-
|
[[SetLootable | SetLootable ]]
| Sets whether a creature leaves a lootable corpse upon death
|-
|
[[SetPickpocketableFlag | SetPickpocketableFlag ]]
| Sets the pickpocketable flag on the item.
|-
|
[[SetStolenFlag | SetStolenFlag ]]
| Set whether the item is stolen
|-
|
[[SKIN_SupportEquipSkin | SKIN_SupportEquipSkin ]]
| Forces a creature to equip a skin item in its creature armor inventory slot.
|-
|
[[SKIN_SupportGetSkin | SKIN_SupportGetSkin ]]
| Retrieves a creature's skin item or creates a new one and forces an equip if the creature does not already have one.
|-
|
[[StripAllPersonalItemsFromEveryone | StripAllPersonalItemsFromEveryone ]]
| Removes henchmen 'hired' items for use in the original campaign.
|-
|
[[TakeArtifactItem | TakeArtifactItem ]]
|
Removes the item returned by [[GetArtifactItem | GetArtifactItem ]] from the player's inventory.
|-
|
[[TakeComplexItem | TakeComplexItem ]]
| Removes the plot related item from a player's inventory.
|-
|
[[TakeFetchItem | TakeFetchItem ]]
| Removes the plot related item from a player's inventory.
|-
|
[[TakeGold | TakeGold ]]
| Removes a given amount of gold from the targets inventory, and optionally removes it from the game.
|-
|
[[TakeNumItems | TakeNumItems ]]
| Takes the number of items specified from the target.
|-
|
[[TakeStoryItem | TakeStoryItem ]]
| Removes the plot related item from a player's inventory.
|-
|
[[TalentBuffSelf | TalentBuffSelf ]]
| Used for Potions of Enhancement and Protection
|}

----
author: NWN Lexicon Group, editor: Mistress, contributor: Axe Murderer 
[[Category:Functions]]
[[Category:Function_Categories]]

Category:Inventory Functions - Revision history

Xordac: 1 revision imported