From 421181431e17133d062cfbd672811ac5193aebe9 Mon Sep 17 00:00:00 2001 From: gurpreetsinghmatharoo Date: Mon, 9 Dec 2024 10:50:03 +0530 Subject: [PATCH 1/4] docs(general): Mark draw function pages that cannot use nine slice sprites --- .../Sprites_And_Tiles/draw_sprite_general.htm | 270 +++++++++--------- .../Sprites_And_Tiles/draw_sprite_part.htm | 5 +- .../draw_sprite_part_ext.htm | 5 +- .../Sprites_And_Tiles/draw_sprite_pos.htm | 7 +- .../Sprites_And_Tiles/draw_sprite_tiled.htm | 140 ++++----- .../draw_sprite_tiled_ext.htm | 182 ++++++------ ...function_does_not_support_nine_slicing.hts | 14 + 7 files changed, 326 insertions(+), 297 deletions(-) create mode 100644 Manual/contents/assets/snippets/This_function_does_not_support_nine_slicing.hts diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Sprites_And_Tiles/draw_sprite_general.htm b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Sprites_And_Tiles/draw_sprite_general.htm index c76e7f231..74ba8f6db 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Sprites_And_Tiles/draw_sprite_general.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Sprites_And_Tiles/draw_sprite_general.htm @@ -1,140 +1,144 @@ - + - - - draw_sprite_general - - - - - - - - - - -

draw_sprite_general

-

This function combines the function draw_sprite_ext() with the function draw_sprite_part(), adding in some additional blending options so that each corner of the final sprite part can be blended with an individual colour.

-

Note that applying colours to corners may not look exactly as you expect due to how sprites are drawn. See the following example, where the image on the left is drawn with a different bottom-left colour, and the image on the right is drawn with a different bottom-right colour:

-

In each image the gradients do not seamlessly span the whole rectangle and instead seem to be split into halves. This is due to a rectangle actually being made up of two triangles, where the corner colours supplied into this function are applied to each vertex of the two triangles (hence 6 vertices at 3 per triangle). This causes the colours between the vertices to be interpolated for each triangle separately.

-

Colour blending is only recommended for the HTML5 target when WebGL is enabled, although you can still set the blending colour if it is not enabled and it will blend the sprite as normal. However all blending in this way creates a duplicate sprite which is then stored in the cache and used when required. This is far from optimal and if you use multiple colour changes it will slow down your games performance unless you activate WebGL. If you do not wish to use WebGL, then you can set the sprite cache size to try and limit this should it be necessary using the function sprite_set_cache_size().

-

This function may not work as expected when using skeleton animation sprites, and you may find that the function only draws the first frame of the default pose. You should be using the draw_skeleton_* functions instead.

-

When drawing with this function, the sprite x offset and y offset are ignored and the sprite part will be drawn with the top left corner at the specified x / y position in the room.

-

-

Syntax:

-

draw_sprite_general(sprite, subimg, left, top, width, height, x, y, xscale, yscale, rot, c1, c2, c3, c4, alpha);

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ArgumentTypeDescription
spriteSprite AssetThe sprite to draw.
subimgRealThe subimg (frame) of the sprite to draw (image_index or -1 correlate to the current frame of animation in the object).
leftRealThe x position on the sprite of the top left corner of the area to draw.
topRealThe y position on the sprite of the top left corner of the area to draw.
widthRealThe width of the area to draw.
heightRealThe height of the area to draw.
xRealThe x coordinate of where to draw the sprite.
yRealThe y coordinate of where to draw the sprite.
xscaleRealThe horizontal scaling of the sprite, as a multiplier: 1 = normal scaling, 0.5 is half etc...
yscaleRealThe vertical scaling of the sprite, as a multiplier: 1 = normal scaling, 0.5 is half etc...
rotRealThe rotation of the sprite. 0=normal, 90=turned 90 degrees counter-clockwise etc.
c1ColourThe colour with which to blend the top left area of the sprite.
c2ColourThe colour with which to blend the top right area of the sprite.
c3ColourThe colour with which to blend the bottom right area of the sprite.
c4ColourThe colour with which to blend the bottom left area of the sprite.
alphaRealThe alpha of the sprite (from 0 to 1 where 0 is transparent and 1 opaque).
-

