SEED - Templates via Spawnargs - Revision history

SteveL: Correcting spawnargs: additional templates need an underscore before number suffix

2014-02-24T00:54:09Z

Correcting spawnargs: additional templates need an underscore before number suffix

← Older revision		Revision as of 00:54, 24 February 2014
Line 23:		Line 23:
	"template_count" "3"		"template_count" "3"
	"template_skin" "tdm_fruit_brownish"		"template_skin" "tdm_fruit_brownish"
	"~~template1~~" "atdm:moveable_food_pear"		"template_1" "atdm:moveable_food_pear"
	"~~template1_count~~" "2"		"template_1_count" "2"

	This would spawn at most 3 apples and at most 2 pears, but overall not more than 4 entities. Remember to make the SEED space big enough so that all to-be spawned entities will fit!		This would spawn at most 3 apples and at most 2 pears, but overall not more than 4 entities. Remember to make the SEED space big enough so that all to-be spawned entities will fit!

Tels: update

2011-02-01T12:13:56Z

update

@@ Line 36: / Line 36: @@
 === template_count ===
-Sets the maximum amount of entities to generate from this template.
+Sets the maximum amount of entities to generate from this template. '''template_max_entities''' is an alias for this. If not set, will default to 1.
 === template_skin ===
@@ Line 63: / Line 45: @@
   "template_skin"  "'', red, green"
 </nowiki></pre>
 {{seed}}

Tels: formatting

2011-02-01T11:15:19Z

formatting

← Older revision		Revision as of 11:15, 1 February 2011
Line 33:		Line 33:

	This is either an entityDef name like '''atdm:moveable_food_apple''', or a model name like '''models/darkmod/decorative/games/cards_stack02.lwo'''. In the latter case, "func_static" will be used as class for the template.		This is either an entityDef name like '''atdm:moveable_food_apple''', or a model name like '''models/darkmod/decorative/games/cards_stack02.lwo'''. In the latter case, "func_static" will be used as class for the template.

	~~{{red\|TODO}}~~

	=== template_count ===		=== template_count ===

	~~{{red\|TODO}}~~		Sets the maximum amount of entities to generate from this template.

	=== template_combine ===		=== template_combine ===

	~~{{red\|TODO}}~~		Default: 1.

			If set to 1, entities generated from this template will be combined (if possible) into multi-static entities with one rendermodel and many clipmodels. If set to 0, each will stay as a separate entity.

	=== template_falloff ===		=== template_falloff ===
Line 60:		Line 60:
	Sets the skin on the template. Can also be a [[random skin]] like:		Sets the skin on the template. Can also be a [[random skin]] like:

			<pre><nowiki>
	"template_skin" "'', red, green"		"template_skin" "'', red, green"
			</nowiki></pre>

	{{seed}}		{{seed}}

Tels: rename "spawn_" to "template_"

2011-02-01T11:13:02Z

rename "spawn_" to "template_"

