FILE_SELECT_MENU

Creates a menu composed of selectable file names from a list of directories and subdirectories. Can be instantiated alone or within a POPUP_MENU or MENU_ITEM. The menu can store the selected file path and name into a string, and also exposes a read/write index parameter to set or get the selected item number in the flattened files list.

If the file path is set programmatically, the corresponding menu item is automatically selected (if found) and the index parameter is updated.

Attributes brief detailed show all inherited

	Name	Description	Default
	directories	List of directories to scan for files, separated by ';'	empty
	file_types	List of file extensions in wildcard syntax, separated by ';'Example: *.txt;*.wav	empty
	scan_on_load	When true, the menu is filled when createdSet this attribute to false if you want to avoid the engine to scan the file system when loading the skin	true
	root_path	List of root directories that can be used to store relative file paths, separated by ';'If the directories are located within one of the root paths, corresponding file paths will be stored relatively to one of the root paths. This is useful when the root location of the files may change (Mac vs Windows, or username dependent paths etc.)	empty
	file_path_string_id	Identifier of the target string to store the selected file path (optional)The stored file path is releative to on of the paths specified in the root_path attribute	empty
	file_name_string_id	Identifier of the target string to store the selected file name for display purposes (optional)	empty
Exposed Objects
	Popup	Menu pops up at the current mouse locationExposed only if the menu is instantiated outside of an existing menu
	Refresh	Refresh the content of the menu by re-scanning the file system
	selected_file_index	The index of the selected item in the flattened files list (-1 if not available)
	item_selected	Fired when the user selects an item in the menu
Common attributes
	id	Identifier of the elementThe id of an element has to be globally unique. Don't start with a digit for AngelScript compatibility.	empty

	Name	Value type	Default	Description	Comment
	directories	string	empty	List of directories to scan for files, separated by ';'
	file_types	string	empty	List of file extensions in wildcard syntax, separated by ';'	Example: *.txt;*.wav
	scan_on_load	boolean	true	When true, the menu is filled when created	Set this attribute to false if you want to avoid the engine to scan the file system when loading the skin
	root_path	string	empty	List of root directories that can be used to store relative file paths, separated by ';'	If the directories are located within one of the root paths, corresponding file paths will be stored relatively to one of the root paths. This is useful when the root location of the files may change (Mac vs Windows, or username dependent paths etc.)
	file_path_string_id	string id	empty	Identifier of the target string to store the selected file path (optional)	The stored file path is releative to on of the paths specified in the root_path attribute
	file_name_string_id	string id	empty	Identifier of the target string to store the selected file name for display purposes (optional)
Exposed Objects
	Popup	action		Menu pops up at the current mouse location	Exposed only if the menu is instantiated outside of an existing menu
	Refresh	action		Refresh the content of the menu by re-scanning the file system
	selected_file_index	integer param		The index of the selected item in the flattened files list (-1 if not available)
	item_selected	event		Fired when the user selects an item in the menu
Common attributes
	id	identifier	empty	Identifier of the element	The id of an element has to be globally unique. Don't start with a digit for AngelScript compatibility.

Example

Here we use menu to select a file located in one of directories listed. Using root_path to truncate (shorten) the resulted file path.

You can also use FILE_SELECT_MENU inside other POPUP_MENU or MENU_ITEM.