Particles - Revision history

Datiswous: /* Particle decl keywords */

2022-11-14T12:52:53Z

Particle decl keywords

← Older revision		Revision as of 12:52, 14 November 2022
Line 63:		Line 63:
	== Particle decl keywords ==		== Particle decl keywords ==
	Most particle settings are applied using the particle editor, but there are a few more keywords that can be added manually to the decl generated by the editor.		Most particle settings are applied using the particle editor, but there are a few more keywords that can be added manually to the decl generated by the editor.
	You can read about most of keywords on the [https://~~www~~.~~iddevnet~~.~~com~~/doom3/editor_particle.html Doom 3 SDK page]. Additional explanation is provided in the [[Particle Editor]] article		You can read about most of keywords on the [https://iddevnet.dhewm3.org/doom3/editor_particle.html Doom 3 SDK page]. Additional explanation is provided in the [[Particle Editor]] article

	=== WorldAxis ===		=== WorldAxis ===

SeriousToni: /* Switching Particles on and off */

2022-01-12T19:55:42Z

Switching Particles on and off

← Older revision		Revision as of 19:55, 12 January 2022
Line 31:		Line 31:
	Particle effects can also be created using the [[Stim/Response]] system.		Particle effects can also be created using the [[Stim/Response]] system.

			Particles can be turned off and on by the game itself too. You can place a "hide_distance" spawnarg on the emitter with the value in units (e.g. "512") after which the particle emitter will be switched off (and on again if the player re-enters the radius). If you encounter problems with particles going through your walls, you can also use the "areaLock" spawnarg with a value called "origin". This ties the entity's visibility to the visleaf in which the origin lies, meaning, if the player leaves the room or closes the vis portal (by shutting the door), the emitter will stop emitting the particles.

	==Starting OFF at game start==		==Starting OFF at game start==

Stgatilov: Added diversityPeriod keyword.

2020-12-09T15:00:29Z

Added diversityPeriod keyword.

← Older revision		Revision as of 15:00, 9 December 2020
Line 79:		Line 79:
	* 0: Turn off soft particles AND Depthhack.		* 0: Turn off soft particles AND Depthhack.
	* Any positive number: sets the particle "radius", which is the amount it's allowed to draw in front of anything solid that intersects it. Defaults to 0.4 times the max particle quad size for the stage. If you have a tricky particle that's showing through a wall, you can reduce the radius a bit. For example: a tdm_dustfog_03 with a max quad size of 100 will have a default radius of 40. If you want to put it in a confined space where it ends up showing through a wall, you could add "softeningRadius 30" to the stage to stop that happening.		* Any positive number: sets the particle "radius", which is the amount it's allowed to draw in front of anything solid that intersects it. Defaults to 0.4 times the max particle quad size for the stage. If you have a tricky particle that's showing through a wall, you can reduce the radius a bit. For example: a tdm_dustfog_03 with a max quad size of 100 will have a default radius of 40. If you want to put it in a confined space where it ends up showing through a wall, you could add "softeningRadius 30" to the stage to stop that happening.

			=== DiversityPeriod ===
			This keyword was introduced in TDM 2.09. With default value 0, every cycle of a particle system looks a bit different from the previous ones in terms of randomness/diversity.
			With value K > 0, every K-th cycle of particle system looks exactly the same. So it makes the system look "periodic". For instance, K = 1 means that every cycle looks the same. Value K = 10 means that ten cycles look different but after that everything repeats.
			The keyword is required for the new [[Particle collisions and cutoff#Linear layout\|"mapLayout linear"]] mode of particle collisions.


	[[Category:Editing]][[Category:Tutorial]][[Category:Particles]]		[[Category:Editing]][[Category:Tutorial]][[Category:Particles]]

Stgatilov: Added references for particle decl keywords

2020-02-18T17:25:56Z

Added references for particle decl keywords

← Older revision		Revision as of 17:25, 18 February 2020
Line 62:		Line 62:
	== Particle decl keywords ==		== Particle decl keywords ==
	Most particle settings are applied using the particle editor, but there are a few more keywords that can be added manually to the decl generated by the editor.		Most particle settings are applied using the particle editor, but there are a few more keywords that can be added manually to the decl generated by the editor.
			You can read about most of keywords on the [https://www.iddevnet.com/doom3/editor_particle.html Doom 3 SDK page]. Additional explanation is provided in the [[Particle Editor]] article

	=== WorldAxis ===		=== WorldAxis ===

SteveL: + particle decl keywords

2015-02-08T10:29:09Z

+ particle decl keywords

← Older revision		Revision as of 10:29, 8 February 2015
Line 48:		Line 48:


	== Soft ~~particles~~ ==		== Soft Particles ==
	Beginning in TDM 2.03, particle effects are softened where they intersect solid objects. There's no longer any need to move lamp glares away from walls, and dust/fog/smoke will appear to be shapeless 3d volumes instead of 2d images cut off ~~into~~ the floor and walls.		Beginning in TDM 2.03, particle effects are softened where they intersect solid objects. There's no longer any need to move lamp glares away from walls, and dust/fog/smoke will appear to be shapeless 3d volumes instead of 2d images cut off at the floor and walls.

	Soft particles start to fade out where they get close to solid objects. And when they intersect solid objects, they continue to draw over the top for a short distance. This "rubs out" any hard edges belonging to the 2d images that make up the particle effect, which stops the eye getting a fix on exactly where those images are and restores the illusion of a 3d volume.		Soft particles start to fade out where they get close to solid objects. And when they intersect solid objects, they continue to draw over the top for a short distance. This "rubs out" any hard edges belonging to the 2d images that make up the particle effect, which stops the eye getting a fix on exactly where those images are and restores the illusion of a 3d volume.
Line 55:		Line 55:
	The range over which the particle fades out -- and is allow to draw over solid stuff -- is proportional to the "radius" of the particle volume being represented. By default, it's 0.4 times the diameter of the particle stages' quads.		The range over which the particle fades out -- and is allow to draw over solid stuff -- is proportional to the "radius" of the particle volume being represented. By default, it's 0.4 times the diameter of the particle stages' quads.

	Soft particles can be toggled on and off using the cvar r_useSoftParticles.		Soft particles can be toggled on and off using the cvar r_useSoftParticles.

	Mappers don't have to do anything to take advantage of this -- it's enabled by default and will "just work" in 99% of cases -- but there are a ~~couple~~ of ~~relevant~~ particle ~~decl keywords~~, ~~including one new keyword for tricky spots~~:		Mappers don't have to do anything to take advantage of this -- it's enabled by default and will "just work" in 99% of cases -- but mappers can control the effect more precisely if they wish using the "SofteningRadius" keyword documented below.


			== Particle decl keywords ==
			Most particle settings are applied using the particle editor, but there are a few more keywords that can be added manually to the decl generated by the editor.

			=== WorldAxis ===
			Added in 2.03 to enable better candle smoke. If a particle stage has an offset to its origin, or if it moves in any way independent of gravity, WorldAxis will make that offset and movement use the world axis instead of the emitter's axis. Particles also have a WorldGravity keyword that's set using the particle editor. WorldGravity affects only movement under gravity. WorldAxis affects other kinds of movement plus offsets. Added so that candle smoke can rise upright at a constant rate no matter how the player turns the candle.

			Example: the new candle smoke in 2.03 starts with a narrow plume of smoke emitted from the candle's wick (which is where the emitter is placed), followed by a wider volume of wispy smoke that spreads out from the top of the narrow plume. Both stages use WorldAxis: the first stage so that it can rise upright from a knocked-over candle at a constant rate; the second stage so that it always starts from a point ''above'' the candle even if the candle is on its side.

	=== DepthHack ===		=== DepthHack ===
	This is a ~~more~~ primitive way of avoiding some particle intersections, the only one that was available in the original idTech4 engine. It's a keyword placed at the top of the particle decl and applies to all stages of the particle: it can't be applied separately to individual stages. It causes the particle to draw in front of solid objects by up to the specified number of units, e.g. "depthHack 20" was used in lamp glares to make them draw over things by up to 20 units.		This is a primitive way of avoiding some particle intersections, the only one that was available in the original idTech4 engine. It's a keyword placed at the top of the particle decl and applies to all stages of the particle: it can't be applied separately to individual stages. It causes the particle to draw in front of solid objects by up to the specified number of units, e.g. "depthHack 20" was used in lamp glares to make them draw over things by up to 20 units.

	DepthHack is overridden by the new soft particle technique in TDM 2.03. The keyword and its value are ignored, unless the particle decl turns off the new soft particles effect.		DepthHack is overridden by the new soft particle technique in TDM 2.03. The keyword and its value are ignored, unless the particle decl turns off the new soft particles effect.

SteveL: tidying up

2015-02-08T10:08:18Z

tidying up

← Older revision		Revision as of 10:08, 8 February 2015
Line 1:		Line 1:
	~~''written by Fidcal''~~


	== Introduction ==		== Introduction ==

Line 26:		Line 23:

	* Note that 'Choose Model' does not assign a model or models to be emitted such as a leaf or snowflake (see [[Particle Editor]]) No, if you choose model then it just assigns a visible model shape to the entity in the normal way. I guess one could use a chimney pot in our example but the particle effect would have to be customised to line up so we shall create a separate particle effect and just place it over a chimney. Depends on what you are doing whether you need a model at the position of the particle effect. It does save on entities, but it is less flexible.		* Note that 'Choose Model' does not assign a model or models to be emitted such as a leaf or snowflake (see [[Particle Editor]]) No, if you choose model then it just assigns a visible model shape to the entity in the normal way. I guess one could use a chimney pot in our example but the particle effect would have to be customised to line up so we shall create a separate particle effect and just place it over a chimney. Depends on what you are doing whether you need a model at the position of the particle effect. It does save on entities, but it is less flexible.



Line 45:		Line 41:

	Note that the particle effect may be very briefly visible at game start then turn off within a second. This is normal and I don't think can be avoided. In most cases this doesn't matter if the effect is not in the player's view right at game start.		Note that the particle effect may be very briefly visible at game start then turn off within a second. This is normal and I don't think can be avoided. In most cases this doesn't matter if the effect is not in the player's view right at game start.



Line 52:		Line 47:
	You can create your own particle effects - or even easier - modify existing ones. To do this read [[Particle Editor]].		You can create your own particle effects - or even easier - modify existing ones. To do this read [[Particle Editor]].


	~~[[Category:Editing]][[Category:Tutorial]][[Category:Particles]]~~

	== Soft particles ==		== Soft particles ==
Line 76:		Line 69:
	* 0: Turn off soft particles AND Depthhack.		* 0: Turn off soft particles AND Depthhack.
	* Any positive number: sets the particle "radius", which is the amount it's allowed to draw in front of anything solid that intersects it. Defaults to 0.4 times the max particle quad size for the stage. If you have a tricky particle that's showing through a wall, you can reduce the radius a bit. For example: a tdm_dustfog_03 with a max quad size of 100 will have a default radius of 40. If you want to put it in a confined space where it ends up showing through a wall, you could add "softeningRadius 30" to the stage to stop that happening.		* Any positive number: sets the particle "radius", which is the amount it's allowed to draw in front of anything solid that intersects it. Defaults to 0.4 times the max particle quad size for the stage. If you have a tricky particle that's showing through a wall, you can reduce the radius a bit. For example: a tdm_dustfog_03 with a max quad size of 100 will have a default radius of 40. If you want to put it in a confined space where it ends up showing through a wall, you could add "softeningRadius 30" to the stage to stop that happening.

			[[Category:Editing]][[Category:Tutorial]][[Category:Particles]]

SteveL: + soft particles

2015-02-08T10:07:12Z

+ soft particles

← Older revision		Revision as of 10:07, 8 February 2015
Line 54:		Line 54:

	[[Category:Editing]][[Category:Tutorial]][[Category:Particles]]		[[Category:Editing]][[Category:Tutorial]][[Category:Particles]]

			== Soft particles ==
			Beginning in TDM 2.03, particle effects are softened where they intersect solid objects. There's no longer any need to move lamp glares away from walls, and dust/fog/smoke will appear to be shapeless 3d volumes instead of 2d images cut off into the floor and walls.

			Soft particles start to fade out where they get close to solid objects. And when they intersect solid objects, they continue to draw over the top for a short distance. This "rubs out" any hard edges belonging to the 2d images that make up the particle effect, which stops the eye getting a fix on exactly where those images are and restores the illusion of a 3d volume.

			The range over which the particle fades out -- and is allow to draw over solid stuff -- is proportional to the "radius" of the particle volume being represented. By default, it's 0.4 times the diameter of the particle stages' quads.

			Soft particles can be toggled on and off using the cvar r_useSoftParticles.

			Mappers don't have to do anything to take advantage of this -- it's enabled by default and will "just work" in 99% of cases -- but there are a couple of relevant particle decl keywords, including one new keyword for tricky spots:

			=== DepthHack ===
			This is a more primitive way of avoiding some particle intersections, the only one that was available in the original idTech4 engine. It's a keyword placed at the top of the particle decl and applies to all stages of the particle: it can't be applied separately to individual stages. It causes the particle to draw in front of solid objects by up to the specified number of units, e.g. "depthHack 20" was used in lamp glares to make them draw over things by up to 20 units.

			DepthHack is overridden by the new soft particle technique in TDM 2.03. The keyword and its value are ignored, unless the particle decl turns off the new soft particles effect.

			=== SofteningRadius ===
			New particle stage keyword for TDM 2.03. Add this to individual particle ''stages'' to change the behaviour of soft particles. Accepted values are:
			* -1: Turn off soft particles and draw this particle stage the old way, including using DepthHack if it's specified in the decl.
			* 0: Turn off soft particles AND Depthhack.
			* Any positive number: sets the particle "radius", which is the amount it's allowed to draw in front of anything solid that intersects it. Defaults to 0.4 times the max particle quad size for the stage. If you have a tricky particle that's showing through a wall, you can reduce the radius a bit. For example: a tdm_dustfog_03 with a max quad size of 100 will have a default radius of 40. If you want to put it in a confined space where it ends up showing through a wall, you could add "softeningRadius 30" to the stage to stop that happening.

SteveL: Adding Category:Particles

2015-01-11T18:24:05Z

Adding Category:Particles

← Older revision		Revision as of 18:24, 11 January 2015
Line 53:		Line 53:


	[[Category:Editing]][[Category:Tutorial]]		[[Category:Editing]][[Category:Tutorial]][[Category:Particles]]

SteveL: SteveL moved page Particles for Beginners to Particles: This is the only article on particles and I plan to add more info, so removing "for beginners"

2014-11-20T18:53:27Z

SteveL moved page Particles for Beginners to Particles: This is the only article on particles and I plan to add more info, so removing "for beginners"

← Older revision	Revision as of 18:53, 20 November 2014
(No difference)

Fidcal: /* Creating Your Own Particle Effects */

2010-06-14T02:53:43Z

Creating Your Own Particle Effects

← Older revision		Revision as of 02:53, 14 June 2010
Line 26:		Line 26:

	* Note that 'Choose Model' does not assign a model or models to be emitted such as a leaf or snowflake (see [[Particle Editor]]) No, if you choose model then it just assigns a visible model shape to the entity in the normal way. I guess one could use a chimney pot in our example but the particle effect would have to be customised to line up so we shall create a separate particle effect and just place it over a chimney. Depends on what you are doing whether you need a model at the position of the particle effect. It does save on entities, but it is less flexible.		* Note that 'Choose Model' does not assign a model or models to be emitted such as a leaf or snowflake (see [[Particle Editor]]) No, if you choose model then it just assigns a visible model shape to the entity in the normal way. I guess one could use a chimney pot in our example but the particle effect would have to be customised to line up so we shall create a separate particle effect and just place it over a chimney. Depends on what you are doing whether you need a model at the position of the particle effect. It does save on entities, but it is less flexible.



			==Switching Particles on and off==

			func_emitter can be turned on and off by using target from any targetting entity eg a button or lever.

			Particle effects can also be created using the [[Stim/Response]] system.


			==Starting OFF at game start==

			To start a particle effect OFF at game start give the func_emitter the property and value...

			start_off 1

			You can then make it start when you want by using target from any targetting entity eg a button or lever.

			Note that the particle effect may be very briefly visible at game start then turn off within a second. This is normal and I don't think can be avoided. In most cases this doesn't matter if the effect is not in the player's view right at game start.



	== Creating Your Own Particle Effects ==		== Creating Your Own Particle Effects ==