← Older revision		Revision as of 11:13, 1 February 2011
Line 13:		Line 13:
	== Overview ==		== Overview ==

	The spawnargs to define a new template always start with '''~~spawn_~~''' and some suffix like "~~class", "skin~~" and so on.		The spawnargs to define a new template always start with '''template''' and some optional suffix like "_skin" and so on.

	You can use multiple of these, and combine it with a overall '''max_entities''' count, too:		You can use multiple of these by inserting any suffix after "template", and combine it with a overall '''max_entities''' count, too:

	"remove" "1" // remove the SEED after spawning the entities		"remove" "1" // remove the SEED after spawning the entities
	"wait_for_trigger" "1" // Optional, wait for a trigger before spawning anything		"wait_for_trigger" "1" // Optional, wait for a trigger before spawning anything
	"max_entities" "4" // Will only spawn at most 4 entities		"max_entities" "4" // Will only spawn at most 4 entities
	"~~spawn_class~~" "atdm:moveable_food_apple"		"template" "atdm:moveable_food_apple"
	"~~spawn_count~~" "3"		"template_count" "3"
	"~~spawn_skin~~" "tdm_fruit_brownish"		"template_skin" "tdm_fruit_brownish"
	"~~spawn_class_1~~" "atdm:moveable_food_pear"		"template1" "atdm:moveable_food_pear"
	"~~spawn_count_1~~" "2"		"template1_count" "2"

	This would spawn at most 3 apples and at most 2 pears, but overall not more than 4 entities. Remember to make the SEED space big enough so that all to-be spawned entities will fit!		This would spawn at most 3 apples and at most 2 pears, but overall not more than 4 entities. Remember to make the SEED space big enough so that all to-be spawned entities will fit!

	~~{{infobox\|Do not confuse '''spawn_class''' with '''spawnclass''', this will make the SEED stop working!}}~~

	== Spawnargs ==		== Spawnargs ==

	=== ~~spawn_class~~ ===		=== template ===

	~~{{infobox\|Do not confuse~~ '''~~spawn_class~~''' ~~with~~ '''~~spawnclass~~''', ~~this~~ will ~~make~~ the ~~SEED stop working!}}~~		This is either an entityDef name like '''atdm:moveable_food_apple''', or a model name like '''models/darkmod/decorative/games/cards_stack02.lwo'''. In the latter case, "func_static" will be used as class for the template.

	~~See also [[[#spawn_model\|'''spawn_model''']~~.

	{{red\|TODO}}		{{red\|TODO}}

	=== ~~spawn_model~~ ===		=== template_count ===

	{{red\|TODO}}		{{red\|TODO}}

	=== ~~spawn_count~~ ===		=== template_combine ===

	{{red\|TODO}}		{{red\|TODO}}

	=== ~~spawn_combine~~ ===		=== template_falloff ===

	{{red\|TODO}}		{{red\|TODO}}

	=== ~~spawn_falloff~~ ===		=== template_floor ===

	{{red\|TODO}}		{{red\|TODO}}

	=== ~~spawn_floor~~ ===		=== template_map ===

	{{red\|TODO}}		{{red\|TODO}}

	=== ~~spawn_map~~ ===		=== template_skin ===

	~~{{red\|TODO}}~~		Sets the skin on the template. Can also be a [[random skin]] like:

	~~=== spawn_skin ===~~		"template_skin" "'', red, green"

	{{red~~\|TODO}}~~

	{{seed}}		{{seed}}

Tels: add

2011-02-01T08:16:24Z

add

← Older revision		Revision as of 08:16, 1 February 2011
Line 6:		Line 6:

	To overcome this, the mechanism of defining targets via spawnargs on the SEED entity was added.		To overcome this, the mechanism of defining targets via spawnargs on the SEED entity was added.

			== Examples ==

			A few pre-made entities exist that use this technique to spawn a variable amount of entities, f.i. '''atdm:random_food'''. You will find them under "darkmod/Randoms" in [[DarkRadiant]] when right-clicking and choosing "Create Entity".

	== Overview ==		== Overview ==

Tels: add

2011-02-01T08:09:09Z

add

New page

== Introduction ==

The [[SEED]] can create random entities with random placements. The normal way to do so is to create "target entities" as blueprints/templates. While this method works, it has the drawback that all blueprints/templates need to be spawned as entities at map start, just so the SEED can read out their properties. If then only some of these targets end up used, you just wasted time and memory to spawn/load/process entities and their models/textures, even tho they are never used in the actual map.

If you f.i. wanted to have the [[SEED]] spawn randomly either one apple or one pear, the traditional "target" method requires you to place one SEED, one apple and one pear entity, for a total of 3 entities, even tho during runtime only one entity would actually survive. With this method you only need on entity (the SEED itself) and it will only spawn the necessary entities later.

To overcome this, the mechanism of defining targets via spawnargs on the SEED entity was added.

== Overview ==

The spawnargs to define a new template always start with '''spawn_''' and some suffix like "class", "skin" and so on.

You can use multiple of these, and combine it with a overall '''max_entities''' count, too:

"remove" "1" // remove the SEED after spawning the entities
"wait_for_trigger" "1" // Optional, wait for a trigger before spawning anything
"max_entities" "4" // Will only spawn at most 4 entities
"spawn_class" "atdm:moveable_food_apple"
"spawn_count" "3"
"spawn_skin" "tdm_fruit_brownish"
"spawn_class_1" "atdm:moveable_food_pear"
"spawn_count_1" "2"

This would spawn at most 3 apples and at most 2 pears, but overall not more than 4 entities. Remember to make the SEED space big enough so that all to-be spawned entities will fit!

{{infobox|Do not confuse '''spawn_class''' with '''spawnclass''', this will make the SEED stop working!}}

== Spawnargs ==

=== spawn_class ===

{{infobox|Do not confuse '''spawn_class''' with '''spawnclass''', this will make the SEED stop working!}}

See also [[[#spawn_model|'''spawn_model'''].

{{red|TODO}}

=== spawn_model ===

{{red|TODO}}

=== spawn_count ===

{{red|TODO}}

=== spawn_combine ===

{{red|TODO}}

=== spawn_falloff ===

{{red|TODO}}

=== spawn_floor ===

{{red|TODO}}

=== spawn_map ===

{{red|TODO}}

=== spawn_skin ===

{{red|TODO}}

{{seed}}