Frictional Game Wiki

<h1>HPL Particle Editor</h1> <div class="level1"> </div> <h2>1 Introduction</h2> <div class="level2"> <p> This is the guide for the HPL-Particle editor which is a tool for creating various particle effects. This page is not up-to-date, the particle editor has more features and functions than listed here. Most can be experimented and understood without any documentation, but if you are up for it please update the wiki documentation.<br/> <br/> <br/> </p> </div> <h3>1.1 Min and Max values</h3> <div class="level3"> <p> A lot of values in the editor have both a min and max. This means that when the value is set to a particle a value between min and max is randomly selected.<br/> <br/> <br/> </p> </div> <h3>1.2 Fading</h3> <div class="level3"> <p> Fading can be used to fade in and/or out some property like size or colour. The fading works like this. There are three relative values that are relative to the start value of the particle. The names for these values are start, middle and end and are used in that order. There are also two times that are relative to the life of the particle, for example if a particle has 2 seconds life time and the middle time is 0.5 then this occurs after 1 second (0.5 * 2). The first time is called middle time and this is when the start value is entirely faded from start to middle. The middle length is how long the middle value lasts. After middle time + middle length the middle value is faded to the end value.<br/> <br/> <br/> </p> </div> <h2>2 Parameters</h2> <div class="level2"> </div> <h3>2.1. General</h3> <div class="level3"> <p> <b>Name</b><br/> The name of the emitter currently selected.<br/> <br/> </p> <p> <b>Max Particles</b><br/> The maximum number of particles that can be alive at once. When this limit is reached no more particles willl be created.<br/> <br/> </p> <p> <b>Particles per Second</b><br/> The number of particles per second that will be created.<br/> <br/> </p> <p> <b>Start time offset</b><br/> Time offset in seconds before the emitter starts.<br/> <br/> </p> <p> <b>Respawn dead particles</b><br/> If dead particles should be respawned.<br/> <br/> </p> <p> <b>Warm up time</b><br/> Time that the emitter gets to warm up. This is useful when doing a a stream of something (like a fire or waterfall) and the particles should not be shown “starting up”.<br/> <br/> </p> <p> <b>Pause</b><br/> A pause is a break during which no particles are created. Particles are updated though.<br/> <br/> </p> <p> <b>Pause Length</b><br/> The length of the pauses, 0 and 0 means that there are no pauses.<br/> <br/> </p> <p> <b>Pause Interval</b><br/> The length between pauses. 0 and 0 means that there are no pauses.<br/> <br/> </p> <p> <b>Offset position</b><br/> How the emitter is offset relative to its starting positon.<br/> <br/> </p> <p> <b>Offset angle</b><br/> How to particle system is offset relative to its start angles.<br/> <br/> <br/> </p> </div> <h3>2.2 Start</h3> <div class="level3"> <p> <b>Start type</b><br/> Sets what method to use to generate the start position of the particles in the emitter.<br/> <br/> </p> <p> <b>Box start</b><br/> A box start is created using an x, y and z min and max value. The collection of particles will get the shape of a box.<br/> <br/> </p> <p> <b>Sphere start</b><br/> The positions are generated using an angle interval and the min and max value for the radius. You can think of it like this; an arrow start pointing up. This arrow is then rotated around the X axis (red) using a value between min and max. After that the arrow is rotated by the y axis (blue). The arrow will now be pointing in a specific direction and in this direction a position is created at a distance from center according to a number generated from min/max radius.<br/> <a href="/lib/exe/detail.php?id=hpl1%3Adocumentation%3Aparticle_editor_document&media=document:spherestart.jpg" class="media wikilink2" title="document:spherestart.jpg"><img src="/lib/exe/fetch.php?media=document:spherestart.jpg" class="media" alt="" /></a> <br/> <br/> </p> </div> <h3>2.3 Movement</h3> <div class="level3"> <p> <b>Velocity type</b><br/> The way in which the starting velocity is generated.<br/> <br/> </p> <p> <b>Box velocity</b><br/> The same as box start but with velocity instead.<br/> <br/> </p> <p> <b>Sphere Velocity</b><br/> The same as sphere start but with velocity instead.<br/> <br/> </p> <p> <b>Coord system</b><br/> The way in which the particles are related to the world and the object the system is attached to (if any). In world all the particles have an individual postion that does change depending on the parent object. In local however the particle position is dependant on the parent object so if that the particle moves and turns along with the parent.<br/> <br/> </p> <p> <b>Uses direction</b><br/> If the direction of the start velocity depends on the way the particle system is “facing” (with no rotation it faces up). This is useful for systems like steam where the system has a direction.<br/> <br/> </p> <p> <b>Gravity Type</b><br/> The type of gravity being applied to the particles.<br/> None: No gravity it applied.<br/> Vector: The gravity acceleration is applied.<br/> Centre: The particles are drawn towards the centre of the particle system with Gravity Acceleration Y as acceleration.<br/> <br/> </p> <p> <b>Gravity Acceleration</b><br/> Used differently according by the gravity type.<br/> <br/> </p> <p> <b>Acceleration</b><br/> Accleration applied to all bodies.<br/> <br/> </p> <p> <b>Speed multiplier</b><br/> How much the speed is multiplied by each second. For example, 0.5 means that the speed halfed each second. 2 means it is doubled each second.<br/> <br/> </p> <p> <b>Maximum speed</b><br/> The maximum speed that the particles can reach.<br/> <br/> <br/> </p> </div> <h3>2.4 Life</h3> <div class="level3"> <p> <b>Lifespan</b><br/> Time in seconds that the particle will live.<br/> <br/> <br/> </p> </div> <h3>2.5 Colour</h3> <div class="level3"> <p> <em>NOTE: all of the colour channels have values from 0 -1.</em><br/> </p> <p> <b>Color</b><br/> This sets the colour of the particle.<br/> <br/> </p> <p> <b>Fading</b><br/> Settings for fading the colour. See chapter 1.2 for fading.<br/> <br/> <br/> </p> </div> <h3>2.6 Rendering</h3> <div class="level3"> <p> <b>Draw Type</b><br/> The different ways in which the particles can be draw to screen.<br/> Point: The particle is a point and will always be pointing towards the camera.<br/> Line: The particle is aligned in the direction in which the particle is travelling.<br/> <br/> </p> <p> <b>Multiply RGB with Alpha</b><br/> Some materials does not fade out the image when alpha is decreased (for example Additive) in this case it can be good to check this.<br/> <br/> </p> <p> <b>Size</b><br/> The size of the particle. This is the value used in the fading.<br/> <br/> </p> <p> <b>Size Fading</b><br/> See 1.2 for instructions on fading.<br/> <br/> <br/> </p> </div> <h3>2.7 Collision</h3> <div class="level3"> <p> <b>Use Collision</b><br/> If collision detection should be used.<br/> <br/> </p> <p> <b>Update Rate</b><br/> How many times a second collision is check for each particle.<br/> <br/> </p> <p> <b>Maximum Collisions</b><br/> The maximum amount of collions can have before dying.<br/> <br/> </p> <p> <b>Bounce Amount</b><br/> How much of the speed is retained when bouncing. 0.5 means half of the speed. 2 means that the speed doubles when bouncing.<br/> <br/> <br/> </p> </div> <h3>2.8 Material</h3> <div class="level3"> <p> <b>File</b><br/> The material file to use.<br/> <br/> </p> <p> <b>Number of Files</b><br/> The number of material files used. Normally this should just be one, but in some cases an animation needed is spread out over several material files. When using several material files these must be name “[name]01.mat”, “[name]02.mat”, etc. Also the file text must be just “[name]”. So if the files are called “test01.mat”, “test02.mat”, etc it must say “test” in the file field.<br/> <br/> </p> <p> <b>Animation length</b><br/> The number of seconds the animation lasts, if the particle lives longer than this time, the animation is looped.<br/> <br/> </p> <p> <b>Sub Division</b><br/> This is used in order to animate individual particles (when using several files, the material for all particles are changed at the same time). It can also be used for more variety among particles. The sub divisoion is set up by specifying how the texture is to be split and then setting how the particles will be assigned to a sub division. The splitting is like this:<br/> <a href="/lib/exe/detail.php?id=hpl1%3Adocumentation%3Aparticle_editor_document&media=document:subdiv.jpg" class="media wikilink2" title="document:subdiv.jpg"><img src="/lib/exe/fetch.php?media=document:subdiv.jpg" class="media" alt="" /></a> <br/> </p> <p> <b>Sub Division Amount</b><br/> The number of divisons on each axis.<br/> <br/> </p> <p> <b>Sub Division Type</b><br/> How the subdivisions are assigned to the particles.<br/> Random: A division is randomly picked.<br/> Animation: During the life time of an object it has all the subdivisions. Starting in the upper left corning and ending in the lower right.<br/> <br/> <br/> </p> </div> <h2>3 Tutorials</h2> <div class="level2"> <p> <a href="/doku.php?id=hpl1:documentation:tutorial.4.-.particles" class="wikilink2" title="hpl1:documentation:tutorial.4.-.particles" rel="nofollow">See tutorial 4</a><br/> <br/> <br/> </p> </div>