virtualx-engine/doc/classes/VisualShaderNodeParticleAccelerator.xml
2023-01-10 22:33:58 +01:00

30 lines
1.3 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeParticleAccelerator" inherits="VisualShaderNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
A visual shader node that accelerates particles.
</brief_description>
<description>
Particle accelerator can be used in "process" step of particle shader. It will accelerate the particles. Connect it to the Velocity output port.
</description>
<tutorials>
</tutorials>
<members>
<member name="mode" type="int" setter="set_mode" getter="get_mode" enum="VisualShaderNodeParticleAccelerator.Mode" default="0">
Defines in what manner the particles will be accelerated.
</member>
</members>
<constants>
<constant name="MODE_LINEAR" value="0" enum="Mode">
The particles will be accelerated based on their velocity.
</constant>
<constant name="MODE_RADIAL" value="1" enum="Mode">
The particles will be accelerated towards or away from the center.
</constant>
<constant name="MODE_TANGENTIAL" value="2" enum="Mode">
The particles will be accelerated tangentially to the radius vector from center to their position.
</constant>
<constant name="MODE_MAX" value="3" enum="Mode">
Represents the size of the [enum Mode] enum.
</constant>
</constants>
</class>