Emitter 3Ditor Wiki

User Tools

Site Tools

Trace: • ped_ui • funcs
funcs

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
funcs [2021/12/06 13:17] – [getEmitterSet] hnegfuncs [2022/03/12 08:58] (current) – [Examples] hneg
Line 100: Line 100:
 <WRAP indent> <WRAP indent>
 Deletes given emitter by name or by the object name it's attached to. 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: Arguments:
Line 124: Line 125:
 Usage: Usage:
 <code>call HNEG_fnc_deleteAllEmitters; //deletes all emitters</code> <code>call HNEG_fnc_deleteAllEmitters; //deletes all emitters</code>
-</WRAP> 
-==== deleteEmitterSet ==== 
-<WRAP todo> TODO: function doesn't exist </WRAP> 
-<WRAP indent> 
-Deletes given emitter set either by any emitter/emitter name in the set, or by the object the set is attached to. 
- 
-Arguments: 
-  * emitter (OBJECT) or emitter name (STRING) or object emitter(s) attached to (OBJECT) 
- 
-Returns: 
-  * nothing 
- 
-Usage: 
-<code> 
-  //TODO 
-</code> 
 </WRAP> </WRAP>
 ==== detachEmitter ==== ==== detachEmitter ====
Line 231: Line 216:
 </WRAP> </WRAP>
 ==== getEmitterSetTypes ==== ==== 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 ==== ==== 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 ==== ==== 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 ==== ==== 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 ==== ==== 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 ==== ==== 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 ==== ==== 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 ==== ==== 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 ==== ==== 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 ==== ==== 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 ==== ==== 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 ==== ==== 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 ==== ==== 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 ==== ==== 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>
funcs.1638796644.txt.gz · Last modified: by hneg

Page Tools