-

Returns:

-

N/A

-

-

Example:

-

draw_sprite_general(sprite_index, image_index, 8, 8, sprite_width-16, sprite_height-16, x, y, 2, 0.5, 180, c_white, c_white, c_black, c_black, 1);

-

This will draw the instances assigned sprite (sprite_index) and its current frame of animation (image_index), however it will shave an 8px margin off all four sides of the sprite. It will be stretched to double its usual width but half its usual height. It will be opaque, and upside down. The top area of the sprite will be blended white and hence normal, but the bottom area will be black, meaning the sprite will go from normal to a silhouette downwards in a smooth gradient.

-

-

-

-
-
-
-
Back: Sprites And Tiles
-
Next: draw_sprite_part
-
+ + + draw_sprite_general + + + + + + + + + + + +

draw_sprite_general

+

This function combines the function draw_sprite_ext() with the function draw_sprite_part(), adding in some additional blending options so that each corner of the final sprite part can be blended with an individual colour.

+

Note that applying colours to corners may not look exactly as you expect due to how sprites are drawn. See the following example, where the image on the left is drawn with a different bottom-left colour, and the image on the right is drawn with a different bottom-right colour:

+

In each image the gradients do not seamlessly span the whole rectangle and instead seem to be split into halves. This is due to a rectangle actually being made up of two triangles, where the corner colours supplied into this function are applied to each vertex of the two triangles (hence 6 vertices at 3 per triangle). This causes the colours between the vertices to be interpolated for each triangle separately.

+

Colour blending is only recommended for the HTML5 target when WebGL is enabled, although you can still set the blending colour if it is not enabled and it will blend the sprite as normal. However all blending in this way creates a duplicate sprite which is then stored in the cache and used when required. This is far from optimal and if you use multiple colour changes it will slow down your games performance unless you activate WebGL. If you do not wish to use WebGL, then you can set the sprite cache size to try and limit this should it be necessary using the function sprite_set_cache_size().

+

This function may not work as expected when using skeleton animation sprites, and you may find that the function only draws the first frame of the default pose. You should be using the draw_skeleton_* functions instead.

+

When drawing with this function, the sprite x offset and y offset are ignored and the sprite part will be drawn with the top left corner at the specified x / y position in the room.

+
+

 

+

Syntax:

+

draw_sprite_general(sprite, subimg, left, top, width, height, x, y, xscale, yscale, rot, c1, c2, c3, c4, alpha);

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ArgumentTypeDescription
spriteSprite AssetThe sprite to draw.
subimgRealThe subimg (frame) of the sprite to draw (image_index or -1 correlate to the current frame of animation in the object).
leftRealThe x position on the sprite of the top left corner of the area to draw.
topRealThe y position on the sprite of the top left corner of the area to draw.
widthRealThe width of the area to draw.
heightRealThe height of the area to draw.
xRealThe x coordinate of where to draw the sprite.
yRealThe y coordinate of where to draw the sprite.
xscaleRealThe horizontal scaling of the sprite, as a multiplier: 1 = normal scaling, 0.5 is half etc...
yscaleRealThe vertical scaling of the sprite, as a multiplier: 1 = normal scaling, 0.5 is half etc...
rotRealThe rotation of the sprite. 0=normal, 90=turned 90 degrees counter-clockwise etc.
c1ColourThe colour with which to blend the top left area of the sprite.
c2ColourThe colour with which to blend the top right area of the sprite.
c3ColourThe colour with which to blend the bottom right area of the sprite.
c4ColourThe colour with which to blend the bottom left area of the sprite.
alphaRealThe alpha of the sprite (from 0 to 1 where 0 is transparent and 1 opaque).
+

 

+

Returns:

+

N/A

+

 

+

Example:

+

draw_sprite_general(sprite_index, image_index, 8, 8, sprite_width-16, sprite_height-16, x, y, 2, 0.5, 180, c_white, c_white, c_black, c_black, 1);

+

This will draw the instances assigned sprite (sprite_index) and its current frame of animation (image_index), however it will shave an 8px margin off all four sides of the sprite. It will be stretched to double its usual width but half its usual height. It will be opaque, and upside down. The top area of the sprite will be blended white and hence normal, but the bottom area will be black, meaning the sprite will go from normal to a silhouette downwards in a smooth gradient.

