Difference between revisions of "CreatePool"
BryanDerksen (Talk | contribs) m (1 revision: Importing auto-generated function articles) |
BryanDerksen (Talk | contribs) m (looks okay, removing tag) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
{{dafunction | {{dafunction | ||
|name=CreatePool | |name=CreatePool | ||
| Line 15: | Line 14: | ||
}} | }} | ||
| − | + | == Description == | |
<!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. --> | <!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. --> | ||
| + | |||
| + | 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. | ||
<!-- == Remarks == --> | <!-- == Remarks == --> | ||
Latest revision as of 21:25, 24 February 2010
Create a pool of creatures while loading an area. It should be used under EVENT_TYPE_AREALOAD_PRELOADEXIT. When creatures die or are set inactive they will automatically return to the pool.
- 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.
