Difference between revisions of "CreatePool"

From Dragon Age Toolset Wiki
Jump to: navigation, search
(switch to using dafunction)
(Generated by Sunjammer's Dragon Age Script Paser)
Line 1: Line 1:
 +
{{Generated}}
 
{{dafunction
 
{{dafunction
 
|name=CreatePool
 
|name=CreatePool
−
|brief=Reserves a block of memory for a fixed number of a particular type of creature
+
|brief=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.
 
|param1type=resource
 
|param1type=resource
 
|param1name=rTemplate
 
|param1name=rTemplate
Line 14: Line 15:
 
}}
 
}}
  
−
== Description ==
+
<!-- == Description == -->
 +
<!-- 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.
+
<!-- == Remarks == -->
−
 
+
<!-- This section contains additional comments, observations and known issues. -->
−
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.
+
  
 
<!-- == Examples == -->
 
<!-- == Examples == -->
 +
<!-- This section contains examples transcluded from the snippet library. -->
  
−
<!-- == Known bugs == -->
+
== See also ==
−
 
+
<!-- This section contains links to articles, functions or constant groups. -->
−
<!-- == See also == -->
+
[[CreateObject]], [[SetObjectActive]]
−
 
+
[[Category: Object functions]]
−
[[Category:Scripts]]
+

Revision as of 02:40, 29 July 2009

This page was generated by Sunjammer's Dragon Age Script Parser.

The parser extracted and matched all the information required to the best of its ability however the parser relies on the source file, and especially a function's comments, to be correctly formatted. If the source file was not correctly formatted the information presented may be incomplete.

This page should be reviewed by a knowledgeable scripter as it may require updating. If an issue with the source file is identified it should be reported to BioWare.

Please remove the {{Generated}} tag once the page has been confirmed or corrected.

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.

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



See also

CreateObject, SetObjectActive

Retrieved from "http://datoolset.net/mw/index.php?title=CreatePool&oldid=2452"