+

 

+

 

+

 

+
+
+
+ +
-
© Copyright YoYo Games Ltd. 2024 All Rights Reserved
- + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Sprites_And_Tiles/draw_sprite_part.htm b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Sprites_And_Tiles/draw_sprite_part.htm index b849e1b97..3843a9abf 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Sprites_And_Tiles/draw_sprite_part.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Sprites_And_Tiles/draw_sprite_part.htm @@ -18,8 +18,9 @@

draw_sprite_part

With this function you can draw part of any sprite at a given position within the room. As with draw_sprite() you can specify a sprite and a sub-image for drawing, then you must give the relative coordinates within the sprite of the area to select for drawing. This means that a left position of 0 and a top position of 0 would be the top left corner of the sprite and all further coordinates should be taken from that position. The image below shows an example of how this works:

draw_sprite_part exampleYou should note that if the texture page permits automatic cropping then this function may not work as expected, since the extra "empty" space around the sprite will have been removed for creating the texture page. To resolve this issue, you will need to set the texture page settings (in the Texture Group Editor) to disable the option Automatic Crop.

-

NOTE: When drawing with this function, the sprite x offset and y offset are ignored and the sprite part will be drawn with the top left corner at the specified x / y position in the room.

-

NOTE: This function is only useful for bitmap sprites and will not work with vector or JSON (Spine) sprites.

+

When drawing with this function, the sprite x offset and y offset are ignored and the sprite part will be drawn with the top left corner at the specified x / y position in the room.

+

This function is only useful for bitmap sprites and will not work with vector or JSON (Spine) sprites.

+

 

Syntax:

draw_sprite_part(sprite, subimg, left, top, width, height, x, y);

diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Sprites_And_Tiles/draw_sprite_part_ext.htm b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Sprites_And_Tiles/draw_sprite_part_ext.htm index aec15de0c..7c4ec4fd9 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Sprites_And_Tiles/draw_sprite_part_ext.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Sprites_And_Tiles/draw_sprite_part_ext.htm @@ -18,8 +18,9 @@

draw_sprite_part_ext

This function will draw a part of the chosen sprite at the given position following the same rules as per draw_sprite_part(), only now you can scale the part, blend a colour with it, or change its alpha when drawing it to the screen (the same as when drawing a sprite with draw_sprite_ext()). You should note that if the texture page permits automatic cropping then this function may not work as expected, since the extra "empty" space around the sprite will have been removed for creating the texture page. To resolve this issue, you will need to set the texture page settings (in the Texture Group Editor) to disable the Automatic Crop.

NOTE When drawing with this function, the sprite x offset and y offset are ignored and the sprite part will be drawn with the top left corner at the specified x / y position in the room.

-

NOTE: This function is only useful for bitmap sprites and will not work with vector or JSON (Spine) sprites.

-

NOTE: Colour blending is only recommended for the HTML5 target when WebGL is enabled, although you can still set the blending colour if it is not enabled and it will blend the sprite as normal. However all blending in this way creates a duplicate sprite which is then stored in the cache and used when required. This is far from optimal and if you use multiple colour changes it will slow down your games performance unless you activate WebGL. if you do not wish to use WebGL, then you can set the font cache size to try and limit this should it be necessary using the function sprite_set_cache_size().

+

This function is only useful for bitmap sprites and will not work with vector or JSON (Spine) sprites.

+

Colour blending is only recommended for the HTML5 target when WebGL is enabled, although you can still set the blending colour if it is not enabled and it will blend the sprite as normal. However all blending in this way creates a duplicate sprite which is then stored in the cache and used when required. This is far from optimal and if you use multiple colour changes it will slow down your games performance unless you activate WebGL. if you do not wish to use WebGL, then you can set the font cache size to try and limit this should it be necessary using the function sprite_set_cache_size().

+

 

Syntax:

draw_sprite_part_ext(sprite, subimg, left, top, width, height, x, y, xscale, yscale, colour, alpha);

diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Sprites_And_Tiles/draw_sprite_pos.htm b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Sprites_And_Tiles/draw_sprite_pos.htm index c55e3b6b8..64381455b 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Sprites_And_Tiles/draw_sprite_pos.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Sprites_And_Tiles/draw_sprite_pos.htm @@ -18,9 +18,10 @@

draw_sprite_pos

With this function you can draw a sprite distorted over the area defined by the four corner coordinates. The first two arguments are the sprite to draw and the sub-image of the sprite (the same as in the function draw_sprite()) but the next ones are those that define the position of each of the four corners of the bounding box of the given sprite. These should be given in clockwise order, so the first coordinate is the top left, then the top right, then bottom right and finally the bottom left. You can also set a value for the alpha of the sprite to draw it with transparency. The image below illustrates how this function works:

draw_sprite_pos example

-

WARNING! The image above is only for illustrative purposes, and if you use this function on a sprite, you will get different results and may experience texture "shearing" due to the way that a sprite is constructed from a quad of primitives.

-

NOTE: This function is only useful for bitmap sprites and will not work with vector or JSON (Spine) sprites.

-

NOTE: When using this function, you should have the Automatically Crop setting disabled for texture pages.

+

The image above is only for illustrative purposes, and if you use this function on a sprite, you will get different results and may experience texture "shearing" due to the way that a sprite is constructed from a quad of primitives.

+

This function is only useful for bitmap sprites and will not work with vector or JSON (Spine) sprites.

+

When using this function, you should have the Automatically Crop setting disabled for texture pages.

+

 

Syntax:

draw_sprite_pos(sprite, subimg, x1, y1, x2, y2, x3, y3, x4, y4, alpha);

diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Sprites_And_Tiles/draw_sprite_tiled.htm b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Sprites_And_Tiles/draw_sprite_tiled.htm index 3dd881328..eaf5cc36c 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Sprites_And_Tiles/draw_sprite_tiled.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Sprites_And_Tiles/draw_sprite_tiled.htm @@ -1,75 +1,79 @@ - + - - - draw_sprite_tiled - - - - - - - - - - -

draw_sprite_tiled

-

This function will take a sprite and then repeatedly tile it across the whole view (or room if no view is defined), starting from the coordinates that you give in the function. Tiling is based on the width and height of the sprite as defined by the sprite variables of the instance running the code. This function is for 2D (orthographic) projections only, and will not work correctly when a 3D camera projection is used.

-

-

Syntax:

-

draw_sprite_tiled(sprite, subimg, x, y);

- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ArgumentTypeDescription
spriteThe sprite to draw.
subimgThe subimg (frame) of the sprite to draw (image_index or -1 correlate to the current frame of animation in the object).
xThe x coordinate of where to draw the sprite.
yThe y coordinate of where to draw the sprite.
-

-

Returns:

-

-

-

Example:

-

draw_sprite_tiled(sprite_index, image_index, x, y);

-

This will draw the instances assigned sprite (sprite_index) and its current frame of animation (image_index) at the instances own x and y position, and tiled horizontally and vertically across the view.

-

-

-

-
-
-
- - -
+ + + draw_sprite_tiled + + + + + + + + + + + +

draw_sprite_tiled

+

This function will take a sprite and then repeatedly tile it across the whole view (or room if no view is defined), starting from the coordinates that you give in the function. Tiling is based on the width and height of the sprite as defined by the sprite variables of the instance running the code. This function is for 2D (orthographic) projections only, and will not work correctly when a 3D camera projection is used.

+
+

 

+

Syntax:

+

draw_sprite_tiled(sprite, subimg, x, y);

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ArgumentTypeDescription
spriteSprite AssetThe sprite to draw.
subimgRealThe subimg (frame) of the sprite to draw (image_index or -1 correlate to the current frame of animation in the object).
xRealThe x coordinate of where to draw the sprite.
yRealThe y coordinate of where to draw the sprite.
+

 

+

Returns:

+

N/A

+

 

+

Example:

+

draw_sprite_tiled(sprite_index, image_index, x, y);

+

This will draw the instances assigned sprite (sprite_index) and its current frame of animation (image_index) at the instances own x and y position, and tiled horizontally and vertically across the view.

+

 

+

 

+

 

