diff --git a/automated_updates_data.json b/automated_updates_data.json index 93530ac0247..fe7492e7e96 100644 --- a/automated_updates_data.json +++ b/automated_updates_data.json @@ -104,6 +104,10 @@ { "date": "2026-07-07", "summary": "Improved keyboard docs: added 'Key just pressed' (held vs one-frame) and 'Any key released' conditions, control-remapping note, and a reference list of valid key names" + }, + { + "date": "2026-07-17", + "summary": "Improved file system docs: added 'Read a directory' action and documented missing expressions (Game executable file, User's Home folder, directory/file name and extension parsing)" } ] } diff --git a/docs/gdevelop5/all-features/filesystem/index.md b/docs/gdevelop5/all-features/filesystem/index.md index a53d7d5ad6a..f9587b1a9e7 100644 --- a/docs/gdevelop5/all-features/filesystem/index.md +++ b/docs/gdevelop5/all-features/filesystem/index.md @@ -192,6 +192,15 @@ It is advised to use the expressions for special folders (see below) to keep you ** (Optional) Result variable: ** Variable to store the result. It can either hold the value 'ok': the task was successful or 'error': an error occurred. The variable will be updated, at the moment the file operation has finished. +--- + +#### Read a directory +This action reads the contents of a directory (all files and sub-directories) and stores them in a variable, as an array. This is useful, for example, to let the player pick from a list of existing save files. +== Parameters == +** Directory path: ** The absolute path to the directory to read. + +** (Optional) Result variable: ** Variable to store the result. On success, it is set to an array containing the names of every file and sub-directory found. On failure, it is set to `"error"`. + ## Expressions These expressions return the path to special folders on the users' operating system. If you use these expressions for loading and saving files it will be guaranteed to work on all supported operating systems. (Currently Windows, Linux, and macOS) !!! tip @@ -202,8 +211,12 @@ This expression returns the operating system independent path to the _Desktop_ f #### Documents folder This expression returns the operating system independent path to the _Documents_ folder of the user that runs your game. This is the standard folder for storing documents. -#### This games executable folder +#### Game executable folder This expression returns the operating system independent path to the folder where your game is being executed from. +#### Game executable file +This expression returns the operating system independent path to the game executable file itself (not just its folder). +#### User's Home folder +This expression returns the operating system independent path to the home folder of the user that runs your game. #### Pictures folder This expression returns the operating system independent path to the _Pictures_ folder of the user that runs your game. This is the standard folder for storing images. @@ -217,6 +230,14 @@ This folder is used for storing application settings. This expression returns the operating system independent path delimiter character. ("\" on Windows and "/" on Linux and macOS). Use this expression to build cross-platform file paths that can be accessed on all supported operating systems. +The following expressions help you split an existing path into its parts: +#### Get directory name from a path +This expression returns the portion of a path that represents the directories, without the ending file name. +#### Get file name from a path +This expression returns the name of the file, with its extension if it has one. +#### Get the extension from a file path +This expression returns the extension of the file, including the leading period (for example: ".txt"). + ## Example In order to save a screenshot to the _Pictures_ directory you could write: