Automated: create new component page |
add info |
||
| Line 3: | Line 3: | ||
|Name=Radiant Search Bar | |Name=Radiant Search Bar | ||
}} | }} | ||
The '''RadiantSearchBar''' component is most commonly used and found in the [[World Browser]]. | |||
== | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|SearchTerm|String| | |SearchTerm|String| The term this is searching for. | ||
|IsSearching|Bool| | |IsSearching|Bool| Whether this component is currently searching. | ||
|SearchAnimTileSpeed|Float| | |SearchAnimTileSpeed|Float| How fast the search animation scrolling speed should be. | ||
|SearchAnimColor|ColorX| | |SearchAnimColor|ColorX| What the color of the search bar should be while searching. | ||
|_textField|'''[[Component:TextField|TextField]]'''|TypeAdv4=true| | |_textField|'''[[Component:TextField|TextField]]'''|TypeAdv4=true| The text field for entering a search. | ||
|_searchText|{{RootFieldType|RelayRef`1|[[Component:Text|Text]]}}|TypeAdv5=true| | |_searchText|{{RootFieldType|RelayRef`1|[[Component:Text|Text]]}}|TypeAdv5=true| The text UIX Component for searching | ||
|_defaultText|'''[[Component:Text|Text]]'''|TypeAdv6=true| | |_defaultText|'''[[Component:Text|Text]]'''|TypeAdv6=true| The text UIX Component that should be visible if a search term has not yet been entered. | ||
|_searchingVisual|'''[[Component:TiledRawImage|TiledRawImage]]'''|TypeAdv7=true| | |_searchingVisual|'''[[Component:TiledRawImage|TiledRawImage]]'''|TypeAdv7=true| The visual to show while searching | ||
|_cancelButton|'''[[Component:Button|Button]]'''|TypeAdv8=true| | |_cancelButton|'''[[Component:Button|Button]]'''|TypeAdv8=true| The button that can be used to cancel a currently running search. | ||
|_defaultVisible|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv9=true| | |_defaultVisible|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv9=true| The field to drive with what should be visible by default. | ||
|_searchingAnimationColor|{{RootFieldType|FieldDrive`1|[[Type:ColorX|ColorX]]}}|TypeAdv10=true| | |_searchingAnimationColor|{{RootFieldType|FieldDrive`1|[[Type:ColorX|ColorX]]}}|TypeAdv10=true| The field to drive for the color of the searching animation visual. | ||
|_searchingTextureOffset|{{RootFieldType|FieldDrive`1|[[Type:Float2|Float2]]}}|TypeAdv11=true| | |_searchingTextureOffset|{{RootFieldType|FieldDrive`1|[[Type:Float2|Float2]]}}|TypeAdv11=true| The offset field to drive to create the searching animation scrolling visual. | ||
}} | |||
== Sync Delegates == | |||
{{Table ComponentTriggers | |||
|OnCancel()|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]] button, [[Type:ButtonEventData|ButtonEventData]] eventData>| Cancels the current search. | |||
}} | }} | ||
== | == Usage == | ||
{{stub}} | |||
== Examples == | == Examples == | ||
Used in the [[RedX]] UI. | |||
== See Also == | == See Also == | ||
| Line 29: | Line 36: | ||
[[Category:Components:Radiant UI:General{{#translation:}}|Radiant Search Bar]] | [[Category:Components:Radiant UI:General{{#translation:}}|Radiant Search Bar]] | ||
[[Category:Components{{#translation:}}|Radiant Search Bar]] | [[Category:Components{{#translation:}}|Radiant Search Bar]] | ||
Revision as of 20:59, 31 January 2025
Component image 
Radiant Search Bar component as seen in the Scene Inspector
The RadiantSearchBar component is most commonly used and found in the World Browser.
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. |
SearchTerm
|
String | The term this is searching for. |
IsSearching
|
Bool | Whether this component is currently searching. |
SearchAnimTileSpeed
|
Float | How fast the search animation scrolling speed should be. |
SearchAnimColor
|
ColorX | What the color of the search bar should be while searching. |
_textField
|
TextField | The text field for entering a search. |
_searchText
|
direct RelayRef`1<Text> | The text UIX Component for searching |
_defaultText
|
Text | The text UIX Component that should be visible if a search term has not yet been entered. |
_searchingVisual
|
TiledRawImage | The visual to show while searching |
_cancelButton
|
Button | The button that can be used to cancel a currently running search. |
_defaultVisible
|
field drive of Bool | The field to drive with what should be visible by default. |
_searchingAnimationColor
|
field drive of ColorX | The field to drive for the color of the searching animation visual. |
_searchingTextureOffset
|
field drive of Float2 | The offset field to drive to create the searching animation scrolling visual. |
Sync Delegates
| Method Name | Method type and Arguments. | Is the method hidden? | Description |
|---|
Usage
This article or section is a Stub. You can help the Resonite Wiki by expanding it.
Examples
Used in the RedX UI.