+
+
+
+ +
-
© Copyright YoYo Games Ltd. 2021 All Rights Reserved
- + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Sprites_And_Tiles/draw_sprite_tiled_ext.htm b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Sprites_And_Tiles/draw_sprite_tiled_ext.htm index 37713eabb..42a221384 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Sprites_And_Tiles/draw_sprite_tiled_ext.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Sprites_And_Tiles/draw_sprite_tiled_ext.htm @@ -1,96 +1,100 @@ - + - - - draw_sprite_tiled_ext - - - - - - - - - - -

draw_sprite_tiled_ext

-

This function will take a sprite and then repeatedly tile it across the whole view (or room if no view is defined), starting from the coordinates that you give in the function and with each tile scaled, colour blended and with the alpha that you define (these properties are the same as those used in draw_sprite_ext()). This function is for 2D (orthographic) projections only, and will not work correctly when a 3D camera projection is used.

-

NOTE: Colour blending is only recommended for the HTML5 target when WebGL is enabled, although you can still set the blending colour if it is not enabled and it will blend the sprite as normal. However all blending in this way creates a duplicate sprite which is then stored in the cache and used when required. This is far from optimal and if you use multiple colour changes it will slow down your games performance unless you activate WebGL. if you do not wish to use WebGL, then you can set the font cache size to try and limit this should it be necessary using the function sprite_set_cache_size().

-

-

Syntax:

-

draw_sprite_tiled_ext(sprite, subimg, x, y, xscale, yscale, colour, alpha);

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ArgumentTypeDescription
spriteThe sprite to draw.
subimgThe subimg (frame) of the sprite to draw (image_index or -1 correlate to the current frame of animation in the object).
xThe x coordinate of where to draw the sprite.
yThe y coordinate of where to draw the sprite.
xscaleThe horizontal scaling of the sprite. A multiplier ' 1 = normal scaling, 0.5 is half etc.
yscaleThe vertical scaling of the sprite. A multiplier ' 1 = normal scaling, 0.5 is half etc.
colourThe colour with which to blend the sprite. c_white is to display it normally.
alphaThe alpha of the sprite (from 0 to 1 where 0 is transparent and 1 opaque).
-

-

Returns:

-

-

-

Example:

-

draw_sprite_tiled_ext(sprite_index, image_index, x, y, 2, 2, c_red, 0.5);

-

This will draw the instances assigned sprite (sprite_index) and its current frame of animation (image_index) at the instances own x and y position, but scaled to twice the normal size, blended red and with half the normal alpha. The sprite will be tiled horizontally and vertically across the view.

-

-

-

-
-
-
- - -
+ + + draw_sprite_tiled_ext + + + + + + + + + + + +

draw_sprite_tiled_ext

+

This function will take a sprite and then repeatedly tile it across the whole view (or room if no view is defined), starting from the coordinates that you give in the function and with each tile scaled, colour blended and with the alpha that you define (these properties are the same as those used in draw_sprite_ext()). This function is for 2D (orthographic) projections only, and will not work correctly when a 3D camera projection is used.

+

Colour blending is only recommended for the HTML5 target when WebGL is enabled, although you can still set the blending colour if it is not enabled and it will blend the sprite as normal. However all blending in this way creates a duplicate sprite which is then stored in the cache and used when required. This is far from optimal and if you use multiple colour changes it will slow down your games performance unless you activate WebGL. if you do not wish to use WebGL, then you can set the font cache size to try and limit this should it be necessary using the function sprite_set_cache_size().

+
+

 

+

Syntax:

+

draw_sprite_tiled_ext(sprite, subimg, x, y, xscale, yscale, colour, alpha);

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ArgumentTypeDescription
spriteSprite AssetThe sprite to draw.
subimgRealThe subimg (frame) of the sprite to draw (image_index or -1 correlate to the current frame of animation in the object).
xRealThe x coordinate of where to draw the sprite.
yRealThe y coordinate of where to draw the sprite.
xscaleRealThe horizontal scaling of the sprite. A multiplier ' 1 = normal scaling, 0.5 is half etc.
yscaleRealThe vertical scaling of the sprite. A multiplier ' 1 = normal scaling, 0.5 is half etc.
colourColourThe colour with which to blend the sprite. c_white is to display it normally.
alphaRealThe alpha of the sprite (from 0 to 1 where 0 is transparent and 1 opaque).
+

 

