From 6b7d020a03a089acc34a1aee7c6ca9360c8ed05c Mon Sep 17 00:00:00 2001 From: gurpreetsinghmatharoo Date: Fri, 8 Dec 2023 11:50:44 +0530 Subject: [PATCH 1/8] [General] Fixed tag for Declare Temporary Variable --- .../Common/Declare_Temporary_Variable.htm | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Manual/contents/Drag_And_Drop/Drag_And_Drop_Reference/Common/Declare_Temporary_Variable.htm b/Manual/contents/Drag_And_Drop/Drag_And_Drop_Reference/Common/Declare_Temporary_Variable.htm index 99404b69e..3d23abb66 100644 --- a/Manual/contents/Drag_And_Drop/Drag_And_Drop_Reference/Common/Declare_Temporary_Variable.htm +++ b/Manual/contents/Drag_And_Drop/Drag_And_Drop_Reference/Common/Declare_Temporary_Variable.htm @@ -4,7 +4,7 @@ Declare Temporary Variable - + @@ -58,7 +58,7 @@
© Copyright YoYo Games Ltd. 2023 All R Action - Assign Variable --> \ No newline at end of file From bc8dba94068a97c335a3a6acf96d096914f5f9bf Mon Sep 17 00:00:00 2001 From: gurpreetsinghmatharoo Date: Fri, 8 Dec 2023 16:41:36 +0530 Subject: [PATCH 2/8] Fixes https://github.com/YoYoGames/GameMaker-Bugs/issues/2155 * Updated example on application_surface --- .../Drawing/Surfaces/application_surface.htm | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Surfaces/application_surface.htm b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Surfaces/application_surface.htm index b7317ad52..168a37499 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Surfaces/application_surface.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Surfaces/application_surface.htm @@ -22,11 +22,17 @@

Syntax:

application_surface;

 

Returns:

-

Surface

+

Surface

 

Example:

-

surface_resize(application_surface, display_get_gui_width(), display_get_gui_height())

-

The above code will resize the application surface to have a 1:1 ratio with the GUI layer.

+

var _cam_width = 320;
+ var _cam_height = 180;
+ var _resolution_scale = 4;
+
+ surface_resize(application_surface, _cam_width * _resolution_scale, _cam_height * _resolution_scale); +

+

This defines the size of the in-game camera (320 x 180), and a resolution scale value (4x), which is how large the target resolution should be in relation to the in-game camera.

+

The camera size is multiplied with that resolution scale and applied as the size of the application surface, which defines the game's resolution.

 

 

From 873a64e43e1dda37d58a0f63fe9ba0cd2051e042 Mon Sep 17 00:00:00 2001 From: gurpreetsinghmatharoo Date: Mon, 11 Dec 2023 12:17:02 +0530 Subject: [PATCH 3/8] [Feature-room_get_info] Added xscale and yscale to instance information https://github.com/YoYoGames/GameMaker-Feature-Requests/issues/1519 --- .../Asset_Management/Rooms/room_get_info.htm | 244 +++++++++--------- 1 file changed, 127 insertions(+), 117 deletions(-) diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/room_get_info.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/room_get_info.htm index 50c1918ff..411a2e44b 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/room_get_info.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/room_get_info.htm @@ -49,7 +49,7 @@

room_get_info

Room Info

This is the main struct returned by the function. All variables listed below are present at the root of this returned struct:

- +
@@ -64,77 +64,77 @@

room_get_info

- + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -177,6 +177,16 @@

room_get_info

+ + + + + + + + + + @@ -214,7 +224,7 @@

room_get_info

This type of struct represents one layer in the room.

These structs are found in the layers array, which is part of the main struct returned by the function.

-
Room Info Struct
widthRealReal The width of the room
heightRealReal The height of the room
creationCodeScript FunctionScript Function The index of the script function that contains this room's creation code
physicsWorldBooleanBoolean Whether the room has a physics world
physicsGravityXRealReal The physics world's gravity component along the x axis
physicsGravityYRealReal The physics world's gravity component along the y axis
physicsPixToMetersRealReal The physics world's pixel-to-metre scale
persistentBooleanBoolean Whether the room is persistent
enableViewsBooleanBoolean Whether views are enabled for the room
clearDisplayBufferBooleanBoolean Whether to clear the display buffer before drawing the room
clearViewportBackgroundBooleanBoolean Whether to clear viewports' backgrounds before drawing to them
colourColourColour The clear colour used when clearDisplayBuffer is set to true
instancesArray of Room Instance Info StructArray of Room Instance Info Struct An array listing all instances placed in the room with basic information on them
layersArray of Room Layer Info StructArray of Room Layer Info Struct An array listing all room layers, in order of increasing depth
viewsArray of Room View Info StructArray of Room View Info Struct An array listing all views, ordered by view index
Real The y coordinate of the instance's position
xscaleRealThe x scale of the instance
yscaleRealThe y scale of the instance
angle Real
+
@@ -229,67 +239,67 @@

room_get_info

- + - + - + - + - + - + - + - + - + - + - + - + - + @@ -299,7 +309,7 @@

room_get_info

This type of struct represents one view in the room.

These structs are found in the views array, which is part of the main struct returned by the function.

-
Layer Info Struct
idRealReal The layer ID
nameStringString The name of the layer
visibleBooleanBoolean Whether the layer is visible
depthRealReal The depth of the layer
xoffsetRealReal The x offset of the layer
yoffsetRealReal The y offset of the layer
hspeedRealReal The horizontal speed of the layer
vspeedRealReal The vertical speed of the layer
effectEnabledBooleanBoolean Whether the layer filter/effect is currently enabled
effectToBeEnabledBooleanBoolean Whether the layer filter/effect should be enabled/disabled in the next frame (the next value of effectEnabled)
effectFX StructFX Struct A struct containing the effect's parameters (-1 if no layer effect is set)
shaderIDShader AssetShader Asset The shader to be applied to the layer (layer_shader)
elementsArray of Room Layer Element Info StructArray of Room Layer Element Info Struct An array listing all elements on the layer. Each element type struct contains information specific to it.
+
@@ -314,77 +324,77 @@

room_get_info

- + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -394,7 +404,7 @@

room_get_info

This type of struct represents one element in a layer.

These structs are found in the elements array, which is part of a layer struct.

-
View Info Struct
visibleBooleanBoolean Whether the view is visible
cameraIDCamera IDCamera ID The camera assigned to this view
xviewRealReal The x coordinate of the view camera's position
yviewRealReal The y coordinate of the view camera's position
wviewRealReal The width of the view's camera
hviewRealReal The height of the view's camera
hspeedRealReal The horizontal movement speed of the view
vspeedRealReal The vertical movement speed of the view
xportRealReal The x position on screen where the view is drawn
yportRealReal The y position on screen where the view is drawn
wportRealReal The width of the viewport
hportRealReal The height of the viewport
objectObject AssetObject Asset The object of which the first instance in the room should be followed by the camera
hborderRealReal The horizontal border around the instance of the object to follow
vborderRealReal The vertical border around the instance of the object to follow
+
@@ -410,12 +420,12 @@

room_get_info

- + - + @@ -423,67 +433,67 @@

room_get_info

- + - + - + - + - + - + - + - + - + - + - + - + - + @@ -491,7 +501,7 @@

room_get_info

- + @@ -499,62 +509,62 @@

room_get_info

- + - + - + - + - + - + - + - + - + - + - + - + @@ -562,42 +572,42 @@

room_get_info

- + - + - + - + - + - + - + - + @@ -605,47 +615,47 @@

room_get_info

- + - + - + - + - + - + - + - + - + @@ -653,67 +663,67 @@

room_get_info

- + - + - + - + - + - + - + - + - + - + - + - + - + @@ -721,62 +731,62 @@

room_get_info

- + - + - + - + - + - + - + - + - + - + - + - + From caacc07b305d57c23f76a95565d5f4cb342263e0 Mon Sep 17 00:00:00 2001 From: gurpreetsinghmatharoo Date: Mon, 11 Dec 2023 12:42:29 +0530 Subject: [PATCH 4/8] [General] JSDoc: pass mulitple types into an argument definition Closes https://github.com/YoYoGames/GameMaker-Bugs/issues/2174 --- .../Code_Editor_Properties/JSDoc_Script_Comments.htm | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/Manual/contents/The_Asset_Editors/Code_Editor_Properties/JSDoc_Script_Comments.htm b/Manual/contents/The_Asset_Editors/Code_Editor_Properties/JSDoc_Script_Comments.htm index c04333d4d..6489b01a4 100644 --- a/Manual/contents/The_Asset_Editors/Code_Editor_Properties/JSDoc_Script_Comments.htm +++ b/Manual/contents/The_Asset_Editors/Code_Editor_Properties/JSDoc_Script_Comments.htm @@ -4,7 +4,7 @@ JSDoc Script Comments - + @@ -43,13 +43,13 @@

JSDoc Script Comments<

- - + + - + @@ -136,7 +136,7 @@

Examples

-
© Copyright YoYo Games Ltd. 2022 All Rights Reserved
+
© Copyright YoYo Games Ltd. 2023 All Rights Reserved

The File System

-

When using the file system functions or included files with GameMaker it is vitally important to know exactly how the file system works and what things are going on behind the scenes. To that end, this section is designed to explain and clarify exactly how things are stored, where they are stored and what possible limits or workarounds there may be to this system.

-

The first and most important thing to note about the file functions is that they are limited - in general and by default - to the sandbox. What this means is that GameMaker cannot save or load files from anywhere that is not part of the game bundle or the local storage for the device without explicit input from the user, and even then this input is limited to only Windows, macOS and Ubuntu (Linux) target platforms.

+

When using the file system functions or included files with GameMaker, it's important to know how the file system works and what things are going on behind the scenes. This section is designed to explain and clarify exactly how things are stored, where they are stored and what possible limits or workarounds there may be to this system.

+

The first thing to note about the file functions is that they are limited - in general and by default - to the sandbox. What this means is that GameMaker cannot save or load files from anywhere that is not part of the game bundle or the local storage for the device without explicit input from the user, and even then this input is limited to only Windows, macOS and Ubuntu (Linux) target platforms.

 It is possible to turn off sandboxing on the Desktop targets (Windows, macOS, and Ubuntu) by checking the Disable file system sandbox option in the Game Options for the target platform. You do this at your own risk, and while this will open up file saving and loading and permit you to access files anywhere on the given system, it may still be limited by the OS permissions.

+

File Areas

To understand the sandbox first of all you need to understand that there are two distinct areas for files:

    -
  • The File Bundle - this is where all the files that are packaged with the executable game are stored, including the files that you have added to the Included Files asset list from the GameMaker IDE (which are the external files that you want packaged with the game).
    • -
  • The Save Area - this is an area of device storage that can be safely written to by the game and the game is guaranteed that this is a writable area.
    • +
  • The File Bundle - This is where all the files that are packaged with the executable game are stored, including the files that you have added to the Included Files asset list from the GameMaker IDE (which are the external files that you want packaged with the game). This area can be accessed through the program_directory variable, however files will be read from this location automatically when reading, without explicitly needing a path - this is explained more in the next section.
    • +
  • The Save Area - This is an area of device storage that can be safely written to by the game and the game is guaranteed that this is a writable area. This can be accessed through the game_save_id variable, however files will be read from this location too automatically when reading, and any saves are done here by default.

The following diagram may help you to visualise this better:

File System Save Areas

-

When your game is sandboxed, the two target areas - the bundle directory and the local storage area - are available on each target platform, but on each one they will work slightly differently. However GameMaker has abstracted out the main essence of what can and can't be done, making it easier to re-target games to multiple environments.

-

To start with, you should understand what is meant when we talk of the working_directory. This is a synonym for the two possible save locations (as illustrated by the diagram above) and when you use that directory it will do one of two things depending on whether you are reading or writing, and whether the file you are reading from has been changed or not:

+

Accessing File Areas

+

When your game is sandboxed, only the two target areas - the file bundle and the save area - are available on each target platform, but on each one they will work slightly differently. However GameMaker has abstracted out the main essence of what can and can't be done, making it easier to re-target games to multiple environments.

+

To start with, let's look at how files are looked up in GameMaker, say if you do a read:

+

buf = buffer_load("my_file.dat");

+

or a write:

+

buffer_save(buf, "my_file.dat");

+

