diff --git a/automated_updates_data.json b/automated_updates_data.json index 88dd158d37e..267b15ea757 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-08-17", + "summary": "Improved file system docs: documented the 'Read a directory' action and added missing path expressions (User's Home folder, executable file, and directory/file-name/extension helpers)" } ] } diff --git a/docs/gdevelop5/all-features/filesystem/index.md b/docs/gdevelop5/all-features/filesystem/index.md index a53d7d5ad6a..35f3f5f284b 100644 --- a/docs/gdevelop5/all-features/filesystem/index.md +++ b/docs/gdevelop5/all-features/filesystem/index.md @@ -192,6 +192,16 @@ 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 their names in an array. This action is always asynchronous. +== Parameters == +** Directory path: ** The path on the file system of the directory to read. +It is advised to use the expressions for special folders (see below) to keep your game platform independent. + +** (Optional) Result variable: ** Variable to store the result. It is set to `'error'` if an error occurred, otherwise it is filled with an array containing the name of each file and sub-directory found in the directory. You can loop through this array with a "For each child" event to process every entry. + ## 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 +212,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 file +This expression returns the operating system independent path to your game's executable file. +#### Game executable folder This expression returns the operating system independent path to the folder where your game is being executed from. +#### 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 +231,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 take an existing path and extract a part of it. They are useful, for example, to process the entries returned by the *Read a directory* action. +#### Get directory name from a path +This expression returns the portion of the given 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 any) from the given path. +#### Get the extension from a file path +This expression returns the extension of the file designated by the given path, including the leading period (for example: `.txt`). + ## Example In order to save a screenshot to the _Pictures_ directory you could write: