Component:ParticleSpray: Difference between revisions

From Resonite Wiki
Automated: update Fields
update
 
(3 intermediate revisions by 2 users not shown)
Line 3: Line 3:
|Name=Particle Spray
|Name=Particle Spray
}}
}}
{{stub}}
The '''ParticleSpray''' component is a tool that shoots particles when the trigger is pulled.


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|_equipLink|{{RootFieldType|LinkTarget`1|[[Type:ITool|ITool]]}}|TypeAdv0=true|
|_equipLink|{{RootFieldType|LinkTarget`1|[[Type:ITool|ITool]]}}|TypeAdv0=true| {{Template:ITool _equipLink}}
|TipReference|Slot|
|TipReference|Slot| {{Template:ITool TipReference}}
|BlockGripEquip|Bool|
|BlockGripEquip|Bool| {{Template:ITool BlockGripEquip}}
|BlockRemoteEquip|Bool|
|BlockRemoteEquip|Bool| {{Template:ITool BlockRemoteEquip}}
|EquipName|String|
|EquipName|String| {{Template:ITool EquipName}}
|_overrideActiveTool|'''[[Component:InteractionHandler|InteractionHandler]]'''|TypeAdv5=true|
|_overrideActiveTool|'''[[Component:InteractionHandler|InteractionHandler]]'''|TypeAdv5=true| {{Template:ITool _overrideActiveTool}}
|_gripPosesGenerated|Bool|
|_gripPosesGenerated|Bool| {{Template:ITool _gripPosesGenerated}}
|Rate|Float|
|Rate|Float| Ths rate at which the spray tip sprays at max (primary strength is raised to <code>RateExp</code> first before multiplying with this)
|RateExp|Float|
|RateExp|Float| primary strength of the tool is raised to this number.
|MinSpeed|Float|
|MinSpeed|Float| The min speed the particles travel at.
|MaxSpeed|Float|
|MaxSpeed|Float| The max speed the particles travel at.
|partStyle|'''[[Component:ParticleStyle|ParticleStyle]]'''|TypeAdv11=true|
|partStyle|'''[[Component:ParticleStyle|ParticleStyle]]'''|TypeAdv11=true| The style of the particles.
|partEmitter|ParticleEmitter|
|partSpeed|'''[[Component:SpeedRangeInitializer|SpeedRangeInitializer]]'''|TypeAdv12=true| The min/max speed the particles travel at, is synced with <code>MinSpeed</code> and <code>MaxSpeed</code>
|partEmitter|ParticleEmitter| the Particle emitter this particle spray is controlling.
}}
}}
== Behavior ==
== Examples ==


== See Also ==
== See Also ==
* [[Type:ITool|ITool]]


[[Category:Components:Tools{{#translation:}}|Particle Spray]]
[[Category:Components:Tools{{#translation:}}|Particle Spray]]
[[Category:Components{{#translation:}}|Particle Spray]]
[[Category:Components{{#translation:}}|Particle Spray]]
[[Category:ComponentStubs]]

Latest revision as of 23:49, 31 March 2025

Component image 
Particle Spray component as seen in the Scene Inspector

The ParticleSpray component is a tool that shoots particles when the trigger is pulled.

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.
_equipLink direct LinkTarget`1<ITool> This is Internal, and is used by the engine to retrieve the component this field is a part of. It cannot be assigned to.
TipReference Slot The slot to use as the tool's tip, instead of the component's slot.
BlockGripEquip Bool Whether to prevent legacy double grip equipping from equipping this tooltip.
BlockRemoteEquip Bool Whether to prevent equipping by clicking via laser
EquipName String The name of the tool in the context menu when equipping via context menu.
_overrideActiveTool InteractionHandler The interaction handler to use instead of this tool as an interaction handler.
_gripPosesGenerated Bool Whether the Grip Pose Reference components and slots have been generated for this tool.
Rate Float Ths rate at which the spray tip sprays at max (primary strength is raised to RateExp first before multiplying with this)
RateExp Float primary strength of the tool is raised to this number.
MinSpeed Float The min speed the particles travel at.
MaxSpeed Float The max speed the particles travel at.
partStyle ParticleStyle The style of the particles.
partSpeed SpeedRangeInitializer The min/max speed the particles travel at, is synced with MinSpeed and MaxSpeed
partEmitter ParticleEmitter the Particle emitter this particle spray is controlling.

See Also