Component:ParticleRibbonsModule: Difference between revisions

Revision as of 20:59, 8 February 2025

Component image

Particle Ribbons Module component as seen in the Scene Inspector

The ParticleRibbonsModule component makes it to where a particle system will have ribbons that connect particles based on distance and other factors.

Fields

Fields
Name	Type	Description
`persistent`	Bool	Determines whether or not this item will be saved to the server.
`UpdateOrder`	Int	Controls the order in which this component is updated.
`Enabled`	Bool	Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
`Material`	Material	The material to give the ribbons
`TextureMode`	TrailTextureMode	How to handle viewing the texture specified on the ribbons.
`MotionVectorMode`	MotionVectorMode	How to handle the rendering of ribbons in regards to motion vectors.
`GenerateLightingData`	Bool	Whether to generate lighting data for the ribbons.
`RibbonPointRatio`	Float	How many of the particles should be ribbons.
`Distribution`	ParticleFollowerDistribution	How to distribute the ribbon followers.
`MaxRibbonPoints`	Int	The max amount of ribbon points there should be.
`InterweavedRibbonCount`	Int
`UseParticleColor`	Bool	Whether to use the color of particles the ribbons are following.
`UseParticleSize`	Bool	Whether to use the size of particles the ribbons should follow.
`SizeInheritanceMode`	UniformSizeMode	How to inherit the size of the particles the ribbons are following.

Usage

Attach to a slot, add to the list of modules in a Component:ParticleSystem, and adjust the values to make the desired effect from this component.

Examples

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

@@ Line 3: / Line 3: @@
 |Name=Particle Ribbons Module
 }}
-{{stub}}
+The '''ParticleRibbonsModule''' component makes it to where a particle system will have ribbons that connect particles based on distance and other factors.
 == Fields ==
 {{Table ComponentFields
-|Material|{{RootFieldType|AssetRef`1|[[Type:Material|Material]]}}|TypeAdv0=true|
+|Material|{{RootFieldType|AssetRef`1|[[Type:Material|Material]]}}|TypeAdv0=true| The material to give the ribbons
-|TextureMode|TrailTextureMode|
+|TextureMode|TrailTextureMode| How to handle viewing the texture specified on the ribbons.
-|MotionVectorMode|MotionVectorMode|
+|MotionVectorMode|MotionVectorMode| How to handle the rendering of ribbons in regards to motion vectors.
-|GenerateLightingData|Bool|
+|GenerateLightingData|Bool| Whether to generate lighting data for the ribbons.
-|RibbonPointRatio|Float|
+|RibbonPointRatio|Float| How many of the particles should be ribbons.
-|Distribution|ParticleFollowerDistribution|
+|Distribution|ParticleFollowerDistribution| How to distribute the ribbon followers.
-|MaxRibbonPoints|Int|
+|MaxRibbonPoints|Int| The max amount of ribbon points there should be.
 |InterweavedRibbonCount|Int|
-|UseParticleColor|Bool|
+|UseParticleColor|Bool| Whether to use the color of particles the ribbons are following.
-|UseParticleSize|Bool|
+|UseParticleSize|Bool| Whether to use the size of particles the ribbons should follow.
-|SizeInheritanceMode|UniformSizeMode|
+|SizeInheritanceMode|UniformSizeMode| How to inherit the size of the particles the ribbons are following.
-}}
-== Sync Delegates ==
-{{Table ComponentTriggers
 }}
 == Usage ==
+Attach to a slot, add to the list of modules in a [[Component:ParticleSystem]], and adjust the values to make the desired effect from this component.
 == Examples ==
+{{stub}}
 == See Also ==
+{{Template:PhotonDustRibbonModules}}
 [[Category:Components:Rendering:Particle System:Modules{{#translation:}}|Particle Ribbons Module]]
 [[Category:Components{{#translation:}}|Particle Ribbons Module]]
 [[Category:ComponentStubs]]