Particles Tutorial - Revision history

Lou Montana: Text replacement - "{{Link|:Category:" to "{{Link|Category:"

2024-10-16T13:52:06Z

Text replacement - "{{Link|:Category:" to "{{Link|Category:"

← Older revision		Revision as of 15:52, 16 October 2024
Line 430:		Line 430:
	== See Also ==		== See Also ==

	* {{Link\|:Category:Particle System\|Particle System category}}		* {{Link\|Category:Particle System\|Particle System category}}
	* [[ParticleArray]] - particle array format		* [[ParticleArray]] - particle array format


	[[Category:Arma Scripting Tutorials]]		[[Category:Arma Scripting Tutorials]]

Lou Montana: Some wiki formatting

2024-07-04T19:52:01Z

Some wiki formatting

← Older revision		Revision as of 21:52, 4 July 2024
Line 1:		Line 1:
	{{TOC\|side}}		{{TOC\|side}}
	~~== Basics ==~~

	A '''{{Link\|https://en.wikipedia.org/wiki/Particle_system\|particle}}''' is a (to some extent, non-physical) 2D plane that always faces the camera, or (more rarely) a 3D model.		A '''{{Link\|https://en.wikipedia.org/wiki/Particle_system\|particle}}''' is a (to some extent, non-physical) 2D plane that always faces the camera, or (more rarely) a 3D model.
	It can be used to simulate ambient effects, such as dust, fire, water splash, wood splinters and even rock debris.		It can be used to simulate ambient effects, such as dust, fire, water splash, wood splinters and even rock debris.
Line 9:		Line 7:
	A particle (as well as a particle source) is '''[[Multiplayer Scripting#Locality\|local]]''' to the computer where the script has been called; one player could see smoke while another could see through without any issue.		A particle (as well as a particle source) is '''[[Multiplayer Scripting#Locality\|local]]''' to the computer where the script has been called; one player could see smoke while another could see through without any issue.

	{{Feature\|informative\|Particles exist since ~~[[:Category:Operation Flashpoint\|~~{{ofp}}]], but the first related command ([[drop]]) was only introduced in [[{{ofpr}}]].<br>		{{Feature\|informative\|Particles exist since {{GameCategory\|ofp\|link= y}}, but the first related command ([[drop]]) was only introduced in {{GameCategory\|ofpr\|link= y}}.<br>
	Particle source notions and commands were introduced in {{arma1}}, some commands were later added in {{arma3}} (e.g [[setParticleFire]], [[setParticleClass]]).}}		Particle source notions and commands were introduced in {{GameCategory\|arma1\|link= y}}, some commands were later added in {{GameCategory\|arma3\|link= y}} (e.g [[setParticleFire]], [[setParticleClass]]).}}


	== How to ==		== How To ==

	=== Create a ~~particle source~~ ===		=== Create a Particle Source ===

	<sqf>private _particleSource = "#particlesource" createVehicleLocal ASLToAGL getPosASL player;</sqf>		<sqf>private _particleSource = "#particlesource" createVehicleLocal ASLToAGL getPosASL player;</sqf>
Line 21:		Line 19:
	{{Feature\|informative\|A particle source is '''[[Multiplayer Scripting#Locality\|local]]''' (and all the particle commands take a local argument too), hence [[createVehicleLocal]] usage.}}		{{Feature\|informative\|A particle source is '''[[Multiplayer Scripting#Locality\|local]]''' (and all the particle commands take a local argument too), hence [[createVehicleLocal]] usage.}}

	{{ArgTitle\|3\|Set ~~source class~~\|{{GVI\|arma3\|0.50}}}}		{{ArgTitle\|3\|Set Source Class\|{{GVI\|arma3\|0.50}}}}

	<sqf>_particleSource setParticleClass "ObjectDestructionFire1Smallx"; // defined in configFile >> "CfgCloudlets"</sqf>		<sqf>_particleSource setParticleClass "ObjectDestructionFire1Smallx"; // defined in configFile >> "CfgCloudlets"</sqf>
