DestroyObjectsInAreaByTag

From NWN Lexicon
Jump to navigationJump to search


DestroyObjectsInAreaByTag(string, object, int)

Destroys all the objects in the area with a given tag.

void DestroyObjectsInAreaByTag(
    string sTag,
    object oCenter = OBJECT_SELF,
    int nLimit = 0
);

Parameters

sTag

The tag you are interested in.

oCenter

An object in the area you are interested in. (Default: OBJECT_SELF)

nLimit

The maximum number of matching objects to destroy. (Default: 0)


Description

Destroys all the objects in the area with a given tag.

If nLimit is > 0, this will be the maximum number of things destroyed with the given tag.



Remarks

oCenter should not be an area, it should be an object IN the area you are interested in. It might actually still work if oCenter is an area but that isn't what the intent of the function is.


Requirements

#include " x0_i0_destroy "


Version

???

See Also

functions: 

DestroyObject



author: Mistress