Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
ardiscript:addparticle [2018/04/17 01:22] optrix [Parameters] |
ardiscript:addparticle [2018/11/27 00:57] (current) optrix [Parameters] |
||
|---|---|---|---|
| Line 5: | Line 5: | ||
| This function allows you to create a particle effect asset in one of three types: liquid, solid or gas. The particle effect will show up in the ARDI Virtual Environment with appropriate graphical representation according to the particle type chosen. | This function allows you to create a particle effect asset in one of three types: liquid, solid or gas. The particle effect will show up in the ARDI Virtual Environment with appropriate graphical representation according to the particle type chosen. | ||
| - | The newly added particle effect can be associated and maniplulated like any other asset in the virtual environment. | + | The newly added particle effect can be associated and manipulated like any other asset in the virtual environment. |
| ====Parameters==== | ====Parameters==== | ||
| Line 14: | Line 14: | ||
| This parameter allows you to specify another asset in the Virtual Environment to parent the particle effect to. If specified, the //position// parameter will be converted to local coordinates based on the parent. | This parameter allows you to specify another asset in the Virtual Environment to parent the particle effect to. If specified, the //position// parameter will be converted to local coordinates based on the parent. | ||
| + | |||
| + | ===Follow=== | ||
| + | |||
| + | //Type: [[Bool]] | ||
| + | Default: True// | ||
| + | |||
| + | When a target is specified, this parameter can be set to false to separate the particle from its target so that it will not follow if the target asset moves within the scene. | ||
| + | |||
| + | ===Name=== | ||
| + | |||
| + | //Type: Text | ||
| + | Default: None// | ||
| + | |||
| + | This parameter allows you to set a //name// for the newly created particle effect. This will allow you to associate with it using other script functions more easily. | ||
| ===ParticleType=== | ===ParticleType=== | ||
| Line 20: | Line 34: | ||
| Default: None// | Default: None// | ||
| - | This parameter specifies the type of particle effect to be added. | + | This parameter specifies the type of particle effect to be added. Please specify one of the following particle types: |
| - | ^Parameter^Meaning^ | + | ^Particle Type^Meaning^ |
| |**Particle_Liquid**|Creates a particle emitter that emits drops of liquid.| | |**Particle_Liquid**|Creates a particle emitter that emits drops of liquid.| | ||
| |**Particle_Gas**|Crates a particle emitter that emanates smoke or gas.| | |**Particle_Gas**|Crates a particle emitter that emanates smoke or gas.| | ||
| |**Particle_Solid**|Creates a particle emitter that emits pieces of rock.| | |**Particle_Solid**|Creates a particle emitter that emits pieces of rock.| | ||
| + | |**Particle_Intake**|Creates a particle emitter that represents air being sucked into a point.| | ||
| + | |||
| + | ===Speed=== | ||
| + | |||
| + | //Type: [[Float]] | ||
| + | Default: **4**// | ||
| + | |||
| + | This parameter controls the speed at which the particle emitter sends out particles. | ||
| ===Position=== | ===Position=== | ||
| Line 60: | Line 82: | ||
| |**b**|The value for the amount of blue to be applied. Must be a value ranging from 0.0 to 1.0| | |**b**|The value for the amount of blue to be applied. Must be a value ranging from 0.0 to 1.0| | ||
| + | ====See Also==== | ||
| + | |||
| + | [[addmesh]] [[addbeacon]] [[addshape]] [[remove]] | ||
| ====Examples==== | ====Examples==== | ||
| + | |||
| + | <code> | ||
| + | <addparticle ParticleType="Particle_Gas" Position="20,10,20" /> | ||
| + | </code> | ||
| + | |||
| + | > This will add a particle effect of type **Particle_Gas** to the position 20,10,20 | ||
| + | |||
| + | <code> | ||
| + | <addparticle ParticleType="Particle_Liquid" Target="Hose" Position="0,0,0" Color="0,1,0"/> | ||
| + | </code> | ||
| + | |||
| + | > This will add a particle effect of type **Particle_Liquid** find the asset named **Hose** and parent the particle effect to the **Hose**. | ||