GetHasInventory

From NWN Lexicon
Jump to: navigation, search



GetHasInventory(object)

Determine whether an object has an inventory.

int GetHasInventory(
    object oObject
);

Parameters

oObject

Creature, store or placeable to investigate.


Description

Returns TRUE for creatures and stores, and checks to see if an item or placeable object is a container and FALSE for all other object types.



Remarks

Creatures always have inventories, and cannot be toggled on/off. Stores also always have an inventory. It never returns FALSE if it just is empty.

For placeables, this is basically a check for the "Has inventory" toggle under the "General" tab of a placeables properties. Because of this, placeables with inventories must be useable because of how the checkboxs are done.


Version

1.22

Example

// Check if the nearest placeable has an inventory, if so, speak its name
// Could be a creature heartbeat
 
void main()
{
    // Get nearest placeable
    object oPlaceable = GetNearestObject(OBJECT_TYPE_PLACEABLE);
 
    // Has it got an inventory?
    if(GetIsObjectValid(oPlaceable))
    {
        // If it has...
        if(GetHasInventory(oPlaceable))
        {
            // Speak about it.
            SpeakString("Hey, " + GetName(oPlaceable) + " might have something in it!");
        }
    }
}

See Also



 author: Tom Cassiotis, editor: Jasperre