Emitter 3Ditor Wiki

User Tools

Site Tools

Trace:
ped_ui

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
ped_ui [2021/11/28 14:58] – [Basic Params] hnegped_ui [2024/08/31 08:24] (current) – [Export/Import] hneg
Line 44: Line 44:
   * **//Revert//**:\\ This is a Hail-Mary pass in case some sort of error occurs that corrupts the tool’s database.\\ Pressing this button will wipe everything edited with this tool from the scenario which should save the scenario from doom. This situation is covered later in more detail.   * **//Revert//**:\\ This is a Hail-Mary pass in case some sort of error occurs that corrupts the tool’s database.\\ Pressing this button will wipe everything edited with this tool from the scenario which should save the scenario from doom. This situation is covered later in more detail.
 ===== Basic Params ===== ===== Basic Params =====
-<BOOKMARK:basic_params> For the purposes of explaining the data you see on the tool UI, insert a single emitter and select **//MediumDestructionFire//** from the **//Emitter Class//** list. The **//Basic Params//** leaf should look like this (and flames should be emitting from the emitter):+<BOOKMARK:basic_params> For the purposes of explaining the data you see on the tool UI, insert a single emitter and select **//MediumDestructionFire//** from the **//Emitter Class//** list. The [[ped_ui#basic_params|Basic Params]] leaf should look like this (and flames should be emitting from the emitter):
 {{:005b_ped_basic.png|}} {{:005b_ped_basic.png|}}
  
Line 98: Line 98:
 ===== Render Params ===== ===== Render Params =====
 {{:006_ped_render.png|}} {{:006_ped_render.png|}}
