Particle Attachment for AI - Revision history

Baddcog at 14:15, 10 June 2007

2007-06-10T14:15:17Z

← Older revision		Revision as of 14:15, 10 June 2007
Line 1:		Line 1:
	== Attaching Particles to an AI ==		== Attaching Particles to an AI ==
	This page covers attaching particle systems to specific bones on an animated model (such as an AI).		This page covers attaching particle systems to specific bones on an animated model (such as an AI).
			This should work for any animated object, it must have an md5 file so it contains bones.

	The particle will be attached to a bone, this gives you plenty of options as most AI have 20+ bones. The names of the bones can be found in the AI's md5 file which can be opened with notepad or wordpad. For example, ''~~pagan_female_mesh~~.md5mesh'' contains the bones for the ~~Pagan female~~. The joint names are usually fairly obvious as the animators need to find that info easily. left_hand is obviously a bone in the left hand.		The particle will be attached to a bone, this gives you plenty of options as most AI have 20+ bones. The names of the bones can be found in the AI's md5 file which can be opened with notepad or wordpad. For example, ''steambot.md5mesh'' contains the bones for the steambot. The joint names are usually fairly obvious as the animators need to find that info easily. left_hand is obviously a bone in the left hand.

	You'll need to create a particle effect using the [[Particle Editor]], or you can use an existing particle effect. Once you have that you can add some info to your AI's def file.		You'll need to create a particle effect using the [[Particle Editor]], or you can use an existing particle effect. Once you have that you can add some info to your AI's def file. Be wary that editing an existing particle in the editor will change all particles of that type, so it's best to add a new particle via the editor (you can copy settings from a similar particle if you like).

	There are probably 2 ways to go with the particle attachment:		There are probably 2 ways to go with the particle attachment:
Line 39:		Line 40:
	The benefit of using this method instead of a timing script is that you can match the particles timing to an AI's action even if something happens in time to mess up the sync.		The benefit of using this method instead of a timing script is that you can match the particles timing to an AI's action even if something happens in time to mess up the sync.

	~~Another consideration is that particles seem~~ to ~~be emitted about~~ the ~~same size as~~ the ~~bone they are coming from~~. ~~You may need to adjust parameters in~~ the [[Particle Editor]] or the particles ~~def file to resize~~, ~~I have yet to test this~~.		Once you have the particle attached to the AI you can go in game and bring down the console ( ''Shift ~'' ) and type '''editparticles'''. This will open the [[Particle Editor]] and you can edit the size, shape, timing, gravity, ect... of the particles. It takes a minute so be patient, once it has been opened it will only take a second to open again until you restart game mode.

			If your number of particles being emitted is too high, the movement speed is too low, or a combination of these two then you might not notice them being emitted at the desired keyframe. If you want visible puffs using only one or two particles, increase as needed.


	------------This is probably to be deleted soon, need to test self starting particles		------------This is probably to be deleted soon, need to test self starting particles

Greebo: categorised

2007-06-10T09:31:33Z

categorised

← Older revision		Revision as of 09:31, 10 June 2007
Line 44:		Line 44:
	I believe nothing other than '''"smokeParticleSystem1" "smokestack"''' is needed, they seem to start on their own, but if you want to start them you need to use above instruct		I believe nothing other than '''"smokeParticleSystem1" "smokestack"''' is needed, they seem to start on their own, but if you want to start them you need to use above instruct
	---------		---------

			[[Category:AI]]
			[[Category:Tutorial]]

Crispy: Miscellaneous cleanup

2007-06-10T08:40:15Z

Miscellaneous cleanup

← Older revision		Revision as of 08:40, 10 June 2007
Line 1:		Line 1:
	== Attaching Particles to an AI ==		== Attaching Particles to an AI ==
			This page covers attaching particle systems to specific bones on an animated model (such as an AI).

	~~Fairly easy~~ to ~~attach particles to an~~ AI ~~once someone looks into~~ the ~~SDK~~ for ~~you :D~~		The particle will be attached to a bone, this gives you plenty of options as most AI have 20+ bones. The names of the bones can be found in the AI's md5 file which can be opened with notepad or wordpad. For example, ''pagan_female_mesh.md5mesh'' contains the bones for the Pagan female. The joint names are usually fairly obvious as the animators need to find that info easily. left_hand is obviously a bone in the left hand.

	The particle will be attached to a bone, this gives you plenty of options as most AI have 20+ bones. The names of the bones can be found in the AI's md5 file which can be opened with notepad or wordpad.		You'll need to create a particle effect using the [[Particle Editor]], or you can use an existing particle effect. Once you have that you can add some info to your AI's def file.
	~~ie: ''pagan_female_mesh.md5mesh'' , usually the joint names are fairly obvious as the animators need to find that info easily. left_hand is obviously a bone in the left hand.~~

	You'll need to create a particle effect using the [[Particle Editor]]. Once you have that you can add some info to your AI's def file~~. It's probably best if you want to add a fire particle to a pagan females hand that you copy her .def file and give it a new name, this way the pagan_female files won't get messed up~~.

	There are probably 2 ways to go with the particle attachment:		There are probably 2 ways to go with the particle attachment:
Line 12:		Line 10:
	*particle emitted at intervals.		*particle emitted at intervals.

	Adding ~~this line~~ to your AI~~'s ''entity def description'' (entityDef atdm:lantern_bot)~~ will add a particle (''steam_puff'') to the joint named ''smokestack''.		Adding the following [[spawnarg]] to your AI will add a particle named ''steam_puff'' to the joint named ''smokestack''.

	'''"smokeParticleSystem1" "steam_puff-smokestack"'''		'''"smokeParticleSystem1" "steam_puff-smokestack"'''

	~~Alternately~~ you can add the particle named ''smokestack'' to the joint named ''smokestack'' by using this line		Alternatively you can add the particle named ''smokestack'' to the joint named ''smokestack'' by using this line

	'''"smokeParticleSystem1" "smokestack"'''		'''"smokeParticleSystem1" "smokestack"'''

	The first option is probably best as you can reuse particles instead of making a new one to match the joint name. Either way you'll notice that the above lines contain ''smokeParticleSystem1''. An AI can have multiple smokeParticleSystems attached. The Monster_Boss_Cyberdemon.def from D3 has 1-9, 2 are used for footsteps, the other seem to be ~~permenately~~ attached flame particles to his back and mouth.		The first option is probably best as you can reuse particles instead of making a new one to match the joint name. Either way you'll notice that the above lines contain ''smokeParticleSystem1''. An AI can have multiple smokeParticleSystems attached, in which case just increase the number: smokeParticleSystem2, smokeParticleSystem3, etc. The Monster_Boss_Cyberdemon.def from standard Doom 3 has 9 of these; 2 are used for footsteps, the other seem to be permanently attached flame particles to his back and mouth.

	OK, ~~great~~ you ~~say~~. ~~But I only want a steam puff coming from my steambot's smokestack everytime the top of the stack opens~~. ~~(In this case it happens to be toward the end of each anim)~~		'''Note:''' Even though the spawnargs are called ''smoke''ParticleSystem#, you don't have to use them just for smoke. They work with any particle effect.

	~~If so~~ you~~'ll need to add~~ a ~~line to your AI~~'s ~~''model def description''. This can also be found in~~ the AI.~~def file~~ (in this case ~~lantern_bot.def). It will make a steampuff appear on~~ the ~~31st frame at~~ the ~~smokestack joint.~~		OK, great you say. But I only want a steam puff coming from my steambot's smokestack everytime the top of the stack opens. (In this case the stack happens to open towards the end of each animation.)
	~~(you can also call things like footstep sounds, or alert sounds in this manner). Importing the model and~~ animation ~~into a 3d program are probably the easiest way to find a specifc frame, but you can also get it right by trial/error guessing~~. ~~Most animations are around 30 frames, look for cycles. A bipeds walk anim is usually 2 steps (ie left foot, right foot~~) ~~so a dust cloud coming from his right foot would be somewhere around frame 25, if it's late or early you can adjust until you get it close enough.~~

	~~The benefit of using this method instead of~~ a ~~timing script is that you~~ can ~~match~~ the ~~particles timing to an~~ AI's ~~action even if something happens~~ in ~~time to mess up the sync~~.		If so you'll need to add a line to your AI's ''model def description'', as in the example below. This can be found in the AI's .def file (in this case lantern_bot.def).

	anim walk models/md5/chars/steambots/lant_bot_walk.md5anim		anim walk models/md5/chars/steambots/lant_bot_walk.md5anim
Line 35:		Line 32:
	frame 31 '''triggerSmokeParticle smokestack'''		frame 31 '''triggerSmokeParticle smokestack'''
	}		}

			In the above example, all of the particle effects attached to the bone named "smokestack" will start from the beginning every time the "walk" animation is at frame 31.

			Importing the model and animation into a 3d program are probably the easiest way to find a specific frame, but you can also get it right by trial/error guessing. Most animations are around 30 frames, look for cycles. A bipeds walk anim is usually 2 steps (ie left foot, right foot) so a dust cloud coming from his right foot would be somewhere around frame 25, if it's late or early you can adjust until you get it close enough.

			The benefit of using this method instead of a timing script is that you can match the particles timing to an AI's action even if something happens in time to mess up the sync.

	Another consideration is that particles seem to be emitted about the same size as the bone they are coming from. You may need to adjust parameters in the [[Particle Editor]] or the particles def file to resize, I have yet to test this.		Another consideration is that particles seem to be emitted about the same size as the bone they are coming from. You may need to adjust parameters in the [[Particle Editor]] or the particles def file to resize, I have yet to test this.
Line 41:		Line 44:
	I believe nothing other than '''"smokeParticleSystem1" "smokestack"''' is needed, they seem to start on their own, but if you want to start them you need to use above instruct		I believe nothing other than '''"smokeParticleSystem1" "smokestack"''' is needed, they seem to start on their own, but if you want to start them you need to use above instruct
	---------		---------
	~~CODE~~
	/*
	~~=====================~~
	~~idAI::SpawnParticles~~
	~~=====================~~
	*/
	~~void idAI::SpawnParticles( const char *keyName ) {~~
	~~const idKeyValue *kv = spawnArgs.MatchPrefix( keyName, NULL );~~
	~~while ( kv ) {~~
	~~particleEmitter_t pe;~~

	~~idStr particleName = kv->GetValue();~~

	~~if ( particleName.Length() ) {~~

	~~idStr jointName = kv->GetValue();~~
	~~int dash = jointName.Find('-');~~
	~~if ( dash > 0 ) {~~
	~~particleName = particleName.Left( dash );~~
	~~jointName = jointName.Right( jointName.Length() - dash - 1 );~~
	}

	~~SpawnParticlesOnJoint( pe, particleName, jointName );~~
	~~particles.Append( pe );~~
	}

	~~kv = spawnArgs.MatchPrefix( keyName, kv );~~
	}
	}


	That's probably Greek to you if you've never seen C++ before... So I'll explain it. Basically what it's doing is looking for a dash (-) in the value of the spawnarg. Everything left of the dash is the name of the particle. Everything to the right of the dash is the name of the joint (for our purposes, a joint just means a bone). If there's no dash, then the particle name is the same as the joint name - this is probably what's happening in your case. It's finding the bone named "smokestack", but it's also looking for a particle named "smokestack". Since it doesn't find such a particle, you get black squares.

	~~So if you want a particle called myawesomeparticle to be (permanently!) emitted from the bone smokestack, you might use the following spawnarg:~~

	~~"smokeParticleSystem1" "myawesomeparticle-smokestack"~~

	So far so good, but it's not active yet (I think - you might want to test this yourself to be sure). So you need to use the triggerSmokeParticle frame command to turn it on. As you've discovered, this is placed within an "anim" block and takes this format:

	~~frame [framenumber] [bonename]~~

	Where [framenumber] is the frame number of the animation, and [bonename] is the name of the bone/joint on which to trigger particle effects. Note that all particle effects on that bone will be triggered, if you have more than one.

Baddcog at 04:10, 10 June 2007

2007-06-10T04:10:34Z

← Older revision		Revision as of 04:10, 10 June 2007
Line 12:		Line 12:
	*particle emitted at intervals.		*particle emitted at intervals.

	Adding this line to your AI's ''entity def description'' (entityDef atdm:lantern_bot) will add a particle (''~~bc_sparx~~'') to the joint named ''smokestack''.		Adding this line to your AI's ''entity def description'' (entityDef atdm:lantern_bot) will add a particle (''steam_puff'') to the joint named ''smokestack''.

	'''"smokeParticleSystem1" "~~bc_sparx~~-smokestack"'''		'''"smokeParticleSystem1" "steam_puff-smokestack"'''

	Alternately you can add the particle named ''smokestack'' to the joint named ''smokestack'' by using this line		Alternately you can add the particle named ''smokestack'' to the joint named ''smokestack'' by using this line
Line 36:		Line 36:
	}		}

			Another consideration is that particles seem to be emitted about the same size as the bone they are coming from. You may need to adjust parameters in the [[Particle Editor]] or the particles def file to resize, I have yet to test this.

	------------This is probably to be deleted soon, need to test self starting particles		------------This is probably to be deleted soon, need to test self starting particles

Baddcog at 04:07, 10 June 2007

2007-06-10T04:07:17Z

← Older revision		Revision as of 04:07, 10 June 2007
Line 6:		Line 6:
	ie: ''pagan_female_mesh.md5mesh'' , usually the joint names are fairly obvious as the animators need to find that info easily. left_hand is obviously a bone in the left hand.		ie: ''pagan_female_mesh.md5mesh'' , usually the joint names are fairly obvious as the animators need to find that info easily. left_hand is obviously a bone in the left hand.

	You'll need to create a [[Particle ~~Effect~~]]. Once you have that you can add some info to your AI's def file. It's probably best if you want to add a fire particle to a pagan females hand that you copy her .def file and give it a new name, this way the pagan_female files won't get messed up.		You'll need to create a particle effect using the [[Particle Editor]]. Once you have that you can add some info to your AI's def file. It's probably best if you want to add a fire particle to a pagan females hand that you copy her .def file and give it a new name, this way the pagan_female files won't get messed up.

	There are probably 2 ways to go with the particle attachment:		There are probably 2 ways to go with the particle attachment:

Baddcog at 04:06, 10 June 2007

2007-06-10T04:06:30Z

← Older revision		Revision as of 04:06, 10 June 2007
Line 6:		Line 6:
	ie: ''pagan_female_mesh.md5mesh'' , usually the joint names are fairly obvious as the animators need to find that info easily. left_hand is obviously a bone in the left hand.		ie: ''pagan_female_mesh.md5mesh'' , usually the joint names are fairly obvious as the animators need to find that info easily. left_hand is obviously a bone in the left hand.

	You'll need to create a [[~~particle effect~~]]. Once you have that you can add some info to your AI's def file. It's probably best if you want to add a fire particle to a pagan females hand that you copy her .def file and give it a new name, this way the pagan_female files won't get messed up.		You'll need to create a [[Particle Effect]]. Once you have that you can add some info to your AI's def file. It's probably best if you want to add a fire particle to a pagan females hand that you copy her .def file and give it a new name, this way the pagan_female files won't get messed up.

	There are probably 2 ways to go with the particle attachment:		There are probably 2 ways to go with the particle attachment:

Baddcog at 04:06, 10 June 2007

2007-06-10T04:06:01Z

← Older revision		Revision as of 04:06, 10 June 2007
Line 6:		Line 6:
	ie: ''pagan_female_mesh.md5mesh'' , usually the joint names are fairly obvious as the animators need to find that info easily. left_hand is obviously a bone in the left hand.		ie: ''pagan_female_mesh.md5mesh'' , usually the joint names are fairly obvious as the animators need to find that info easily. left_hand is obviously a bone in the left hand.

	You'll need to create a particle effect. Once you have that you can add some info to your AI's def file. It's probably best if you want to add a fire particle to a pagan females hand that you copy her .def file and give it a new name, this way the pagan_female files won't get messed up.		You'll need to create a [[particle effect]]. Once you have that you can add some info to your AI's def file. It's probably best if you want to add a fire particle to a pagan females hand that you copy her .def file and give it a new name, this way the pagan_female files won't get messed up.

	There are probably 2 ways to go with the particle attachment:		There are probably 2 ways to go with the particle attachment:

Baddcog at 04:04, 10 June 2007

2007-06-10T04:04:32Z

← Older revision		Revision as of 04:04, 10 June 2007
Line 12:		Line 12:
	*particle emitted at intervals.		*particle emitted at intervals.

	Adding this line to your AI's ''entity def description'' (''entityDef atdm:lantern_bot'') will add a particle (''bc_sparx'') to the joint named ''smokestack''.		Adding this line to your AI's ''entity def description'' (entityDef atdm:lantern_bot) will add a particle (''bc_sparx'') to the joint named ''smokestack''.

	'''"smokeParticleSystem1" "bc_sparx-smokestack"'''		'''"smokeParticleSystem1" "bc_sparx-smokestack"'''

Baddcog at 04:04, 10 June 2007

2007-06-10T04:04:14Z

← Older revision		Revision as of 04:04, 10 June 2007
Line 14:		Line 14:
	Adding this line to your AI's ''entity def description'' (''entityDef atdm:lantern_bot'') will add a particle (''bc_sparx'') to the joint named ''smokestack''.		Adding this line to your AI's ''entity def description'' (''entityDef atdm:lantern_bot'') will add a particle (''bc_sparx'') to the joint named ''smokestack''.

	'''"smokeParticleSystem1" "bc_sparx-smokestack"'''		'''"smokeParticleSystem1" "bc_sparx-smokestack"'''

	Alternately you can add the particle named ''smokestack'' to the joint named ''smokestack'' by using this line		Alternately you can add the particle named ''smokestack'' to the joint named ''smokestack'' by using this line

	'''"smokeParticleSystem1" "smokestack"'''		'''"smokeParticleSystem1" "smokestack"'''

	The first option is probably best as you can reuse particles instead of making a new one to match the joint name. Either way you'll notice that the above lines contain ''smokeParticleSystem1''. An AI can have multiple smokeParticleSystems attached. The Monster_Boss_Cyberdemon.def from D3 has 1-9, 2 are used for footsteps, the other seem to be permenately attached flame particles to his back and mouth.		The first option is probably best as you can reuse particles instead of making a new one to match the joint name. Either way you'll notice that the above lines contain ''smokeParticleSystem1''. An AI can have multiple smokeParticleSystems attached. The Monster_Boss_Cyberdemon.def from D3 has 1-9, 2 are used for footsteps, the other seem to be permenately attached flame particles to his back and mouth.

Baddcog at 04:03, 10 June 2007

2007-06-10T04:03:52Z

← Older revision		Revision as of 04:03, 10 June 2007
Line 39:		Line 39:

	------------This is probably to be deleted soon, need to test self starting particles		------------This is probably to be deleted soon, need to test self starting particles
	~~-------------~~I believe nothing other than '''"smokeParticleSystem1" "smokestack"''' is needed, they seem to start on their own, but if you want to start them you need to use above instruct-----------		I believe nothing other than '''"smokeParticleSystem1" "smokestack"''' is needed, they seem to start on their own, but if you want to start them you need to use above instruct
			---------
	CODE		CODE
	/*		/*