Automated: create new component page |
add info |
||
| Line 3: | Line 3: | ||
|Name=Glowing Sphere Toggle | |Name=Glowing Sphere Toggle | ||
}} | }} | ||
The '''GlowingSphereToggle''' component can be used to toggle a boolean value when clicked. | |||
== | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|TargetField|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv0=true| | |TargetField|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv0=true| The field to toggle. | ||
|FadeSpeed|Float| | |FadeSpeed|Float| How fast to fade after being clicked. | ||
|CooldownTime|Float| | |CooldownTime|Float| How long the user has to wait before they can toggle it again. | ||
|Radius|Float| | |Radius|Float| The size of the toggle sphere. | ||
|GlowColor|ColorX| | |GlowColor|ColorX| What color the sphere should glow. | ||
|_emissiveColor|{{RootFieldType|FieldDrive`1|[[Type:ColorX|ColorX]]}}|TypeAdv5=true| | |_emissiveColor|{{RootFieldType|FieldDrive`1|[[Type:ColorX|ColorX]]}}|TypeAdv5=true| The color to drive with the sphere color for emissive. | ||
|_rimColor|{{RootFieldType|FieldDrive`1|[[Type:ColorX|ColorX]]}}|TypeAdv6=true| | |_rimColor|{{RootFieldType|FieldDrive`1|[[Type:ColorX|ColorX]]}}|TypeAdv6=true| The color to drive with the rim color. | ||
|_sphereRadius|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv7=true| | |_sphereRadius|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv7=true| The field to drive with the sphere radius. | ||
|_sphereExtrude|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv8=true| | |_sphereExtrude|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv8=true| The field to drive with the sphere extrude value. | ||
|_colliderRadius|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv9=true| | |_colliderRadius|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv9=true| The field to drive with the collider radius. | ||
}} | }} | ||
== | == Usage == | ||
Attach to a slot and provide values as well as something to toggle for this component to work. | |||
== Examples == | == Examples == | ||
{{stub}} | |||
== See Also == | == See Also == | ||
* [[Component:ButtonToggle]] | |||
[[Category:Components:Uncategorized{{#translation:}}|Glowing Sphere Toggle]] | [[Category:Components:Uncategorized{{#translation:}}|Glowing Sphere Toggle]] | ||
[[Category:Components{{#translation:}}|Glowing Sphere Toggle]] | [[Category:Components{{#translation:}}|Glowing Sphere Toggle]] | ||
Latest revision as of 17:02, 2 March 2025
Component image 
Glowing Sphere Toggle component as seen in the Scene Inspector
The GlowingSphereToggle component can be used to toggle a boolean value when clicked.
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. |
TargetField
|
IField`1<Bool> | The field to toggle. |
FadeSpeed
|
Float | How fast to fade after being clicked. |
CooldownTime
|
Float | How long the user has to wait before they can toggle it again. |
Radius
|
Float | The size of the toggle sphere. |
GlowColor
|
ColorX | What color the sphere should glow. |
_emissiveColor
|
field drive of ColorX | The color to drive with the sphere color for emissive. |
_rimColor
|
field drive of ColorX | The color to drive with the rim color. |
_sphereRadius
|
field drive of Float | The field to drive with the sphere radius. |
_sphereExtrude
|
field drive of Float | The field to drive with the sphere extrude value. |
_colliderRadius
|
field drive of Float | The field to drive with the collider radius. |
Usage
Attach to a slot and provide values as well as something to toggle for this component to work.
Examples
This article or section is a Stub. You can help the Resonite Wiki by expanding it.