CreatePool - Revision history

BryanDerksen: looks okay, removing tag

2010-02-24T20:25:36Z

looks okay, removing tag

BryanDerksen: merge earlier and auto-generated revisions

2009-07-29T15:45:50Z

merge earlier and auto-generated revisions

BryanDerksen: 1 revision: Importing auto-generated function articles

2009-07-29T15:44:21Z

1 revision: Importing auto-generated function articles

Sunjammer: Generated by Sunjammer's Dragon Age Script Paser

2009-07-29T01:40:43Z

Generated by Sunjammer's Dragon Age Script Paser

BryanDerksen: switch to using dafunction

2009-07-23T23:43:29Z

switch to using dafunction

BryanDerksen: 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.

2009-07-21T21:45:16Z

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: remove stray quotes

2009-07-21T21:42:05Z

remove stray quotes

BryanDerksen: apply changes that were done to the prototype template

2009-07-21T21:41:21Z

apply changes that were done to the prototype template

BryanDerksen: take out a stray "s"

2009-07-21T19:46:18Z

take out a stray "s"

BryanDerksen: trying out the dafunction formatting

2009-07-21T19:42:41Z

trying out the dafunction formatting

← Older revision		Revision as of 20:25, 24 February 2010
Line 1:		Line 1:
−	~~{{Generated}}~~
	{{dafunction		{{dafunction
	\|name=CreatePool		\|name=CreatePool

@@ Line 15: / 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. -->
 <!-- == Remarks == -->

@@ Line 1: / Line 1: @@
 {{dafunction
 |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
 |param1name=rTemplate
@@ Line 14: / Line 15: @@
 }}
-== Description ==
+<!-- == 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.
+<!-- == 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 == -->
-<!-- == Known bugs == -->
+== See also ==
+<!-- This section contains links to articles, functions or constant groups. -->
-<!-- == See also == -->
+[[CreateObject]], [[SetObjectActive]]
+[[Category: Object functions]]
-[[Category:Scripts]]

@@ Line 1: / Line 1: @@
-Reserves a block of memory for a fixed number of a particular type of creature
+{{dafunction
+|name=CreatePool
-<dascript>
+|brief=Reserves a block of memory for a fixed number of a particular type of creature
-int CreatePool (
+|param1type=resource
-        resource rTemplate,
+|param1name=rTemplate
-        int nPoolSize
+|param1desc=The template to use
+|param2type=int
-</dascript>
+|param2name=nPoolSize
+|param2desc=Number of creatures of this type to create
-<dl>
+|returntype=int
-<dt>Parameters:
+|returndesc=TRUE if successful
-<dd>
+|sourcefile=script.ldf
-<dl>
+|sourcemodule=
-<dt style="font-weight:normal; font-style:italic;">rTemplate<dd>The template to use
+}}
-<dt style="font-weight:normal; font-style:italic;">nPoolSize<dd>Number of creatures of this type to create
-</dl>
-<dt>Returns:
-<dd>TRUE if successful
-<dt>Source:
-<dd>[[script.ldf]]
-</dl>
 == Description ==

@@ Line 9: / Line 9: @@
 <dl>
-<dt style="font-weight:normal;">Parameters:
+<dt>Parameters:
 <dd>
 <dl>
@@ Line 15: / Line 15: @@
 <dt style="font-weight:normal; font-style:italic;">nPoolSize<dd>Number of creatures of this type to create
 </dl>
-<dt style="font-weight:normal;">Returns:
+<dt>Returns:
 <dd>TRUE if successful
-<dt style="font-weight:normal;">Source:
+<dt>Source:
 <dd>[[script.ldf]]
 </dl>

← Older revision	Revision as of 15:44, 29 July 2009
(No difference)