User Tools

Site Tools


funcs

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
funcs [2021/12/06 14:02] – [getLightIntensity] 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 345: Line 330:
 </WRAP> </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.1638799373.txt.gz · Last modified: 2021/12/06 14:02 by hneg