-This also works in lieu of the animation discussed in [[:ped_ui#anchorname|Basic Params]].+This also works in lieu of the animation discussed in [[ped_ui#basic_params|Basic Params]].
 The animation is also affected by the lifetime of the particle, so when dealing with the animation all the following parameters play together: //Sprite, nTieth, Index, Count, Loop, Lifetime, Scale and Anim Speed//. The animation is also affected by the lifetime of the particle, so when dealing with the animation all the following parameters play together: //Sprite, nTieth, Index, Count, Loop, Lifetime, Scale and Anim Speed//.
 <wrap hi>**If the particle lifetime is longer than the animation and the animation is not looped the last frame of the animation is shown until the particle dies.**</wrap> <wrap hi>**If the particle lifetime is longer than the animation and the animation is not looped the last frame of the animation is shown until the particle dies.**</wrap>
Line 119: Line 119:
   ** **//Color preset//**:\\ Has some "factory presets" for colors, selecting one will "insert" that color for the given frame (changes the color sliders etc). You can also save and delete your own color presets.\\ {{ :006_ped_render_pre.png  |}}   ** **//Color preset//**:\\ Has some "factory presets" for colors, selecting one will "insert" that color for the given frame (changes the color sliders etc). You can also save and delete your own color presets.\\ {{ :006_ped_render_pre.png  |}}
   .. Deleting a preset is done by selecting the preset from the list and pressing Delete. “Factory presets” can not be deleted.   .. Deleting a preset is done by selecting the preset from the list and pressing Delete. “Factory presets” can not be deleted.
-  .. Saving a preset is simple, just use the sliders to doctor yourself a color and press **//Save Preset button//**. It will open a new sub leaf where you can (must) give a name for your preset.\\ {{:006_ped_render_savepre.png|}}\\ Pressing **//Save//** saves the preset, **//Back//** returns you to the main **//Render Params//** leaf.\\ <WRAP important>NOTE that names can only include English alphabet letters, no number as first letter of the name and only one kind of special character, underscore, is allowed.</WRAP><WRAP tip>Keyboard shortcuts:\\ ``ENTER`` = Save\\ ``ESC`` = Back</WRAP>+  .. Saving a preset is simple, just use the sliders to doctor yourself a color and press **//Save Preset button//**. It will open a new sub leaf where you can (must) give a name for your preset.\\ {{:006_ped_render_savepre.png|}}\\ Pressing **//Save//** saves the preset, **//Back//** returns you to the main [[ped_ui#render_params|Render Params]] leaf.\\ <WRAP important>NOTE that names can only include English alphabet letters, no number as first letter of the name and only one kind of special character, underscore, is allowed.</WRAP><WRAP tip>Keyboard shortcuts:\\ ``ENTER`` = Save\\ ``ESC`` = Back</WRAP>
 ===== Random ===== ===== Random =====
 +{{:007_ped_random.png|}}
 +Here you can randomize some of the parameters applied in [[ped_ui#basic_params|Basic Params]] and [[ped_ui#render_params|Render Params]].\\
 +These are parameters you would apply to a particle emitter with the [[https://community.bistudio.com/wiki/setParticleRandom|setParticleRandom]] scripting command.
  
 +  * **//Lifetime//**:\\ An interpolation between the lifetime value in [[ped_ui#basic_params|Basic Params]] and this.\\ In other words the lifetime of the emitted single particle is randomized between basic lifetime and this random lifetime.\\ Data type is number.
 +
 +  * **//Position//**:\\ Works the same as above lifetime, a randomized position between the [[ped_ui#basic_params|Basic Params]] position and this.\\ Each vector element is randomized individually.\\ Data type is array (of numbers).
 +
 +  * **//Move velocity//**:\\ Randomized move velocity vector between [[ped_ui#basic_params|Basic Params]] move velocity and this.\\ Each vector element is randomized individually.\\ Data type is array.
 +
 +  * **//Rotation Velocity//**:\\ Rotation speed randomizer value, randomized between the [[ped_ui#basic_params|Basic Params]] rotation velocity and this.\\ Each vector element is randomized individually. Data type is number.
 +
 +  * **//Scale//**:\\ Randomizer for the particle size defined in [[ped_ui#render_params|Render Params]] leaf.\\ Random value between the latter and this. Data type is number.
 +
 +  * **//Rand. Direction Intensity//**:\\ Randomizer value for the [[ped_ui#basic_params|Basic Params]] Rand. Direction Intensity.\\ Interpolates a random value between it and this. Data type is number.
 +
 +  * **//Rand. Direction Period//**:\\ Interval (in seconds) in which the above Rand. Direction Intensity is applied.\\ Value is a random value interpolated between the [[ped_ui#basic_params|Basic Params]] Rand. Direction Period and this.\\ Data type is number.
 +
 +  * **//Angle//**:\\ Randomizer for the [[ped_ui#basic_params|Basic Params]] angle.\\ Interpolates a random value between the it and this. When using angle vector functionality is unknown, presumably interpolates each vector element individually.\\ Data type is number.
 +
 +  * **//Color//**:\\ Randomizer for the color set in [[ped_ui#render_params|Render Params]]. Randomizes each frame color setting individually.\\ Luminance is the same as the luminance switch in the [[ped_ui#render_params|Render Params]] leaf, switches the alpha slider between alpha and luminance.
 +      
 +  * **//BounceOnSurface//**:\\ Randomizer value for the [[ped_ui#basic_params|Basic Params]] bounceOnSurface.\\ Interpolates a random value between it and this. Data type is number.
 ===== Circle ===== ===== Circle =====
 +{{:008_ped_circle.png|}}
 +Parameters you would apply to a particle emitter with the [[https://community.bistudio.com/wiki/setParticleCircle|setParticleCircle]] scripting command.
 +
 +  * **//Radius//**:\\ The radius of the circle created on the emitter position, in meters. The circle center is the emitter position.\\ Data type is number.
 +      
 +  * **//Velocity//**:\\ Velocity vector along the circle disc defined with Radius.\\ Velocity is transformed (I guess vector magnitude is calculated) and added to total velocity determined by move velocity in [[ped_ui#basic_params|Basic Params]] and [[ped_ui#random|Random]].\\ Data type is array (of numbers).
  
 ===== Damage ===== ===== Damage =====
 +{{:009_ped_damage.png|}}
 +Parameters which you would apply to particles with the [[https://community.bistudio.com/wiki/setParticleFire|setParticleFire]] scripting command.
 +
 +  * **//Damage type//**:\\ Type of damage to inflict, //Fire// is only one available though.
 +      
 +  * **//Core intensity//**:\\ Damage intensity in emitter center (position). Seems to be some sort of coefficient of some value determined in the damage type somewhere in the bowels of the game engine.\\ Data type is number.
 +      
 +  * **//Core Distance//**:\\ Distance from the emitter center to receive the damage defined by Core intensity. In meters. Data type is number.
 +      
 +  * **//Damage Time//**:\\ Interval to inflict the damage in. 1 means once a second, 0.5 two times a second, and so on. Data type is number.
 +      
  
 ===== Special ===== ===== Special =====
 +{{:010_ped_spec.png|}}
 +Perhaps a bit dumb name for this leaf but whatever, this houses a few special attributes.
 +  * **//Die out//**:\\ Same as with the [[attributes|Attribute Emitters]], this is a timer in seconds, after which the given emitter (or emitter set) will be deleted.\\ The time starts from the moment the emitter starts emitting. The deleting will be instant, the emitter will NOT wind down gradually.\\ Data type is number.
  
 +  * **//Follow objectHide//**:\\ This is the same as with the [[attributes|Attribute Emitters]]. Will make the emitter(s) follow the objectHide "status"  of the object (hidden or not with obj objectHide true/false) the emitter is be attached to (if any).\\ <WRAP important>Made optional because starts a looping script on each object this is used with.</WRAP>
 +
 +  ** **//Import modules//**:\\ If the scenario in question has BI Particle effect module(s), this button becomes active.\\ By pressing this button you can import the module(s) into the tool. Note that the module is deleted from the scenario once it has been imported. The module is replaced with an emitter.\\ You can then edit those emitters the same way you can edit the emitters placed with ``INSERT``.
 +  .. Related to this, if this tool is running and you load a scenario into the editor which has the BI particle effect module(s) present the tool will ask whether you want to import them. More on this covered in [[ped_examples#import_module|Particle Editor Section -> Examples -> Import Module]]
 +
 +  * **//Enable for Zeus//**:\\ Toggle selected emitter/emitter set as editable by Zeus. When enabled will show up for all Zeus’ in the scenario as editable object. See more details on dedicated section [[zeus|Zeus Interaction]].
 +      
 +  * **//Only for Zeus//**:\\ Limit the selected emitter/emitter set as editable to only the given Zeus, or given multiple Zeus'. Enter the variable name of the Zeus module(s) here. If multiple Zeus' used separate names with a semicolon (no spaces!!), like: ??Zeus1;Zeus2;Zeus3??\\ See more details on dedicated section [[zeus|Zeus Interaction]].
 +      
 +  * **//Particles//**:\\ Available only when running the [[https://community.bistudio.com/wiki/Arma_3:_Diagnostics_Exe|diagnostic exe]] of the game. On/off switch for the "Particles" [[https://community.bistudio.com/wiki/diag_enable|diag_enable]].
 +      
 +  * **//Particle Names//**:\\ Available only when running the [[https://community.bistudio.com/wiki/Arma_3:_Diagnostics_Exe|diagnostic exe]]. On/off switch for the "ParticleNames" [[https://community.bistudio.com/wiki/diag_enable|diag_enable]].
 +      
 ===== Export/Import ===== ===== Export/Import =====
 +{{:011_ped_export.png|}}
 +Export is here if for some reason need to cook up parameters and paste them into a script instead of just placing them with this tool into the scenario. It’s is possible if you need to have the emitters do something specific with an object other than just stay on it.
 +
 +To export in config/description.ext format press and hold down ``CTRL`` on your keyboard when pressing the **//Export//** button.
 +
 +Import stands for "pasting" parameters from a script "into" the emitter placed with this tool.
 +In here you can also save and load your own parameter presets.
 +
 +  * **//Clear//**:\\ Pressing this button will clear all data from the export fields.
 +
 +  ** **//Export Sqf/Cfg//**:\\ Pressing this button will export the parameters shown on the "export data fields" onto the clipboard for pasting into a separate script/text file. The parameters are pasted exactly as they’re shown on the fields. By default exports in sqf format, by holding down ``CTRL`` while pressing this button will export in config format.
 +
 +  ** **//Export current only//** checkbox:\\ If this is checked the export button will export only the parameters shown on the fields, if it is unchecked export will export parameters for __//all emitters in the scenario//__.\\ Exclude light emitters means that if checked and you are exporting a set of emitters which includes a light emitter its parameters won’t get exported, as in export particle parameters only.      
 +  .. The horizontal list of particles below the "export fields" relates also to the emitter sets. It lists the emitters in the selected emitter set.\\ {{  :scroller.png  |}}\\ With this list you can scroll through the individual emitters in the given set, the “export fields” showing the currently shown emitter’s parameters.
 +  .. Lock export fields disables the "auto-filling" of the export fields when selecting emitters. Handy if you wish to "paste" parameters into several different emitters/emitter sets for example. Or are just annoyed by the auto-filling..
 +
 +  *  **//Paste Params//**:\\ If you have some favorite particle params in some scripts of yours you can use this to "import" them into the emitters placed via this tool.\\ Just copy/paste the appropriate params to their places on the "export fields", place down a particle emitter and press **//Paste Params//**. The emitter should receive these params and start emitting according to them.\\ You can then edit them further with this tool if you wish.\\ <WRAP important>NOTE that obviously the parameters have to be valid, no expressions of any kind are supported.</WRAP>
 +
 +  * **//Save Preset//**:\\ Pressing this opens a separate sub leaf in which you can save the current selected emitter/emitter set as a preset.\\ {{:011_ped_export_savepre.png|}}\\ Name is required, description is optional. Description is useful to for example noting how many emitters a set of emitters needs if the preset is saved as a set. The description will be shown as tool tip when hovering over the preset name in the Load Preset dialog.\\ Save set as preset does what it says, if you want to save the whole emitter set (if one is selected) as a preset check this box.\\ <WRAP important>NOTE that when saving sets as presets importing them requires equal amount and equal types of emitters placed as a set in the same exact order as the saved preset set was.
 +NOTE that when loading a single emitter preset you can only load particle presets "into" a particle emitter.</WRAP><WRAP tip>Keyboard shortcuts:
 +``ENTER`` = Save
 +``ESC`` = Back
 +</WRAP>
 +
 +  ** **//Load Preset//**:\\ Opens up a separate sub leaf for "loading" particle presets into emitters.\\ {{:011_ped_export_loadpre.png}}\\ Presets which are emitter sets are in red color so as explained above they will need the same amount of emitters and same exact types in the same exact order in a set to load into.\\ So let’s say the set you save as a preset has two particle emitters and a light emitter; particle_1 – particle_2 – light_3.\\ To load that preset into a set the set must consist of particle emitter – particle emitter – light emitter.
 +  .. You can also delete unwanted presets here, just select the preset you want to remove and press Delete.\\ <WRAP tip>Keyboard shortcuts:
 +``ENTER`` = Load
 +``ESC`` = Back
 +``DELETE`` = Delete
 +</WRAP>
ped_ui.1638111510.txt.gz · Last modified: 2021/11/28 14:58 by hneg

Page Tools