This will do one of two things depending on whether you are reading or writing:

    -
  • Reading Operations - working_directory will first check the save area to see if the file being accessed is there, and if it is uses that. However if the file does not exist in the save area, it then checks the file bundle area and uses that (if the file being looked for is an included file with your game).
    • -
  • Writing Operations - This can only happen in the save area.
    • +
  • Reading Operations - This will first check the save area to see if the file being accessed is there, and if it is, it uses that. However if the file does not exist in the save area, it then checks the file bundle area and uses that (if the file being looked for is an Included File with your game).
    • +
  • Writing Operations - This can only happen in the save area, unless the sandbox is disabled and a path outside the save area is explicitly specified.
-

 In general GameMaker will handle all this for you and you rarely need to use the working_directory built-in variable.

Using these two simple rules we can now see how the following functions work (these are examples to help you to visualise the process for the different functions available):

  • directory_create (and the other directory functions) will only work in the save area.
    • -
  • the file system functions will return information on files from both the bundle and the save area, but will only write to the save area.
    • -
  • the functions for writing text, binary or INI files will create a new file in the save area if one does not already exist, copying over any information from the original files included with the game bundle should they exist. Note that the original files will still remain in the read-only part of the save directory, but they won't be referenced as long as a version exists in the read/write section of the save area.
    • +
  • The file system functions will return information on files from both the bundle and the save area, but will only write to the save area.
    • +
  • The functions for writing text, binary or INI files will create a new file in the save area if one does not already exist, copying over any information from the original files included with the game bundle should they exist. Note that the original files will still remain in the read-only part of the save directory, but they won't be referenced as long as a version exists in the read/write section of the save area.
-

On the Windows, macOS and Ubuntu (Linux) platforms there are two ways to save and load files from outside of the sandbox and that is either using the functions get_open_filename and get_save_filename (both of these functions will require that the user select an area for loading and saving and the return string can then be used in the rest of the file functions to bypass the sandbox - see the function descriptions for more details). The other way is to disable the sandbox altogether from the Game Options for the target platform (only available for Desktop targets, as discussed further up this page).

+

Outside The Sandbox

+

On the Windows, macOS and Ubuntu (Linux) platforms there are two ways to save and load files from outside of the sandbox and that is either using the functions get_open_filename and get_save_filename (both of these functions will require that the user select an area for loading and saving, and the returned string can then be used in the rest of the file functions to bypass the sandbox - see the function descriptions for more details). The other way is to disable the sandbox altogether from the Game Options for the target platform (only available for Desktop targets, as discussed further up this page).

On HTML5 it is also possible to load files from outside the sandbox from a server, however this should only be done using the function buffer_load_async as loading synchronously has been deprecated on most browsers and will eventually be obsoleted. This means that files being loaded in this way should be saved as binary files - for example, you can save an *.ini as a string (see ini_close for details) and then write that into a buffer which can then be saved and loaded using the async functions. Note that if you are loading images using sprite_add then these are already dealt with asynchronously.

-

You should also know that each target platform has its own save area where files and directories can be written to and read from. Below is a list of those areas for each target when sandboxed:

+

Save Area Locations

+

