Component:FileBrowser: Difference between revisions

From Resonite Wiki
← Older editNewer edit →
VisualWikitext
add info
Automated: update Fields, SyncDelegates
Line 15: Line 15:
|_buttonsRoot|Slot| The root of the area being used to show the different button actions.
|_buttonsRoot|Slot| The root of the area being used to show the different button actions.
|_folderGrid|'''[[Component:GridLayout|GridLayout]]'''|TypeAdv7=true| The grid layout Component being used to align the folders in the directory.
|_folderGrid|'''[[Component:GridLayout|GridLayout]]'''|TypeAdv7=true| The grid layout Component being used to align the folders in the directory.
|_itemGrid|'''[[Component:GridLayout|GridLayout]]'''|TypeAdv8=true| The grid layout Component being used to align the files in the directory.  
|_itemGrid|'''[[Component:GridLayout|GridLayout]]'''|TypeAdv8=true| The grid layout Component being used to align the files in the directory.
|_tabSprite|'''[[Component:SpriteProvider|SpriteProvider]]'''|TypeAdv9=true| The sprite being used to show the tab sprite.
|_tabSprite|'''[[Component:SpriteProvider|SpriteProvider]]'''|TypeAdv9=true| The sprite being used to show the tab sprite.
|_loadingIndicator|Slot| The slot that stores the loading indicator for a newly opened directory.
|_loadingIndicator|Slot| The slot that stores the loading indicator for a newly opened directory.
|_swapper|'''[[Component:SlideSwapRegion|SlideSwapRegion]]'''|TypeAdv11=true| The component to handle the slide animation when opening a different directory.
|_swapper|'''[[Component:SlideSwapRegion|SlideSwapRegion]]'''|TypeAdv11=true| The component to handle the slide animation when opening a different directory.
|CurrentPath|String| The current folder path.  
|CurrentPath|String| The current folder path.
|_lastPath|String| The last folder path.
|_lastPath|String| The last folder path.
|_user|{{RootFieldType|MachineUserRef}}|TypeAdv14=true| The user using this file browser.
|_user|{{RootFieldType|MachineUserRef}}|TypeAdv14=true| The user using this file browser.
|_importButton|'''[[Component:Button|Button]]'''|TypeAdv15=true| The button to import a selected folder or file.  
|_importButton|'''[[Component:Button|Button]]'''|TypeAdv15=true| The button to import a selected folder or file.
|_rawImportButton|'''[[Component:Button|Button]]'''|TypeAdv16=true| The button to import a selected file as a raw file object.
|_rawImportButton|'''[[Component:Button|Button]]'''|TypeAdv16=true| The button to import a selected file as a raw file object.
|_createNewButton|'''[[Component:Button|Button]]'''|TypeAdv17=true| The button to create a new file directory.
|_createNewButton|'''[[Component:Button|Button]]'''|TypeAdv17=true| The button to create a new file directory.
|_reloadButton|'''[[Component:Button|Button]]'''|TypeAdv18=true| The button used to refresh the folder and file list.
|_reloadButton|'''[[Component:Button|Button]]'''|TypeAdv18=true| The button used to refresh the folder and file list.
}}
== Sync Delegates ==
{{Table ComponentTriggers
|CreateDirectory(string, String&)|[[Component:BrowserCreateDirectoryDialog#CreateHandler|CreateHandler]]<[[Type:String|String]]: name, [[Type:String&|String&]]: error> -> [[Type:Bool|Bool]] : HIDDEN METHOD|
|RunImport(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData> -> [[Type:Void|Void]] : HIDDEN METHOD|
|RunRawImport(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData> -> [[Type:Void|Void]] : HIDDEN METHOD|
|CreateNew(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData> -> [[Type:Void|Void]] : HIDDEN METHOD|
|Reload(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData> -> [[Type:Void|Void]] : HIDDEN METHOD|
|OnGoUp(IButton, ButtonEventData, int)|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData, [[Type:Int|Int]]: levels> -> [[Type:Void|Void]] : HIDDEN METHOD|
}}
}}


Revision as of 22:29, 16 March 2025

Component image 
File:FileBrowserComponent.png
File Browser component as seen in the Scene Inspector

The FileBrowser component is used to show file lists of files on the user's PC in the dash world Dash Menu.

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.
SelectedItem BrowserItem The currently selected item being highlighted.
_previousSelectedItem BrowserItem The item previously highlighted.
AllowSelect Bool Whether this file browser allows selecting item elements.
ItemSize Float How big the items are on the view.
_selectedText Text The text to fill with the name of the selected item.
_pathRoot Slot The root of the area being used to display the current path.
_buttonsRoot Slot The root of the area being used to show the different button actions.
_folderGrid GridLayout The grid layout Component being used to align the folders in the directory.
_itemGrid GridLayout The grid layout Component being used to align the files in the directory.
_tabSprite SpriteProvider The sprite being used to show the tab sprite.
_loadingIndicator Slot The slot that stores the loading indicator for a newly opened directory.
_swapper SlideSwapRegion The component to handle the slide animation when opening a different directory.
CurrentPath String The current folder path.
_lastPath String The last folder path.
_user direct MachineUserRef The user using this file browser.
_importButton Button The button to import a selected folder or file.
_rawImportButton Button The button to import a selected file as a raw file object.
_createNewButton Button The button to create a new file directory.
_reloadButton Button The button used to refresh the folder and file list.

Sync Delegates

Lua error in mw.text.lua at line 25: bad argument #1 to 'match' (string expected, got nil).
Triggers
Method Name Method type and Arguments. Is the method hidden? Description

Usage

Not used directly by the user.

Examples

Used in the dash menu on the file browser tab.

See Also

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