+

Returns:

+

N/A

+

 

+

Example:

+

draw_sprite_tiled_ext(sprite_index, image_index, x, y, 2, 2, c_red, 0.5);

+

This will draw the instances assigned sprite (sprite_index) and its current frame of animation (image_index) at the instances own x and y position, but scaled to twice the normal size, blended red and with half the normal alpha. The sprite will be tiled horizontally and vertically across the view.

+

 

+

 

+

 

+
+
+
+ +
-
© Copyright YoYo Games Ltd. 2021 All Rights Reserved
- + +--> + \ No newline at end of file diff --git a/Manual/contents/assets/snippets/This_function_does_not_support_nine_slicing.hts b/Manual/contents/assets/snippets/This_function_does_not_support_nine_slicing.hts new file mode 100644 index 000000000..6c07ddf98 --- /dev/null +++ b/Manual/contents/assets/snippets/This_function_does_not_support_nine_slicing.hts @@ -0,0 +1,14 @@ + + + + + + + + This_function_does_not_support_nine_slicing + + + +

 You cannot draw sprites that have Nine Slice enabled using this function.

+ + \ No newline at end of file From 5d1527cbc66057a32d91ca5be576bc972e8ffcc6 Mon Sep 17 00:00:00 2001 From: gurpreetsinghmatharoo Date: Mon, 9 Dec 2024 11:35:41 +0530 Subject: [PATCH 2/4] docs(feature): "Auto indent clipboard contents" is disabled https://github.com/YoYoGames/GameMaker-Bugs/issues/6708 --- .../IDE_Preferences/Text_Editor_2_Preferences.htm | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/Manual/contents/Setting_Up_And_Version_Information/IDE_Preferences/Text_Editor_2_Preferences.htm b/Manual/contents/Setting_Up_And_Version_Information/IDE_Preferences/Text_Editor_2_Preferences.htm index 370fb86c1..57c8428dd 100644 --- a/Manual/contents/Setting_Up_And_Version_Information/IDE_Preferences/Text_Editor_2_Preferences.htm +++ b/Manual/contents/Setting_Up_And_Version_Information/IDE_Preferences/Text_Editor_2_Preferences.htm @@ -14,8 +14,8 @@ -

Code Editor (Beta) Preferences

-

This page describes all the preferences for The Code Editor, which contains the following sections:

+

Code Editor Preferences

+

This page describes all the preferences for The Code Editor (Beta), which contains the following sections:

