Component:ComponentSelector: Difference between revisions

From Resonite Wiki
← Older edit
Visual
Automated: update SyncDelegates
add info
 
(2 intermediate revisions by one other user not shown)
Line 20: Line 20:
== Sync Delegates ==
== Sync Delegates ==
{{Table ComponentTriggers
{{Table ComponentTriggers
|OnCancelPressed(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData> -> [[Type:Void|Void]] : HIDDEN METHOD| Closes the UI and doesn't attach anything.
|OnCancelPressed:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Closes the UI and doesn't attach anything.
|OnOpenCategoryPressed(IButton, ButtonEventData, string)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData, [[Type:String|String]]: path> -> [[Type:Void|Void]] : HIDDEN METHOD| Opens a category of the path argument given.
|OnOpenCategoryPressed:[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]<[[Type:String|String]]>|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]<[[Type:String|String]]>|true| Opens a category of the path argument given.
|OpenGenericTypesPressed(IButton, ButtonEventData, string)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData, [[Type:String|String]]: pathType> -> [[Type:Void|Void]] : HIDDEN METHOD|
|OpenGenericTypesPressed:[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Type:String|String]]&gt;|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Type:String|String]]&gt;|true| Handles loading the menu for selecting a generic argument screen for a component that has a generic argument like <T>, <A>, or <S> to name a few.
|OpenGroupPressed(IButton, ButtonEventData, string)|[[Type:Delegate|Delegate]]&lt;[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData, [[Type:String|String]]: pathWithGroup&gt; -> [[Type:Void|Void]] : HIDDEN METHOD|
|OpenGroupPressed:[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Type:String|String]]&gt;|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Type:String|String]]&gt;|true| Handles bringing up the menu for opening a group of components of the same type (purple buttons).
|OnAddComponentPressed(IButton, ButtonEventData, string)|[[Type:Delegate|Delegate]]&lt;[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData, [[Type:String|String]]: typename&gt; -> [[Type:Void|Void]] : HIDDEN METHOD| Triggers when a component is addrd.
|OnAddComponentPressed:[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Type:String|String]]&gt;|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]&lt;[[Type:String|String]]&gt;|true| Triggers when a component is addrd.
|OnCreateCustomType(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]&lt;[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData&gt; -> [[Type:Void|Void]] : HIDDEN METHOD| Triggers when a component is made via the attacher with a generic type that isn't in the list of preselected generics.
|OnCreateCustomType:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Triggers when a component is made via the attacher with a generic type that isn't in the list of preselected generics.
}}
}}


Latest revision as of 23:02, 18 March 2025

Component image 
Component Selector component as seen in the Scene Inspector

The Component Selector is better understood on its page, Complex Types in Components.

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.
ComponentSelected delegate of identity ComponentSelectionHandler The Sync delegate to call when the component is attached.
ComponentFilter delegate of identity Predicate`1<Type> The type of Components to show in the attacher.
GenericArgumentPrefiller delegate of identity GenericArgumentPrefiller A sync delegate that fills the list of generic arguments for a selected type so it doesn't only ask for a certain type.
_uiRoot Slot The root slot of the UI.
_rootPath String The path that this is navigated to in the component attacher.
_genericType direct SyncType The generic type we are trying to make a generic fill for.
_customGenericTypeLabel field drive of String The label for the generic type we are attaching.
_customGenericTypeColor field drive of ColorX The color for the generic type we are attaching.
_customGenericArguments list of TextField The generic arguments being used for the current Component being attached. See Complex Types in Components.

Sync Delegates

Triggers
Method Name Method type and Arguments. Is the method hidden? Description
OnCancelPressed:ButtonEventHandler ButtonEventHandler ✓ Closes the UI and doesn't attach anything.
OnOpenCategoryPressed:ButtonEventHandler`1<String> ButtonEventHandler`1<String> ✓ Opens a category of the path argument given.
OpenGenericTypesPressed:ButtonEventHandler`1<String> ButtonEventHandler`1<String> ✓ Handles loading the menu for selecting a generic argument screen for a component that has a generic argument like <T>, <A>, or to name a few.
OpenGroupPressed:ButtonEventHandler`1<String> ButtonEventHandler`1<String> ✓ Handles bringing up the menu for opening a group of components of the same type (purple buttons).
OnAddComponentPressed:ButtonEventHandler`1<String> ButtonEventHandler`1<String> ✓ Triggers when a component is addrd.
OnCreateCustomType:ButtonEventHandler ButtonEventHandler ✓ Triggers when a component is made via the attacher with a generic type that isn't in the list of preselected generics.

Usage

See Complex Types in Components.

Examples

See Complex Types in Components.

See Also

Retrieved from "https://wiki.resonite.com/index.php?title=Component:ComponentSelector&oldid=98352"