Emitter 3Ditor Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== In-game Functions ======
As the tool only does things in Eden only but you need to "gain access" to the emitters while your scenario is running, like deleting or otherwise manipulating the emitters or their parameters, you need to rely on some functions that need to be copy/pasted into your scenario folder and stuff added into your description.ext file, exactly as is.

===== Set Up =====
Where the functions are located depends on your download method:
  * if your downloaded the 7z package "manually" the functions can be found in that package, folder is called //HNEG_emed_scenario_functions//
  * if you downloaded from Steam you will find the //HNEG_emed_scenario_functions// folder in the installation location, which you can access with the game launcher the easiest, in the doc folder where this file also resides.

<WRAP important>The folder HNEG_emed_scenario_functions has to be copied into your scenario exactly directory __**as is**__.</WRAP>

So your scenario directory would look something like this:
{{  :dir.png  |}}

Once the folder is copy/pasted in to the scenario directory the easiest way you can gain access to the functions by defining them in the [[url|description.ext CfgFunctions]].

There are two ways to do this depending if you already have //CfgFunctions// in your description.ext or not.
If you **DO NOT** have //CfgFunctions// defined you can copy/paste the following into your description.ext:
<code>class CfgFunctions {
	#include "HNEG_emed_scenario_functions\HNEG_emed_scenario_functions.hpp"
};</code>

If you **DO** have //CfgFunctions// already defined, just copy/paste the following "into" it:
<code>#include "HNEG_emed_scenario_functions\HNEG_emed_scenario_functions.hpp"</code>

===== Function List =====
Each function needs the prefix //HNEG_fnc_// when called, as in for example ??call HNEG_fnc_allEmitters??

==== allEmitters ====
<WRAP indent>Returns all the emitters in the scenario inserted via this tool.
<wrap important>NOTE that this is heavy on performance.</wrap>

Arguments:
  * none

Returns:
  * Array of #particleSources and/or #lightpoints

Usage:
<code>call HNEG_fnc_allEmitters</code>
</WRAP>
==== allEmittersNames ====
<WRAP indent>Returns the names of all the emitters inserted via this tool.
<wrap important> NOTE that this is heavy on performance.</wrap>
Arguments:
  * none

Returns:
  * Array of STRINGS

Usage:
<code>call HNEG_fnc_allEmittersNames</code>
</WRAP>
==== attachEmitter ====
<WRAP indent>Attaches emitter inserted via this tool to some object.
Optional position offset or selection, or [selection, pos offset] can be passed.

Arguments:
  * OBJECT (emitter) or STRING (emitter name), object to attach to (OBJECT), offset (ARRAY) or model selection (STRING) or model selection with position offset ([STRING, ARRAY])

Returns:
  * nothing

Usage:
<code>
 //attach the emitter to the object center/rotation center in model space
[_emtr1, _helo] call HNEG_fnc_attachEmitter;

//attach the emitter to the object center/rotation center in model space
["particle_emitter_6", _helo] call HNEG_fnc_attachEmitter;

//attach the emitter to the object center/rotation center model space, with position offset
["particle_emitter_6", _helo, [0, 0, -5]] call HNEG_fnc_attachEmitter;

//attach the emitter to the object model selection "head"
["particle_emitter_6", _man1, "head"] call HNEG_fnc_attachEmitter;

//attaches the emitter to the object model selection "head" with position offset (from the selection)
["particle_emitter_6", _man1, ["head", [0, 0.3, 0.4]]] call HNEG_fnc_attachEmitter; 
</code>
</WRAP>
==== attachEmitterSet ====
<WRAP indent>
Same as above but for emitter sets, only difference is that accepts emitter set object array as input.

Arguments:
  * OBJECT (emitter) or STRING (emitter name) or ARRAY of objects (emitter set), object to attach to (OBJECT), offset (ARRAY) or model selection (STRING) or model selection with position offset ([STRING, ARRAY])

Returns:
  * nothing

Usage:
<code> //attach the emitter set the given emitter belongs to the object center/rotation center in model space
[_emtr1, _helo] call HNEG_fnc_attachEmitter;

//attach the given emitter set to the object model selection "head" with position offset (from the selection)
["particle_emitter_6", _man1, ["head", [0, 0.3, 0.4]]] call HNEG_fnc_attachEmitterSet; 
</code>
</WRAP>
==== deleteEmitter ====
<WRAP indent>
Deletes given emitter by name or by the object name it's attached to.
__If the emitter is part of an emitter set the whole set will be deleted__.

Arguments:
  * OBJECT (any object) or STRING (emitter name)

Returns:
  * nothing

Usage:
<code>"particle_emitter_6" call HNEG_fnc_deleteEmitter; //deletes emitter with the name "particle_emitter_6"
e_car1 call HNEG_fnc_deleteEmitter; //deletes emitter(s) attached to an object named e_car1
</code>
</WRAP>
==== deleteAllEmitters ====
<WRAP indent>
Deletes all emitters inserted by Emitter 3Ditor in the scenario.

Arguments:
  * none

Returns:
  * nothing

Usage:
<code>call HNEG_fnc_deleteAllEmitters; //deletes all emitters</code>
</WRAP>
==== detachEmitter ====
<WRAP indent>Detaches given emitter if attached to some entity.
Arguments:
 * OBJECT (emitter) or STRING (emitter name)

Returns:
 * nothing

Usage:
<code>_emtr1 call HNEG_fnc_detachEmitter;
"particle_emitter_6" call HNEG_fnc_detachemitter;
</code>
</WRAP>
==== detachEmitterSet ====
<WRAP indent>Same as above but for detaching whole emitter sets. Only difference is that accepts emitter set object array as input.

Arguments:
  * OBJECT (emitter) or STRING (emitter name) or ARRAY of objects (emitter set)

Returns:
  * nothing

Usage:
<code>_emtr1 call HNEG_fnc_detachEmitterSet;
"particle_emitter_6" call HNEG_fnc_detachemitterSet;
_emtrSet1 call HNEG_fnc_detachEmitterSet;
</code>
</WRAP>
==== findEmitter ====
<WRAP indent>Find an emitter by name.

Arguments:
  * emitter name (STRING)

Returns:
  * #particleSource, #lightpoint or #lightreflector (OBJECT), objNull if no emitter is found

Usage:
<code>"poop_schute" call HNEG_fnc_findEmitter</code>
</WRAP>
==== getAllEmitterParams ====
<WRAP todo>TODO: IR and direction stuff</WRAP>
<WRAP indent>Returns all the parameters for given emitter.

Arguments:
  * particle name (STRING) or #particleSource / #lightpoint / #lightreflector (OBJECT)

Returns (depending on emitter type):
  ** all particle params (ARRAY) in format:\\
  .. <code>[
  <particle params> (ARRAY),
  <particle random> (ARRAY),
  <particle circle> (ARRAY),
  <particle fire> (ARRAY),
  <drop interval> (NUMBER)
]</code>
  ** all light params (ARRAY) in format:\\
  .. <code>[
  <color> (ARRAY),
  <emissive color> (ARRAY),
  <intensity> (NUMBER),
  <useFlare> (BOOL),
  <flareSize> (NUMBER),
  <flareMaxDistance> (NUMBER),
  <dayLight> (BOOL),
  <attenuation> (ARRAY)
]</code>
  * if no params are found returns empty array []

Usage:
<code>_emtr1  call HNEG_fnc_getAllEmitterParams;
"effing_awesome_particle" call HNEG_fnc_getAllEmitterParams;
</code>
</WRAP>
==== getEmitterSet ====
<WRAP indent>Returns the whole emitter set if given emitter belongs to one.
<wrap important>NOTE that this is quite heavy on performance.</wrap>

Arguments:
  * #particlesource / #lightpoint / #lightreflector (OBJECT) or emitter name (STRING)

Returns:
  * ARRAY of emitters (OBJECTS), empty array if emitter does not belong to a set

Usage:
<code>_emtr1 call HNEG_fnc_getEmitterSet;
"some_emitter" call HNEG_fnc_getEmitterSet;
</code>
</WRAP>
==== getEmitterSetTypes ====
<WRAP indent>Returns the emitter types for the whole emitter set if given emitter belongs to one.
<wrap important>NOTE that this is quite heavy on performance.</wrap>

Arguments:
  * #particlesource / #lightpoint / #lightreflector (OBJECT) or emitter name (STRING)

Returns:
  * ARRAY of emitter types (STRINGS), empty array if emitter does not belong to a set

Usage:
<code>
_emtr1 call HNEG_fnc_getEmitterSetTypes;
"some_emitter" call HNEG_fnc_getEmitterSetTypes;
</code>
</WRAP>
==== getLightAttenuation ====
<WRAP indent>Returns the attenuation data of the given light emitter, used with setLightAttenuation

Arguments:
  * #lightpoint / #lightreflector (OBJECT) or light emitter name (STRING)

Returns:
  * ARRAY of light attenuation values

Usage:
<code>_light1 call HNEG_fnc_getLightAttenuation;
"pink_light" call HNEG_fnc_getLightAttenuation;
</code>
</WRAP>
==== getLightColor ====
<WRAP indent>Returns the color data of the given light emitter, used with setLightColor

Arguments:
  * #lightpoint / #lightreflector (OBJECT) or light emitter name (STRING)

Returns:
  * ARRAY of color data (RGB)

Usage:
<code>_light1 call HNEG_fnc_getLightColor;
"pink_light" call HNEG_fnc_getLightColor;
</code>
</WRAP>
==== getLightDayLight ====
<WRAP indent>Returns the dayLight boolean value (true/false) of the given light emitter, used with setLightDayLight

