Difference between revisions of "CreatePool"

Revision as of 20:33, 3 July 2009

The CreatePool function is used to reserve a block of memory for a fixed number of a particular type of creature. Creatures of that type that are spawned with the CreateObject function in this area will use this block of memory, and when creatures of this type die or are set inactive their memory space will automatically be returned to the pool.

The purpose of this function is to allow for endlessly respawning monsters, or similar situations.

It should be used under EVENT_TYPE_AREALOAD_PRELOADEXIT. When creatures die or are set inactive they will automatically return to the pool.

Note that pool creatures should have "no permanent death" enabled, otherwise certain effects (such as decapitation) will remain on them when they respawn.

Pool size should be at least twice the number of enemies from that will ever be active simultaneously.

int CreatePool (
                resource rTemplate,
                int nPoolSize
               )

Parameters:

rTemplate

• The template to use

nPoolSize

• Number of creatures of this type to create

Returns:

TRUE if successful