Line 27:		Line 25:
	{{Feature\|informative\|Particle source class must be defined in game [[configFile\|config]] and '''cannot''' be declared in [[missionConfigFile]] or [[campaignConfigFile]]. See [[Arma 3: Particle Effects]] for more information.}}		{{Feature\|informative\|Particle source class must be defined in game [[configFile\|config]] and '''cannot''' be declared in [[missionConfigFile]] or [[campaignConfigFile]]. See [[Arma 3: Particle Effects]] for more information.}}

	=== Set ~~source parameters~~ ===		=== Set Source Parameters ===

	See [[ParticleArray]] for details on the array format.		See [[ParticleArray]] for details on the array format.
Line 49:		Line 47:
	</sqf>		</sqf>

	=== Set ~~source drop interval~~ ===		=== Set Source Drop Interval ===

	<sqf>_particleSource setDropInterval 0.0625; // duration between drops</sqf>		<sqf>_particleSource setDropInterval 0.0625; // duration between drops</sqf>

	=== Set ~~source drop circle~~ ===		=== Set Source Drop Circle ===

	<sqf>_particleSource setParticleCircle [3, [0,1,0]]; // [circle radius, velocity]</sqf>		<sqf>_particleSource setParticleCircle [3, [0,1,0]]; // [circle radius, velocity]</sqf>

	=== Set ~~source random values~~ ===		=== Set Source Random Values ===

	<sqf>		<sqf>
Line 75:		Line 73:
	</sqf>		</sqf>

	{{ArgTitle\|3\|Set ~~source fire properties~~\|{{GVI\|arma3\|1.08}}}}		{{ArgTitle\|3\|Set Source Fire Properties\|{{GVI\|arma3\|1.08}}}}

	<sqf>_particleSource setParticleFire [0.1, 0.5, 2]; // [coreIntensity, coreDistance, damageTime]</sqf>		<sqf>_particleSource setParticleFire [0.1, 0.5, 2]; // [coreIntensity, coreDistance, damageTime]</sqf>

	=== Delete ~~source~~ ===		=== Delete Source ===

	<sqf>deleteVehicle _particleSource; // as simple as that</sqf>		<sqf>deleteVehicle _particleSource; // as simple as that</sqf>

	=== Use the [[drop]] ~~command~~ ===		=== Use the [[drop]] Command ===

	The [[drop]] command only drops one particle. If multiple ones are needed, a loop ([[for]], [[while]]) must be used.		The [[drop]] command only drops one particle. If multiple ones are needed, a loop ([[for]], [[while]]) must be used.
Line 116:		Line 114:

	private _posATL = player modelToWorld [0,10,0];		private _posATL = player modelToWorld [0,10,0];


	ps1 = "#particlesource" createVehicleLocal _posATL;		ps1 = "#particlesource" createVehicleLocal _posATL;
Line 130:		Line 127:
	<sqf>execVM "particles.sqf";</sqf>		<sqf>execVM "particles.sqf";</sqf>

	This format deletes all previous effects and still allows you to use the [[Arma 3: Debug Console\|Debug Console]] in order to adjust particle source settings thanks to the usage of global variables (here, {{hl\|ps1}} and {{hl\|ps2}})		This format deletes all previous effects and still allows you to use the [[Arma 3: Debug Console\|Debug Console]] in order to adjust particle source settings thanks to the usage of global variables (here, {{hl\|ps1}} and {{hl\|ps2}}).

	=== Using a Mod ===		=== Using a Mod ===
