Difference between revisions of "CreatePool"
BryanDerksen (Talk | contribs) (apply changes that were done to the prototype template) |
BryanDerksen (Talk | contribs) m (remove stray quotes) |
||
| Line 12: | Line 12: | ||
<dd> | <dd> | ||
<dl> | <dl> | ||
| − | <dt style="font-weight:normal; | + | <dt style="font-weight:normal; font-style:italic;">rTemplate<dd>The template to use |
| − | <dt style="font-weight:normal; | + | <dt style="font-weight:normal; font-style:italic;">nPoolSize<dd>Number of creatures of this type to create |
</dl> | </dl> | ||
<dt style="font-weight:normal;">Returns: | <dt style="font-weight:normal;">Returns: | ||
Revision as of 22:42, 21 July 2009
Reserves a block of memory for a fixed number of a particular type of creature
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
- Source:
- script.ldf
Description
Creatures of this 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.
