Component:BillboardBrushTool

Component image 

Billboard Brush Tool component as seen in the Scene Inspector

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

TODO: are all these field descriptions correct? These field descriptions were done on a phone with no in game testing or verification done.

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.
_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.
FixedMinimumPointDistance	Float	The minimum distance that can be between points on the line
PositionSmoothing	Float	how much to smooth the drawing position wise
RotationSmoothing	Float	how much to smooth the drawing rotation wise
PressureSmoothing	Float	how much to smooth the drawing trigger strength wise
MaxStrokeLength	Float	the maximum length of stroke before a new stroke object is made with a new mesh.
StrokeFadeInLength	Float	the length used for the stroke width to fade in
StrokeFadeOutLength	Float	the length used for the stroke width to fade out
StrokeGroupFinishWaitTime	Float
ActivationThreshold	Float	How much the user has to press primary strength before the tool starts drawing. Doesn't apply to desktop.
DeactivationThresholdRatio	Float	How much the user has to press primary strength before the tool stops drawing. Doesn't apply to desktop.
MenuSizeChange	Float
SnapTip	Bool	Whether to snap the tip to tool storage objects.
SnapLine	Bool	Whether to snap the line to snap planes or objects like a plane with a Component:SnapPlane on it.
StrokesSpace	direct RootSpace	The space in which to do strokes and stroke calculation.
MakeStrokesGrabbable	Bool	Whether to allow drawn strokes to be picked up.
PositionStrokesToTip	Bool
OrientStrokesToTip	Bool
ScaleStrokesToUser	Bool	Whether strokes should scale up or down depending on the user holding the tooltip
PickMaterials	Bool	Whether to allow this brush to pick materials from material orbs by dipping into them
PickColors	Bool	Whether to allow this brush to pick colors from material orbs by dipping into them
CurrentMaterial	Material	The material that this tool is currently drawing with.
ColorMappings	list of ColorMapping
ParticleSystem	LegacyParticleSystem	The Particle system to use when drawing Particle emitting lines.
MeshEmitterTemplate	LegacyMeshEmitter
ParticleTemplateHandling	TemplateHandling
EmissionRatePerUnitLength	Nullable`1<Float>
_colorPicker	direct SlotCleanupRef`1<ColorDialogInterface>	The color dialouge currently being used to pick a color for this tool.
_pickedColor	ColorX	The color picked for this tool.
_hideOnStroke	list of Slot	The slots to hide as the tool draws.
_lastUsedMaterial	Material	The last material this tool was drawing with
_lastCreatedMaterial	Material
Pressure	raw output of Float	How strong the user is pressing primary while using this tool.
Position	raw output of Float3	The position of the drawing tip of this tool in local space after applying StrokeSpace.
Rotation	raw output of FloatQ	The rotation of the tooltip after applying StrokeSpace.
LastPointDelta	raw output of Float3	The distance of the tooltip in StrokeSpace from the last point drawn.
Velocity	raw output of Float3	the speed of the drawing tip in StrokeSpace.
RawDelta	raw output of Float3	The Raw unfiltered delta speed of the tooltip (also known as acceleration) in StrokeSpace.
RawVelocity	raw output of Float3	the raw unfiltered velocity of the tooltip in StrokeSpace.
RawStrokeLength	raw output of Float	The Raw unfiltered stroke length in StrokeSpace.
StrokeLength	raw output of Float	The length of the current stroke in StrokeSpace.
NormalizedStrokeLength	raw output of Float	The length of the stroke from 0->1 where 1 is max stroke length in StrokeSpace.
StrokeFadeMultiplier	raw output of Float	the multiplier being used to fade in and out stroke width based on the current stroke length in StrokeSpace.
StrokeGroupIndex	raw output of Int	The index of the current stroke within a group of strokes (a slot with a bunch of stroke objects parented under it.
TipAnchor	Slot	The slot point where strokes come from.
StrokePointRate	Float	The distance between points in meters affected by pressure that come from the tool.
ConstantPointRate	Float	the distance between points in meters. Used if PressureAffectsRate is disabled.
PressureAffectsRate	Bool	Whether pressure like primary strength affects tool stroke point placement distance.
PressureAffectsRadius	Bool
ParticleSpawnRadius	Float
SnapPoints	Bool	Whether the tool should snap to Component:SnapPoints.
MinColor	Color
MaxColor	Color
Profile	ColorProfile	The color profile to use for MinColor and MaxColor
ColorGap	Float
MinSize	Float2
MaxSize	Float2
SizeGap	Float
AtlasInfo	AtlasInfo
PressureAffectsSize	Bool
PressureAffectsAlpha	Bool
PressureAffectsIntensity	Bool
UseColor	Bool	Whether to use the MinColor and MaxColor in Particle system generation.
MinRotation	Float	The minimum rotation to use when making Particle system emitters
MaxRotation	Float	the maximum rotation to use when making Particle system emitters
RotationGap	Float
UseRotation	Bool	Whether particle/Particle Emitters should use MinRotation and MaxRotation
UseSize	Bool
UseUV	Bool
_previewRenderer	MeshRenderer
_previewMesh	direct DriveRef`1<PointMesh>
_previewMeshOffset	field drive of Float3