Mini TOC (placeholder)

    @@ -25,8 +25,8 @@

    Code Editor (Beta) Preferences

    Main

    The main section contains the following options:

      -
    • Enabled: Enable or disable the Code Editor (Beta), disabling will make it fall back to the Legacy Code Editor. Changing this option will require you to restart the IDE. (Default: Disabled)
      • -
    • Open Asset in Inspector when Editor is opened: When you open an asset in the Code Editor (Beta), and this option is enabled, The Inspector will switch its focus to the newly opened asset so you can modify its properties. (Default: Enabled)
      • +
    • Enabled: Enable or disable the Code Editor, disabling will make it fall back to the Legacy Code Editor. Changing this option will require you to restart the IDE. (Default: Disabled)
      • +
    • Open Asset in Inspector when Editor is opened: When you open an asset in the Code Editor, and this option is enabled, The Inspector will switch its focus to the newly opened asset so you can modify its properties. (Default: Enabled)
    • Lock Documents when Debugger is active: When enabled, all documents in the project will become read-only while the Debugger is active. When disabled, you can edit those documents during Debugging.
    • Default Delete Document Choice: This controls what happens when you choose to delete a document. You can choose to show the dialog message, or automatically delete (Yes) or not delete (No) the document.
    @@ -79,7 +79,7 @@

    Editing

  1. Auto-insert braces: Whether an ending brace should be auto-inserted when you write the beginning brace (e.g. {}, ()).
  2. Allow Overwrite Mode: When enabled, pressing insert will toggle between insertion mode and overwrite mode. When disabled, nothing will happen, and the editor will stay on insertion mode. (Default: Enabled)
  3. Auto Indent Mode: See Auto-Indent.
    4. -
  4. Auto Indent clipboard contents: Whether automatic indentation should be applied to pasted code.
    5. +
  5. Auto Indent clipboard contents: Whether automatic indentation should be applied to pasted code.   This feature is currently disabled and will not have any effect.
  6. Allow selected text to be dragged and dropped: This controls whether you are able to drag and drop selected text in an editor from one place in the document to another.
  7. Trim leading whitespace on backspace: When deleting whitespace at the start of a line using backspace, this controls whether the newline character before the whitespace is deleted as well, joining both lines together.
  8. Insert separating whitespace when joining lines: This controls whether whitespace is inserted when pressing Backspace at the start of a line to join it with the line before.
    9. @@ -87,7 +87,7 @@

    Editing

    Theme

    The Theme section allows you to modify how documents are rendered in the editor.

    -

    The first option is the font used by the Code Editor (Beta). Fonts that are fixed-width (which are recommended for coding over non-fixed-width fonts) are bolded in the drop-down list.

    +

    The first option is the font used by the Code Editor. Fonts that are fixed-width (which are recommended for coding over non-fixed-width fonts) are bolded in the drop-down list.

    You can also choose the size of the font, and whether to enable ligatures for fonts that use them.

    Theme Selector

    This contains a drop-drop menu for theme selection, with the default being "GameMaker Dark - Default". You can edit any properties of the default theme.

    From 9680ec063093607654b3d5197b6a6fc7332248e8 Mon Sep 17 00:00:00 2001 From: gurpreetsinghmatharoo Date: Mon, 9 Dec 2024 13:03:40 +0530 Subject: [PATCH 3/4] docs(general): sprite_delete() after drawing that sprite in the same event makes the sprite fail to draw https://github.com/YoYoGames/GameMaker-Bugs/issues/8598 --- .../Sprites/Sprite_Manipulation/sprite_delete.htm | 1 + 1 file changed, 1 insertion(+) diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Sprites/Sprite_Manipulation/sprite_delete.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Sprites/Sprite_Manipulation/sprite_delete.htm index fc0c32c17..54086a200 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Sprites/Sprite_Manipulation/sprite_delete.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Sprites/Sprite_Manipulation/sprite_delete.htm @@ -17,6 +17,7 @@

    sprite_delete

    This function will delete a sprite from the game, freeing any memory that was reserved for it. This is a very important function for those moments when you need to create and change sprites from external sources (like loading a sprite from a file with sprite_add(), or duplicating a sprite using sprite_duplicate()) and should always be used to remove those assets that are no longer needed by a game, or to clear an indexed asset from a variable before re-assigning another asset to that variable.

     This cannot be used to delete sprites that are included in the game as part of the assets in the Asset Browser.

    +

     Deleting the sprite in the same event after drawing the sprite may cause the sprite to not draw that frame. Work around this by deleting the sprite in a later event or in a different frame where the sprite is not drawn.

    This function will return true if the sprite was successfully deleted, or false in case of an invalid sprite (e.g. it was already deleted).

     

    Syntax:

    From 2967cd192495e83ea1a728b17de51bfcac5d1648 Mon Sep 17 00:00:00 2001 From: gurpreetsinghmatharoo Date: Tue, 24 Dec 2024 12:32:12 +0530 Subject: [PATCH 4/4] docs(general): Fix Gamepad Input page https://github.com/YoYoGames/GameMaker-Bugs/issues/8677 --- .../Game_Input/GamePad_Input/Gamepad_Input.htm | 6 +++--- .../Object_Properties/Async_Events/System.htm | 1 + 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Game_Input/GamePad_Input/Gamepad_Input.htm b/Manual/contents/GameMaker_Language/GML_Reference/Game_Input/GamePad_Input/Gamepad_Input.htm index f471c161f..59eea7b34 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Game_Input/GamePad_Input/Gamepad_Input.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Game_Input/GamePad_Input/Gamepad_Input.htm @@ -147,7 +147,7 @@

    Compatibility

    The following list shows current compatibility across the platforms (note that this will change with future updates):

    • Windows is fully supported with up to a maximum of 12 connected devices permitted at once (numbered from 0 to 11, with 0 - 3 being XInput devices and 4 - 11 being DirectInput). Remapping of controller constants is also permitted.
      • -
    • macOS is supported with up to a maximum of 4 connected devices permitted at once. Be aware that when submitting to the macOS App Store the choice of gamepads allowed by Apple is quite limited, but in testing on your own machine or if you're not submitting to the App Store, then a large number of modern pads are allowed (and you can use GameMaker's gamepad-mapping functions to make even more pads work for your game). The "Build for Mac App Store" option in Mac Game Options needs to be OFF for pad support to work.
      • +
    • macOS is supported with up to a maximum of 4 connected devices permitted at once. Be aware that when submitting to the macOS App Store the choice of gamepads allowed by Apple is quite limited, but in testing on your own machine or if you're not submitting to the App Store, then a large number of modern pads are allowed (and you can use GameMaker's gamepad-mapping functions to make even more pads work for your game). The "Build for Mac App Store" option in Mac Game Options needs to be OFF for pad support to work.
    • Ubuntu does also support Gamepad input, but you may need to install additional libraries from the Ubuntu repository. You can do this easily by opening a command line terminal and typing the following (this will install GUI support for the joystick/gamepad as well as the joystick/gamepad API itself - remapping of controller constants is not permitted):

      sudo apt-get install jstest-gtk
      sudo apt-get install joystick

      @@ -155,8 +155,8 @@

      Compatibility

    • HTML5 games using gamepads are supported by most major browsers, except Safari. Remapping of controller constants is not permitted.
    • Web browsers will only detect gamepads when a button is pressed or an axis is moved, so they may not be available at the immediate start of the game. This applies to the GX.games and HTML target platforms.
    • Gamepad support also extends to iOS with the iCade cabinet. The left axis maps to the stick controller (although the input is digital, not analogue), the four "face" buttons map to the cabinet front buttons, and the four shoulder buttons map to those at the back of the cabinet.
      • -
    • Android (and Amazon Fire) export supports NYKO controllers and generic Bluetooth controllers, but only when they are enabled, meaning that you will have to tick the iCade/Bluetooth option in the General section of the Android Game Options. They require API level 12 for them to work fully and it should be noted that GameMaker will register as connected any Bluetooth devices that your device is paired with, whether or not it's actually connected. Therefore this should be taken into account when assigning and checking "slots". Note that the remapping of controller constants is also permitted.
      • -
    • On PS4, if you want to use the touch pad tracking you need to use the device_mouse_* buttons. Remapping of controller constants is not permitted.
      • +
    • Android export supports NYKO controllers and generic Bluetooth controllers, but only when they are enabled, meaning that you will have to tick the iCade/Bluetooth option in the General section of the Android Game Options. They require API level 12 for them to work fully and it should be noted that GameMaker will register as connected any Bluetooth devices that your device is paired with, whether or not it's actually connected. Therefore this should be taken into account when assigning and checking "slots". Note that the remapping of controller constants is also permitted.
      • +
    • On PlayStation, if you want to use the touch pad tracking you need to use the device_mouse_* buttons. Remapping of controller constants is not permitted.
    • On, Xbox One and Nintendo Switch targets, gamepads are fully supported, but remapping of controller constants is not permitted.

     

    diff --git a/Manual/contents/The_Asset_Editors/Object_Properties/Async_Events/System.htm b/Manual/contents/The_Asset_Editors/Object_Properties/Async_Events/System.htm index d671047b5..c923db88b 100644 --- a/Manual/contents/The_Asset_Editors/Object_Properties/Async_Events/System.htm +++ b/Manual/contents/The_Asset_Editors/Object_Properties/Async_Events/System.htm @@ -28,6 +28,7 @@

    Game Pads

  9. "pad_index" - the index of the pad that has been added or removed

    10. This event now permits you to move all your gamepad checking logic from the Step Event or an Alarm event into the System Event and only run it when it's actually required.

    +

    Read the Gamepad Movement example on Movement And Controls to understand how gamepads can be detected and used.

     This event will NOT be triggered unless you have at least one gamepad_* function or GML Visual action in your game code. The runner will only initialise the gamepad sub-system when the functions are used in the project, so if they aren't present, adding/removing gamepads will not trigger the System Event.

    Virtual Keyboards

    When this event is triggered for a virtual keyboard being opened or closed it will return the following key/value pairs in the async_load map: