Scripting:AIBreathTutorial

Setting up the TWTrapAIBreath system is fairly simple, but it's important to note that directly attaching the particles to the AI will produce very odd-looking particle behaviour: you must use an intermediary marker as a detail attachment and attach the particles to that proxy object if you want the particles to behave sensibly.

You can find a complete example of this setup in the TWScriptDemo mission files, including the fpuff.tga file needed for the particles.

Obviously before you begin you should make sure that TWScript is loaded in your FM, or you'll end up with AIs constantly breathing out steam wherever they go!

BreathProxy and AIBreath

The first step to setting up the system is to create the breath proxy marker and particle archetype:

• Open the Object Hierarchy
• Open Object -> fnord and select Marker
• Click Add and enter the name BreathProxy
• Open Object -> SFX -> GasFX and select RoboSteam
• Click Addand enter the name AIBreath
• Select AIBreath and click Edit
• Add SFX -> Particle Launch Info
• Enter the following settings and click OK

• Add SFX -> Particles
• Enter the following settings and click OK

• Finally add Links -> ParticleAttachement and set the link to go from AIBreath to BreathProxy (Note this should be ParticleAttachement, not ~ParticleAttachement)

AI Setup

Next you need to either modify existing AIs to add the TWTrapAIBreath setup, or create new archetypes of each AI that needs to have the system applied. It's likely that any AI that chases the player may end up being drawn into a cold area, so arguably you could add the necessary elements to physical -> Creature -> Animal -> Human, but there are no free Script slots on that archetype. The following gives instructions for modifying the existing guard archetype - you may want to add the modifications to the other Human subobjects:

• Select Object -> physical -> Creature -> Animal -> Human -> guard and click Edit
• Add Editor -> Design Note and set the design note to, for example:

TWTrapAIBreathColdRooms=Outside;TWTrapAIBreathExhaleTime=600

• Select Scripts and click Edit
• Add TWTrapAIBreath to the list of scripts
• Add Links -> ~DetailAttachement and make the link go from guard to BreathProxy
• Edit the data for the newly added link, and set the values to the following - this should place the BreathProxy object in front of the face of most AIs:

Room setup

Now you have AIs that will have visible breath when they are in any room that is an instance of the the Outside room archetype:

• Open the Object Hierarchy
• From Show Tree select Rooms
• Select Base Room -> Default Room
• Click Add and enter the name Outside
• Click Create
• Start placing your outside rooms.

If you want to use several different 'outside' room archetypes, just make sure you add the names to the TWTrapAIBreathColdRooms parameter in the design note.

With everything set up, you can place your AIs as normal and they will pick up the script and detail attachment automatically - if you are retrofitting an existing FM with the system, you will need to either delete and remake your existing AIs, or manually add the necessary BreathProxy object and DetailAttachement links for each.