Frictional Game Wiki

<h1>Particle Editor</h1> <div class="level1"> <p> The Particle Editor is used to create Particle Systems to be used in maps or entities. </p> </div> <h2>Foreword</h2> <div class="level2"> </div> <h3>Min and Max values</h3> <div class="level3"> <p> A lot of values in this 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. </p> </div> <h3>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. </p> </div> <h2>Overview</h2> <div class="level2"> <p> When run, the first screen we get to see is like this: </p> <p> <img src="/lib/exe/fetch.php?media=hpl3:tools:particle_editor.png" class="mediacenter" alt="" /> </p> <p> Each part of the screen has a specific function, as follows: </p> </div> <h2>Main Menu</h2> <div class="level2"> <p> This is a menu bar, just like in any other windowed application. Available options for this particular editor are as follows: </p> <ul> <li class="level1 node"> <b>File</b><ul> <li class="level2"> <b>New</b>: This command will reset the Particle System to an empty one, and the editor to a default state as well.</li> <li class="level2"> <b>Open</b>: This will load a Particle System file (.ps) in the editor.</li> <li class="level2"> <b>Save</b>: Use this to save your work to a file in disk. Will ask for a file name when no file has been created.</li> <li class="level2"> <b>Save As</b>: This will also save your work, but will ask for a file name everytime it is called.</li> <li class="level2"> <b>Open Recent</b>: This will show a list of up to 10 files that have been recently loaded or saved.</li> <li class="level2"> <b>Quit</b>: This will exit the program.</li> </ul> </li> <li class="level1"> <b>Edit</b></li> <li class="level1"> <b>View</b></li> </ul> </div> <h2>Emitter management controls</h2> <div class="level2"> <p> These controls help to add, duplicate and remove particle emitters. The Add button will create a new particle emitter and select it (i.e. pick it in the combo box), the Copy button will create a copy emitter out of the selected one, and the Delete button will delete the selected emitter. </p> <p> When a particle emitter is selected, all its parameters will be shown in the tab frame below. </p> </div> <h2>Emitter parameters tab frame</h2> <div class="level2"> </div> <h3>General</h3> <div class="level3"> <ul> <li class="level1"> <b>Name</b>: The name of the emitter currently selected.</li> <li class="level1"> <b>Max Particles</b>: The maximum number of particles that can be alive at once. When this limit is reached no more particles will be created.</li> <li class="level1"> <b>Particles per Second</b>: The number of particles per second that will be created.</li> <li class="level1"> <b>Start time offset</b>: Time offset in seconds before the emitter starts.</li> <li class="level1"> <b>Respawn dead particles</b>: If dead particles should be respawned.</li> <li class="level1"> <b>Warm up time</b>: 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”.</li> <li class="level1"> <b>Pause</b>: A pause is a break during which no particles are created. Particles are updated though.</li> <li class="level1"> <b>Pause Length</b>: The length of the pauses, 0 and 0 means that there are no pauses.</li> <li class="level1"> <b>Pause Interval</b>: The length between pauses. 0 and 0 means that there are no pauses.</li> <li class="level1"> <b>Offset position</b>: How the emitter is offset relative to its starting position.</li> <li class="level1"> <b>Offset angle</b>: How the particle system is offset relative to its start angles.</li> </ul> </div> <h3>Start</h3> <div class="level3"> <ul> <li class="level1"> <b>Start type</b>: Sets what method to use to generate the start position of the particles in the emitter.</li> <li class="level1"> <b>Box start</b>: 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.</li> <li class="level1"> <b>Sphere start</b>: 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.</li> </ul> <p> <img src="/lib/exe/fetch.php?media=hpl2:tools:editors:spherestart.jpg" class="mediacenter" alt="" /> </p> </div> <h3>Movement</h3> <div class="level3"> <ul> <li class="level1"> <b>Velocity type</b>: The way in which the starting velocity is generated.</li> <li class="level1"> <b>Box velocity</b>: The same as box start but with velocity instead.</li> <li class="level1"> <b>Sphere Velocity</b>: The same as sphere start but with velocity instead.</li> <li class="level1"> <b>Coord system</b>: 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.</li> <li class="level1"> <b>Uses direction</b>: 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.</li> <li class="level1 node"> <b>Gravity Type</b>: The type of gravity being applied to the particles.<ul> <li class="level2"> <b>None</b>: No gravity it applied.</li> <li class="level2"> <b>Vector</b>: The gravity acceleration is applied.</li> <li class="level2"> <b>Centre</b>: The particles are drawn towards the centre of the particle system with Gravity Acceleration Y as acceleration.</li> </ul> </li> <li class="level1"> <b>Gravity Acceleration</b>: Used differently according by the gravity type.</li> <li class="level1"> <b>Acceleration</b>: Acceleration applied to all bodies.</li> <li class="level1"> <b>Speed multiplier</b>: 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.</li> <li class="level1"> <b>Maximum speed</b>: The maximum speed that the particles can reach.</li> </ul> </div> <h3>Rendering</h3> <div class="level3"> <ul> <li class="level1 node"> <b>Draw Type</b>: The different ways in which the particles can be draw to screen.<ul> <li class="level2"> <b>Point</b>: The particle is a point and will always be pointing towards the camera.</li> <li class="level2"> <b>Line</b>: The particle is aligned in the direction in which the particle is travelling.</li> </ul> </li> <li class="level1"> <b>Multiply RGB with Alpha</b>: 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.</li> <li class="level1"> <b>Size</b>: The size of the particle. This is the value used in the fading.</li> <li class="level1"> <b>Size Fading</b>: See 1.2 for instructions on fading.</li> </ul> </div> <h3>Color</h3> <div class="level3"> <p> <b>NOTE</b>: all of the color channels have values from 0 -1. </p> <ul> <li class="level1"> <b>Color</b>: This sets the color of the particle.</li> <li class="level1"> <b>Fading</b>: Settings for fading the color. See foreword for fading.</li> </ul> </div> <h3>Life</h3> <div class="level3"> <ul> <li class="level1"> <b>Lifespan</b>: Time in seconds that the particle will live.</li> <li class="level1"> <b>Death Type</b>: type of death for the particles. Currently only age can be selected.</li> <li class="level1"> <b>PS created at death</b>: Particle system to be spawned when the particle dies.</li> </ul> </div> <h3>Material</h3> <div class="level3"> <ul> <li class="level1"> <b>File</b>: The material file to use.</li> <li class="level1"> <b>Number of Files</b>: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.</li> <li class="level1"> <b>Animation length</b>: The number of seconds the animation lasts, if the particle lives longer than this time, the animation is looped.</li> <li class="level1 node"> <b>Sub Division</b>: 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 material already includes splitting info, so the only thing we need here is to specify how we want to use that setup:<ul> <li class="level2 node"> <b>Sub Division Type</b>: How the subdivisions are assigned to the particles.<ul> <li class="level3"> <b>Random</b>: A division is randomly picked.</li> <li class="level3"> <b>Animation</b>: During the life time of an object it has all the subdivisions. Starting in the upper left corning and ending in the lower right.</li> </ul> </li> </ul> </li> </ul> </div> <h3>Rotation</h3> <div class="level3"> <ul> <li class="level1"> <b>Use Particle Spinning</b>: If enabled, particles will rotate around themselves.</li> <li class="level1 node"> <b>Spin Type</b>: Type for the particle spinning. Can be:<ul> <li class="level2"> <b>Constant</b>: A value will be picked from the spin velocity range at random.</li> <li class="level2"> <b>Movement</b>: The rotation will be linked to how fast the particle is moving.</li> </ul> </li> <li class="level1"> <b>Particle spin velocity range (rad/s)</b>: Spin velocity for constant spin type.</li> <li class="level1"> <b>Use Revolution</b>: If enabled, particles will rotate around some axis.</li> <li class="level1"> <b>Revolution speed</b>: 3D Vector that will determine the axis and rotation speed for particles.</li> </ul> </div> <h3>Collision</h3> <div class="level3"> <ul> <li class="level1"> <b>Use Collision</b>: If collision detection should be used.</li> <li class="level1"> <b>Update Rate</b>: How many times a second collision is check for each particle.</li> <li class="level1"> <b>Maximum Collisions</b>: The maximum amount of collisions can have before dying.</li> <li class="level1"> <b>Bounce Amount</b>: How much of the speed is retained when bouncing. 0.5 means half of the speed. 2 means that the speed doubles when bouncing.</li> </ul> </div> <h2>Preview viewport</h2> <div class="level2"> <p> Here we will see the currently edited particle system in a preview fashion. Every time the user changes a parameter value, the particle system is reset. </p> </div>