Each target platform has its own save area where files and directories can be written to and read from. Below is a list of those areas for each target when sandboxed:

    -
  • Windows: Windows has all files in the %localappdata%\<Game Name> directory (on Windows 7 this is the /Users/<User Name>/AppData/Local/<Game Name> directory).
    • +
  • Windows: Windows has all files in the %localappdata%\<Game Name> directory (on Windows this is the /Users/<User Name>/AppData/Local/<Game Name> directory).
  • HTML5, GX.games: Everything is done through the local storage.
  • macOS: Storage will depend on whether the application is sandboxed or not (following Apple's rules, with the path usually being ~/Library/Application Support/<Game Name>).
  • Ubuntu (Linux): Files are stored in the Home/.config/gamename where "Home" is the users home directory - /home/<username>
    • @@ -55,8 +62,8 @@

    The File System

    - - + +
    © Copyright YoYo Games Ltd. 2023 All Rights Reserved
    diff --git a/Manual/contents/GameMaker_Language/GML_Reference/File_Handling/File_Directories/program_directory.htm b/Manual/contents/GameMaker_Language/GML_Reference/File_Handling/File_Directories/program_directory.htm index 4dea8756c..b949574d7 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/File_Handling/File_Directories/program_directory.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/File_Handling/File_Directories/program_directory.htm @@ -15,10 +15,11 @@

    program_directory

    -

    This function returns the directory where the game executable is stored. However, this may not always be useful, particularly as some devices run the exe from a *.zip file, so this would return the same no matter where the game is actually running from.

    -

     This function may not work as you expect due to GameMaker being sandboxed! Please see the section on The File System for more information.

    +

    This function returns the directory where the game executable is stored. However, this may not always be useful, particularly as some devices run the executable from a *.zip file, so this would return that location no matter where the extracted executable is actually running from.

    +

     GameMaker doesn't limit writing to this directory so whether this is possible depends on OS permissions. It is however discouraged that you write to program_directory, as it is possible to damage the game installation this way.

    +

    Read: The File System

     

    Syntax:

    program_directory

    diff --git a/Manual/contents/GameMaker_Language/GML_Reference/File_Handling/File_Directories/working_directory.htm b/Manual/contents/GameMaker_Language/GML_Reference/File_Handling/File_Directories/working_directory.htm index 896e39aa7..3a55f93c3 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/File_Handling/File_Directories/working_directory.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/File_Handling/File_Directories/working_directory.htm @@ -15,18 +15,13 @@

    working_directory

    -

    working_directory can actually return two different values depending on what you are using it for: 

    -
      -
    • If you are writing a file to disk, working_directory points to the area of local storage that is reserved for your game on the target device (in Windows this is "%LOCALAPPDATA%/gamedir/" where the "gamedir" is the directory with the name of your game).
      • -
    • However, when reading from disk, working_directory can be either the local storage (game_save_id) or the area where the Included Files are stored.
      • -
    +

    This is the current working directory of the game.

    +

    In most cases, this is the same as the program_directory. It may be a different directory when testing your project through the IDE, to point to where the Included Files are stored.

    +

    When using this directory to write out a file, GameMaker will redirect it to the game_save_id location if the file system sandbox does not allow writing to the program directory.

    +

    It's not recommended to use this variable because of the uncertainty of where it might point. Either use a filename without this path prefixed (see Accessing File Areas), or use program_directory or game_save_id depending on what you need.

    -

    For example, if you have a default *.txt file included with your game and read it into memory using working_directory, then that file will be taken from the area where the Included Files are stored. If you then choose to write that information to a text file using working_directory, this will write the file to the target platform's local storage, where it will be read from the next time unless you instruct GameMaker to delete the file, in which case working_directory will once more point to the area where the Included Files are stored.

    -

    It is worth noting that in general you do not need to use this and simply specify the file name itself (plus any additional path information), which is sufficient. For example, this:

    -

    file_text_open_read(working_directory + "my_file.txt");

    -

    would be better done as this:

    -

    file_text_open_read("my_file.txt");

    +

    Read: The File System

     

    Syntax:

    working_directory

    @@ -36,7 +31,7 @@

    Returns:

     

    Example:

    ini_open(working_directory + "temp_ini.ini");

    -

    This will open an INI file from the working directory of the game (creating it if it does not already exist). This could be the local storage, or the area where the included files are depending on whether the file being looked for exists in either place.

    +

    This will open an INI file from the working directory of the game (creating it if it does not already exist). This could be the save area or the program directory depending on the sandbox level.

     

     

    diff --git a/Manual/contents/GameMaker_Language/GML_Reference/General_Game_Control/game_save_id.htm b/Manual/contents/GameMaker_Language/GML_Reference/General_Game_Control/game_save_id.htm index fac4aa0c7..55a6c6c56 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/General_Game_Control/game_save_id.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/General_Game_Control/game_save_id.htm @@ -4,7 +4,7 @@ game_save_id - + @@ -15,15 +15,20 @@

    game_save_id

    -

    This read-only variable will return the full path ID of the directory that is used by your game to save files to. This directory may or may not be visible to other applications, depending on the platform.

    -

    On the HTML5 target it will return an empty string.

    -

    NOTE This variable exists purely for information and should not be used to get a file path or anything similar, as it will not work correctly across all platforms.

    +

    This read-only variable points to the area of local storage that is reserved for your game on the target device. See Save Area Locations.

    +

    In general, you do not need to use this to write or read files in the save area, as GameMaker automatically resolves paths to the save area when reading/writing files. For example, this:

    +

    buffer_save(buf, game_save_id + "my_file.dat");

    +

    would be better done as just this:

    +

    buffer_save(buf, "my_file.dat");

    +

    This directory may or may not be visible to other applications, depending on the platform.

    +

     On the HTML5 target it will return an empty string.

    +

    Read: The File System

     

    Syntax:

    game_save_id

     

    Returns:

    -

    String

    +

    String

     

    Example:

    save_dir = game_save_id;

    @@ -38,7 +43,7 @@

    Example:

    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    +
    © Copyright YoYo Games Ltd. 2023 All Rights Reserved

    program_directory

    -

    This function returns the directory where the game executable is stored. However, this may not always be useful, particularly as some devices run the executable from a *.zip file, so this would return that location no matter where the extracted executable is actually running from.

    +

    This function returns the directory where the game's runner (executable) is stored. However, this may not always be useful, particularly as some devices run the executable from a *.zip file, so this would return that location no matter where the extracted executable is actually running from.

    +

    This is different from working_directory, which stores where the game's files are stored, however by default they are in the same location.

    -

     GameMaker doesn't limit writing to this directory so whether this is possible depends on OS permissions. It is however discouraged that you write to program_directory, as it is possible to damage the game installation this way.

    +
    -

    Read: The File System

     

    Syntax:

    program_directory

    diff --git a/Manual/contents/GameMaker_Language/GML_Reference/File_Handling/File_Directories/working_directory.htm b/Manual/contents/GameMaker_Language/GML_Reference/File_Handling/File_Directories/working_directory.htm index 3a55f93c3..3ec10e16f 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/File_Handling/File_Directories/working_directory.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/File_Handling/File_Directories/working_directory.htm @@ -15,13 +15,13 @@

    working_directory

    -

    This is the current working directory of the game.

    -

    In most cases, this is the same as the program_directory. It may be a different directory when testing your project through the IDE, to point to where the Included Files are stored.

    -

    When using this directory to write out a file, GameMaker will redirect it to the game_save_id location if the file system sandbox does not allow writing to the program directory.

    -

    It's not recommended to use this variable because of the uncertainty of where it might point. Either use a filename without this path prefixed (see Accessing File Areas), or use program_directory or game_save_id depending on what you need.

    -
    +

    This returns a path that points to where the game's files are stored.

    +

    In most cases, this is the same as the program_directory, which is the path to the game's runner (executable). However if the game's files happen to be in a different directory than the runner (say you use game_change to use a different working directory or use command line to run a runner in a different location), then this will point to where the game files are, not the runner.

    +

    It may also be a different directory when testing your project through the IDE, as then the game files and the runner are in different locations as well.

    +

    When using this directory to write out a file, GameMaker will redirect it to the game_save_id location if the file system sandbox does not allow writing to the working directory (this is the default behaviour, which can be disabled in the Game Options for Desktop targets only).

    -

    Read: The File System

    +
    +

     

    Syntax:

    working_directory

    diff --git a/Manual/contents/assets/snippets/Warning_directory_os_permissions.hts b/Manual/contents/assets/snippets/Warning_directory_os_permissions.hts new file mode 100644 index 000000000..de39fc712 --- /dev/null +++ b/Manual/contents/assets/snippets/Warning_directory_os_permissions.hts @@ -0,0 +1,14 @@ + + + + + + + + Warning_directory_os_permissions + + + +

     GameMaker doesn't limit writing to this directory so whether this is possible depends on OS permissions. It is however discouraged that you write to Warning_directory_os_permissions, as it is possible to damage the game installation this way.

    + + \ No newline at end of file
Layer Element Info Struct
idRealReal The unique ID of the element
typeLayer Element Type ConstantLayer Element Type Constant The type of element
sprite_indexSprite AssetSprite Asset The sprite used by the background
image_indexRealReal The sprite's subimage
xscaleRealReal The scale along the x axis
yscaleRealReal The scale along the y axis
htiledBooleanBoolean Whether to tile the background image horizontally
vtiledBooleanBoolean Whether to tile the background image vertically
stretchBooleanBoolean Whether to stretch the background so it fills the entire room
visibleBooleanBoolean Whether the background should be visible
blendColourColourColour The blend colour to draw the background with
blendAlphaRealReal The alpha value between 0 and 1 to use
image_speedRealReal The image speed of the background
speed_typeSprite Speed ConstantSprite Speed Constant The units in which image_speed is expressed, either spritespeed_framespersecond or spritespeed_framespergameframe
nameStringString The name of the background
inst_idObject InstanceObject Instance The ID of the instance
sprite_indexSprite AssetSprite Asset The sprite index of this sprite element
image_indexRealReal The subimage of the sprite
xRealReal The x coordinate of the sprite's position
yRealReal The y coordinate of the sprite's position
image_xscaleRealReal The scale of the image along the x axis
image_yscaleRealReal The scale of the image along the y axis
image_angleRealReal The image angle
image_alphaRealReal The alpha value between 0 and 1
image_blendColourColour The blend colour
image_speedRealReal The animation speed of the image, expressed in speed_type units
speed_typeSprite Speed ConstantSprite Speed Constant The units in which image_speed is expressed, either spritespeed_framespersecond or spritespeed_framespergameframe
nameStringString The name of the sprite element as given in The Room Editor (default is graphic_*)
xRealReal The x position (or offset) of the tile map in the room
yRealReal The y position (or offset) of the tile map in the room
tileset_indexTile Set AssetTile Set Asset The tile set that this tile map uses
data_maskRealReal The bitmask value for the tile map
tilesArray of RealArray of Real This variable is only present when the tilemap_data parameter is set to true. It is a one-dimensional array that contains all the tile map data, listed row by row.
widthRealReal The width in cells of the tile map
heightRealReal The height in cells of the tile map
nameStringString The tile map's name
psParticle System AssetParticle System Asset The particle system
xRealReal The x coordinate of the particle system's position
yRealReal The y coordinate of the particle system's position
angleRealReal The angle by which the particle system is rotated
xscaleRealReal The scale along the x axis of the particle system
yscaleRealReal The scale along the y axis of the particle system
blendColourColour The blend colour to use to draw the particle system
alphaRealReal The alpha value between 0 and 1 to use
nameStringString The name of the particle system element as defined in The Room Editor (default is particle_*)
visibleBooleanBoolean Whether the tile is visible
sprite_indexSprite AssetSprite Asset The sprite this tile is on
xRealReal The x coordinate of the tile position
yRealReal The y coordinate of the tile position
widthRealReal The width of the tile
heightRealReal The height of the tile
image_xscaleRealReal The scale factor along the x axis of the tile
image_yscaleRealReal The scale factor along the y axis of the tile
image_angleRealReal The angle of the tile
image_blendColourColour The blend colour to use to draw the tile
image_alphaRealReal The alpha to use
xoRealReal The x offset
yoRealReal The y offset
xRealReal The x coordinate of the sequence position
yRealReal The y coordinate of the sequence position
image_xscaleRealReal The scale along the x axis of the entire sequence
image_yscaleRealReal The scale along the y axis of the entire sequence
image_angleRealReal The angle by which the sequence is rotated
image_alphaRealReal The alpha value between 0 and 1 to use
image_blendColourColour The blend colour to use to draw the sequence
image_speedRealReal The animation speed of the sequence, expressed in speed_type units
speedTypeSprite Speed ConstantSprite Speed Constant The units in which image_speed is expressed, either spritespeed_framespersecond or spritespeed_framespergameframe
seq_idSequence AssetSequence Asset The sequence asset
nameStringString The name of the sequence element as defined in The Room Editor (default is graphic_*)
head_positionRealReal The playhead position of the sequence
@param / @parameter / @arg / @argumentInformation on arguments, with an optional type@param {type} name <Parameter description>Information on an argument, with an optional type in {} (or multiple acceptable types separated by |)@param {type|type} name <Parameter description>
@return / @returns Type of data the function returns@return {type} <Return description>@return {type|type} <Return description>
Feather only