Component:LegacyGlowCircle: Difference between revisions

Revision as of 20:31, 21 January 2025

Component image

**Glow Circle** component as seen in the Scene Inspector

The GlowCircle component is used to make the circle that surrounds default spawn areas.

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.
`Radius`	Float	The radius of the circle visual.
`Height`	Float	The height of the walls for the glow visual.
`Color`	ColorX	The color of the glow visual.
`_cylinderOffset`	field drive of Float3	The field to drive with the offset of the cylinder used for this visual.
`_cylinderRadius`	field drive of Float	The field to drive with the radius of the cylinder used for this visual.
`_cylinderHeight`	field drive of Float	The field to drive with the height of the cylinder used for this visual.
`_circleQuadSize`	field drive of Float2	The field to drive with the size of the cylinder faces used for this visual.
`_circleTint`	field drive of ColorX	The field to drive with the color of the circle used for this visual.
`_cylinderTint`	field drive of ColorX	The field to drive with the color of the cylinder used for this visual.

Usage

Doesn't need to be used by the user. Is auto generated by spawn points when they make their visual.

Examples

Used in spawn points in world's.

@@ Line 3: / Line 3: @@
 |Name=Glow Circle
 }}
-{{stub}}
+The '''GlowCircle''' component is used to make the circle that surrounds default spawn areas.
-== Usage ==
+== Fields ==
 {{Table ComponentFields
-|Radius|Float|
+|Radius|Float| The radius of the circle visual.
-|Height|Float|
+|Height|Float| The height of the walls for the glow visual.
-|Color|ColorX|
+|Color|ColorX| The color of the glow visual.
-|_cylinderOffset|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv3=true|
+|_cylinderOffset|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv3=true| The field to drive with the offset of the cylinder used for this visual.
-|_cylinderRadius|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv4=true|
+|_cylinderRadius|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv4=true| The field to drive with the radius of the cylinder used for this visual.
-|_cylinderHeight|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv5=true|
+|_cylinderHeight|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv5=true| The field to drive with the height of the cylinder used for this visual.
-|_circleQuadSize|{{RootFieldType|FieldDrive`1|[[Type:Float2|Float2]]}}|TypeAdv6=true|
+|_circleQuadSize|{{RootFieldType|FieldDrive`1|[[Type:Float2|Float2]]}}|TypeAdv6=true| The field to drive with the size of the cylinder faces used for this visual.
-|_circleTint|{{RootFieldType|FieldDrive`1|[[Type:ColorX|ColorX]]}}|TypeAdv7=true|
+|_circleTint|{{RootFieldType|FieldDrive`1|[[Type:ColorX|ColorX]]}}|TypeAdv7=true| The field to drive with the color of the circle used for this visual.
-|_cylinderTint|{{RootFieldType|FieldDrive`1|[[Type:ColorX|ColorX]]}}|TypeAdv8=true|
+|_cylinderTint|{{RootFieldType|FieldDrive`1|[[Type:ColorX|ColorX]]}}|TypeAdv8=true| The field to drive with the color of the cylinder used for this visual.
 }}
-== Behavior ==
+== Usage ==
+Doesn't need to be used by the user. Is auto generated by spawn points when they make their visual.
 == Examples ==
+Used in spawn points in world's.
 == See Also ==
@@ Line 26: / Line 28: @@
 [[Category:Components:Rendering:Visuals{{#translation:}}|Glow Circle]]
 [[Category:Components{{#translation:}}|Glow Circle]]
-[[Category:ComponentStubs]]