Line 138:		Line 135:


	== ~~Full examples~~ ==		== Examples ==

	{{Feature\|informative\|The following examples are for {{arma2}} and later titles. For {{arma1}} examples, see [[ParticleTemplates]].}}		{{Feature\|informative\|The following examples are for {{arma2}} and later titles. For {{arma1}} examples, see [[ParticleTemplates]].}}
	{{Feature \| important \| For games other than {{arma3}}:		{{Feature\|important\|
			For games other than {{arma3}}:
	* remove [[private]] usage		* remove [[private]] usage
	* replace {{hl\|\A3\Data_F\}} with:		* replace {{hl\|\A3\Data_F\}} with:
Line 430:		Line 428:

	{{Clear}}		{{Clear}}
	== See ~~also~~ ==		== See Also ==

	* [[:Category:Particle System]]		* {{Link\|:Category:Particle System\|Particle System category}}
	* [[ParticleArray]] - particle array format		* [[ParticleArray]] - particle array format


	[[Category:Arma Scripting Tutorials]]		[[Category:Arma Scripting Tutorials]]

Lou Montana: Text replacement - "{{Feature | Informative | " to "{{Feature|informative|"

2024-05-16T20:41:51Z

Text replacement - "{{Feature | Informative | " to "{{Feature|informative|"

← Older revision		Revision as of 22:41, 16 May 2024
Line 9:		Line 9:
	A particle (as well as a particle source) is '''[[Multiplayer Scripting#Locality\|local]]''' to the computer where the script has been called; one player could see smoke while another could see through without any issue.		A particle (as well as a particle source) is '''[[Multiplayer Scripting#Locality\|local]]''' to the computer where the script has been called; one player could see smoke while another could see through without any issue.

	{{Feature \| ~~Informative~~ \| Particles exist since [[:Category:Operation Flashpoint\|{{ofp}}]], but the first related command ([[drop]]) was only introduced in [[{{ofpr}}]].<br>		{{Feature\|informative\|Particles exist since [[:Category:Operation Flashpoint\|{{ofp}}]], but the first related command ([[drop]]) was only introduced in [[{{ofpr}}]].<br>
	Particle source notions and commands were introduced in {{arma1}}, some commands were later added in {{arma3}} (e.g [[setParticleFire]], [[setParticleClass]]).}}		Particle source notions and commands were introduced in {{arma1}}, some commands were later added in {{arma3}} (e.g [[setParticleFire]], [[setParticleClass]]).}}

Line 19:		Line 19:
	<sqf>private _particleSource = "#particlesource" createVehicleLocal ASLToAGL getPosASL player;</sqf>		<sqf>private _particleSource = "#particlesource" createVehicleLocal ASLToAGL getPosASL player;</sqf>

	{{Feature \| ~~Informative~~ \| A particle source is '''[[Multiplayer Scripting#Locality\|local]]''' (and all the particle commands take a local argument too), hence [[createVehicleLocal]] usage.}}		{{Feature\|informative\|A particle source is '''[[Multiplayer Scripting#Locality\|local]]''' (and all the particle commands take a local argument too), hence [[createVehicleLocal]] usage.}}

	{{ArgTitle\|3\|Set source class\|{{GVI\|arma3\|0.50}}}}		{{ArgTitle\|3\|Set source class\|{{GVI\|arma3\|0.50}}}}
Line 25:		Line 25:
	<sqf>_particleSource setParticleClass "ObjectDestructionFire1Smallx"; // defined in configFile >> "CfgCloudlets"</sqf>		<sqf>_particleSource setParticleClass "ObjectDestructionFire1Smallx"; // defined in configFile >> "CfgCloudlets"</sqf>

	{{Feature \| ~~Informative~~ \| Particle source class must be defined in game [[configFile\|config]] and '''cannot''' be declared in [[missionConfigFile]] or [[campaignConfigFile]]. See [[Arma 3: Particle Effects]] for more information.}}		{{Feature\|informative\|Particle source class must be defined in game [[configFile\|config]] and '''cannot''' be declared in [[missionConfigFile]] or [[campaignConfigFile]]. See [[Arma 3: Particle Effects]] for more information.}}

	=== Set source parameters ===		=== Set source parameters ===
Line 140:		Line 140:
	== Full examples ==		== Full examples ==

	{{Feature \| ~~Informative~~ \| The following examples are for {{arma2}} and later titles. For {{arma1}} examples, see [[ParticleTemplates]].}}		{{Feature\|informative\|The following examples are for {{arma2}} and later titles. For {{arma1}} examples, see [[ParticleTemplates]].}}
	{{Feature \| important \| For games other than {{arma3}}:		{{Feature \| important \| For games other than {{arma3}}:
	* remove [[private]] usage		* remove [[private]] usage

Lou Montana: Text replacement - "[[Image:" to "[[File:"

2023-11-20T22:12:01Z

Text replacement - "[[Image:" to "[[File:"

← Older revision		Revision as of 00:12, 21 November 2023
Line 155:		Line 155:
	=== Burning Vehicle Fire Look-Alike ===		=== Burning Vehicle Fire Look-Alike ===

	[[~~Image~~:PE_BurningVehicleLookAlike.jpg\|thumb\|left\|100px\|Burning vehicle fire look-alike]]		[[File:PE_BurningVehicleLookAlike.jpg\|thumb\|left\|100px\|Burning vehicle fire look-alike]]
	<sqf>		<sqf>
	private _posATL = player modelToWorld [0,10,0];		private _posATL = player modelToWorld [0,10,0];
Line 192:		Line 192:
	=== Fire ===		=== Fire ===

	[[~~Image~~:PE_fire.jpg\|thumb\|left\|100px\|Fire]]		[[File:PE_fire.jpg\|thumb\|left\|100px\|Fire]]
	<sqf>		<sqf>
	private _posATL = player modelToWorld [0,10,0];		private _posATL = player modelToWorld [0,10,0];
Line 219:		Line 219:
	=== Floating Orb ===		=== Floating Orb ===

	[[~~Image~~:PE_FloatingOrb.jpg\|thumb\|left\|100px\|Floating Orb]]		[[File:PE_FloatingOrb.jpg\|thumb\|left\|100px\|Floating Orb]]
	<sqf>		<sqf>
	private _posATL = player modelToWorld [0,10,0];		private _posATL = player modelToWorld [0,10,0];
Line 234:		Line 234:
	=== Heavy Oily Smoke (Small) ===		=== Heavy Oily Smoke (Small) ===

	[[~~Image~~:PE_HeavyOilySmokeSmall.jpg\|thumb\|left\|100px\|Heavy Oily Smoke (Small)]]		[[File:PE_HeavyOilySmokeSmall.jpg\|thumb\|left\|100px\|Heavy Oily Smoke (Small)]]
	<sqf>		<sqf>
	private _posATL = player modelToWorld [0,10,0];		private _posATL = player modelToWorld [0,10,0];
Line 251:		Line 251:
	=== Heavy Oily Smoke (Medium) ===		=== Heavy Oily Smoke (Medium) ===

	[[~~Image~~:PE_HeavyOilySmokeMedium.jpg\|thumb\|left\|100px\|Heavy Oily Smoke (Medium)]]		[[File:PE_HeavyOilySmokeMedium.jpg\|thumb\|left\|100px\|Heavy Oily Smoke (Medium)]]
	<sqf>		<sqf>
	private _posATL = player modelToWorld [0,10,0];		private _posATL = player modelToWorld [0,10,0];
Line 268:		Line 268:
	=== Heavy Oily Smoke (Large) ===		=== Heavy Oily Smoke (Large) ===

	[[~~Image~~:PE_HeavyOilySmokeLarge.jpg\|thumb\|left\|100px\|Heavy Oily Smoke (Large)]]		[[File:PE_HeavyOilySmokeLarge.jpg\|thumb\|left\|100px\|Heavy Oily Smoke (Large)]]
	<sqf>		<sqf>
	private _posATL = player modelToWorld [0,10,0];		private _posATL = player modelToWorld [0,10,0];
Line 285:		Line 285:
	=== Light Wood Smoke (Small) ===		=== Light Wood Smoke (Small) ===

	[[~~Image~~:PE_LightWoodSmokeSmall.jpg\|thumb\|left\|100px\|Light Wood Smoke (Small)]]		[[File:PE_LightWoodSmokeSmall.jpg\|thumb\|left\|100px\|Light Wood Smoke (Small)]]
	<sqf>		<sqf>
	private _posATL = player modelToWorld [0,10,0];		private _posATL = player modelToWorld [0,10,0];
Line 302:		Line 302:
	=== Light Wood Smoke (Medium) ===		=== Light Wood Smoke (Medium) ===

	[[~~Image~~:PE_LightWoodSmokeMedium.jpg\|thumb\|left\|100px\|Light Wood Smoke (Medium)]]		[[File:PE_LightWoodSmokeMedium.jpg\|thumb\|left\|100px\|Light Wood Smoke (Medium)]]
	<sqf>		<sqf>
	private _posATL = player modelToWorld [0,10,0];		private _posATL = player modelToWorld [0,10,0];
Line 319:		Line 319:
	=== Light Wood Smoke (Large) ===		=== Light Wood Smoke (Large) ===

	[[~~Image~~:PE_LightWoodSmokeLarge.jpg\|thumb\|left\|100px\|Light Wood Smoke (Large)]]		[[File:PE_LightWoodSmokeLarge.jpg\|thumb\|left\|100px\|Light Wood Smoke (Large)]]
	<sqf>		<sqf>
	private _posATL = player modelToWorld [0,10,0];		private _posATL = player modelToWorld [0,10,0];
Line 336:		Line 336:
	=== Mixed Smoke (Small) ===		=== Mixed Smoke (Small) ===

	[[~~Image~~:PE_MixedSmokeSmall.jpg\|thumb\|left\|100px\|Mixed Smoke (Small)]]		[[File:PE_MixedSmokeSmall.jpg\|thumb\|left\|100px\|Mixed Smoke (Small)]]
	<sqf>		<sqf>
	private _posATL = player modelToWorld [0,10,0];		private _posATL = player modelToWorld [0,10,0];
Line 362:		Line 362:
	=== Mixed Smoke (Medium) ===		=== Mixed Smoke (Medium) ===

	[[~~Image~~:PE_MixedSmokeMedium.jpg\|thumb\|left\|100px\|Mixed Smoke (Medium)]]		[[File:PE_MixedSmokeMedium.jpg\|thumb\|left\|100px\|Mixed Smoke (Medium)]]
	<sqf>		<sqf>
	private _posATL = player modelToWorld [0,10,0];		private _posATL = player modelToWorld [0,10,0];
Line 388:		Line 388:
	=== Mixed Smoke (Large) ===		=== Mixed Smoke (Large) ===

	[[~~Image~~:PE_MixedSmokeLarge.jpg\|thumb\|left\|100px\|Mixed Smoke (Large)]]		[[File:PE_MixedSmokeLarge.jpg\|thumb\|left\|100px\|Mixed Smoke (Large)]]
	<sqf>		<sqf>
	private _posATL = player modelToWorld [0,10,0];		private _posATL = player modelToWorld [0,10,0];
Line 414:		Line 414:
	=== Rock Shower ===		=== Rock Shower ===

	[[~~Image~~:PE_RockShower.jpg\|thumb\|left\|100px\|Rock Shower]]		[[File:PE_RockShower.jpg\|thumb\|left\|100px\|Rock Shower]]
	<sqf>		<sqf>
	private _posATL = player modelToWorld [0,10,0];		private _posATL = player modelToWorld [0,10,0];

Lou Montana: Text replacement - "Arma[ _]3[ _]Debug[ _]Console" to "Arma 3: Debug Console"

2023-04-27T16:08:34Z

Text replacement - "Arma[ _]3[ _]Debug[ _]Console" to "Arma 3: Debug Console"

← Older revision		Revision as of 18:08, 27 April 2023
Line 106:		Line 106:
	== Design Workflow ==		== Design Workflow ==

	In order to determine ''one'' particle behaviour, a simple [[drop]] usage in the [[Arma 3 Debug Console\|Debug Console]] can do;		In order to determine ''one'' particle behaviour, a simple [[drop]] usage in the [[Arma 3: Debug Console\|Debug Console]] can do;
	but seeing the complete end result can be another task at hand.		but seeing the complete end result can be another task at hand.

Line 130:		Line 130:
	<sqf>execVM "particles.sqf";</sqf>		<sqf>execVM "particles.sqf";</sqf>

	This format deletes all previous effects and still allows you to use the [[Arma 3 Debug Console\|Debug Console]] in order to adjust particle source settings thanks to the usage of global variables (here, {{hl\|ps1}} and {{hl\|ps2}})		This format deletes all previous effects and still allows you to use the [[Arma 3: Debug Console\|Debug Console]] in order to adjust particle source settings thanks to the usage of global variables (here, {{hl\|ps1}} and {{hl\|ps2}})

	=== Using a Mod ===		=== Using a Mod ===

Lou Montana: Fix Wikipedia link

2023-02-23T22:53:03Z

Fix Wikipedia link

← Older revision		Revision as of 00:53, 24 February 2023
Line 2:		Line 2:
	== Basics ==		== Basics ==

	A '''{{~~Wikipedia~~\|~~Particle system~~\|particle}}''' is a (to some extent, non-physical) 2D plane that always faces the camera, or (more rarely) a 3D model.		A '''{{Link\|https://en.wikipedia.org/wiki/Particle_system\|particle}}''' is a (to some extent, non-physical) 2D plane that always faces the camera, or (more rarely) a 3D model.
	It can be used to simulate ambient effects, such as dust, fire, water splash, wood splinters and even rock debris.		It can be used to simulate ambient effects, such as dust, fire, water splash, wood splinters and even rock debris.

Lou Montana: Text replacement - "{{ExternalLink|" to "{{Link|"

2023-01-04T15:24:49Z

Text replacement - "{{ExternalLink|" to "{{Link|"

← Older revision		Revision as of 17:24, 4 January 2023
Line 135:		Line 135:

	'''Emitter 3Ditor''' (a real-time WYSIWYG particle source editor) adds and uses particle and light emitters in your scenarios '''without any scripting nor mod dependency'''.<br>		'''Emitter 3Ditor''' (a real-time WYSIWYG particle source editor) adds and uses particle and light emitters in your scenarios '''without any scripting nor mod dependency'''.<br>
	{{~~ExternalLink~~\|link= https://steamcommunity.com/sharedfiles/filedetails/?id=1613905318\|text= Steam page}} - {{~~ExternalLink~~\|link= https://forums.bohemia.net/forums/topic/221163-emitter-3ditor/\|text= Forums post}}		{{Link\|link= https://steamcommunity.com/sharedfiles/filedetails/?id=1613905318\|text= Steam page}} - {{Link\|link= https://forums.bohemia.net/forums/topic/221163-emitter-3ditor/\|text= Forums post}}

Lou Montana: Text replacement - "ASLtoAGL" to "ASLToAGL"

2022-07-29T16:58:01Z

Text replacement - "ASLtoAGL" to "ASLToAGL"

← Older revision		Revision as of 18:58, 29 July 2022
Line 17:		Line 17:
	=== Create a particle source ===		=== Create a particle source ===

	<sqf>private _particleSource = "#particlesource" createVehicleLocal ~~ASLtoAGL~~ getPosASL player;</sqf>		<sqf>private _particleSource = "#particlesource" createVehicleLocal ASLToAGL getPosASL player;</sqf>

	{{Feature \| Informative \| A particle source is '''[[Multiplayer Scripting#Locality\|local]]''' (and all the particle commands take a local argument too), hence [[createVehicleLocal]] usage.}}		{{Feature \| Informative \| A particle source is '''[[Multiplayer Scripting#Locality\|local]]''' (and all the particle commands take a local argument too), hence [[createVehicleLocal]] usage.}}

Lou Montana: Some wiki formatting

2022-07-22T10:27:46Z

Some wiki formatting

Show changes

Leopard20: fix fire

2022-02-12T18:35:02Z

fix fire

← Older revision		Revision as of 20:35, 12 February 2022
Line 191:		Line 191:
	[0.25,1], 1, 1, "", "", _ps1];		[0.25,1], 1, 1, "", "", _ps1];
	_ps1 [[setParticleRandom]] [0.2, [0.5, 0.5, 0.25], [0.125, 0.125, 0.125], 0.2, 0.2, [0, 0, 0, 0], 0, 0];		_ps1 [[setParticleRandom]] [0.2, [0.5, 0.5, 0.25], [0.125, 0.125, 0.125], 0.2, 0.2, [0, 0, 0, 0], 0, 0];
	_ps1 setDropInterval 0.05;		_ps1 [[setDropInterval]] 0.05;

	{{cc\|Smoke}}		{{cc\|Smoke}}