Difference between revisions of "CreatePool"
BryanDerksen (Talk | contribs) (Hm... I think it loses something without the bolding to distinguish terms from definitions. trying a version with bolded top-level terms, keeping italics for the second-level ones.) |
BryanDerksen (Talk | contribs) (switch to using dafunction) |
||
| Line 1: | Line 1: | ||
| − | Reserves a block of memory for a fixed number of a particular type of creature | + | {{dafunction |
| − | + | |name=CreatePool | |
| − | + | |brief=Reserves a block of memory for a fixed number of a particular type of creature | |
| − | + | |param1type=resource | |
| − | + | |param1name=rTemplate | |
| − | + | |param1desc=The template to use | |
| − | + | |param2type=int | |
| − | + | |param2name=nPoolSize | |
| − | + | |param2desc=Number of creatures of this type to create | |
| − | + | |returntype=int | |
| − | + | |returndesc=TRUE if successful | |
| − | + | |sourcefile=script.ldf | |
| − | + | |sourcemodule= | |
| − | + | }} | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
== Description == | == Description == | ||
Revision as of 00:43, 24 July 2009
Reserves a block of memory for a fixed number of a particular type of creature
- 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.