Arguments:
  * #lightpoint / #lightreflector (OBJECT) or light emitter name (STRING)

Returns:
  * BOOLEAN

Usage:
<code>_light1 call HNEG_fnc_getLightDayLight;
"pink_light" call HNEG_fnc_getLightDayLight;
</code>
</WRAP>
==== getLightEmissiveColor ====
<WRAP indent>Returns the emissive color data of the given light emitter, used with setLightEmissiveColor

Arguments:
  * #lightpoint / #lightreflector (OBJECT) or light emitter name (STRING)

Returns:
  * ARRAY of emissive color data (RGB)

Usage:
<code>_light1 call HNEG_fnc_getLightEmissiveColor;
"pink_light" call HNEG_fnc_getLightEmissiveColor;
</code>
</WRAP>
==== getLightFlareMaxDistance ====
<WRAP indent>Returns the flareMaxDistance value of the given light emitter, used with setLightFlareMaxDistance

Arguments:
  * #lightpoint / #lightreflector (OBJECT) or light emitter name (STRING)

Returns:
  * NUMBER

Usage:
<code>_light1 call HNEG_fnc_getLightFlareMaxDistance;
"pink_light" call HNEG_fnc_getLightFlareMaxDistance;
</code>
</WRAP>
==== getLightFlareSize ====
<WRAP indent>Returns the flareSize value of the given light emitter, used with setLightFlareSize

Arguments:
  * #lightpoint / #lightreflector (OBJECT) or light emitter name (STRING)

Returns:
  * NUMBER

Usage:
<code>_light1 call HNEG_fnc_getLightFlareSize;
"pink_light" call HNEG_fnc_getLightFlareSize;
</code>
</WRAP>
==== getLightIntensity ====
<WRAP indent>Returns the Intensity value of the given light emitter, used with setLightIntensity

Arguments:
  * #lightpoint / #lightreflector (OBJECT) or light emitter name (STRING)

Returns:
  * NUMBER

Usage:
<code>_light1 call HNEG_fnc_getLightIntensity;
"pink_light" call HNEG_fnc_getLightIntensity;
</code>
</WRAP>
==== getLightUseFlare ====
<WRAP indent>Returns the useFlare value (true/false) of the given light emitter, used with setLightUseFlare

Arguments:
  * #lightpoint / #lightreflector (OBJECT) or light emitter name (STRING)

Returns:
  * BOOLEAN

Usage:
<code>_light1 call HNEG_fnc_getLightUseFlare;
"pink_light" call HNEG_fnc_getLightUseFlare;
</code>
</WRAP>
==== getParticleCircle ====
<WRAP indent>Returns the given #particlesource particleCircle, used with setParticleCircle

Arguments:
  * particle name (STRING) or #particleSource (OBJECT)

Returns:
  * particle circle (ARRAY)

Usage:
<code>_flame1 call HNEGfnc_getParticleCircle;
"my_awesome_flameo" call HNEG_fnc_getParticleCircle;
</code>
</WRAP>
==== getParticleFire ====
<WRAP indent>Returns the given emitter particle fire (fire damage), used with setParticleFire

Arguments:
  * particle name (STRING) or #particleSource (OBJECT)

Returns:
  * particle fire (ARRAY)

Usage:
<code>_flame1 call HNEG_fnc_getParticleFire;
"my_awesome_flameo" call HNEG_fnc_getParticleFire;
</code>
</WRAP>
==== getParticleInterval ====
<WRAP indent>Returns the given emitter particle drop interval, used with setDropInterval

Arguments:
  * particle name (STRING) or #particleSource (OBJECT)

Returns:
  * drop interval (NUMBER)

Usage:
<code>_flame call HNEG_fnc_getParticleInterval;
"my_awesome_flameo" call HNEG_fnc_getParticleInterval;
</code>
</WRAP>
==== getParticleParams ====
<WRAP indent>Returns the given emitter particle params, used with setParticleParams

Arguments:
  * particle name (STRING) or #particleSource (OBJECT)

Returns:
  * particle params (ARRAY)

Usage:
<code>_flame call HNEG_fnc_getParticleParams;
"my_awesome_flameo" call HNEG_fnc_getParticleParams;
</code>
</WRAP>
==== getParticleRandom ====
<WRAP indent>Returns the given #particlesource random params, used with setParticleRandom

Arguments:
  * particle name (STRING) or #particleSource (OBJECT)

Returns:
  * particle random (ARRAY)

Usage:
<code>_flame1 call HNEG_fnc_getParticleRandom;
"my_awesome_flameo" call HNEG_fnc_getParticleRandom;
</code>
</WRAP>

===== Examples =====
<WRAP todo>TODO</WRAP>
Emitter 3Ditor Wiki

User Tools

Site Tools

Page Tools
