From 68cb13a0ebb19aec0b8801626509addafe1cbc04 Mon Sep 17 00:00:00 2001 From: gurpreetsinghmatharoo Date: Mon, 11 Nov 2024 18:16:47 +0530 Subject: [PATCH 1/5] docs(general): Remove mention of 'delete' freeing memory in the next step --- .../GML_Overview/Language_Features/delete.htm | 4 ++-- Manual/contents/GameMaker_Language/GML_Overview/Structs.htm | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Manual/contents/GameMaker_Language/GML_Overview/Language_Features/delete.htm b/Manual/contents/GameMaker_Language/GML_Overview/Language_Features/delete.htm index a1e78c9d2..482d3ccc7 100644 --- a/Manual/contents/GameMaker_Language/GML_Overview/Language_Features/delete.htm +++ b/Manual/contents/GameMaker_Language/GML_Overview/Language_Features/delete.htm @@ -15,9 +15,9 @@

delete

-

The delete operator is used to de-reference a struct, and has the following syntax:

+

The delete operator is used to de-reference a struct and has the following syntax:

delete <variable>;

-

What this means is that you call the delete operator along with the variable that holds a struct and it will remove the specific reference to the struct stored in the given variable (a reference is simply a value that points to the memory area that is storing the struct and its contents). If this reference was the last reference to the struct in your game, then the garbage collector will remove the struct from memory in a following iteration, typically at the very start of the next step.

+

You call the delete operator along with the variable that holds a struct and it will remove the specific reference to the struct stored in the given variable (a reference is simply a value that points to the memory area that is storing the struct and its contents). If this reference was the last reference to the struct in your game, then the garbage collector will remove the struct from memory in its next iteration.

 delete can only be used along with variables, and not expressions.

By default, structs with no further references in code will be garbage collected automatically in the steps following their use, but it is good practice to use this operator to flag them explicitly for the garbage collector to remove from memory at the very start of the following step, freeing the memory quickly and more efficiently.

The following example shows a struct being created - for example in the Create Event of an instance:

diff --git a/Manual/contents/GameMaker_Language/GML_Overview/Structs.htm b/Manual/contents/GameMaker_Language/GML_Overview/Structs.htm index 985fb3f98..e8b76a65e 100644 --- a/Manual/contents/GameMaker_Language/GML_Overview/Structs.htm +++ b/Manual/contents/GameMaker_Language/GML_Overview/Structs.htm @@ -137,7 +137,7 @@

Accessing Struct Variables

and writing: 

mystruct[$ "x"] = 200;

If you need to use strings to access a struct variable, it is faster to get its hash and use that in read/write to the variable.

-

When a struct is no longer required it can be removed from memory using the delete operator, which flags the struct as being able to be garbage collected. This is not strictly required as the garbage collector will do this automatically if the struct is no longer referenced in your code, but using delete prioritises the referenced struct for garbage collection (for example, call delete in the Clean Up event of an instance to explicitly tell the garbage collector that an instance scope struct is to be deleted as soon as possible). Setting a struct variable to undefined has the same effect.

+

When a struct is no longer required it can be removed from memory using the delete operator, which flags the struct as being able to be garbage collected. This is not strictly required as the garbage collector will do this automatically if the struct is no longer referenced in your code, but using delete prioritises the referenced struct for garbage collection (for example, call delete in the Clean Up event of an instance to explicitly tell the garbage collector that an instance scope struct is to be deleted as soon as possible).

Here is an example:

// Create event
mystruct =
From d2ded502a3ace19cb4347762487567dd89b1c304 Mon Sep 17 00:00:00 2001 From: gurpreetsinghmatharoo Date: Wed, 20 Nov 2024 16:17:07 +0530 Subject: [PATCH 2/5] docs(feature): Mark SVG support as beta only https://github.com/YoYoGames/YoYoStudio/issues/10930 --- .../Sprite_Information/sprite_get_info.htm | 96 +++++++++---------- .../Sprites_And_Tiles/Sprites_And_Tiles.htm | 5 +- .../Sprites_And_Tiles/draw_enable_svg_aa.htm | 1 + .../draw_get_svg_aa_level.htm | 1 + .../draw_get_swf_aa_level.htm | 2 +- .../draw_set_svg_aa_level.htm | 1 + .../Introduction_To_GameMaker_Studio_2.htm | 2 +- .../Introduction/The_Asset_Browser.htm | 4 +- .../IDE_Preferences/General/Paths.htm | 2 +- .../Sprite_Editor_Preferences.htm | 2 +- .../Non-Bitmap_Sprites.htm | 21 +++- Manual/contents/The_Asset_Editors/Sprites.htm | 8 +- .../snippets/Vector_Types_Supported.hts | 14 +++ Manual/toc/Default.toc | 6 +- 14 files changed, 99 insertions(+), 66 deletions(-) create mode 100644 Manual/contents/assets/snippets/Vector_Types_Supported.hts diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Sprites/Sprite_Information/sprite_get_info.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Sprites/Sprite_Information/sprite_get_info.htm index 5ae1ca5c8..f7a0480fd 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Sprites/Sprite_Information/sprite_get_info.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Sprites/Sprite_Information/sprite_get_info.htm @@ -73,7 +73,7 @@

sprite_get_info

0 - Bitmap (Regular sprites)
1 - SWF
2 - Spine
- 3 - SVG + 3 - SVG @@ -230,7 +230,7 @@

sprite_get_info

This section contains information on variables included in the struct for all kinds of sprites.

The messages variable is an array that contains information on the broadcast messages that exist in the given sprite. Each broadcast message in this array is a struct containing the following variables:

- +
@@ -239,19 +239,19 @@

sprite_get_info

- + - +
Variable Name
frameRealReal The timing of this broadcast message from the start of the animation (in frames)
messageStringString The broadcast message string

The frame_info variable is an array that contains information on the timings of the sprite's frames. Each frame in this array is a struct containing the following variables:

 For sprites that do not contain any stretched frames, frame_info will be undefined, meaning no array is provided.

- +
@@ -260,17 +260,17 @@

sprite_get_info

- + - + - + @@ -281,7 +281,7 @@

sprite_get_info

This section contains information on variables included in the struct for Bitmap sprites (sprites that are not Spine or vector type sprites).

The frames variable is an array that contains information on the textures of the sprite's frames. Each frame in this array is a struct containing the following variables:

-
Variable Name
frameRealReal The timing for the start of this frame (in frames)
durationRealReal The duration of this frame (in frames)
image_indexRealReal The image index of this frame
+
@@ -295,57 +295,57 @@

sprite_get_info

- + - + - + - + - + - + - + - + - + - + - + @@ -356,7 +356,7 @@

sprite_get_info

This section contains information on variables included in the struct for Spine sprites.

The bones variable is an array that contains information on all bones in the given Spine sprite. Each bone in this array is a struct containing the following variables:

-
xRealReal The X position of this frame on its texture page (in pixels)
yRealReal The Y position of this frame on its texture page (in pixels)
wRealReal The logical width of the frame (in pixels) used internally
hRealReal The logical height of the frame (in pixels) used internally
textureRealReal The texture page ID for this frame
original_widthRealReal The original width of the frame (in pixels)
original_heightRealReal The original height of the frame (in pixels)
crop_widthRealReal The actual width of the frame on the texture page after cropping and scaling (since GameMaker automatically trims the empty space around an image, and also scales it down if it doesn't fit)
crop_heightRealReal The actual height of the frame on the texture page after cropping and scaling
x_offsetRealReal The X offset from the left edge of the original image to the left edge of the cropped section
y_offsetRealReal The Y offset from the top edge of the original image to the top edge of the cropped section
+
@@ -365,69 +365,69 @@

sprite_get_info

- + - + - + - + - + - + - + - + - + - + - + - +
Variable Name
parentStringString The name of the parent bone, or undefined if this bone doesn't have a parent
nameStringString The name of this bone
indexRealReal The index of this bone
lengthRealReal The length of this bone
xRealReal The X position of this bone
yRealReal The Y position of this bone
rotationRealReal The rotation of this bone
scale_xRealReal (Internal to Spine) Scale value on X
scale_yRealReal (Internal to Spine) Scale value on Y
shear_xRealReal (Internal to Spine) Shear value on X
shear_yRealReal (Internal to Spine) Shear value on Y
transform_modeRealReal (Internal to Spine) The transform mode

 Please consult the Spine documentation for more information regarding Spine's internal variables.

The slots variable is an array that contains information on all slots in the given Spine sprite. Each slot in this array is a struct containing the following variables:

- +
@@ -436,72 +436,72 @@

sprite_get_info

- + - + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Sprites_And_Tiles/Sprites_And_Tiles.htm b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Sprites_And_Tiles/Sprites_And_Tiles.htm index a773cd98e..4464ec4ad 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Sprites_And_Tiles/Sprites_And_Tiles.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Sprites_And_Tiles/Sprites_And_Tiles.htm @@ -31,11 +31,14 @@

Sprites And Tiles

  • draw_sprite_tiled_ext

    •  

    -

    If you are using SWF or SVG format sprites, then there are also additional options for controlling the anti-aliasing used when drawing (see Importing Non-Bitmap Sprites for more information on these types of sprites). Note that these functions work on a global level and will set the AA on all vector SWF or SVG sprites drawn after they have been called.

    +

    If you are using  format sprites, then there are also additional options for controlling the anti-aliasing used when drawing (see Importing Non-Bitmap Sprites for more information on these types of sprites). Note that these functions work on a global level and will set the AA on all vector sprites drawn after they have been called.

    +

     

    +
    Variable Name
    nameStringString The name of the slot
    indexRealReal The index of the slot
    boneStringString The name of the slot's bone, or "(none)" if there is no bone for this slot
    attachmentStringString Attachment name
    redRealReal Red component of the slot's colour (0-1)
    greenRealReal Green component of the slot's colour (0-1)
    blueRealReal Blue component of the slot's colour (0-1)
    alphaRealReal Alpha component of the slot's colour (0-1)
    blend_modeRealReal (Internal to Spine) Blend mode for the slot
    dark_red*RealReal Red component of the slot's dark colour (0-1)
    dark_green*RealReal Green component of the slot's dark colour (0-1)
    dark_blue*RealReal Blue component of the slot's dark colour (0-1)
    dark_alpha*StringString Alpha component of the slot's dark colour (0-1)
    attachmentsArray of StringArray of String An array containing the names of all available attachments for this slot.
    - - - - - - - - - - - - -
    ArgumentTypeDescription
    background_element_idBackground Element IDThe unique ID value of the background element to be destroyed
    -

    -

    Returns:

    -

    N/A

    -

    -

    Example:

    -

    var lay_id = layer_get_id("Background_trees"); -
    - var bck_id = layer_background_get_id("Forrest"); -
    - if (layer_background_exists(lay_id, bck_id)) -
    - { -
    - layer_background_destroy(bck_id); -
    - }

    -

    The above code checks the layer "Background_trees" to see if the given background element exists and if it does, then it is destroyed (but not the layer).

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_background_destroy + + + + + + + + + + + +

    layer_background_destroy

    +

    This function will destroy the given background element. You supply the background ID (which you get when you create the background using layer_background_create() or when you use the layer handle along with layer_get_background_id()) and this will remove it. Note that this does not remove the layer, only the background from it, and if the background is one that has been added in the room editor, then the next time you leave the room and then return, the background will be recreated again. However if the room is persistent, the background will be removed unless room persistence is switched off again.

    +

     

    +

    Syntax:

    +

    layer_background_destroy(background_element_id)

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    background_element_idBackground Element IDThe unique ID value of the background element to be destroyed
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("Background_trees");
    + var bck_id = layer_background_get_id("Forrest");
    +
    + if (layer_background_exists(lay_id, bck_id))
    + {
    +     layer_background_destroy(bck_id);
    + } +

    +

    The above code checks the layer "Background_trees" to see if the given background element exists and if it does, then it is destroyed (but not the layer).

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_exists.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_exists.htm index b79914d81..54b1d971d 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_exists.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_exists.htm @@ -1,74 +1,75 @@ - + - - - layer_background_exists - - - - - - - - - - -

    layer_background_exists

    -

    You can use this function to check and see if a background element exists on any given layer. You supply the layer handle (which you get when you create the layer using layer_create()) or the layer name (as a string - this will have a performance impact) and the background element ID (which you get when you create a background element using layer_background_create() or when you use the function layer_background_get_id()) and the function will return either true if the element exists, or false if it does not.

    -

    This function works within the scope of the current target room - by default the room in which the function is called - which can be set using the function layer_set_target_room().

    -

    -

    Syntax:

    -

    layer_background_exists(layer_id, background_element_id)

    - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    layer_idString or Layer IDThe handle of the layer to target (or the layer name as a string)
    background_element_idBackground Element IDThe unique ID value of the background element to check
    -

    -

    Returns:

    -

    Boolean

    -

    -

    Example:

    -

    var lay_id = layer_get_id("Background_trees"); -
    - if (layer_background_exists(lay_id, global.TreesBackground)) -
    - { -
    - layer_background_destroy(lay_id, global.TreesBackground); -
    - }

    -

    The above code checks the layer "Background_trees" to see if the given background element exists and if it does, then it is destroyed (but not the layer).

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_background_exists + + + + + + + + + + + +

    layer_background_exists

    +

    You can use this function to check and see if a background element exists on any given layer. You supply the layer handle (which you get when you create the layer using layer_create()) or the layer name (as a string - this will have a performance impact) and the background element ID (which you get when you create a background element using layer_background_create() or when you use the function layer_background_get_id()) and the function will return either true if the element exists, or false if it does not.

    +

    This function works within the scope of the current target room - by default the room in which the function is called - which can be set using the function layer_set_target_room().

    +

     

    +

    Syntax:

    +

    layer_background_exists(layer_id, background_element_id)

    + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    layer_idString or LayerThe handle of the layer to target (or the layer name as a string)
    background_element_idBackground Element IDThe unique ID value of the background element to check
    +

     

    +

    Returns:

    +

    Boolean

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("Background_trees");
    + if (layer_background_exists(lay_id, global.TreesBackground))
    +
    + {
    +     layer_background_destroy(lay_id, global.TreesBackground);
    + } +

    +

    The above code checks the layer "Background_trees" to see if the given background element exists and if it does, then it is destroyed (but not the layer).

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2023 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_alpha.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_alpha.htm index 86c874b3a..db163e5c6 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_alpha.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_alpha.htm @@ -1,70 +1,70 @@ - + - - - layer_background_get_alpha - - - - - - - - - - -

    layer_background_get_alpha

    -

    This function can be used to get the alpha value of the background element. You give the background element ID (which you get when you create a background element using layer_background_create() or when you use the function layer_background_get_id()), and the function will return a value between 0 (fully transparent) and 1 (fully opaque).

    -

    -

    Syntax:

    -

    layer_background_get_alpha(background_element_id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    background_element_idThe unique ID value of the background element to get the information from
    -

    -

    Returns:

    -

    (from 0 to 1)

    -

    -

    Example:

    -

    var lay_id = layer_get_id("Background_sky"); -
    - var back_id = layer_background_get_id(lay_id); -
    - if (layer_background_get_alpha(back_id) < 0.1) -
    - { -
    - layer_background_destroy(back_id); -
    - }

    -

    The above code will get the layer handle for the layer named "Background_sky" and then use that to get the ID of the background element on that layer. This ID is then used to check the element alpha and if it is less than 0.1, then the layer element is destroyed.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_background_get_alpha + + + + + + + + + + + +

    layer_background_get_alpha

    +

    This function can be used to get the alpha value of the background element. You give the background element ID (which you get when you create a background element using layer_background_create() or when you use the function layer_background_get_id()), and the function will return a value between 0 (fully transparent) and 1 (fully opaque).

    +

     

    +

    Syntax:

    +

    layer_background_get_alpha(background_element_id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    background_element_idBackground Element IDThe unique ID value of the background element to get the information from
    +

     

    +

    Returns:

    +

    Real (from 0 to 1)

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("Background_sky");
    + var back_id = layer_background_get_id(lay_id);
    +
    + if (layer_background_get_alpha(back_id) < 0.1)
    + {
    +     layer_background_destroy(back_id);
    + } +

    +

    The above code will get the layer handle for the layer named "Background_sky" and then use that to get the ID of the background element on that layer. This ID is then used to check the element alpha and if it is less than 0.1, then the layer element is destroyed.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2021 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_blend.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_blend.htm index 089998106..21435d00d 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_blend.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_blend.htm @@ -1,70 +1,70 @@ - + - - - layer_background_get_blend - - - - - - - - - - -

    layer_background_get_blend

    -

    This function can be used to get the blend colour of the background element. You give the background element ID (which you get when you create a background element using layer_background_create() or when you use the function layer_background_get_id()), and the function will return real value that represents the colour assigned.

    -

    -

    Syntax:

    -

    layer_background_get_blend(background_element_id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    background_element_idThe unique ID value of the background element to get the information from
    -

    -

    Returns:

    -

    Colour Constant

    -

    -

    Example:

    -

    var lay_id = layer_get_id("Background_sky"); -
    - var back_id = layer_background_get_id(lay_id); -
    - if (layer_background_get_blend(back_id) == c_white) -
    - { -
    - layer_background_blend(back_id, make_colour_rgb(random(255), random(255), 255)); -
    - }

    -

    The above code will get the layer handle for the layer named "Background_sky" and then use that to get the ID of the background element on that layer. This ID is then used to check the element blend colour and if it is equivalent to the constant c_white, then the layer blend is set to a random colour.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_background_get_blend + + + + + + + + + + + +

    layer_background_get_blend

    +

    This function can be used to get the blend colour of the background element. You give the background element ID (which you get when you create a background element using layer_background_create() or when you use the function layer_background_get_id()), and the function will return real value that represents the colour assigned.

    +

     

    +

    Syntax:

    +

    layer_background_get_blend(background_element_id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    background_element_idBackground Element IDThe unique ID value of the background element to get the information from
    +

     

    +

    Returns:

    +

    Colour

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("Background_sky");
    + var back_id = layer_background_get_id(lay_id);
    +
    + if (layer_background_get_blend(back_id) == c_white)
    + {
    +     layer_background_blend(back_id, make_colour_rgb(random(255), random(255), 255));
    + } +

    +

    The above code will get the layer handle for the layer named "Background_sky" and then use that to get the ID of the background element on that layer. This ID is then used to check the element blend colour and if it is equivalent to the constant c_white, then the layer blend is set to a random colour.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_htiled.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_htiled.htm index 5108ffc45..4b9cd6237 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_htiled.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_htiled.htm @@ -1,70 +1,70 @@ - + - - - layer_background_get_htiled - - - - - - - - - - -

    layer_background_get_htiled

    -

    This function can be used to find out if the background element is tiled horizontally or not. You give the background element ID (which you get when you create a background element using layer_background_create() or when you use the function layer_background_get_id()), and the function will return either true if the element is currently tiled, or false if it is not.

    -

    -

    Syntax:

    -

    layer_background_get_htiled(background_element_id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    background_element_idThe unique ID value of the background element to get the information from
    -

    -

    Returns:

    -

    -

    -

    Example:

    -

    var lay_id = layer_get_id("Background_sky"); -
    - var back_id = layer_background_get_id(lay_id); -
    - if (!layer_background_get_htiled(back_id)) -
    - { -
    - layer_background_htiled(back_id, true); -
    - }

    -

    The above code will get the layer handle for the layer named "Background_sky" and then use that to get the ID of the background element on that layer. This ID is then used to check if the element is tiling across the horizontal axis, and if it is not then it is set to do so.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_background_get_htiled + + + + + + + + + + + +

    layer_background_get_htiled

    +

    This function can be used to find out if the background element is tiled horizontally or not. You give the background element ID (which you get when you create a background element using layer_background_create() or when you use the function layer_background_get_id()), and the function will return either true if the element is currently tiled, or false if it is not.

    +

     

    +

    Syntax:

    +

    layer_background_get_htiled(background_element_id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    background_element_idBackground Element IDThe unique ID value of the background element to get the information from
    +

     

    +

    Returns:

    +

    Boolean

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("Background_sky");
    + var back_id = layer_background_get_id(lay_id);
    +
    + if (!layer_background_get_htiled(back_id))
    + {
    +     layer_background_htiled(back_id, true);
    + } +

    +

    The above code will get the layer handle for the layer named "Background_sky" and then use that to get the ID of the background element on that layer. This ID is then used to check if the element is tiling across the horizontal axis, and if it is not then it is set to do so.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2021 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_index.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_index.htm index 48524f8cf..b7b09ccac 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_index.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_index.htm @@ -1,70 +1,68 @@ - + - - - layer_background_get_index - - - - - - - - - - -

    layer_background_get_index

    -

    This function can be used to get the current image index value of the background element. You give the background element ID (which you get when you create a background element using layer_background_create() or when you use the function layer_background_get_id()), and the function will return real value that represents the image index being shown for the sprite. The function will return -1 if either the background element doesn't exist or the element doesn't have a valid sprite assigned to it.

    -

    -

    Syntax:

    -

    layer_background_get_index(background_element_id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    background_element_idThe unique ID value of the background element to get the information from
    -

    -

    Returns:

    -

    Real (the current sprite image index or -1)

    -

    -

    Example:

    -

    var lay_id = layer_get_id("Background_sky"); -
    - var back_id = layer_background_get_id(lay_id); -
    - if (layer_background_get_index(back_id) < 4) -
    - { -
    - layer_background_index(back_id, 4); -
    - }

    -

    The above code will get the layer handle for the layer named "Background_sky" and then use that to get the ID of the background element on that layer. This ID is then used to check if the image index for the element is less than 4, and if so it is set to 4.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_background_get_index + + + + + + + + + + + +

    layer_background_get_index

    +

    This function can be used to get the current image index value of the background element. You give the background element ID (which you get when you create a background element using layer_background_create() or when you use the function layer_background_get_id()), and the function will return real value that represents the image index being shown for the sprite. The function will return -1 if either the background element doesn't exist or the element doesn't have a valid sprite assigned to it.

    +

     

    +

    Syntax:

    +

    layer_background_get_index(background_element_id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    background_element_idBackground Element IDThe unique ID value of the background element to get the information from
    +

     

    +

    Returns:

    +

    Real (the current sprite image index or -1)

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("Background_sky");
    + var back_id = layer_background_get_id(lay_id);
    + if (layer_background_get_index(back_id) < 4)
    + {
    +     layer_background_index(back_id, 4);
    + }

    +

    The above code will get the layer handle for the layer named "Background_sky" and then use that to get the ID of the background element on that layer. This ID is then used to check if the image index for the element is less than 4, and if so it is set to 4.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_speed.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_speed.htm index 2384e40ef..658c6aa5d 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_speed.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_speed.htm @@ -1,70 +1,68 @@ - + - - - layer_background_get_speed - - - - - - - - - - -

    layer_background_get_speed

    -

    This function can be used to get the current speed multiplier value of the background element. You give the background element ID (which you get when you create a background element using layer_background_create() or when you use the function layer_background_get_id()), and the function will return real value that represents the speed multiplier being used to animate the sprite. Default value is 1.

    -

    -

    Syntax:

    -

    layer_background_get_speed(background_element_id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    background_element_idThe unique ID value of the background element to get the information from
    -

    -

    Returns:

    -

    -

    -

    Example:

    -

    var lay_id = layer_get_id("Background_sky"); -
    - var back_id = layer_background_get_id(lay_id); -
    - if (layer_background_get_speed(back_id) > 0) -
    - { -
    - layer_background_speed(back_id, 0); -
    - }

    -

    The above code will get the layer handle for the layer named "Background_sky" and then use that to get the ID of the background element on that layer. This ID is then used to check the animation speed for the element and if it is greater than 0, it is set to 0.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_background_get_speed + + + + + + + + + + + +

    layer_background_get_speed

    +

    This function can be used to get the current speed multiplier value of the background element. You give the background element ID (which you get when you create a background element using layer_background_create() or when you use the function layer_background_get_id()), and the function will return real value that represents the speed multiplier being used to animate the sprite. Default value is 1.

    +

     

    +

    Syntax:

    +

    layer_background_get_speed(background_element_id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    background_element_idBackground Element IDThe unique ID value of the background element to get the information from
    +

     

    +

    Returns:

    +

    Real

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("Background_sky");
    + var back_id = layer_background_get_id(lay_id);
    + if (layer_background_get_speed(back_id) > 0)
    + {
    +     layer_background_speed(back_id, 0);
    + }

    +

    The above code will get the layer handle for the layer named "Background_sky" and then use that to get the ID of the background element on that layer. This ID is then used to check the animation speed for the element and if it is greater than 0, it is set to 0.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2021 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_sprite.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_sprite.htm index 2498e1701..ea10f05f7 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_sprite.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_sprite.htm @@ -1,70 +1,68 @@ - + - - - layer_background_get_sprite - - - - - - - - - - -

    layer_background_get_sprite

    -

    This function can be used to get the current sprite of the background element. You give the background element ID (which you get when you create a background element using layer_background_create() or when you use the function layer_background_get_id()), and the function will return a handle that represents the sprite index being shown. If the element has no sprite assigned, the function will return -1.

    -

    -

    Syntax:

    -

    layer_background_get_sprite(background_element_id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    background_element_idBackground Element IDThe unique ID value of the background element to get the information from
    -

    -

    Returns:

    -

    Sprite Asset or -1

    -

    -

    Example:

    -

    var lay_id = layer_get_id("Background_sky"); -
    - var back_id = layer_background_get_id(lay_id); -
    - if (layer_background_get_sprite(back_id) != spr_Clouds) -
    - { -
    - layer_background_sprite(back_id, spr_Clouds); -
    - }

    -

    The above code will get the layer handle for the layer named "Background_sky" and then use that to get the ID of the background element on that layer. This ID is then used to check the sprite assigned to the element, setting it to the sprite "spr_Clouds" if it is not already.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_background_get_sprite + + + + + + + + + + + +

    layer_background_get_sprite

    +

    This function can be used to get the current sprite of the background element. You give the background element ID (which you get when you create a background element using layer_background_create() or when you use the function layer_background_get_id()), and the function will return a handle that represents the sprite index being shown. If the element has no sprite assigned, the function will return -1.

    +

     

    +

    Syntax:

    +

    layer_background_get_sprite(background_element_id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    background_element_idBackground Element IDThe unique ID value of the background element to get the information from
    +

     

    +

    Returns:

    +

    Sprite Asset or -1

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("Background_sky");
    + var back_id = layer_background_get_id(lay_id);
    + if (layer_background_get_sprite(back_id) != spr_Clouds)
    + {
    +     layer_background_sprite(back_id, spr_Clouds);
    + }

    +

    The above code will get the layer handle for the layer named "Background_sky" and then use that to get the ID of the background element on that layer. This ID is then used to check the sprite assigned to the element, setting it to the sprite "spr_Clouds" if it is not already.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2024 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_stretch.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_stretch.htm index e7eb25b1b..89890c9ea 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_stretch.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_stretch.htm @@ -1,70 +1,68 @@ - + - - - layer_background_get_stretch - - - - - - - - - - -

    layer_background_get_stretch

    -

    This function can be used to get the stretched state of the background element sprite. You give the background element ID (which you get when you create a background element using layer_background_create() or when you use the function layer_background_get_id()), and the function will return either true if the element sprite is currently stretched to fit the room, or false if it is not.

    -

    -

    Syntax:

    -

    layer_background_get_stretch(background_element_id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    background_element_idThe unique ID value of the background element to get the information from
    -

    -

    Returns:

    -

    -

    -

    Example:

    -

    var lay_id = layer_get_id("Background_sky"); -
    - var back_id = layer_background_get_id(lay_id); -
    - if (layer_background_get_stretch(back_id)) -
    - { -
    - layer_background_stretch(back_id, false); -
    - }

    -

    The above code will get the layer handle for the layer named "Background_sky" and then use that to get the ID of the background element on that layer. This ID is then used to check and see if the element sprite will be stretched to fit the room or not and if it is stretched, then this property is set to false.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_background_get_stretch + + + + + + + + + + + +

    layer_background_get_stretch

    +

    This function can be used to get the stretched state of the background element sprite. You give the background element ID (which you get when you create a background element using layer_background_create() or when you use the function layer_background_get_id()), and the function will return either true if the element sprite is currently stretched to fit the room, or false if it is not.

    +

     

    +

    Syntax:

    +

    layer_background_get_stretch(background_element_id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    background_element_idBackground Element IDThe unique ID value of the background element to get the information from
    +

     

    +

    Returns:

    +

    Boolean

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("Background_sky");
    + var back_id = layer_background_get_id(lay_id);
    + if (layer_background_get_stretch(back_id))
    + {
    +     layer_background_stretch(back_id, false);
    + }

    +

    The above code will get the layer handle for the layer named "Background_sky" and then use that to get the ID of the background element on that layer. This ID is then used to check and see if the element sprite will be stretched to fit the room or not and if it is stretched, then this property is set to false.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2021 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_visible.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_visible.htm index c394121dc..122bb8906 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_visible.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_visible.htm @@ -1,70 +1,68 @@ - + - - - layer_background_get_visible - - - - - - - - - - -

    layer_background_get_visible

    -

    This function can be used to get the visible state of the background element. You give the background element ID (which you get when you create a background element using layer_background_create() or when you use the function layer_background_get_id()), and the function will return either true if the element is currently visible, or false if it is not. Note that this return value is not affected by whether the layer the element is on is visible or not.

    -

    -

    Syntax:

    -

    layer_background_get_visible(background_element_id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    background_element_idThe unique ID value of the background element to get the information from
    -

    -

    Returns:

    -

    -

    -

    Example:

    -

    var lay_id = layer_get_id("Background_sky"); -
    - var back_id = layer_background_get_id(lay_id); -
    - if (layer_background_get_visible(back_id)) -
    - { -
    - layer_background_visible(back_id, false); -
    - }

    -

    The above code will get the layer handle for the layer named "Background_sky" and then use that to get the ID of the background element on that layer. This ID is then used to check the element visibility and if it is visible, then this property is set to false.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_background_get_visible + + + + + + + + + + + +

    layer_background_get_visible

    +

    This function can be used to get the visible state of the background element. You give the background element ID (which you get when you create a background element using layer_background_create() or when you use the function layer_background_get_id()), and the function will return either true if the element is currently visible, or false if it is not. Note that this return value is not affected by whether the layer the element is on is visible or not.

    +

     

    +

    Syntax:

    +

    layer_background_get_visible(background_element_id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    background_element_idBackground Element IDThe unique ID value of the background element to get the information from
    +

     

    +

    Returns:

    +

    Boolean

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("Background_sky");
    + var back_id = layer_background_get_id(lay_id);
    + if (layer_background_get_visible(back_id))
    + {
    +     layer_background_visible(back_id, false);
    + }

    +

    The above code will get the layer handle for the layer named "Background_sky" and then use that to get the ID of the background element on that layer. This ID is then used to check the element visibility and if it is visible, then this property is set to false.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2021 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_vtiled.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_vtiled.htm index b0704df35..c58746ce3 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_vtiled.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_vtiled.htm @@ -1,70 +1,68 @@ - + - - - layer_background_get_vtiled - - - - - - - - - - -

    layer_background_get_vtiled

    -

    This function can be used to find out if the background element is tiled vertically or not. You give the background element ID (which you get when you create a background element using layer_background_create() or when you use the function layer_background_get_id()), and the function will return either true if the element is currently tiled, or false if it is not.

    -

    -

    Syntax:

    -

    layer_background_get_vtiled(background_element_id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    background_element_idThe unique ID value of the background element to get the information from
    -

    -

    Returns:

    -

    -

    -

    Example:

    -

    var lay_id = layer_get_id("Background_sky"); -
    - var back_id = layer_background_get_id(lay_id); -
    - if (!layer_background_get_vtiled(back_id)) -
    - { -
    - layer_background_vtiled(back_id, true); -
    - }

    -

    The above code will get the layer handle for the layer named "Background_sky" and then use that to get the ID of the background element on that layer. This ID is then used to check if the element is tiling across the vertical axis, and if it is not then it is set to do so.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_background_get_vtiled + + + + + + + + + + + +

    layer_background_get_vtiled

    +

    This function can be used to find out if the background element is tiled vertically or not. You give the background element ID (which you get when you create a background element using layer_background_create() or when you use the function layer_background_get_id()), and the function will return either true if the element is currently tiled, or false if it is not.

    +

     

    +

    Syntax:

    +

    layer_background_get_vtiled(background_element_id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    background_element_idBackground Element IDThe unique ID value of the background element to get the information from
    +

     

    +

    Returns:

    +

    Boolean

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("Background_sky");
    + var back_id = layer_background_get_id(lay_id);
    + if (!layer_background_get_vtiled(back_id))
    + {
    +     layer_background_vtiled(back_id, true);
    + }

    +

    The above code will get the layer handle for the layer named "Background_sky" and then use that to get the ID of the background element on that layer. This ID is then used to check if the element is tiling across the vertical axis, and if it is not then it is set to do so.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2021 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_xscale.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_xscale.htm index 1e15638a0..4e463a2b9 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_xscale.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_xscale.htm @@ -1,70 +1,68 @@ - + - - - layer_background_get_xscale - - - - - - - - - - -

    layer_background_get_xscale

    -

    This function can be used to get the current scale multiplier value of the background element. You give the background element ID (which you get when you create a background element using layer_background_create() or when you use the function layer_background_get_id()), and the function will return real value that represents the scale multiplier being used to draw the sprite. Default value is 1.

    -

    -

    Syntax:

    -

    layer_background_get_xscale(background_element_id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    background_element_idThe unique ID value of the background element to get the information from
    -

    -

    Returns:

    -

    -

    -

    Example:

    -

    var lay_id = layer_get_id("Background_sky"); -
    - var back_id = layer_background_get_id(lay_id); -
    - if (layer_background_get_xscale(back_id) != -1) -
    - { -
    - layer_background_xscale(back_id, -1); -
    - }

    -

    The above code will get the layer handle for the layer named "Background_sky" and then use that to get the ID of the background element on that layer. This ID is then used to check the x scale for the element and if it is not -1, it is set to -1.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_background_get_xscale + + + + + + + + + + + +

    layer_background_get_xscale

    +

    This function can be used to get the current scale multiplier value of the background element. You give the background element ID (which you get when you create a background element using layer_background_create() or when you use the function layer_background_get_id()), and the function will return real value that represents the scale multiplier being used to draw the sprite. Default value is 1.

    +

     

    +

    Syntax:

    +

    layer_background_get_xscale(background_element_id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    background_element_idBackground Element IDThe unique ID value of the background element to get the information from
    +

     

    +

    Returns:

    +

    Real

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("Background_sky");
    + var back_id = layer_background_get_id(lay_id);
    + if (layer_background_get_xscale(back_id) != -1)
    + {
    +     layer_background_xscale(back_id, -1);
    + }

    +

    The above code will get the layer handle for the layer named "Background_sky" and then use that to get the ID of the background element on that layer. This ID is then used to check the x scale for the element and if it is not -1, it is set to -1.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2021 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_yscale.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_yscale.htm index b6902479f..9dedc29f1 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_yscale.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_get_yscale.htm @@ -1,70 +1,68 @@ - + - - - layer_background_get_yscale - - - - - - - - - - -

    layer_background_get_yscale

    -

    This function can be used to get the current scale multiplier value of the background element. You give the background element ID (which you get when you create a background element using layer_background_create() or when you use the function layer_background_get_id()), and the function will return real value that represents the scale multiplier being used to draw the sprite. Default value is 1.

    -

    -

    Syntax:

    -

    layer_background_get_yscale(background_element_id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    background_element_idThe unique ID value of the background element to get the information from
    -

    -

    Returns:

    -

    -

    -

    Example:

    -

    var lay_id = layer_get_id("Background_sky"); -
    - var back_id = layer_background_get_id(lay_id); -
    - if (layer_background_get_yscale(back_id) != -1) -
    - { -
    - layer_background_yscale(back_id, -1); -
    - }

    -

    The above code will get the layer handle for the layer named "Background_sky" and then use that to get the ID of the background element on that layer. This ID is then used to check the y scale for the element and if it is not -1, it is set to -1.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_background_get_yscale + + + + + + + + + + + +

    layer_background_get_yscale

    +

    This function can be used to get the current scale multiplier value of the background element. You give the background element ID (which you get when you create a background element using layer_background_create() or when you use the function layer_background_get_id()), and the function will return real value that represents the scale multiplier being used to draw the sprite. Default value is 1.

    +

     

    +

    Syntax:

    +

    layer_background_get_yscale(background_element_id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    background_element_idBackground Element IDThe unique ID value of the background element to get the information from
    +

     

    +

    Returns:

    +

    Real

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("Background_sky");
    + var back_id = layer_background_get_id(lay_id);
    + if (layer_background_get_yscale(back_id) != -1)
    + {
    +     layer_background_yscale(back_id, -1);
    + }

    +

    The above code will get the layer handle for the layer named "Background_sky" and then use that to get the ID of the background element on that layer. This ID is then used to check the y scale for the element and if it is not -1, it is set to -1.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2021 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_sprite.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_sprite.htm index 207ee8775..d2b914fda 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_sprite.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Background_Layers/layer_background_sprite.htm @@ -1,78 +1,76 @@ - + - - - layer_background_sprite - - - - - - - - - - -

    layer_background_sprite

    -

    Using this function you can set the sprite index of the background element. You supply the background element ID (which you get when you create a background element using layer_background_create() or when you use the function layer_background_get_id()), and then give a sprite index to be used. The background element image will be replaced with the new sprite. If you give a value of -1, the element will have no sprite assigned (but will still exist and can have a sprite assigned again later).

    -

    This function also has the alias layer_background_change().

    -

    -

    Syntax:

    -

    layer_background_sprite(background_element_id, sprite_index)

    - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    background_element_idBackground Element IDThe unique ID value of the background element to change
    sprite_indexSprite AssetThe sprite index of the sprite to use for the background element
    -

    -

    Returns:

    -

    N/A

    -

    -

    Example:

    -

    var lay_id = layer_get_id("Background_sky"); -
    - var back_id = layer_background_get_id(lay_id); -
    - if (layer_background_get_sprite(back_id) != spr_Clouds) -
    - { -
    - layer_background_sprite(back_id, spr_Clouds); -
    - }

    -

    The above code will get the layer handle for the layer named "Background_sky" and then use that to get the ID of the background element on that layer. This ID is then used to check the sprite assigned to the element, setting it to the sprite "spr_Clouds" if it is not already.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_background_sprite + + + + + + + + + + + +

    layer_background_sprite

    +

    Using this function you can set the sprite index of the background element. You supply the background element ID (which you get when you create a background element using layer_background_create() or when you use the function layer_background_get_id()), and then give a sprite index to be used. The background element image will be replaced with the new sprite. If you give a value of -1, the element will have no sprite assigned (but will still exist and can have a sprite assigned again later).

    +

    This function also has the alias layer_background_change().

    +

     

    +

    Syntax:

    +

    layer_background_sprite(background_element_id, sprite_index)

    + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    background_element_idBackground Element IDThe unique ID value of the background element to change
    sprite_indexSprite AssetThe sprite index of the sprite to use for the background element
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("Background_sky");
    + var back_id = layer_background_get_id(lay_id);
    + if (layer_background_get_sprite(back_id) != spr_Clouds)
    + {
    +     layer_background_sprite(back_id, spr_Clouds);
    + }

    +

    The above code will get the layer handle for the layer named "Background_sky" and then use that to get the ID of the background element on that layer. This ID is then used to check the sprite assigned to the element, setting it to the sprite "spr_Clouds" if it is not already.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Filter_Effect_Layers/layer_clear_fx.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Filter_Effect_Layers/layer_clear_fx.htm index 08f9c4b95..7bbc3a45d 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Filter_Effect_Layers/layer_clear_fx.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Filter_Effect_Layers/layer_clear_fx.htm @@ -1,94 +1,80 @@ - + - - - layer_clear_fx - - - - - - - - - -

    layer_clear_fx

    -

    This function is used to clear the FX struct that is applied to the specified layer. You specify either the ID or the name of the layer you want to modify and this function will remove the FX struct that is applied to that layer, disabling its effects completely.

    -

    If you use this function to temporarily disable an effect and need to restore it layer, you should first save the FX struct for the layer by calling layer_get_fx() and then call this function to clear it on the layer. You can later apply it back to the layer by calling layer_set_fx(), which will re-enable the effect.

    -

    -

    Syntax:

    -

    layer_clear_fx(layer_name_or_id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    layer_name_or_idString or Layer IDThe name or ID of the layer to clear the FX for
    -

    -

    Returns:

    -

    N/A

    -

    -

    Example:

    -

    // Disable effect -
    - if (keyboard_check_pressed(ord("E"))) -
    - { -
    - if (layer_get_fx("EffectLayer") != -1) -
    - { -
    - temp_fx = layer_get_fx("EffectLayer"); -
    - layer_clear_fx("EffectLayer"); -
    - } -
    - } -
    - // Re-enable effect -
    - else if (keyboard_check_pressed(ord("F"))) -
    - { -
    - if (temp_fx != -1) -
    - { -
    - layer_set_fx("EffectLayer", temp_fx); -
    - temp_fx = -1; -
    - } -
    - }

    -

    The above code checks if the "E" key is pressed, and then checks if the layer "EffectLayer" has a filter/effect applied to it; in that case it stores its FX struct in a temporary instance variable and clears the layer of any filters/effects. When the "F" key is pressed, it checks if the temporary variable holds something other than -1, and in that case it applies that FX back to the layer and resets the temporary variable to -1. All of this essentially allows you to enable and disable an effect whenever you need without losing its parameters.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_clear_fx + + + + + + + + + + +

    layer_clear_fx

    +

    This function is used to clear the FX struct that is applied to the specified layer. You specify either the ID or the name of the layer you want to modify and this function will remove the FX struct that is applied to that layer, disabling its effects completely.

    +

    If you use this function to temporarily disable an effect and need to restore it layer, you should first save the FX struct for the layer by calling layer_get_fx() and then call this function to clear it on the layer. You can later apply it back to the layer by calling layer_set_fx(), which will re-enable the effect.

    +

     

    +

    Syntax:

    +

    layer_clear_fx(layer_name_or_id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    layer_name_or_idString or LayerThe name or ID of the layer to clear the FX for
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    // Disable effect
    + if (keyboard_check_pressed(ord("E")))
    + {
    +     if (layer_get_fx("EffectLayer") != -1)
    +     {
    +         temp_fx = layer_get_fx("EffectLayer");
    +         layer_clear_fx("EffectLayer");
    +     }
    + }
    + // Re-enable effect
    + else if (keyboard_check_pressed(ord("F")))
    + {
    +     if (temp_fx != -1)
    +     {
    +         layer_set_fx("EffectLayer", temp_fx);
    +         temp_fx = -1;
    +     }
    + }

    +

    The above code checks if the "E" key is pressed, and then checks if the layer "EffectLayer" has a filter/effect applied to it; in that case it stores its FX struct in a temporary instance variable and clears the layer of any filters/effects. When the "F" key is pressed, it checks if the temporary variable holds something other than -1, and in that case it applies that FX back to the layer and resets the temporary variable to -1. All of this essentially allows you to enable and disable an effect whenever you need without losing its parameters.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Filter_Effect_Layers/layer_enable_fx.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Filter_Effect_Layers/layer_enable_fx.htm index 381e7db29..0e6d03e33 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Filter_Effect_Layers/layer_enable_fx.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Filter_Effect_Layers/layer_enable_fx.htm @@ -1,80 +1,76 @@ - + - - - layer_enable_fx - - - - - - - - - -

    layer_enable_fx

    -

    This function enables/disables the filter/effect assigned to a Room Layer. You specify either the ID or the name of the layer you want to modify, and then a boolean value telling whether the FX should be enabled (true) or disabled (false).

    -

    Passing in false will not remove the FX from the layer, but simply make it invisible. Use layer_clear_fx() to remove an FX from a layer.

    -

    Similarly, passing in true will not do anything if there is no FX applied to the layer. Use layer_set_fx() to apply an FX to a layer.

    -

    -

    Syntax:

    -

    layer_enable_fx(layer_name_or_id, enable);

    - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    layer_name_or_idString or Layer IDThe name or ID of the layer to modify
    enableBooleanWhether to enable or disable the FX
    -

    -

    Returns:

    -

    N/A

    -

    -

    Example:

    -

    if (hp <= 3) -
    - { -
    - layer_enable_fx("DesaturateLayer", true); -
    - } -
    - else -
    - { -
    - layer_enable_fx("DesaturateLayer", false); -
    - }

    -

    The above code enables a Desaturate FX layer if the instance's HP value is less than or equal to 3, otherwise it disables it. This indicates to the player that their HP is low, by desaturating the screen.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_enable_fx + + + + + + + + + + +

    layer_enable_fx

    +

    This function enables/disables the filter/effect assigned to a Room Layer. You specify either the ID or the name of the layer you want to modify, and then a boolean value telling whether the FX should be enabled (true) or disabled (false).

    +

    Passing in false will not remove the FX from the layer, but simply make it invisible. Use layer_clear_fx() to remove an FX from a layer.

    +

    Similarly, passing in true will not do anything if there is no FX applied to the layer. Use layer_set_fx() to apply an FX to a layer.

    +

     

    +

    Syntax:

    +

    layer_enable_fx(layer_name_or_id, enable);

    + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    layer_name_or_idString or LayerThe name or ID of the layer to modify
    enableBooleanWhether to enable or disable the FX
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    if (hp <= 3)
    + {
    +     layer_enable_fx("DesaturateLayer", true);
    + }
    + else
    + {
    +     layer_enable_fx("DesaturateLayer", false);
    + }

    +

    The above code enables a Desaturate FX layer if the instance's HP value is less than or equal to 3, otherwise it disables it. This indicates to the player that their HP is low, by desaturating the screen.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Filter_Effect_Layers/layer_fx_is_enabled.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Filter_Effect_Layers/layer_fx_is_enabled.htm index 8f93da1ba..a6cded1b3 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Filter_Effect_Layers/layer_fx_is_enabled.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Filter_Effect_Layers/layer_fx_is_enabled.htm @@ -1,73 +1,71 @@ - + - - - layer_fx_is_enabled - - - - - - - - - -

    layer_fx_is_enabled

    -

    This function returns whether the filter/effect for a layer is enabled.

    -

    You specify either the ID or the name of the layer you want to target, and the function returns a boolean value indicating whether the layer's FX is enabled (true) or disabled (false).

    -

    -

    Syntax:

    -

    layer_fx_is_enabled(layer_name_or_id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    layer_name_or_idString or Layer IDThe name or ID of the layer to check
    -

    -

    Returns:

    -

    Boolean

    -

    -

    Example:

    -

    x = xstart; -
    - y = ystart; -
    - hp = hp_max; -
    -
    - if (layer_fx_is_enabled("DesaturateLayer")) -
    - { -
    - layer_enable_fx("DesaturateLayer", false); -
    - }

    -

    The above code "respawns" the instance, by moving it to its original position and refilling its HP. It then checks if the Desaturate FX layer is enabled, and if it is, disables it.

    -

    -

    -

    -
    -
    -
    - -
    Next: fx_create
    -
    + + + layer_fx_is_enabled + + + + + + + + + + +

    layer_fx_is_enabled

    +

    This function returns whether the filter/effect for a layer is enabled.

    +

    You specify either the ID or the name of the layer you want to target, and the function returns a boolean value indicating whether the layer's FX is enabled (true) or disabled (false).

    +

     

    +

    Syntax:

    +

    layer_fx_is_enabled(layer_name_or_id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    layer_name_or_idString or LayerThe name or ID of the layer to check
    +

     

    +

    Returns:

    +

    Boolean

    +

     

    +

    Example:

    +

    x = xstart;
    + y = ystart;
    + hp = hp_max;
    +
    + if (layer_fx_is_enabled("DesaturateLayer"))
    + {
    +     layer_enable_fx("DesaturateLayer", false);
    + } +

    +

    The above code "respawns" the instance, by moving it to its original position and refilling its HP. It then checks if the Desaturate FX layer is enabled, and if it is, disables it.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    Next: fx_create
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Filter_Effect_Layers/layer_get_fx.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Filter_Effect_Layers/layer_get_fx.htm index 6acd8c464..d9b4e1579 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Filter_Effect_Layers/layer_get_fx.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Filter_Effect_Layers/layer_get_fx.htm @@ -1,83 +1,75 @@ - + - - - layer_get_fx - - - - - - - - - -

    layer_get_fx

    -

    This function is used to retrieve the FX struct for a layer. You specify either the ID or the name of the layer you want to target and the function will return a struct containing information on its applied effect. This struct will be similar to the struct you get from fx_create(), and the functions fx_get_parameter/s and fx_set_parameter/s can be used on it to read and modify its parameters.

    -

    If the specified layer has no filters/effects applied to it, the function will return -1.

    -

    -

    Syntax:

    -

    layer_get_fx(layer_name_or_id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    layer_name_or_idString or Layer IDThe name or ID of the layer to read
    -

    -

    Returns:

    -

    FX Struct (or -1 if not found)

    -

    -

    Example:

    -

    var layers = layer_get_all(); -
    - for(var i = 0; i < array_length(layers); i ++) -
    - { -
    - var layer_fx = layer_get_fx(layers[i]); -
    -
    - if (layer_fx != -1) -
    - { -
    - if (fx_get_name(layer_fx) == "_filter_tintfilter") -
    - { -
    - fx_set_parameter(layer_fx, "g_TintCol", [0, 0, 1, 1]); -
    - } -
    - } -
    - }

    -

    The above code runs a for loop through all the layers present in the room, and checks each layer for an FX struct. If a layer has an FX struct, it checks the name of that filter/effect by calling fx_get_name() on it; if it's equal to "_filter_tintfilter" meaning that it's a "Colour Tint" filter, it changes its tint colour to blue.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_get_fx + + + + + + + + + + +

    layer_get_fx

    +

    This function is used to retrieve the FX struct for a layer. You specify either the ID or the name of the layer you want to target and the function will return a struct containing information on its applied effect. This struct will be similar to the struct you get from fx_create(), and the functions fx_get_parameter/s and fx_set_parameter/s can be used on it to read and modify its parameters.

    +

    If the specified layer has no filters/effects applied to it, the function will return -1.

    +

     

    +

    Syntax:

    +

    layer_get_fx(layer_name_or_id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    layer_name_or_idString or LayerThe name or ID of the layer to read
    +

     

    +

    Returns:

    +

    FX Struct (or -1 if not found)

    +

     

    +

    Example:

    +

    var layers = layer_get_all();
    + for(var i = 0; i < array_length(layers); i ++)
    + {
    +     var layer_fx = layer_get_fx(layers[i]);
    +    
    +     if (layer_fx != -1)
    +     {
    +         if (fx_get_name(layer_fx) == "_filter_tintfilter")
    +         {
    +             fx_set_parameter(layer_fx, "g_TintCol", [0, 0, 1, 1]);
    +         }
    +     }
    + }

    +

    The above code runs a for loop through all the layers present in the room, and checks each layer for an FX struct. If a layer has an FX struct, it checks the name of that filter/effect by calling fx_get_name() on it; if it's equal to "_filter_tintfilter" meaning that it's a "Colour Tint" filter, it changes its tint colour to blue.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2023 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_element_move.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_element_move.htm index 8cc1eb971..994f7f1ef 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_element_move.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_element_move.htm @@ -1,80 +1,75 @@ - + - - - layer_element_move - - - - - - - - - -

    layer_element_move

    -

    You can use this function to move an element from one layer to another. You give the element ID, as returned by the function used to create the element or the room editor or the function layer_get_all_elements(), and then you give the layer handle (which you get when you create the layer using layer_create()) or the layer name (as a string - this will have a performance impact).

    -

    -

    Syntax:

    -

    layer_element_move(element_id, layer_id);

    - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    element_idLayer Element IDThe unique ID value of the element to move
    layer_idString or LayerThe handle of the layer to move the element to (or the layer name as a string)
    -

    -

    Returns:

    -

    N/A

    -

    -

    Example:

    -

    var a = layer_get_all_elements(layer); -
    - asset_layer = layer_create(-100); -
    - for (var i = 0; i < array_length(a); i++) -
    - { -
    - if layer_get_element_type(a[i]) == layerelementtype_sprite -
    - { -
    - layer_element_move(a[i], asset_layer) -
    - } -
    - }

    -

    The above code gets the elements on the layer that the instance running the code is assigned to, then checks them to see if they are sprite assets, and if they are then they are moved to the layer with the ID stored in the variable "asset_layer".

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_element_move + + + + + + + + + + +

    layer_element_move

    +

    You can use this function to move an element from one layer to another. You give the element ID, as returned by the function used to create the element or the room editor or the function layer_get_all_elements(), and then you give the layer handle (which you get when you create the layer using layer_create()) or the layer name (as a string - this will have a performance impact).

    +

     

    +

    Syntax:

    +

    layer_element_move(element_id, layer_id);

    + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    element_idLayer Element IDThe unique ID value of the element to move
    layer_idString or LayerThe handle of the layer to move the element to (or the layer name as a string)
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    var a = layer_get_all_elements(layer);
    + asset_layer = layer_create(-100);
    + for (var i = 0; i < array_length(a); i++)
    + {
    +     if layer_get_element_type(a[i]) == layerelementtype_sprite
    +     {
    +         layer_element_move(a[i], asset_layer)
    +     }
    + }

    +

    The above code gets the elements on the layer that the instance running the code is assigned to, then checks them to see if they are sprite assets, and if they are then they are moved to the layer with the ID stored in the variable "asset_layer".

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2024 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_hspeed.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_hspeed.htm index 18796e5c9..4482f4739 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_hspeed.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_hspeed.htm @@ -40,10 +40,10 @@

    Returns:

     

    Example:

    var lay_id = layer_get_id("Sprites");
    - if layer_get_hspeed(lay_id) != 0 || layer_get_vspeed(lay_id) != 0
    + if (layer_get_hspeed(lay_id) != 0 || layer_get_vspeed(lay_id) != 0)
    {
    - layer_hspeed(lay_id, 0);
    - layer_vspeed(lay_id, 0);
    +     layer_hspeed(lay_id, 0);
    +     layer_vspeed(lay_id, 0);
    }

    The above code checks the given layer horizontal and vertical speeds and if they are not both set to 0 then it is sets them to 0.

     

    diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_id_at_depth.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_id_at_depth.htm index cadbb81a9..017f961e8 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_id_at_depth.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_id_at_depth.htm @@ -40,7 +40,7 @@

    Returns:

     

    Example:

    var a = layer_get_id_at_depth(0);
    - if a[0] != -1
    + if (a[0] != -1)
    {
        for (var i = 0; i < array_length(a); i++;)
        {
    diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_name.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_name.htm index 8a456dbbd..74b67fc11 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_name.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_name.htm @@ -1,76 +1,71 @@ - + - - - layer_get_name - - - - - - - - - - -

    layer_get_name

    -

    This function gets the name of the given layer.

    -

    You supply the unique layer handle value and if the layer is one of the named layers created in The Room Editor, then the function will return a string with the layer name. If the layer is not one of the Room Editor ones (i.e.: it was created using layer_create) then an empty string "" will be returned.

    -

    -

    Syntax:

    -

    layer_get_name(layer_id)

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    layer_idLayerThe handle of the layer to get the name of
    -

    -

    Returns:

    -

    String

    -

    -

    Example:

    -

    var _arr_layers = layer_get_all(); -
    - var _arr_layers_named = []; -
    - for (var i = 0; i < array_length(_arr_layers); i++) -
    - { -
    - if (layer_get_name(_arr_layers[i]) != "") -
    - { -
    - array_push(_arr_layers_named, _arr_layers[i]); -
    - } -
    - }

    -

    The above code gets the IDs of all the layers in the room and then loops through them to see if they're named layers. If they are they are then their ID is added to a list.

    -

    -

    -
    -
    -
    -
    Back: Layers
    - -
    + + + layer_get_name + + + + + + + + + + + +

    layer_get_name

    +

    This function gets the name of the given layer.

    +

    You supply the unique layer handle value and if the layer is one of the named layers created in The Room Editor, then the function will return a string with the layer name. If the layer is not one of the Room Editor ones (i.e.: it was created using layer_create) then an empty string "" will be returned.

    +

     

    +

    Syntax:

    +

    layer_get_name(layer_id)

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    layer_idLayerThe handle of the layer to get the name of
    +

     

    +

    Returns:

    +

    String

    +

     

    +

    Example:

    +

    var _arr_layers = layer_get_all();
    + var _arr_layers_named = [];
    + for (var i = 0; i < array_length(_arr_layers); i++)
    + {
    +     if (layer_get_name(_arr_layers[i]) != "")
    +     {
    +         array_push(_arr_layers_named, _arr_layers[i]);
    +     }
    + }

    +

    The above code gets the IDs of all the layers in the room and then loops through them to see if they're named layers. If they are they are then their ID is added to a list.

    +

     

    +

     

    +
    +
    +
    +
    Back: Layers
    +
    -
    © Copyright YoYo Games Ltd. 2024 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_script_begin.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_script_begin.htm index c4165af65..e8b9c5571 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_script_begin.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_script_begin.htm @@ -1,66 +1,66 @@ - + - - - layer_get_script_begin - - - - - - - - - - -

    layer_get_script_begin

    -

    You supply the layer handle (which you get when you create the layer using layer_create()) or the layer name (as a string - this will have a performance impact) and this function will return the script function index of the function assigned to run at the beginning of rendering for that layer, or it will return -1 if no function is assigned. You can assign script functions to a layer with layer_script_begin() and layer_script_end().

    -

    -

    Syntax:

    -

    layer_get_script_begin(layer_id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    layer_idString or Layer IDThe handle of the layer to target (or the layer name as a string)
    -

    -

    Returns:

    -

    Script Function or -1 (if no function is assigned)

    -

    -

    Example:

    -

    if (layer_get_script_begin(layer) == -1) -
    - { -
    - layer_script_begin(layer, scr_SetShaderValues); -
    - }

    -

    The above code will check to see if the layer that the instance running the code has a script function assigned to it and if it doesn't one is assigned.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_get_script_begin + + + + + + + + + + + +

    layer_get_script_begin

    +

    You supply the layer handle (which you get when you create the layer using layer_create()) or the layer name (as a string - this will have a performance impact) and this function will return the script function index of the function assigned to run at the beginning of rendering for that layer, or it will return -1 if no function is assigned. You can assign script functions to a layer with layer_script_begin() and layer_script_end().

    +

     

    +

    Syntax:

    +

    layer_get_script_begin(layer_id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    layer_idString or LayerThe handle of the layer to target (or the layer name as a string)
    +

     

    +

    Returns:

    +

    Script Function or -1 (if no function is assigned)

    +

     

    +

    Example:

    +

    if (layer_get_script_begin(layer) == -1)
    + {
    +     layer_script_begin(layer, scr_SetShaderValues);
    + }

    +

    The above code will check to see if the layer that the instance running the code has a script function assigned to it and if it doesn't one is assigned.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_script_end.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_script_end.htm index e9edb5926..171b99d7f 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_script_end.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_script_end.htm @@ -1,66 +1,66 @@ - + - - - layer_get_script_end - - - - - - - - - - -

    layer_get_script_end

    -

    This function returns the script function index of the function assigned to run at the end of rendering the given layer, or it will return -1 if no function is assigned. You supply the layer handle (which you get when you create the layer using layer_create()) or the layer name (as a string - this will have a performance impact). You can assign script functions to a layer with layer_script_begin() and layer_script_end().

    -

    -

    Syntax:

    -

    layer_get_script_end(layer_id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    layer_idString or Layer IDThe handle of the layer to target (or the layer name as a string)
    -

    -

    Returns:

    -

    Script Function or -1 (if no function is assigned)

    -

    -

    Example:

    -

    if (layer_get_script_end(layer) == -1) -
    - { -
    - layer_script_end(layer, scr_ResetShaderValues); -
    - }

    -

    The above code will check to see if the layer that the instance running the code has a script function assigned to it and if it doesn't one is assigned.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_get_script_end + + + + + + + + + + + +

    layer_get_script_end

    +

    This function returns the script function index of the function assigned to run at the end of rendering the given layer, or it will return -1 if no function is assigned. You supply the layer handle (which you get when you create the layer using layer_create()) or the layer name (as a string - this will have a performance impact). You can assign script functions to a layer with layer_script_begin() and layer_script_end().

    +

     

    +

    Syntax:

    +

    layer_get_script_end(layer_id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    layer_idString or LayerThe handle of the layer to target (or the layer name as a string)
    +

     

    +

    Returns:

    +

    Script Function or -1 (if no function is assigned)

    +

     

    +

    Example:

    +

    if (layer_get_script_end(layer) == -1)
    + {
    +     layer_script_end(layer, scr_ResetShaderValues);
    + }

    +

    The above code will check to see if the layer that the instance running the code has a script function assigned to it and if it doesn't one is assigned.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_shader.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_shader.htm index 08d0d58d2..95c102b93 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_shader.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_shader.htm @@ -1,66 +1,66 @@ - + - - - layer_get_shader - - - - - - - - - - -

    layer_get_shader

    -

    This function can be used to check if the given layer has a shader assigned to it. You supply the layer handle (which you get when you create the layer using layer_create()) or the layer name (as a string - this will have a performance impact), and the function will return either the shader index of the shader assigned, or -1 if no shader is assigned.

    -

    -

    Syntax:

    -

    layer_get_shader(layer_id)

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    layer_idString or Layer IDThe handle of the layer to target (or the layer name as a string)
    -

    -

    Returns:

    -

    Shader Asset or -1 (if no shader is assigned)

    -

    -

    Example:

    -

    if (layer_get_shader(layer) == -1) -
    - { -
    - layer_shader(layer, shd_Sepia); -
    - }

    -

    The above code will check to see if the layer that the instance running the code has a shader assigned to it and if it doesn't one is assigned.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_get_shader + + + + + + + + + + + +

    layer_get_shader

    +

    This function can be used to check if the given layer has a shader assigned to it. You supply the layer handle (which you get when you create the layer using layer_create()) or the layer name (as a string - this will have a performance impact), and the function will return either the shader index of the shader assigned, or -1 if no shader is assigned.

    +

     

    +

    Syntax:

    +

    layer_get_shader(layer_id)

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    layer_idString or LayerThe handle of the layer to target (or the layer name as a string)
    +

     

    +

    Returns:

    +

    Shader Asset or -1 (if no shader is assigned)

    +

     

    +

    Example:

    +

    if (layer_get_shader(layer) == -1)
    + {
    +     layer_shader(layer, shd_Sepia);
    + }

    +

    The above code will check to see if the layer that the instance running the code has a shader assigned to it and if it doesn't one is assigned.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_visible.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_visible.htm index d11698be5..a2a703f3d 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_visible.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_visible.htm @@ -42,11 +42,11 @@

    Example:

    var lay_id = layer_get_id("Instances");
    if (layer_get_visible(lay_id))
    {
    - layer_set_visible(lay_id, false);
    +     layer_set_visible(lay_id, false);
    }
    else
    {
    - layer_set_visible(lay_id, true);
    +     layer_set_visible(lay_id, true);
    }

    The above code gets the handle for the layer named "Instances" in the room editor, then uses the ID to check if the layer is visible or not, toggling the layer visibility depending on the returned value.

     

    diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_vspeed.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_vspeed.htm index 78016ef20..f9494b4c1 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_vspeed.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_vspeed.htm @@ -1,70 +1,68 @@ - + - - - layer_get_vspeed - - - - - - - - - - -

    layer_get_vspeed

    -

    You can use this function to retrieve the vertical speed (in pixels per game frame) of the layer within the currently scoped room. You supply the layer handle (which you get when you create the layer using layer_create()) or the layer name (as a string - this will have a performance impact) and the function returns a real number for the vertical speed, where a positive value is down and a negative value up. Default is 0 (unless set in the room editor).

    -

    -

    Syntax:

    -

    layer_get_vspeed(layer_id)

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    layer_idString or Layer IDThe handle of the layer to get the vertical speed from
    -

    -

    Returns:

    -

    N/A

    -

    -

    Example:

    -

    var lay_id = layer_get_id("Sprites"); -
    - if layer_get_hspeed(lay_id) != 0 || layer_get_vspeed(lay_id) != 0 -
    - { -
    - layer_hspeed(lay_id, 0); -
    - layer_vspeed(lay_id, 0); -
    - }

    -

    The above code checks the given layer horizontal and vertical speeds and if they are not both set to 0 then it is sets them to 0.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_get_vspeed + + + + + + + + + + + +

    layer_get_vspeed

    +

    You can use this function to retrieve the vertical speed (in pixels per game frame) of the layer within the currently scoped room. You supply the layer handle (which you get when you create the layer using layer_create()) or the layer name (as a string - this will have a performance impact) and the function returns a real number for the vertical speed, where a positive value is down and a negative value up. Default is 0 (unless set in the room editor).

    +

     

    +

    Syntax:

    +

    layer_get_vspeed(layer_id)

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    layer_idString or LayerThe handle of the layer to get the vertical speed from
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("Sprites");
    + if (layer_get_hspeed(lay_id) != 0 || layer_get_vspeed(lay_id) != 0)
    + {
    +     layer_hspeed(lay_id, 0);
    +     layer_vspeed(lay_id, 0);
    + }

    +

    The above code checks the given layer horizontal and vertical speeds and if they are not both set to 0 then it is sets them to 0.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_x.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_x.htm index bf7ec18a6..8fed41850 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_x.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_x.htm @@ -1,70 +1,68 @@ - + - - - layer_get_x - - - - - - - - - - -

    layer_get_x

    -

    You can use this function to retrieve the x position of the layer within the currently scoped room. You supply the layer handle (which you get when you create the layer using layer_create()) or the layer name (as a string - this will have a performance impact) and the function returns a real number for the x position of the layer, relative to the (0,0) position of the room. Default is 0.

    -

    -

    Syntax:

    -

    layer_get_x(layer_id)

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    layer_idString or Layer IDThe handle of the layer to get the x position of
    -

    -

    Returns:

    -

    Real

    -

    -

    Example:

    -

    var lay_id = layer_get_id("Sprites"); -
    - if layer_get_x(lay_id) != 0 || layer_get_y(lay_id) != 0 -
    - { -
    - layer_x(lay_id, 0); -
    - layer_y(lay_id, 0); -
    - }

    -

    The above code checks the given layer position and if it is not set to (0, 0) then it is set to that position.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_get_x + + + + + + + + + + + +

    layer_get_x

    +

    You can use this function to retrieve the x position of the layer within the currently scoped room. You supply the layer handle (which you get when you create the layer using layer_create()) or the layer name (as a string - this will have a performance impact) and the function returns a real number for the x position of the layer, relative to the (0,0) position of the room. Default is 0.

    +

     

    +

    Syntax:

    +

    layer_get_x(layer_id)

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    layer_idString or LayerThe handle of the layer to get the x position of
    +

     

    +

    Returns:

    +

    Real

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("Sprites");
    + if (layer_get_x(lay_id) != 0 || layer_get_y(lay_id) != 0)
    + {
    +     layer_x(lay_id, 0);
    +     layer_y(lay_id, 0);
    + }

    +

    The above code checks the given layer position and if it is not set to (0, 0) then it is set to that position.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_y.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_y.htm index e4e8431d1..977bfe822 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_y.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_get_y.htm @@ -1,70 +1,68 @@ - + - - - layer_get_y - - - - - - - - - - -

    layer_get_y

    -

    You can use this function to retrieve the y position of the layer within the currently scoped room. You supply the layer handle (which you get when you create the layer using layer_create()) or the layer name (as a string - this will have a performance impact) and the function returns a real number for the x position of the layer, relative to the (0,0) position of the room. Default is 0.

    -

    -

    Syntax:

    -

    layer_get_y(layer_id)

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    layer_idString or Layer IDThe handle of the layer to get the y position of
    -

    -

    Returns:

    -

    Real

    -

    -

    Example:

    -

    var lay_id = layer_get_id("Sprites"); -
    - if layer_get_x(lay_id) != 0 || layer_get_y(lay_id) != 0 -
    - { -
    - layer_x(lay_id, 0); -
    - layer_y(lay_id, 0); -
    - }

    -

    The above code checks the given layer position and if it is not set to (0, 0) then it is set to that position.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_get_y + + + + + + + + + + + +

    layer_get_y

    +

    You can use this function to retrieve the y position of the layer within the currently scoped room. You supply the layer handle (which you get when you create the layer using layer_create()) or the layer name (as a string - this will have a performance impact) and the function returns a real number for the x position of the layer, relative to the (0,0) position of the room. Default is 0.

    +

     

    +

    Syntax:

    +

    layer_get_y(layer_id)

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    layer_idString or LayerThe handle of the layer to get the y position of
    +

     

    +

    Returns:

    +

    Real

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("Sprites");
    + if (layer_get_x(lay_id) != 0 || layer_get_y(lay_id) != 0)
    + {
    +     layer_x(lay_id, 0);
    +     layer_y(lay_id, 0);
    + }

    +

    The above code checks the given layer position and if it is not set to (0, 0) then it is set to that position.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_has_instance.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_has_instance.htm index f40a4feb2..0fcd76ba8 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_has_instance.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_has_instance.htm @@ -1,71 +1,71 @@ - + - - - layer_has_instance - - - - - - - - - - -

    layer_has_instance

    -

    This function can be used to check if a given instance is currently assigned to the given layer. You supply the layer handle (which you get when you create the layer using layer_create()) or the layer name (as a string - this will have a performance impact) and the instance ID of the instance to check for. You can also give an object_index (ie: the name of the object in the Asset Browser) and the function will check if any instances of that object are on the given layer. The function will return true if the instance is on the layer and false if it is not.

    -

    -

    Syntax:

    -

    layer_has_instance(layer_id, instance_id)

    - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    layer_idString or Layer IDThe handle of the layer to target (or the layer name as a string)
    instance_idInstance IDThe unique instance ID or the object index of the instance to check for
    -

    -

    Returns:

    -

    Boolean

    -

    -

    Example:

    -

    if (!layer_has_instance(global.Bullet_Layer, obj_Bullet_Parent)) -
    - { -
    - layer_destroy(global.Bullet_Layer); -
    - }

    -

    The above code will check to see if the given layer contains any instances of the object "obj_Bullet_Parent" and if not it will destroy the layer.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_has_instance + + + + + + + + + + + +

    layer_has_instance

    +

    This function can be used to check if a given instance is currently assigned to the given layer. You supply the layer handle (which you get when you create the layer using layer_create()) or the layer name (as a string - this will have a performance impact) and the instance ID of the instance to check for. You can also give an object_index (ie: the name of the object in the Asset Browser) and the function will check if any instances of that object are on the given layer. The function will return true if the instance is on the layer and false if it is not.

    +

     

    +

    Syntax:

    +

    layer_has_instance(layer_id, instance_id)

    + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    layer_idString or LayerThe handle of the layer to target (or the layer name as a string)
    instance_idObject InstanceThe unique instance ID or the object index of the instance to check for
    +

     

    +

    Returns:

    +

    Boolean

    +

     

    +

    Example:

    +

    if (!layer_has_instance(global.Bullet_Layer, obj_Bullet_Parent))
    + {
    +     layer_destroy(global.Bullet_Layer);
    + }

    +

    The above code will check to see if the given layer contains any instances of the object "obj_Bullet_Parent" and if not it will destroy the layer.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_hspeed.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_hspeed.htm index 845550e09..dbe5ee893 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_hspeed.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_hspeed.htm @@ -1,75 +1,73 @@ - + - - - layer_hspeed - - - - - - - - - -

    layer_hspeed

    -

    You can use this function to set the horizontal speed (in pixels per game frame) of the layer within the currently scoped room.

    -

    You supply the layer handle (which you get when you create the layer using layer_create) or the layer name (as a string - this will have a performance impact) and the speed value to set, where a positive value is to the right and a negative value to the left.

    -
    -

    -

    Syntax:

    -

    layer_hspeed(layer_id, hspd)

    - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    layer_idString or Layer IDThe handle of the layer to set the horizontal speed of
    hspdRealThe horizontal speed (in pixels per game frame) to set
    -

    -

    Returns:

    -

    N/A

    -

    -

    Example:

    -

    var lay_id = layer_get_id("Sprites"); -
    - if layer_get_hspeed(lay_id) != 0 || layer_get_vspeed(lay_id) != 0 -
    - { -
    - layer_hspeed(lay_id, 0); -
    - layer_vspeed(lay_id, 0); -
    - }

    -

    The above code checks the given layer horizontal and vertical speeds and if they are not both set to 0 then it is sets them to 0.

    -

    -

    -
    -
    -
    - - -
    + + + layer_hspeed + + + + + + + + + + +

    layer_hspeed

    +

    You can use this function to set the horizontal speed (in pixels per game frame) of the layer within the currently scoped room.

    +

    You supply the layer handle (which you get when you create the layer using layer_create) or the layer name (as a string - this will have a performance impact) and the speed value to set, where a positive value is to the right and a negative value to the left.

    +
    +

     

    +

    Syntax:

    +

    layer_hspeed(layer_id, hspd)

    + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    layer_idString or LayerThe handle of the layer to set the horizontal speed of
    hspdRealThe horizontal speed (in pixels per game frame) to set
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("Sprites");
    + if layer_get_hspeed(lay_id) != 0 || layer_get_vspeed(lay_id) != 0
    + {
    +     layer_hspeed(lay_id, 0);
    +     layer_vspeed(lay_id, 0);
    + }

    +

    The above code checks the given layer horizontal and vertical speeds and if they are not both set to 0 then it is sets them to 0.

    +

     

    +

     

    +
    +
    +
    +
    Back: Layers
    +
    -
    © Copyright YoYo Games Ltd. 2023 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_reset_target_room.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_reset_target_room.htm index ab6c776e4..b81cc7e56 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_reset_target_room.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_reset_target_room.htm @@ -1,57 +1,54 @@ - + - - - layer_reset_target_room - - - - - - - - - -

    layer_reset_target_room

    -

    This function is used to reset the layer target to the current room. See the function layer_set_target_room() for further information.

    -

    -

    Syntax:

    -

    layer_reset_target_room()

    -

    -

    Returns:

    -

    -

    -

    Example:

    -

    layer_set_target_room(rm_Game); -
    - var l = layer_get_id("SpriteAssets"); -
    - repeat(50) -
    - { -
    - layer_sprite_create(l, irandom(1000), irandom(1000), spr_Trees); -
    - } -
    - layer_reset_target_room();

    -

    The above code sets the target room to the room "rm_Game" and then gets the layer handle for the layer called "SpriteAssets" in that room. This layer handle is then used to add 50 random sprite assets to the layer, before the layer target is reset to the current room.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_reset_target_room + + + + + + + + + + +

    layer_reset_target_room

    +

    This function is used to reset the layer target to the current room. See the function layer_set_target_room() for further information.

    +

     

    +

    Syntax:

    +

    layer_reset_target_room()

    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    layer_set_target_room(rm_Game);
    + var l = layer_get_id("SpriteAssets");
    + repeat(50)
    + {
    +     layer_sprite_create(l, irandom(1000), irandom(1000), spr_Trees);
    + }
    + layer_reset_target_room();

    +

    The above code sets the target room to the room "rm_Game" and then gets the layer handle for the layer called "SpriteAssets" in that room. This layer handle is then used to add 50 random sprite assets to the layer, before the layer target is reset to the current room.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2021 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_script_begin.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_script_begin.htm index 47ea32fab..7f5ae867e 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_script_begin.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_script_begin.htm @@ -1,121 +1,99 @@ - + - - - layer_script_begin - - - - - - - - - -

    layer_script_begin

    -

    With this function you can assign a script function to a layer and it will be called before the layer is rendered. When adding a function to a layer, in this way it will be run at the start of each of the different draw events so you may want to check in the function assigned which event is currently rendering and adapt the code to suit. This can be done by checking the event_type and/or the event_number (see the extended example below). Note that the function is not meant to be called in any draw events or step events, but rather only needs to be called at the start of the room in the Room Creation Code or in the Create Event / Room Start Event of an instance.

    -

    -

    Syntax:

    -

    layer_script_begin(layer_id, script);

    - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    layer_idString or Layer IDThe handle of the layer to target (or the layer name as a string)
    scriptScript FunctionThe script function index to assign to the layer
    -

    -

    Returns:

    -

    N/A

    -

    -

    Extended Example:

    -

    In this extended example, we will first show you how a simple script function is structured to set some shader uniform data so that when the given layer is drawn, this function will be run and the shader will work correctly. In the example, it is worth noting how we check which event is being called so that the rest of the function is only run on the specific event that we require it to work on - in this case, only on the main draw event:

    -

    /// @function layer_shader_start(); -
    - function layer_shader_start() -
    - { -
    - if (event_type == ev_draw) -
    - { -
    - if (event_number == ev_draw_normal) -
    - { -
    - colour_to_find = shader_get_uniform(sShaderDemo5, "f_Colour1"); -
    - colour_to_set = shader_get_uniform(sShaderDemo5, "f_Colour2"); -
    - shader_set(s_ColourChanger); -
    - shader_set_uniform_f(colour_to_find, 1, 1, 1); -
    - shader_set_uniform_f(colour_to_set, 1, 0, 0); -
    - } -
    - } -
    - }

    -

    We would then have a companion function to reset the shader after all the drawing is done:

    -

    /// @function layer_shader_end(); -
    - function layer_shader_end() -
    - { -
    - if (event_type == ev_draw) -
    - { -
    - if (event_number == ev_draw_normal) -
    - { -
    - shader_reset(); -
    - } -
    - } -
    - }

    -

    Now that we have defined our script functions for setting the shader, we then have to assign them to a specific layer so that the layer knows to call them. This would be done in the room creation code, or in the create event or room start event of some controller object (they do not need to be set every step, but rather once at the start of the room, or when the layer is initially created):

    -

    var lay_id = layer_get_id("Instances"); -
    - layer_script_begin(lay_id, layer_shader_start); -
    - layer_script_end(lay_id, layer_shader_end);

    -

    This final code block assigns the scripts to the layer.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_script_begin + + + + + + + + + + +

    layer_script_begin

    +

    With this function you can assign a script function to a layer and it will be called before the layer is rendered. When adding a function to a layer, in this way it will be run at the start of each of the different draw events so you may want to check in the function assigned which event is currently rendering and adapt the code to suit. This can be done by checking the event_type and/or the event_number (see the extended example below). Note that the function is not meant to be called in any draw events or step events, but rather only needs to be called at the start of the room in the Room Creation Code or in the Create Event / Room Start Event of an instance.

    +

     

    +

    Syntax:

    +

    layer_script_begin(layer_id, script);

    + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    layer_idString or LayerThe handle of the layer to target (or the layer name as a string)
    scriptScript FunctionThe script function index to assign to the layer
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Extended Example:

    +

    In this extended example, we will first show you how a simple script function is structured to set some shader uniform data so that when the given layer is drawn, this function will be run and the shader will work correctly. In the example, it is worth noting how we check which event is being called so that the rest of the function is only run on the specific event that we require it to work on - in this case, only on the main draw event:

    +

    /// @function layer_shader_start();
    + function layer_shader_start()
    + {
    +     if (event_type == ev_draw)
    +     {
    +         if (event_number == ev_draw_normal)
    +         {
    +             colour_to_find = shader_get_uniform(sShaderDemo5, "f_Colour1");
    +             colour_to_set = shader_get_uniform(sShaderDemo5, "f_Colour2");
    +             shader_set(s_ColourChanger);
    +             shader_set_uniform_f(colour_to_find, 1, 1, 1);
    +             shader_set_uniform_f(colour_to_set, 1, 0, 0);
    +         }
    +     }
    + }

    +

    We would then have a companion function to reset the shader after all the drawing is done:

    +

    /// @function layer_shader_end();
    + function layer_shader_end()
    + {
    +     if (event_type == ev_draw)
    +     {
    +         if (event_number == ev_draw_normal)
    +         {
    +             shader_reset();
    +         }
    +     }
    + }

    +

    Now that we have defined our script functions for setting the shader, we then have to assign them to a specific layer so that the layer knows to call them. This would be done in the room creation code, or in the create event or room start event of some controller object (they do not need to be set every step, but rather once at the start of the room, or when the layer is initially created):

    +

    var lay_id = layer_get_id("Instances");
    + layer_script_begin(lay_id, layer_shader_start);
    + layer_script_end(lay_id, layer_shader_end); +

    +

    This final code block assigns the scripts to the layer.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_script_end.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_script_end.htm index c42168746..b87d62e65 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_script_end.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_script_end.htm @@ -1,121 +1,99 @@ - + - - - layer_script_end - - - - - - - - - -

    layer_script_end

    -

    With this function you can assign a script function to a layer and it will be called after the layer is rendered. When adding a function to a layer in this way, it will be run at the end of each of the different draw events so you may want to check in the function assigned which event is currently finished rendering and adapt the code to suit. This can be done by checking the event_type and/or the event_number (see the extended example below). Note that the function is not meant to be called in any draw events or step events, but rather only needs to be called at the start of the room in the Room Creation Code or in the Create Event / Room Start Event of an instance.

    -

    -

    Syntax:

    -

    layer_script_end(layer_id, script);

    - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    layer_idString or Layer IDThe handle of the layer to target (or the layer name as a string)
    scriptScript FunctionThe script function index to assign to the layer
    -

    -

    Returns:

    -

    N/A

    -

    -

    Extended Example:

    -

    In this extended example, we will first show you how a simple script function is structured to set some shader uniform data so that when the given layer is drawn, this function will be run and the shader will work correctly. In the example, it is worth noting how we check which event is being called so that the rest of the function is only run on the specific event that we require it to work on - in this case, only on the main draw event:

    -

    /// @function layer_shader_start(); -
    - function layer_shader_start() -
    - { -
    - if (event_type == ev_draw) -
    - { -
    - if (event_number == ev_draw_normal) -
    - { -
    - colour_to_find = shader_get_uniform(sShaderDemo5, "f_Colour1"); -
    - colour_to_set = shader_get_uniform(sShaderDemo5, "f_Colour2"); -
    - shader_set(s_ColourChanger); -
    - shader_set_uniform_f(colour_to_find, 1, 1, 1); -
    - shader_set_uniform_f(colour_to_set, 1, 0, 0); -
    - } -
    - } -
    - }

    -

    We would then have a companion function to reset the shader after all the drawing is done:

    -

    /// @function layer_shader_end(); -
    - function layer_shader_end() -
    - { -
    - if (event_type == ev_draw) -
    - { -
    - if (event_number == ev_draw_normal) -
    - { -
    - shader_reset(); -
    - } -
    - } -
    - }

    -

    Now that we have defined our script functions for setting the shader, we then have to assign them to a specific layer so that the layer knows to call them. This would be done in the room creation code, or in the create event or room start event of some controller object (they do not need to be set every step, but rather once at the start of the room, or when the layer is initially created):

    -

    var lay_id = layer_get_id("Instances"); -
    - layer_script_begin(lay_id, layer_shader_start); -
    - layer_script_end(lay_id, layer_shader_end);

    -

    This final code block assigns the scripts to the layer.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_script_end + + + + + + + + + + +

    layer_script_end

    +

    With this function you can assign a script function to a layer and it will be called after the layer is rendered. When adding a function to a layer in this way, it will be run at the end of each of the different draw events so you may want to check in the function assigned which event is currently finished rendering and adapt the code to suit. This can be done by checking the event_type and/or the event_number (see the extended example below). Note that the function is not meant to be called in any draw events or step events, but rather only needs to be called at the start of the room in the Room Creation Code or in the Create Event / Room Start Event of an instance.

    +

     

    +

    Syntax:

    +

    layer_script_end(layer_id, script);

    + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    layer_idString or LayerThe handle of the layer to target (or the layer name as a string)
    scriptScript FunctionThe script function index to assign to the layer
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Extended Example:

    +

    In this extended example, we will first show you how a simple script function is structured to set some shader uniform data so that when the given layer is drawn, this function will be run and the shader will work correctly. In the example, it is worth noting how we check which event is being called so that the rest of the function is only run on the specific event that we require it to work on - in this case, only on the main draw event:

    +

    /// @function layer_shader_start();
    + function layer_shader_start()
    + {
    +     if (event_type == ev_draw)
    +     {
    +         if (event_number == ev_draw_normal)
    +         {
    +             colour_to_find = shader_get_uniform(sShaderDemo5, "f_Colour1");
    +             colour_to_set = shader_get_uniform(sShaderDemo5, "f_Colour2");
    +             shader_set(s_ColourChanger);
    +             shader_set_uniform_f(colour_to_find, 1, 1, 1);
    +             shader_set_uniform_f(colour_to_set, 1, 0, 0);
    +         }
    +     }
    + }

    +

    We would then have a companion function to reset the shader after all the drawing is done:

    +

    /// @function layer_shader_end();
    + function layer_shader_end()
    + {
    +     if (event_type == ev_draw)
    +     {
    +         if (event_number == ev_draw_normal)
    +         {
    +             shader_reset();
    +         }
    +     }
    + }

    +

    Now that we have defined our script functions for setting the shader, we then have to assign them to a specific layer so that the layer knows to call them. This would be done in the room creation code, or in the create event or room start event of some controller object (they do not need to be set every step, but rather once at the start of the room, or when the layer is initially created):

    +

    var lay_id = layer_get_id("Instances");
    + layer_script_begin(lay_id, layer_shader_start);
    + layer_script_end(lay_id, layer_shader_end); +

    +

    This final code block assigns the scripts to the layer.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_set_target_room.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_set_target_room.htm index e0a7fedea..3513ec14f 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_set_target_room.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_set_target_room.htm @@ -1,76 +1,71 @@ - + - - - layer_set_target_room - - - - - - - - - -

    layer_set_target_room

    -

    This function tells GameMaker that all further layer functions should be applied to the given room. In this way you can procedurally change or generate layers and layer contents in a room that is not the current room.

    -

    When you are finished adding layers or layer elements to a room, call the function layer_reset_target_room to reset the room target or call this function again with a room argument of -1.

    -

    While targeting another room, you can use all the regular layer functions except you cannot create instances using instance_create_layer or instance_create_depth, nor will the layer function layer_add_instance be available.

    -

    -

    Syntax:

    -

    layer_set_target_room(room);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    roomRoom AssetThe room to target for all further layer functions, or -1 for the current room
    -

    -

    Returns:

    -

    N/A

    -

    -

    Example:

    -

    layer_set_target_room(rm_Game); -
    - var l = layer_get_id("SpriteAssets"); -
    - repeat(50) -
    - { -
    - var _x = irandom(1000); -
    - var _y = irandom(1000); -
    - layer_sprite_create(l, _x, _y, spr_Trees); -
    - } -
    - layer_reset_target_room();

    -

    The above code sets the target room to the room "rm_Game" and then gets the layer handle for the layer called "SpriteAssets" in that room. This layer handle is then used to add 50 random sprite assets to the layer, before the layer target is reset to the current room.

    -

    -

    -
    -
    -
    - - -
    + + + layer_set_target_room + + + + + + + + + + +

    layer_set_target_room

    +

    This function tells GameMaker that all further layer functions should be applied to the given room. In this way you can procedurally change or generate layers and layer contents in a room that is not the current room.

    +

    When you are finished adding layers or layer elements to a room, call the function layer_reset_target_room to reset the room target or call this function again with a room argument of -1.

    +

    While targeting another room, you can use all the regular layer functions except you cannot create instances using instance_create_layer or instance_create_depth, nor will the layer function layer_add_instance be available.

    +

     

    +

    Syntax:

    +

    layer_set_target_room(room);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    roomRoom AssetThe room to target for all further layer functions, or -1 for the current room
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    layer_set_target_room(rm_Game);
    + var l = layer_get_id("SpriteAssets");
    + repeat(50)
    + {
    +     var _x = irandom(1000);
    +     var _y = irandom(1000);
    +     layer_sprite_create(l, _x, _y, spr_Trees);
    + }
    + layer_reset_target_room();

    +

    The above code sets the target room to the room "rm_Game" and then gets the layer handle for the layer called "SpriteAssets" in that room. This layer handle is then used to add 50 random sprite assets to the layer, before the layer target is reset to the current room.

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2023 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_set_visible.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_set_visible.htm index 494bf2472..3e6797664 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_set_visible.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_set_visible.htm @@ -47,11 +47,11 @@

    Example:

    var lay_id = layer_get_id("Instances");
    if (layer_get_visible(lay_id))
    {
    - layer_set_visible(lay_id, false);
    +     layer_set_visible(lay_id, false);
    }
    else
    {
    - layer_set_visible(lay_id, true);
    +     layer_set_visible(lay_id, true);
    }

    The above code gets the handle for the layer named "Instances" in the room editor, then uses the ID to check if the layer is visible or not, toggling the layer visibility depending on the returned value.

     

    diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_vspeed.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_vspeed.htm index 0c537f55d..fe19709f2 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_vspeed.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_vspeed.htm @@ -1,75 +1,73 @@ - + - - - layer_vspeed - - - - - - - - - -

    layer_vspeed

    -

    You can use this function to set the vertical speed (in pixels per game frame) of the layer within the currently scoped room.

    -

    You supply the layer handle (which you get when you create the layer using layer_create) or the layer name (as a string - this will have a performance impact) and the speed value to set, where a positive value is downwards and a negative value upwards.

    -
    -

    -

    Syntax:

    -

    layer_vspeed(layer_id, vspd)

    - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    layer_idString or Layer IDThe handle of the layer to set the vertical speed of
    vspdRealThe vertical speed (in pixels per game frame) to set
    -

    -

    Returns:

    -

    N/A

    -

    -

    Example:

    -

    var lay_id = layer_get_id("Sprites"); -
    - if layer_get_hspeed(lay_id) != 0 || layer_get_vspeed(lay_id) != 0 -
    - { -
    - layer_hspeed(lay_id, 0); -
    - layer_vspeed(lay_id, 0); -
    - }

    -

    The above code checks the given layer horizontal and vertical speeds and if they are not both set to 0 then it is sets them to 0.

    -

    -

    -
    -
    -
    - - -
    + + + layer_vspeed + + + + + + + + + + +

    layer_vspeed

    +

    You can use this function to set the vertical speed (in pixels per game frame) of the layer within the currently scoped room.

    +

    You supply the layer handle (which you get when you create the layer using layer_create) or the layer name (as a string - this will have a performance impact) and the speed value to set, where a positive value is downwards and a negative value upwards.

    +
    +

     

    +

    Syntax:

    +

    layer_vspeed(layer_id, vspd)

    + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    layer_idString or LayerThe handle of the layer to set the vertical speed of
    vspdRealThe vertical speed (in pixels per game frame) to set
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("Sprites");
    + if (layer_get_hspeed(lay_id) != 0 || layer_get_vspeed(lay_id) != 0)
    + {
    +     layer_hspeed(lay_id, 0);
    +     layer_vspeed(lay_id, 0);
    + }

    +

    The above code checks the given layer horizontal and vertical speeds and if they are not both set to 0 then it is sets them to 0.

    +

     

    +

     

    +
    +
    +
    +
    Back: Layers
    +
    -
    © Copyright YoYo Games Ltd. 2023 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_x.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_x.htm index 35df167fc..6a0423fe9 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_x.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_x.htm @@ -1,75 +1,73 @@ - + - - - layer_x - - - - - - - - - -

    layer_x

    -

    You can use this function to set the x position of the layer within the currently scoped room.

    -

    You supply the layer handle (which you get when you create the layer using layer_create) or the layer name (as a string - this will have a performance impact) and the function will move the layer the given number of pixels along the horizontal axis of the room.

    -
    -

    -

    Syntax:

    -

    layer_x(layer_id, x)

    - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    layer_idString or Layer IDThe handle of the layer to set the x position of
    xRealThe x position in the room to set the layer to
    -

    -

    Returns:

    -

    N/A

    -

    -

    Example:

    -

    var lay_id = layer_get_id("Sprites"); -
    - if layer_get_x(lay_id) != 0 || layer_get_y(lay_id) != 0 -
    - { -
    - layer_x(lay_id, 0); -
    - layer_y(lay_id, 0); -
    - }

    -

    The above code checks the given layer position and if it is not set to (0, 0) then it is set to that position.

    -

    -

    -
    -
    -
    - -
    Next: layer_y
    -
    + + + layer_x + + + + + + + + + + +

    layer_x

    +

    You can use this function to set the x position of the layer within the currently scoped room.

    +

    You supply the layer handle (which you get when you create the layer using layer_create) or the layer name (as a string - this will have a performance impact) and the function will move the layer the given number of pixels along the horizontal axis of the room.

    +
    +

     

    +

    Syntax:

    +

    layer_x(layer_id, x)

    + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    layer_idString or LayerThe handle of the layer to set the x position of
    xRealThe x position in the room to set the layer to
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("Sprites");
    + if layer_get_x(lay_id) != 0 || layer_get_y(lay_id) != 0
    + {
    +     layer_x(lay_id, 0);
    +     layer_y(lay_id, 0);
    + }

    +

    The above code checks the given layer position and if it is not set to (0, 0) then it is set to that position.

    +

     

    +

     

    +
    +
    +
    +
    Back: Layers
    +
    Next: layer_y
    -
    © Copyright YoYo Games Ltd. 2023 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_y.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_y.htm index ad897ce14..e6fe6e778 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_y.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/General_Layer_Functions/layer_y.htm @@ -1,75 +1,73 @@ - + - - - layer_y - - - - - - - - - -

    layer_y

    -

    You can use this function to set the y position of the layer within the currently scoped room.

    -

    You supply the layer handle (which you get when you create the layer using layer_create) or the layer name (as a string - this will have a performance impact) and the function will move the layer the given number of pixels along the vertical axis of the room.

    -
    -

    -

    Syntax:

    -

    layer_y(layer_id, y)

    - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    layer_idString or Layer IDThe handle of the layer to set the y position of
    yRealThe y position in the room to set the layer to
    -

    -

    Returns:

    -

    N/A

    -

    -

    Example:

    -

    var lay_id = layer_get_id("Sprites"); -
    - if layer_get_x(lay_id) != 0 || layer_get_y(lay_id) != 0 -
    - { -
    - layer_x(lay_id, 0); -
    - layer_y(lay_id, 0); -
    - }

    -

    The above code checks the given layer position and if it is not set to (0, 0) then it is set to that position.

    -

    -

    -
    -
    -
    - - -
    + + + layer_y + + + + + + + + + + +

    layer_y

    +

    You can use this function to set the y position of the layer within the currently scoped room.

    +

    You supply the layer handle (which you get when you create the layer using layer_create) or the layer name (as a string - this will have a performance impact) and the function will move the layer the given number of pixels along the vertical axis of the room.

    +
    +

     

    +

    Syntax:

    +

    layer_y(layer_id, y)

    + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    layer_idString or LayerThe handle of the layer to set the y position of
    yRealThe y position in the room to set the layer to
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("Sprites");
    + if layer_get_x(lay_id) != 0 || layer_get_y(lay_id) != 0
    + {
    +     layer_x(lay_id, 0);
    +     layer_y(lay_id, 0);
    + }

    +

    The above code checks the given layer position and if it is not set to (0, 0) then it is set to that position.

    +

     

    +

     

    +
    +
    +
    +
    Back: Layers
    +
    -
    © Copyright YoYo Games Ltd. 2023 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sequence_Layers/layer_sequence_exists.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sequence_Layers/layer_sequence_exists.htm index 0fed15681..07429d21e 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sequence_Layers/layer_sequence_exists.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sequence_Layers/layer_sequence_exists.htm @@ -1,73 +1,72 @@ - + - - - layer_sequence_exists - - - - - - - - - - -

    layer_sequence_exists

    -

    With this function you can check to see if a sequence element exists on the given layer. You supply the layer handle which can be a string of the layer name - as defined in the Room Editor - or the unique layer handle - as returned by the function layer_get_id(), as well the sequence element ID - as returned by layer_sequence_create() or by one of the layer element functions - and it will return true if the given element exists or false otherwise.

    -

    -

    Syntax:

    -

    layer_sequence_exists(layer_id, sequence_element_id)

    - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    layer_IDString or Layer IDThe unique ID or name of the layer to check
    sequence_element_idSequence Element IDThe unique ID value of the sequence element to target
    -

    -

    Returns:

    -

    Boolean

    -

    -

    Example:

    -

    if (!layer_sequence_exists("Background", my_seq)) -
    - { -
    - my_seq = layer_sequence_create("Background", 0, 0, seq_AnimatedBackground); -
    - layer_sequence_pause(my_seq); -
    - }

    -

    The above code checks to see if the given sequence element exists, and if it does not then it creates a new sequence on the given layer then pauses it.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_sequence_exists + + + + + + + + + + + +

    layer_sequence_exists

    +

    With this function you can check to see if a sequence element exists on the given layer. You supply the layer handle which can be a string of the layer name - as defined in the Room Editor - or the unique layer handle - as returned by the function layer_get_id(), as well the sequence element ID - as returned by layer_sequence_create() or by one of the layer element functions - and it will return true if the given element exists or false otherwise.

    +

     

    +

    Syntax:

    +

    layer_sequence_exists(layer_id, sequence_element_id)

    + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    layer_IDString or LayerThe unique ID or name of the layer to check
    sequence_element_idSequence Element IDThe unique ID value of the sequence element to target
    +

     

    +

    Returns:

    +

    Boolean

    +

     

    +

    Example:

    +

    if (!layer_sequence_exists("Background", my_seq))
    + {
    +     my_seq = layer_sequence_create("Background", 0, 0, seq_AnimatedBackground);
    +     layer_sequence_pause(my_seq);
    + }

    +

    The above code checks to see if the given sequence element exists, and if it does not then it creates a new sequence on the given layer then pauses it.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2023 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_create.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_create.htm index 6e3e95529..df040a1bb 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_create.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_create.htm @@ -1,87 +1,84 @@ - + - - - layer_sprite_create - - - - - - - - - - -

    layer_sprite_create

    -

    With this function you can assign a sprite resource to a layer to be used in your project. You supply the layer handle (which you get when you create the layer using layer_create() or when you use the layer name along with layer_get_id()), a position within the room, and a sprite index (which would be the name of the sprite as shown in the Asset Browser), and it will be added to the layer. The function returns the unique ID value for the element, which can then be used in further layer functions for sprites.

    -

    -

    Syntax:

    -

    layer_sprite_create(layer_id, x, y, sprite)

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    layer_idString or LayerThe handle of the layer to target
    xRealThe x position to use
    yRealThe y position to use
    spriteSprite AssetThe sprite index to be used
    -

    -

    Returns:

    -

    Sprite Element ID

    -

    -

    Example:

    -

    global.asset_layer = layer_create(10000); -
    - for (var i = 0; i< 10; i++;) -
    - { -
    - var _x = random(room_width); -
    - var _y = room_height - 100; -
    - global.asset_spr_trees[i] = layer_sprite_create(global.asset_layer, _x, _y, spr_Trees); -
    - }

    -

    The above code creates a new layer and then adds 10 new sprite elements to it, storing the ID of each element to an array.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_sprite_create + + + + + + + + + + + +

    layer_sprite_create

    +

    With this function you can assign a sprite resource to a layer to be used in your project. You supply the layer handle (which you get when you create the layer using layer_create() or when you use the layer name along with layer_get_id()), a position within the room, and a sprite index (which would be the name of the sprite as shown in the Asset Browser), and it will be added to the layer. The function returns the unique ID value for the element, which can then be used in further layer functions for sprites.

    +

     

    +

    Syntax:

    +

    layer_sprite_create(layer_id, x, y, sprite)

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    layer_idString or LayerThe handle of the layer to target
    xRealThe x position to use
    yRealThe y position to use
    spriteSprite AssetThe sprite index to be used
    +

     

    +

    Returns:

    +

    Sprite Element ID

    +

     

    +

    Example:

    +

    global.asset_layer = layer_create(10000);
    + for (var i = 0; i< 10; i++;)
    + {
    +     var _x = random(room_width);
    +     var _y = room_height - 100;
    +     global.asset_spr_trees[i] = layer_sprite_create(global.asset_layer, _x, _y, spr_Trees);
    + }

    +

    The above code creates a new layer and then adds 10 new sprite elements to it, storing the ID of each element to an array.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2024 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_destroy.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_destroy.htm index 2af7f5d22..d9f43a9a4 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_destroy.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_destroy.htm @@ -1,70 +1,69 @@ - + - - - layer_sprite_destroy - - - - - - - - - -

    layer_sprite_destroy

    -

    This function will destroy the given sprite element. You supply the sprite ID (which you get when you create the sprite using layer_sprite_create() or when you use the layer handle along with layer_get_sprite_id()) and this will remove it. Note that this does not remove the layer, only the sprite from it, and if the sprite is one that has been added in the room editor, then the next time you leave the room and then return, the sprite will be recreated again. However if the room is persistent, the sprite will be removed unless room persistence is switched off again.

    -

    -

    Syntax:

    -

    layer_sprite_destroy(sprite_element_id)

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    sprite_element_idSprite Element IDThe unique ID value of the sprite to be destroyed
    -

    -

    Returns:

    -

    N/A

    -

    -

    Example:

    -

    var lay_id = layer_get_id("Asset_Trees"); -
    - var spr_id = layer_sprite_get_id(lay_id, "graphic_254367CB"); -
    -
    - if (layer_sprite_exists(lay_id, spr_id)) -
    - { -
    - layer_sprite_destroy(spr_id); -
    - }

    -

    The above code checks the layer "Asset_Trees" to see if the given sprite element exists and if it does, then it is destroyed (but not the layer).

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_sprite_destroy + + + + + + + + + + +

    layer_sprite_destroy

    +

    This function will destroy the given sprite element. You supply the sprite ID (which you get when you create the sprite using layer_sprite_create() or when you use the layer handle along with layer_get_sprite_id()) and this will remove it. Note that this does not remove the layer, only the sprite from it, and if the sprite is one that has been added in the room editor, then the next time you leave the room and then return, the sprite will be recreated again. However if the room is persistent, the sprite will be removed unless room persistence is switched off again.

    +

     

    +

    Syntax:

    +

    layer_sprite_destroy(sprite_element_id)

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    sprite_element_idSprite Element IDThe unique ID value of the sprite to be destroyed
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("Asset_Trees");
    + var spr_id = layer_sprite_get_id(lay_id, "graphic_254367CB");
    +
    + if (layer_sprite_exists(lay_id, spr_id))
    + {
    +     layer_sprite_destroy(spr_id);
    + } +

    +

    The above code checks the layer "Asset_Trees" to see if the given sprite element exists and if it does, then it is destroyed (but not the layer).

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2024 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_exists.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_exists.htm index 1c48df908..d9a9ed4a3 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_exists.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_exists.htm @@ -1,77 +1,76 @@ - + - - - layer_sprite_exists - - - - - - - - - - -

    layer_sprite_exists

    -

    You can use this function to check and see if a sprite element exists on any given layer. You supply the layer handle (which you get when you create the layer using layer_create()) or the layer name (as a string - this will have a performance impact) and the sprite element ID (which you get when you create a sprite element using layer_sprite_create() or when you use the function layer_sprite_get_id()) and the function will return either true if the element exists, or false if it does not.

    -

    This function works within the scope of the current target room - by default the room in which the function is called - which can be set using the function layer_set_target_room().

    -

    -

    Syntax:

    -

    layer_sprite_exists(layer_id, sprite_element_id)

    - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    layer_idString or LayerThe handle of the layer to target (or the layer name as a string)
    sprite_element_idSprite Element IDThe unique ID value of the sprite element to check
    -

    -

    Returns:

    -

    Boolean

    -

    -

    Example:

    -

    var lay_id = layer_get_id("Asset_Trees"); -
    - var spr_id = layer_sprite_get_id(lay_id, "graphic_254367CB"); -
    -
    - if (layer_sprite_exists(lay_id, spr_id)) -
    - { -
    - layer_sprite_destroy(spr_id); -
    - }

    -

    The above code checks the layer "Asset_trees" to see if the given sprite element exists and if it does, then it is destroyed (but not the layer).

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_sprite_exists + + + + + + + + + + + +

    layer_sprite_exists

    +

    You can use this function to check and see if a sprite element exists on any given layer. You supply the layer handle (which you get when you create the layer using layer_create()) or the layer name (as a string - this will have a performance impact) and the sprite element ID (which you get when you create a sprite element using layer_sprite_create() or when you use the function layer_sprite_get_id()) and the function will return either true if the element exists, or false if it does not.

    +

    This function works within the scope of the current target room - by default the room in which the function is called - which can be set using the function layer_set_target_room().

    +

     

    +

    Syntax:

    +

    layer_sprite_exists(layer_id, sprite_element_id)

    + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    layer_idString or LayerThe handle of the layer to target (or the layer name as a string)
    sprite_element_idSprite Element IDThe unique ID value of the sprite element to check
    +

     

    +

    Returns:

    +

    Boolean

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("Asset_Trees");
    + var spr_id = layer_sprite_get_id(lay_id, "graphic_254367CB");
    +
    + if (layer_sprite_exists(lay_id, spr_id))
    + {
    +     layer_sprite_destroy(spr_id);
    + } +

    +

    The above code checks the layer "Asset_trees" to see if the given sprite element exists and if it does, then it is destroyed (but not the layer).

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2024 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_alpha.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_alpha.htm index 61ccf6f87..f39b7359b 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_alpha.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_alpha.htm @@ -1,70 +1,68 @@ - + - - - layer_sprite_get_alpha - - - - - - - - - - -

    layer_sprite_get_alpha

    -

    This function can be used to get the alpha value of the sprite element. You give the sprite element ID (which you get when you create a sprite element using layer_sprite_create() or when you use the function layer_sprite_get_id()), and the function will return a value between 0 (fully transparent) and 1 (fully opaque).

    -

    -

    Syntax:

    -

    layer_sprite_get_alpha(sprite_element_id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    sprite_element_idSprite Element IDThe unique ID value of the sprite element to get the information from
    -

    -

    Returns:

    -

    Real (from 0 to 1)

    -

    -

    Example:

    -

    var lay_id = layer_get_id("sprite_sky"); -
    - var spr_id = layer_sprite_get_id(lay_id, "Clouds"); -
    - if (layer_sprite_get_alpha(spr_id) < 0.1) -
    - { -
    - layer_sprite_destroy(spr_id); -
    - }

    -

    The above code will get the layer handle for the layer named "sprite_sky" and then use that to get the ID of the sprite element on that layer. This ID is then used to check the element alpha and if it is less than 0.1, then the layer element is destroyed.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_sprite_get_alpha + + + + + + + + + + + +

    layer_sprite_get_alpha

    +

    This function can be used to get the alpha value of the sprite element. You give the sprite element ID (which you get when you create a sprite element using layer_sprite_create() or when you use the function layer_sprite_get_id()), and the function will return a value between 0 (fully transparent) and 1 (fully opaque).

    +

     

    +

    Syntax:

    +

    layer_sprite_get_alpha(sprite_element_id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    sprite_element_idSprite Element IDThe unique ID value of the sprite element to get the information from
    +

     

    +

    Returns:

    +

    Real (from 0 to 1)

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("sprite_sky");
    + var spr_id = layer_sprite_get_id(lay_id, "Clouds");
    + if (layer_sprite_get_alpha(spr_id) < 0.1)
    + {
    +     layer_sprite_destroy(spr_id);
    + }

    +

    The above code will get the layer handle for the layer named "sprite_sky" and then use that to get the ID of the sprite element on that layer. This ID is then used to check the element alpha and if it is less than 0.1, then the layer element is destroyed.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2024 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_angle.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_angle.htm index 6a6fbdea0..6532e7879 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_angle.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_angle.htm @@ -1,70 +1,68 @@ - + - - - layer_sprite_get_angle - - - - - - - - - - -

    layer_sprite_get_angle

    -

    This function can be used to get the current angle for the sprite element. You give the sprite element ID (which you get when you create a sprite element using layer_sprite_create() or when you use the function layer_sprite_get_id()), and the function will return real value for the angle. This value will be between 0 and 360, where 0 represents right, 90 up, 180 left and 270 down.

    -

    -

    Syntax:

    -

    layer_sprite_get_angle(sprite_element_id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    sprite_element_idSprite Element IDThe unique ID value of the sprite element to get the information from
    -

    -

    Returns:

    -

    Real

    -

    -

    Example:

    -

    var lay_id = layer_get_id("sprite_sky"); -
    - var spr_id = layer_sprite_get_id(lay_id, "Clouds"); -
    - if (layer_sprite_get_angle(spr_id) != 0) -
    - { -
    - layer_sprite_yscale(spr_id, 0); -
    - }

    -

    The above code will get the layer handle for the layer named "sprite_sky" and then use that to get the ID of the sprite element on that layer. This ID is then used to check the angle and if it is anything other than 0 it is set to 0.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_sprite_get_angle + + + + + + + + + + + +

    layer_sprite_get_angle

    +

    This function can be used to get the current angle for the sprite element. You give the sprite element ID (which you get when you create a sprite element using layer_sprite_create() or when you use the function layer_sprite_get_id()), and the function will return real value for the angle. This value will be between 0 and 360, where 0 represents right, 90 up, 180 left and 270 down.

    +

     

    +

    Syntax:

    +

    layer_sprite_get_angle(sprite_element_id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    sprite_element_idSprite Element IDThe unique ID value of the sprite element to get the information from
    +

     

    +

    Returns:

    +

    Real

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("sprite_sky");
    + var spr_id = layer_sprite_get_id(lay_id, "Clouds");
    + if (layer_sprite_get_angle(spr_id) != 0)
    + {
    +     layer_sprite_yscale(spr_id, 0);
    + }

    +

    The above code will get the layer handle for the layer named "sprite_sky" and then use that to get the ID of the sprite element on that layer. This ID is then used to check the angle and if it is anything other than 0 it is set to 0.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2024 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_blend.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_blend.htm index 2a4d92261..afa089d0b 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_blend.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_blend.htm @@ -1,70 +1,68 @@ - + - - - layer_sprite_get_blend - - - - - - - - - - -

    layer_sprite_get_blend

    -

    This function can be used to get the blend colour of the sprite element. You give the sprite element ID (which you get when you create a sprite element using layer_sprite_create() or when you use the function layer_sprite_get_id()), and the function will return real value that represents the colour assigned.

    -

    -

    Syntax:

    -

    layer_sprite_get_blend(sprite_element_id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    sprite_element_idSprite Element IDThe unique ID value of the sprite element to get the information from
    -

    -

    Returns:

    -

    Colour

    -

    -

    Example:

    -

    var lay_id = layer_get_id("sprite_sky"); -
    - var back_id = layer_sprite_get_id(lay_id, "Clouds"); -
    - if (layer_sprite_get_blend(back_id) == c_white) -
    - { -
    - layer_sprite_blend(back_id, make_colour_rgb(random(255), random(255), 255)); -
    - }

    -

    The above code will get the layer handle for the layer named "sprite_sky" and then use that to get the ID of the sprite element on that layer. This ID is then used to check the element blend colour and if it is equivalent to the constant c_white, then the element blend is set to a random colour.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_sprite_get_blend + + + + + + + + + + + +

    layer_sprite_get_blend

    +

    This function can be used to get the blend colour of the sprite element. You give the sprite element ID (which you get when you create a sprite element using layer_sprite_create() or when you use the function layer_sprite_get_id()), and the function will return real value that represents the colour assigned.

    +

     

    +

    Syntax:

    +

    layer_sprite_get_blend(sprite_element_id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    sprite_element_idSprite Element IDThe unique ID value of the sprite element to get the information from
    +

     

    +

    Returns:

    +

    Colour

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("sprite_sky");
    + var back_id = layer_sprite_get_id(lay_id, "Clouds");
    + if (layer_sprite_get_blend(back_id) == c_white)
    + {
    +     layer_sprite_blend(back_id, make_colour_rgb(random(255), random(255), 255));
    + }

    +

    The above code will get the layer handle for the layer named "sprite_sky" and then use that to get the ID of the sprite element on that layer. This ID is then used to check the element blend colour and if it is equivalent to the constant c_white, then the element blend is set to a random colour.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2024 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_index.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_index.htm index 77f5fd5ec..bfac7b4ce 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_index.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_index.htm @@ -1,70 +1,68 @@ - + - - - layer_sprite_get_index - - - - - - - - - - -

    layer_sprite_get_index

    -

    This function can be used to get the current image index value of the sprite element. You give the sprite element ID (which you get when you create a sprite element using layer_sprite_create() or when you use the function layer_sprite_get_id()), and the function will return real value that represents the image index being shown for the sprite. The function will return -1 if either the sprite element doesn't exist or the element doesn't have a valid sprite assigned to it.

    -

    -

    Syntax:

    -

    layer_sprite_get_index(sprite_element_id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    sprite_element_idSprite Element IDThe unique ID value of the sprite element to get the information from
    -

    -

    Returns:

    -

    Real or -1

    -

    -

    Example:

    -

    var lay_id = layer_get_id("sprite_sky"); -
    - var spr_id = layer_sprite_get_id(lay_id, "Clouds"); -
    - if (layer_sprite_get_index(spr_id) < 4) -
    - { -
    - layer_sprite_index(spr_id, 4); -
    - }

    -

    The above code will get the layer handle for the layer named "sprite_sky" and then use that to get the ID of the sprite element on that layer. This ID is then used to check if the image index for the element is less than 4, and if so it is set to 4.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_sprite_get_index + + + + + + + + + + + +

    layer_sprite_get_index

    +

    This function can be used to get the current image index value of the sprite element. You give the sprite element ID (which you get when you create a sprite element using layer_sprite_create() or when you use the function layer_sprite_get_id()), and the function will return real value that represents the image index being shown for the sprite. The function will return -1 if either the sprite element doesn't exist or the element doesn't have a valid sprite assigned to it.

    +

     

    +

    Syntax:

    +

    layer_sprite_get_index(sprite_element_id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    sprite_element_idSprite Element IDThe unique ID value of the sprite element to get the information from
    +

     

    +

    Returns:

    +

    Real or -1

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("sprite_sky");
    + var spr_id = layer_sprite_get_id(lay_id, "Clouds");
    + if (layer_sprite_get_index(spr_id) < 4)
    + {
    +     layer_sprite_index(spr_id, 4);
    + }

    +

    The above code will get the layer handle for the layer named "sprite_sky" and then use that to get the ID of the sprite element on that layer. This ID is then used to check if the image index for the element is less than 4, and if so it is set to 4.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2024 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_speed.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_speed.htm index ec57d3097..86e07526b 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_speed.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_speed.htm @@ -1,70 +1,68 @@ - + - - - layer_sprite_get_speed - - - - - - - - - - -

    layer_sprite_get_speed

    -

    This function can be used to get the current speed multiplier value of the sprite element. You give the sprite element ID (which you get when you create a sprite element using layer_sprite_create() or when you use the function layer_sprite_get_id()), and the function will return real value that represents the speed multiplier being used to animate the sprite. Default value is 1.

    -

    -

    Syntax:

    -

    layer_sprite_get_speed(sprite_element_id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    sprite_element_idSprite Element IDThe unique ID value of the sprite element to get the information from
    -

    -

    Returns:

    -

    Real

    -

    -

    Example:

    -

    var lay_id = layer_get_id("sprite_sky"); -
    - var spr_id = layer_sprite_get_id(lay_id, "Clouds"); -
    - if (layer_sprite_get_speed(spr_id) > 0) -
    - { -
    - layer_sprite_speed(spr_id, 0); -
    - }

    -

    The above code will get the layer handle for the layer named "sprite_sky" and then use that to get the ID of the sprite element on that layer. This ID is then used to check the animation speed for the element and if it is greater than 0, it is set to 0.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_sprite_get_speed + + + + + + + + + + + +

    layer_sprite_get_speed

    +

    This function can be used to get the current speed multiplier value of the sprite element. You give the sprite element ID (which you get when you create a sprite element using layer_sprite_create() or when you use the function layer_sprite_get_id()), and the function will return real value that represents the speed multiplier being used to animate the sprite. Default value is 1.

    +

     

    +

    Syntax:

    +

    layer_sprite_get_speed(sprite_element_id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    sprite_element_idSprite Element IDThe unique ID value of the sprite element to get the information from
    +

     

    +

    Returns:

    +

    Real

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("sprite_sky");
    + var spr_id = layer_sprite_get_id(lay_id, "Clouds");
    + if (layer_sprite_get_speed(spr_id) > 0)
    + {
    +     layer_sprite_speed(spr_id, 0);
    + }

    +

    The above code will get the layer handle for the layer named "sprite_sky" and then use that to get the ID of the sprite element on that layer. This ID is then used to check the animation speed for the element and if it is greater than 0, it is set to 0.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2024 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_sprite.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_sprite.htm index 3e100f338..d1a9a950c 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_sprite.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_sprite.htm @@ -1,70 +1,68 @@ - + - - - layer_sprite_get_sprite - - - - - - - - - - -

    layer_sprite_get_sprite

    -

    This function can be used to get the current sprite index of the sprite element. You give the sprite element ID (which you get when you create a sprite element using layer_sprite_create or when you use the function layer_sprite_get_id), and the function will return a real value that represents the sprite index being shown. If the element has no sprite assigned, the function will return -1.

    -

    -

    Syntax:

    -

    layer_sprite_get_sprite(sprite_element_id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    sprite_element_idSprite Element IDThe unique ID value of the sprite element to get the information from
    -

    -

    Returns:

    -

    Sprite Asset or -1

    -

    -

    Example:

    -

    var lay_id = layer_get_id("sprite_sky"); -
    - var spr_id = layer_sprite_get_id(lay_id, "Clouds"); -
    - if layer_sprite_get_sprite(spr_id) != spr_Clouds -
    - { -
    - layer_sprite_change(spr_id, spr_Clouds); -
    - }

    -

    The above code will get the layer handle for the layer named "sprite_sky" and then use that to get the ID of the sprite element on that layer. This ID is then used to check the sprite assigned to the element, setting it to the sprite "spr_Clouds" if it is not already.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_sprite_get_sprite + + + + + + + + + + + +

    layer_sprite_get_sprite

    +

    This function can be used to get the current sprite index of the sprite element. You give the sprite element ID (which you get when you create a sprite element using layer_sprite_create or when you use the function layer_sprite_get_id), and the function will return a real value that represents the sprite index being shown. If the element has no sprite assigned, the function will return -1.

    +

     

    +

    Syntax:

    +

    layer_sprite_get_sprite(sprite_element_id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    sprite_element_idSprite Element IDThe unique ID value of the sprite element to get the information from
    +

     

    +

    Returns:

    +

    Sprite Asset or -1

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("sprite_sky");
    + var spr_id = layer_sprite_get_id(lay_id, "Clouds");
    + if layer_sprite_get_sprite(spr_id) != spr_Clouds
    + {
    +     layer_sprite_change(spr_id, spr_Clouds);
    + }

    +

    The above code will get the layer handle for the layer named "sprite_sky" and then use that to get the ID of the sprite element on that layer. This ID is then used to check the sprite assigned to the element, setting it to the sprite "spr_Clouds" if it is not already.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_x.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_x.htm index dae45a84d..9ff89f53d 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_x.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_x.htm @@ -1,70 +1,68 @@ - + - - - layer_sprite_get_x - - - - - - - - - - -

    layer_sprite_get_x

    -

    This function can be used to get the x position of the sprite element in the room. You give the sprite element ID (which you get when you create a sprite element using layer_sprite_create() or when you use the function layer_sprite_get_id()), and the function will return the x position value.

    -

    -

    Syntax:

    -

    layer_sprite_get_x(sprite_element_id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    sprite_element_idSprite Element IDThe unique ID value of the sprite element to get the information from
    -

    -

    Returns:

    -

    Real

    -

    -

    Example:

    -

    var lay_id = layer_get_id("sprite_sky"); -
    - var spr_id = layer_sprite_get_id(lay_id, "Clouds"); -
    - if (layer_sprite_get_x(spr_id) < 0) -
    - { -
    - layer_sprite_x(spr_id, room_width); -
    - }

    -

    The above code will get the layer handle for the layer named "sprite_sky" and then use that to get the ID of the sprite element on that layer. This ID is then used to check the element x position and if it is less than 0, then the layer element is moved to a different x position.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_sprite_get_x + + + + + + + + + + + +

    layer_sprite_get_x

    +

    This function can be used to get the x position of the sprite element in the room. You give the sprite element ID (which you get when you create a sprite element using layer_sprite_create() or when you use the function layer_sprite_get_id()), and the function will return the x position value.

    +

     

    +

    Syntax:

    +

    layer_sprite_get_x(sprite_element_id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    sprite_element_idSprite Element IDThe unique ID value of the sprite element to get the information from
    +

     

    +

    Returns:

    +

    Real

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("sprite_sky");
    + var spr_id = layer_sprite_get_id(lay_id, "Clouds");
    + if (layer_sprite_get_x(spr_id) < 0)
    + {
    +     layer_sprite_x(spr_id, room_width);
    + }

    +

    The above code will get the layer handle for the layer named "sprite_sky" and then use that to get the ID of the sprite element on that layer. This ID is then used to check the element x position and if it is less than 0, then the layer element is moved to a different x position.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2024 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_xscale.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_xscale.htm index 675b1c539..25ca94272 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_xscale.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_xscale.htm @@ -1,70 +1,68 @@ - + - - - layer_sprite_get_xscale - - - - - - - - - - -

    layer_sprite_get_xscale

    -

    This function can be used to get the current scale multiplier along the x axis for the sprite element. You give the sprite element ID (which you get when you create a sprite element using layer_sprite_create() or when you use the function layer_sprite_get_id()), and the function will return real value for the x scale, where 1 is no scaling.

    -

    -

    Syntax:

    -

    layer_sprite_get_xscale(sprite_element_id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    sprite_element_idSprite Element IDThe unique ID value of the sprite element to get the information from
    -

    -

    Returns:

    -

    Real

    -

    -

    Example:

    -

    var lay_id = layer_get_id("sprite_sky"); -
    - var spr_id = layer_sprite_get_id(lay_id, "Clouds"); -
    - if (layer_sprite_get_xscale(spr_id) != 1) -
    - { -
    - layer_sprite_xscale(spr_id, 1); -
    - }

    -

    The above code will get the layer handle for the layer named "sprite_sky" and then use that to get the ID of the sprite element on that layer. This ID is then used to check the xscale value and if it is anything other than 1 it is set to 1.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_sprite_get_xscale + + + + + + + + + + + +

    layer_sprite_get_xscale

    +

    This function can be used to get the current scale multiplier along the x axis for the sprite element. You give the sprite element ID (which you get when you create a sprite element using layer_sprite_create() or when you use the function layer_sprite_get_id()), and the function will return real value for the x scale, where 1 is no scaling.

    +

     

    +

    Syntax:

    +

    layer_sprite_get_xscale(sprite_element_id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    sprite_element_idSprite Element IDThe unique ID value of the sprite element to get the information from
    +

     

    +

    Returns:

    +

    Real

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("sprite_sky");
    + var spr_id = layer_sprite_get_id(lay_id, "Clouds");
    + if (layer_sprite_get_xscale(spr_id) != 1)
    + {
    +     layer_sprite_xscale(spr_id, 1);
    + }

    +

    The above code will get the layer handle for the layer named "sprite_sky" and then use that to get the ID of the sprite element on that layer. This ID is then used to check the xscale value and if it is anything other than 1 it is set to 1.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2024 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_y.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_y.htm index d8d1018b3..793b655fe 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_y.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_y.htm @@ -1,70 +1,68 @@ - + - - - layer_sprite_get_y - - - - - - - - - - -

    layer_sprite_get_y

    -

    This function can be used to get the y position of the sprite element in the room. You give the sprite element ID (which you get when you create a sprite element using layer_sprite_create() or when you use the function layer_sprite_get_id()), and the function will return the y position value.

    -

    -

    Syntax:

    -

    layer_sprite_get_y(sprite_element_id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    sprite_element_idSprite Element IDThe unique ID value of the sprite element to get the information from
    -

    -

    Returns:

    -

    Real

    -

    -

    Example:

    -

    var lay_id = layer_get_id("sprite_sky"); -
    - var spr_id = layer_sprite_get_id(lay_id, "Clouds"); -
    - if (layer_sprite_get_y(spr_id) < 0) -
    - { -
    - layer_sprite_y(spr_id, room_height); -
    - }

    -

    The above code will get the layer handle for the layer named "sprite_sky" and then use that to get the ID of the sprite element on that layer. This ID is then used to check the element y position and if it is less than 0, then the layer element is moved to a different y position.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_sprite_get_y + + + + + + + + + + + +

    layer_sprite_get_y

    +

    This function can be used to get the y position of the sprite element in the room. You give the sprite element ID (which you get when you create a sprite element using layer_sprite_create() or when you use the function layer_sprite_get_id()), and the function will return the y position value.

    +

     

    +

    Syntax:

    +

    layer_sprite_get_y(sprite_element_id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    sprite_element_idSprite Element IDThe unique ID value of the sprite element to get the information from
    +

     

    +

    Returns:

    +

    Real

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("sprite_sky");
    + var spr_id = layer_sprite_get_id(lay_id, "Clouds");
    + if (layer_sprite_get_y(spr_id) < 0)
    + {
    +     layer_sprite_y(spr_id, room_height);
    + }

    +

    The above code will get the layer handle for the layer named "sprite_sky" and then use that to get the ID of the sprite element on that layer. This ID is then used to check the element y position and if it is less than 0, then the layer element is moved to a different y position.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2024 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_yscale.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_yscale.htm index f4fee5aaf..0bae90554 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_yscale.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Sprite_Layers/layer_sprite_get_yscale.htm @@ -1,70 +1,68 @@ - + - - - layer_sprite_get_yscale - - - - - - - - - - -

    layer_sprite_get_yscale

    -

    This function can be used to get the current scale multiplier along the y axis for the sprite element. You give the sprite element ID (which you get when you create a sprite element using layer_sprite_create() or when you use the function layer_sprite_get_id()), and the function will return real value for the y scale, where 1 is no scaling.

    -

    -

    Syntax:

    -

    layer_sprite_get_yscale(sprite_element_id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    sprite_element_idSprite Element IDThe unique ID value of the sprite element to get the information from
    -

    -

    Returns:

    -

    Real

    -

    -

    Example:

    -

    var lay_id = layer_get_id("sprite_sky"); -
    - var spr_id = layer_sprite_get_id(lay_id, "Clouds"); -
    - if (layer_sprite_get_yscale(spr_id) != 1) -
    - { -
    - layer_sprite_yscale(spr_id, 1); -
    - }

    -

    The above code will get the layer handle for the layer named "sprite_sky" and then use that to get the ID of the sprite element on that layer. This ID is then used to check the yscale value and if it is anything other than 1 it is set to 1.

    -

    -

    -

    -
    -
    -
    - - -
    + + + layer_sprite_get_yscale + + + + + + + + + + + +

    layer_sprite_get_yscale

    +

    This function can be used to get the current scale multiplier along the y axis for the sprite element. You give the sprite element ID (which you get when you create a sprite element using layer_sprite_create() or when you use the function layer_sprite_get_id()), and the function will return real value for the y scale, where 1 is no scaling.

    +

     

    +

    Syntax:

    +

    layer_sprite_get_yscale(sprite_element_id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    sprite_element_idSprite Element IDThe unique ID value of the sprite element to get the information from
    +

     

    +

    Returns:

    +

    Real

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("sprite_sky");
    + var spr_id = layer_sprite_get_id(lay_id, "Clouds");
    + if (layer_sprite_get_yscale(spr_id) != 1)
    + {
    +     layer_sprite_yscale(spr_id, 1);
    + }

    +

    The above code will get the layer handle for the layer named "sprite_sky" and then use that to get the ID of the sprite element on that layer. This ID is then used to check the yscale value and if it is anything other than 1 it is set to 1.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2024 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Tile_Map_Layers/layer_tilemap_destroy.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Tile_Map_Layers/layer_tilemap_destroy.htm index f3dea04d7..98ef9b46d 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Tile_Map_Layers/layer_tilemap_destroy.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Tile_Map_Layers/layer_tilemap_destroy.htm @@ -1,70 +1,68 @@ - + - - - layer_tilemap_destroy - - - - - - - - - -

    layer_tilemap_destroy

    -

    This function will destroy the given tile map element.

    -

    You supply the tile map ID (which you get when you create the tile map using layer_tilemap_create() or when you use the layer handle along with layer_get_tilemap_id()) and this will remove it.

    -

    This does not remove the layer, only the tile map from it. If the tile map is one that has been added in the Room Editor, the next time you leave the room and then return, the tile map will be created again. If the room is persistent, however, the tile map will be removed unless room persistence is switched off again.

    -

    -

    Syntax:

    -

    layer_tilemap_destroy(tilemap_element_id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    tilemap_element_idTile Map Element IDThe unique ID value of the tile map to be destroyed
    -

    -

    Returns:

    -

    N/A

    -

    -

    Example:

    -

    var lay_id = layer_get_id("Tiles_trees"); -
    - var tile_id = layer_tilemap_get_id(lay_id); -
    - if (layer_tilemap_exists(lay_id, tile_id)) -
    - { -
    - layer_tilemap_destroy(tile_id); -
    - }

    -

    The above code checks the layer "Tiles_trees" to see if the given tile map element exists and if it does, then it is destroyed (but not the layer).

    -

    -

    -
    -
    -
    - - -
    + + + layer_tilemap_destroy + + + + + + + + + + +

    layer_tilemap_destroy

    +

    This function will destroy the given tile map element.

    +

    You supply the tile map ID (which you get when you create the tile map using layer_tilemap_create() or when you use the layer handle along with layer_get_tilemap_id()) and this will remove it.

    +

    This does not remove the layer, only the tile map from it. If the tile map is one that has been added in the Room Editor, the next time you leave the room and then return, the tile map will be created again. If the room is persistent, however, the tile map will be removed unless room persistence is switched off again.

    +

     

    +

    Syntax:

    +

    layer_tilemap_destroy(tilemap_element_id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    tilemap_element_idTile Map Element IDThe unique ID value of the tile map to be destroyed
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("Tiles_trees");
    + var tile_id = layer_tilemap_get_id(lay_id);
    + if (layer_tilemap_exists(lay_id, tile_id))
    + {
    +     layer_tilemap_destroy(tile_id);
    + }

    +

    The above code checks the layer "Tiles_trees" to see if the given tile map element exists and if it does, then it is destroyed (but not the layer).

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2023 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Tile_Map_Layers/layer_tilemap_exists.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Tile_Map_Layers/layer_tilemap_exists.htm index 7d6f03757..5b0aeca86 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Tile_Map_Layers/layer_tilemap_exists.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Rooms/Tile_Map_Layers/layer_tilemap_exists.htm @@ -1,74 +1,73 @@ - + - - - layer_tilemap_exists - - - - - - - - - - -

    layer_tilemap_exists

    -

    You can use this function to check and see if a tile map element exists on any given layer.

    -

    You supply the layer handle (which you get when you create the layer using layer_create()) or the layer name (as a string - this will have a performance impact) and the tile map element ID (which you get when you create a tile map element using layer_tilemap_create() or when you use the function layer_tilemap_get_id()) and the function will return either true if the element exists, or false if it does not.

    -

    This function works within the scope of the current target room - by default the room in which the function is called - which can be set using the function layer_set_target_room().

    -

    -

    Syntax:

    -

    layer_tilemap_exists(layer_id, tilemap_element_id)

    - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    layer_idString or Layer IDThe handle of the layer to target (or the layer name as a string)
    tilemap_element_idTile Map Element IDThe unique ID value of the tile map element to check
    -

    -

    Returns:

    -

    Boolean

    -

    -

    Example:

    -

    var lay_id = layer_get_id("tilemap_trees"); -
    - if (layer_tilemap_exists(lay_id, global.Treestilemap)) -
    - { -
    - layer_tilemap_destroy(lay_id, global.Treestilemap); -
    - }

    -

    The above code checks the layer "tilemap_trees" to see if the given tile map element exists and if it does, then it is destroyed (but not the layer).

    -

    -

    -
    -
    -
    - - -
    + + + layer_tilemap_exists + + + + + + + + + + + +

    layer_tilemap_exists

    +

    You can use this function to check and see if a tile map element exists on any given layer.

    +

    You supply the layer handle (which you get when you create the layer using layer_create()) or the layer name (as a string - this will have a performance impact) and the tile map element ID (which you get when you create a tile map element using layer_tilemap_create() or when you use the function layer_tilemap_get_id()) and the function will return either true if the element exists, or false if it does not.

    +

    This function works within the scope of the current target room - by default the room in which the function is called - which can be set using the function layer_set_target_room().

    +

     

    +

    Syntax:

    +

    layer_tilemap_exists(layer_id, tilemap_element_id)

    + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    layer_idString or LayerThe handle of the layer to target (or the layer name as a string)
    tilemap_element_idTile Map Element IDThe unique ID value of the tile map element to check
    +

     

    +

    Returns:

    +

    Boolean

    +

     

    +

    Example:

    +

    var lay_id = layer_get_id("tilemap_trees");
    + if (layer_tilemap_exists(lay_id, global.Treestilemap))
    + {
    +     layer_tilemap_destroy(lay_id, global.Treestilemap);
    + }

    +

    The above code checks the layer "tilemap_trees" to see if the given tile map element exists and if it does, then it is destroyed (but not the layer).

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2023 All Rights Reserved
    - + +--> + \ No newline at end of file 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 ce6adf3a3..7d2e1fd09 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 @@ -21,29 +21,29 @@

    room_get_info

    The format of the returned struct is as follows:

    room_info_struct =
    {
    - instances:
    - [
    - {/* Instance Info Struct */},
    - {/* Instance Info Struct */},
    - ],
    - layers:
    - [
    - {
    - elements:
    - [
    - {/* Layer Element Info Struct */},
    - {
    - /* Example */
    - type: layerelementtype_tilemap,
    - tiles: [/* Tile Map Data */]
    - }
    - ]
    - },
    - ],
    - views:
    - [
    - {/* View Info Struct */},
    - ]
    +     instances:
    +     [
    +         {/* Instance Info Struct */},
    +         {/* Instance Info Struct */},
    +     ],
    +     layers:
    +     [
    +         {
    +             elements:
    +             [
    +                 {/* Layer Element Info Struct */},
    +                     {
    +                         /* Example */
    +                         type: layerelementtype_tilemap,
    +                         tiles: [/* Tile Map Data */]
    +                     }
    +                 ]
    +             },
    +         ],
    +     views:
    +     [
    +         {/* View Info Struct */},
    +     ]
    }

    The tables below list all the possible structs that can be contained in the returned struct:

    Room Info

    @@ -144,7 +144,7 @@

    room_get_info

    This type of struct represents one instance in the room.

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

    - +
    @@ -159,62 +159,62 @@

    room_get_info

    - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_destroy.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_destroy.htm index 8ea536e58..60c8f95b4 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_destroy.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_destroy.htm @@ -1,69 +1,67 @@ - + - - - ds_grid_destroy - - - - - - - - - -

    ds_grid_destroy

    -

    This function will remove the given grid data structure from memory, freeing up the resources it was using and removing all values that it contained. This function should always be used when you are finished using the DS grid to prevent memory leaks that can slow down and crash your game.

    -
    -

    -

    Syntax:

    -

    ds_grid_destroy(index);

    -
    Instance Info Struct
    idObject InstanceObject Instance The instance ID
    object_indexStringString The name of the object this is an instance of (use asset_get_index to get the actual object)
    xRealReal The x coordinate of the instance's position
    yRealReal The y coordinate of the instance's position
    xscaleRealReal The x scale of the instance
    yscaleRealReal The y scale of the instance
    angleRealReal The rotation angle of the instance
    image_indexRealReal The image index used by the instance
    image_speedRealReal The image speed of the instance
    colourColourColour The blend colour used to draw the instance
    creation_codeScript FunctionScript Function The index of the script function that contains the instance's creation code
    pre_creation_codeScript FunctionScript Function The index of the script function that holds the pre-creation code for this specific instance, i.e. the overrides for its Object Variables as set in the Room Editor. See: Pre-creation Code
    - - - - - - - - - - - - -
    ArgumentTypeDescription
    indexDS GridThis handle of the grid to destroy.
    -

    -

    Returns:

    -

    N/A

    -

    -

    Example:

    -

    if (lives == 0) -
    - { -
    - ds_grid_destroy(Wall_Grid); -
    - Wall_Grid = -1; -
    - room_goto(rm_Menu); -
    - }

    -

    The above code will check the value of the built in global variable lives and if it is 0, it destroys the DS grid referenced in the variable Wall_Grid and then changes rooms.

    -

    -

    -
    -
    -
    -
    Back: DS Grids
    - -
    + + + ds_grid_destroy + + + + + + + + + + +

    ds_grid_destroy

    +

    This function will remove the given grid data structure from memory, freeing up the resources it was using and removing all values that it contained. This function should always be used when you are finished using the DS grid to prevent memory leaks that can slow down and crash your game.

    +
    +

     

    +

    Syntax:

    +

    ds_grid_destroy(index);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    indexDS GridThis handle of the grid to destroy.
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    if (lives == 0)
    + {
    +     ds_grid_destroy(Wall_Grid);
    +     Wall_Grid = -1;
    +     room_goto(rm_Menu);
    + }

    +

    The above code will check the value of the built in global variable lives and if it is 0, it destroys the DS grid referenced in the variable Wall_Grid and then changes rooms.

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Grids
    +
    -
    © Copyright YoYo Games Ltd. 2023 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_height.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_height.htm index 37feb0265..a1e6bc6e8 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_height.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_height.htm @@ -1,79 +1,73 @@ - + - - - ds_grid_height - - - - - - - - - - -

    ds_grid_height

    -

    This function will return the height of the given grid. This value is the number of cells the grid has along the y-axis and is always an integer, as shown in the image below:

    -

    DS grid height

    -

    -

    Syntax:

    -

    ds_grid_height(index);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    indexThis handle of the grid to find the height of.
    -

    -

    Returns:

    -

    -

    -

    Example:

    -

    for (var i = 0; i < ds_grid_width(grid); ++i) -
    - { -
    - for (var j = 0; j < ds_grid_height(grid); ++j) -
    - { -
    - if (ds_grid_get(grid, i, j) == 1) -
    - { -
    - instance_create_Layer(i * 32, j * 32, "Walls", obj_Wall); -
    - } -
    - } -
    - }

    -

    The above code will loop through the DS grid indexed in the variable "grid" and if the value found in any specific cell is equal to 1, it will then create an instance of "obj_Wall" at the appropriate position within the room.

    -

    -

    -

    -
    -
    -
    -
    Back: DS Grids
    - -
    + + + ds_grid_height + + + + + + + + + + + +

    ds_grid_height

    +

    This function will return the height of the given grid. This value is the number of cells the grid has along the y-axis and is always an integer, as shown in the image below:

    +

    DS grid height

    +

     

    +

    Syntax:

    +

    ds_grid_height(index);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    indexDS GridThis handle of the grid to find the height of.
    +

     

    +

    Returns:

    +

    Real

    +

     

    +

    Example:

    +

    for (var i = 0; i < ds_grid_width(grid); ++i)
    + {
    +     for (var j = 0; j < ds_grid_height(grid); ++j)
    +     {
    +         if (ds_grid_get(grid, i, j) == 1)
    +         {
    +             instance_create_Layer(i * 32, j * 32, "Walls", obj_Wall);
    +         }
    +     }
    + }

    +

    The above code will loop through the DS grid indexed in the variable "grid" and if the value found in any specific cell is equal to 1, it will then create an instance of "obj_Wall" at the appropriate position within the room.

    +

     

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Grids
    +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_set.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_set.htm index 1990611a1..8d623cbcd 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_set.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_set.htm @@ -1,100 +1,92 @@ - + - - - ds_grid_set - - - - - - - - - -

    ds_grid_set

    -

    This function can be used to set a given cell within the given DS grid to any value, which can be a real number or a string. The image below illustrates this:

    -

    DS grid set

    -

    Syntax:

    -

    ds_grid_set(index, x, y, value);

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    indexThis handle of the grid.
    xThe x position of the cell to set.
    yThe y position of the cell to set.
    valueThe value with which to set the cell.
    -

    -

    Returns:

    -

    -

    -

    Example:

    -

    grid = ds_grid_create(5, 5); -
    - var i = 0; -
    - var j = 0; -
    -
    - repeat (ds_grid_width(grid)) -
    - { -
    - repeat (ds_grid_height(grid)) -
    - { -
    - ds_grid_set(grid, i, j, irandom(9)); -
    - j += 1; -
    - } -
    -
    - j = 0; -
    - i += 1; -
    - }

    -

    The above code creates a grid and stores its index in the variable "grid". It then populates this grid with random integers from 0 to 9.

    -

    -

    -

    -
    -
    -
    -
    Back: DS Grids
    - -
    + + + ds_grid_set + + + + + + + + + + +

    ds_grid_set

    +

    This function can be used to set a given cell within the given DS grid to any value, which can be a real number or a string. The image below illustrates this:

    +

    DS grid set

    +

    Syntax:

    +

    ds_grid_set(index, x, y, value);

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    indexDS GridThis handle of the grid.
    xRealThe x position of the cell to set.
    yRealThe y position of the cell to set.
    valueAnyThe value with which to set the cell.
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    grid = ds_grid_create(5, 5);
    + var i = 0;
    + var j = 0;
    +
    + repeat (ds_grid_width(grid))
    + {
    +     repeat (ds_grid_height(grid))
    +     {
    +         ds_grid_set(grid, i, j, irandom(9));
    +         j += 1;
    +     }
    +     
    +     j = 0;
    +     i += 1;
    + } +

    +

    The above code creates a grid and stores its index in the variable "grid". It then populates this grid with random integers from 0 to 9.

    +

     

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Grids
    +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_value_disk_exists.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_value_disk_exists.htm index 6815ff0d4..8c1c6026b 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_value_disk_exists.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_value_disk_exists.htm @@ -1,88 +1,87 @@ - + - - - ds_grid_value_disk_exists - - - - - - - - - - -

    ds_grid_value_disk_exists

    -

    With this function you can check to see if a specific value (real or string) is present within a circular area of a given DS grid. If it is present the function will return true otherwise it will return false.

    -

    -

    Syntax:

    -

    ds_grid_value_disk_exists(index, xm, ym, r, val);

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    indexThe handle of the grid.
    xmThe x position of the disk on the grid.
    ymThe y position of the disk on the grid.
    rThe radius of the disk on the grid.
    valThe value to find.
    -

    -

    Returns:

    -

    -

    -

    Example:

    -

    if (ds_grid_value_disk_exists(grid, 5, 5, 5, val)) -
    - { -
    - xpos = ds_grid_value_disk_x(grid, 5, 5, 5, val); -
    - ypos = ds_grid_value_disk_y(grid, 5, 5, 5, val); -
    - }

    -

    The above code checks a DS grid for a specific value within a disk region. if it is found, it then stores the x and y position of the value in two variables for later use.

    -

    -

    -

    -
    -
    -
    -
    Back: DS Grids
    - -
    + + + ds_grid_value_disk_exists + + + + + + + + + + + +

    ds_grid_value_disk_exists

    +

    With this function you can check to see if a specific value (real or string) is present within a circular area of a given DS grid. If it is present the function will return true otherwise it will return false.

    +

     

    +

    Syntax:

    +

    ds_grid_value_disk_exists(index, xm, ym, r, val);

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    indexDS GridThe handle of the grid.
    xmRealThe x position of the disk on the grid.
    ymRealThe y position of the disk on the grid.
    rRealThe radius of the disk on the grid.
    valAnyThe value to find.
    +

     

    +

    Returns:

    +

    Boolean

    +

     

    +

    Example:

    +

    if (ds_grid_value_disk_exists(grid, 5, 5, 5, val))
    + {
    +     xpos = ds_grid_value_disk_x(grid, 5, 5, 5, val);
    +     ypos = ds_grid_value_disk_y(grid, 5, 5, 5, val);
    + }

    +

    The above code checks a DS grid for a specific value within a disk region. if it is found, it then stores the x and y position of the value in two variables for later use.

    +

     

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Grids
    +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_value_disk_x.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_value_disk_x.htm index 5d058ab34..86693d6c7 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_value_disk_x.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_value_disk_x.htm @@ -1,88 +1,87 @@ - + - - - ds_grid_value_disk_x - - - - - - - - - - -

    ds_grid_value_disk_x

    -

    With this function you can get the x coordinate (within the given grid disc-shaped region) of the value being searched for. You give the DS grid index (as returned by ds_grid_create()) along with the x/y positions for the center cell of the disk. Then you give the radius (as an integer value) around the center cell to search, before supplying the value to search for. If the value being searched for does not exist, then the function will return -1.

    -

    -

    Syntax:

    -

    ds_grid_value_disk_x(index, xm, ym, r, val);

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    indexThe handle of the grid.
    xmThe x position of the disk on the grid.
    ymThe y position of the disk on the grid.
    rThe radius of the disk on the grid.
    valThe value to find.
    -

    -

    Returns:

    -

    -

    -

    Example:

    -

    if (ds_grid_value_disk_exists(grid, 5, 5, 5, val)) -
    - { -
    - xpos = ds_grid_value_disk_x(grid, 5, 5, 5, val); -
    - ypos = ds_grid_value_disk_y(grid, 5, 5, 5, val); -
    - }

    -

    The above code checks a ds_grid for a specific value within a disk region. if it is found, it then stores the x and y position of the value in two variables for later use.

    -

    -

    -

    -
    -
    -
    -
    Back: DS Grids
    - -
    + + + ds_grid_value_disk_x + + + + + + + + + + + +

    ds_grid_value_disk_x

    +

    With this function you can get the x coordinate (within the given grid disc-shaped region) of the value being searched for. You give the DS grid index (as returned by ds_grid_create()) along with the x/y positions for the center cell of the disk. Then you give the radius (as an integer value) around the center cell to search, before supplying the value to search for. If the value being searched for does not exist, then the function will return -1.

    +

     

    +

    Syntax:

    +

    ds_grid_value_disk_x(index, xm, ym, r, val);

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    indexDS GridThe handle of the grid.
    xmRealThe x position of the disk on the grid.
    ymRealThe y position of the disk on the grid.
    rRealThe radius of the disk on the grid.
    valAnyThe value to find.
    +

     

    +

    Returns:

    +

    Real

    +

     

    +

    Example:

    +

    if (ds_grid_value_disk_exists(grid, 5, 5, 5, val))
    + {
    +     xpos = ds_grid_value_disk_x(grid, 5, 5, 5, val);
    +     ypos = ds_grid_value_disk_y(grid, 5, 5, 5, val);
    + }

    +

    The above code checks a ds_grid for a specific value within a disk region. if it is found, it then stores the x and y position of the value in two variables for later use.

    +

     

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Grids
    +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_value_disk_y.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_value_disk_y.htm index 3d8d7a10f..7cdd8eec3 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_value_disk_y.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_value_disk_y.htm @@ -1,88 +1,87 @@ - + - - - ds_grid_value_disk_y - - - - - - - - - - -

    ds_grid_value_disk_y

    -

    With this function you can get the y coordinate (within the given grid disc-shaped region) of the value being searched for. You give the DS grid index (as returned by ds_grid_create()) along with the x/y positions for the center cell of the disk. Then you give the radius (as an integer value) around the center cell to search, before supplying the value to search for. If the value being searched for does not exist, then the function will return -1.

    -

    -

    Syntax:

    -

    ds_grid_value_disk_y(index, xm, ym, r, val);

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    indexThe handle of the grid.
    xmThe x position of the disk on the grid.
    ymThe y position of the disk on the grid.
    rThe radius of the disk on the grid.
    valThe value to find.
    -

    -

    Returns:

    -

    -

    -

    Example:

    -

    if (ds_grid_value_disk_exists(grid, 5, 5, 5, val)) -
    - { -
    - xpos = ds_grid_value_disk_x(grid, 5, 5, 5, val); -
    - ypos = ds_grid_value_disk_y(grid, 5, 5, 5, val); -
    - }

    -

    The above code checks a DS grid for a specific value within a disk region. if it is found, it then stores the x and y position of the value in two variables for later use.

    -

    -

    -

    -
    -
    -
    -
    Back: DS Grids
    - -
    + + + ds_grid_value_disk_y + + + + + + + + + + + +

    ds_grid_value_disk_y

    +

    With this function you can get the y coordinate (within the given grid disc-shaped region) of the value being searched for. You give the DS grid index (as returned by ds_grid_create()) along with the x/y positions for the center cell of the disk. Then you give the radius (as an integer value) around the center cell to search, before supplying the value to search for. If the value being searched for does not exist, then the function will return -1.

    +

     

    +

    Syntax:

    +

    ds_grid_value_disk_y(index, xm, ym, r, val);

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    indexDS GridThe handle of the grid.
    xmRealThe x position of the disk on the grid.
    ymRealThe y position of the disk on the grid.
    rRealThe radius of the disk on the grid.
    valAnyThe value to find.
    +

     

    +

    Returns:

    +

    Real

    +

     

    +

    Example:

    +

    if (ds_grid_value_disk_exists(grid, 5, 5, 5, val))
    + {
    +     xpos = ds_grid_value_disk_x(grid, 5, 5, 5, val);
    +     ypos = ds_grid_value_disk_y(grid, 5, 5, 5, val);
    + }

    +

    The above code checks a DS grid for a specific value within a disk region. if it is found, it then stores the x and y position of the value in two variables for later use.

    +

     

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Grids
    +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_value_exists.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_value_exists.htm index aaf644b6c..5e579ac8d 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_value_exists.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_value_exists.htm @@ -1,93 +1,92 @@ - + - - - ds_grid_value_exists - - - - - - - - - - -

    ds_grid_value_exists

    -

    With this function you can check to see if a specific value (real or string) is present within a rectangular area of a given DS grid. If it is present the function will return true otherwise it will return false.

    -

    -

    Syntax:

    -

    ds_grid_value_exists(index, x1, y1, x2, y2, val);

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    indexThe handle of the grid.
    x1The x position of the left of the region in the grid.
    y1The y position of the top of the region in the grid.
    x2The x position of the right of the region in the grid.
    y2The y position of the bottom of the region in the grid.
    valThe value to find.
    -

    -

    Returns:

    -

    -

    -

    Example:

    -

    if (ds_grid_value_exists(grid, 0, 1, 5, 6, val)) -
    - { -
    - xpos = ds_grid_value_x(grid, 0, 1, 5, 6, val); -
    - ypos = ds_grid_value_y(grid, 0, 1, 5, 6, val); -
    - }

    -

    The above code checks a DS grid for a specific value within a rectangular region. if it is found, it then stores the x and y position of the value in two variables for later use.

    -

    -

    -

    -
    -
    -
    -
    Back: DS Grids
    - -
    + + + ds_grid_value_exists + + + + + + + + + + + +

    ds_grid_value_exists

    +

    With this function you can check to see if a specific value (real or string) is present within a rectangular area of a given DS grid. If it is present the function will return true otherwise it will return false.

    +

     

    +

    Syntax:

    +

    ds_grid_value_exists(index, x1, y1, x2, y2, val);

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    indexDS GridThe handle of the grid.
    x1RealThe x position of the left of the region in the grid.
    y1RealThe y position of the top of the region in the grid.
    x2RealThe x position of the right of the region in the grid.
    y2RealThe y position of the bottom of the region in the grid.
    valAnyThe value to find.
    +

     

    +

    Returns:

    +

    Boolean

    +

     

    +

    Example:

    +

    if (ds_grid_value_exists(grid, 0, 1, 5, 6, val))
    + {
    +     xpos = ds_grid_value_x(grid, 0, 1, 5, 6, val);
    +     ypos = ds_grid_value_y(grid, 0, 1, 5, 6, val);
    + }

    +

    The above code checks a DS grid for a specific value within a rectangular region. if it is found, it then stores the x and y position of the value in two variables for later use.

    +

     

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Grids
    +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_value_x.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_value_x.htm index 565ad788c..fbc95f269 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_value_x.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_value_x.htm @@ -1,93 +1,92 @@ - + - - - ds_grid_value_x - - - - - - - - - - -

    ds_grid_value_x

    -

    With this function you can get the x coordinate (within the given rectangular grid region) of the value being searched for. You give the DS grid index (as returned by ds_grid_create()) along with the x/y positions for the top left and bottom right corners of the grid region to search, before supplying the value to search for. If the value being searched for does not exist, then the function will return -1.

    -

    -

    Syntax:

    -

    ds_grid_value_x(index, x1, y1, x2, y2, val);

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    indexThe handle of the grid.
    x1The x position of the left of the region in the grid, from 0 to (grid width - 1).
    y1The y position of the top of the region in the grid, from 0 to (grid height - 1).
    x2The x position of the right of the region in the grid, from 0 to (grid width - 1).
    y2The y position of the bottom of the region in the grid, from 0 to (grid height - 1).
    valThe value to find.
    -

    -

    Returns:

    -

    -

    -

    Example:

    -

    if (ds_grid_value_exists(grid, 0, 1, 5, 6, val)) -
    - { -
    - xpos = ds_grid_value_x(grid, 0, 1, 5, 6, val); -
    - ypos = ds_grid_value_y(grid, 0, 1, 5, 6, val); -
    - }

    -

    The above code checks a ds_grid for a specific value within a rectangular region. if it is found, it then stores the x and y position of the value in two variables for later use.

    -

    -

    -

    -
    -
    -
    -
    Back: DS Grids
    - -
    + + + ds_grid_value_x + + + + + + + + + + + +

    ds_grid_value_x

    +

    With this function you can get the x coordinate (within the given rectangular grid region) of the value being searched for. You give the DS grid index (as returned by ds_grid_create()) along with the x/y positions for the top left and bottom right corners of the grid region to search, before supplying the value to search for. If the value being searched for does not exist, then the function will return -1.

    +

     

    +

    Syntax:

    +

    ds_grid_value_x(index, x1, y1, x2, y2, val);

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    indexDS GridThe handle of the grid.
    x1RealThe x position of the left of the region in the grid, from 0 to (grid width - 1).
    y1RealThe y position of the top of the region in the grid, from 0 to (grid height - 1).
    x2RealThe x position of the right of the region in the grid, from 0 to (grid width - 1).
    y2RealThe y position of the bottom of the region in the grid, from 0 to (grid height - 1).
    valAnyThe value to find.
    +

     

    +

    Returns:

    +

    Real

    +

     

    +

    Example:

    +

    if (ds_grid_value_exists(grid, 0, 1, 5, 6, val))
    + {
    +     xpos = ds_grid_value_x(grid, 0, 1, 5, 6, val);
    +     ypos = ds_grid_value_y(grid, 0, 1, 5, 6, val);
    + }

    +

    The above code checks a ds_grid for a specific value within a rectangular region. if it is found, it then stores the x and y position of the value in two variables for later use.

    +

     

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Grids
    +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_value_y.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_value_y.htm index 83e9f3ab7..80d3b7d0d 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_value_y.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_value_y.htm @@ -1,93 +1,92 @@ - + - - - ds_grid_value_y - - - - - - - - - - -

    ds_grid_value_y

    -

    With this function you can get the y coordinate (within the given rectangular grid region) of the value being searched for. You give the DS grid index (as returned by ds_grid_create()) along with the x/y positions for the top left and bottom right corners of the grid region to search, before supplying the value to search for. If the value being searched for does not exist, then the function will return -1.

    -

    -

    Syntax:

    -

    ds_grid_value_y(index, x1, y1, x2, y2, val);

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    indexThe handle of the grid.
    x1The x position of the left of the region in the grid, from 0 to (grid width - 1).
    y1The y position of the top of the region in the grid, from 0 to (grid height - 1).
    x2The x position of the right of the region in the grid, from 0 to (grid width - 1).
    y2The y position of the bottom of the region in the grid, from 0 to (grid height - 1)
    valThe value to find.
    -

    -

    Returns:

    -

    -

    -

    Example:

    -

    if (ds_grid_value_exists(grid, 0, 1, 5, 6, val)) -
    - { -
    - xpos = ds_grid_value_x(grid, 0, 1, 5, 6, val); -
    - ypos = ds_grid_value_y(grid, 0, 1, 5, 6, val); -
    - }

    -

    The above code checks a ds_grid for a specific value within a rectangular region. if it is found, it then stores the x and y position of the value in two variables for later use.

    -

    -

    -

    -
    -
    -
    -
    Back: DS Grids
    - -
    + + + ds_grid_value_y + + + + + + + + + + + +

    ds_grid_value_y

    +

    With this function you can get the y coordinate (within the given rectangular grid region) of the value being searched for. You give the DS grid index (as returned by ds_grid_create()) along with the x/y positions for the top left and bottom right corners of the grid region to search, before supplying the value to search for. If the value being searched for does not exist, then the function will return -1.

    +

     

    +

    Syntax:

    +

    ds_grid_value_y(index, x1, y1, x2, y2, val);

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    indexDS GridThe handle of the grid.
    x1RealThe x position of the left of the region in the grid, from 0 to (grid width - 1).
    y1RealThe y position of the top of the region in the grid, from 0 to (grid height - 1).
    x2RealThe x position of the right of the region in the grid, from 0 to (grid width - 1).
    y2RealThe y position of the bottom of the region in the grid, from 0 to (grid height - 1)
    valAnyThe value to find.
    +

     

    +

    Returns:

    +

    Real

    +

     

    +

    Example:

    +

    if (ds_grid_value_exists(grid, 0, 1, 5, 6, val))
    + {
    +     xpos = ds_grid_value_x(grid, 0, 1, 5, 6, val);
    +     ypos = ds_grid_value_y(grid, 0, 1, 5, 6, val);
    + }

    +

    The above code checks a ds_grid for a specific value within a rectangular region. if it is found, it then stores the x and y position of the value in two variables for later use.

    +

     

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Grids
    +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_width.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_width.htm index f522ce46c..812a0e821 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_width.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Grids/ds_grid_width.htm @@ -1,78 +1,72 @@ - + - - - ds_grid_width - - - - - - - - - - -

    ds_grid_width

    -

    This function will return the width of the given grid. This value is the number of cells the grid has along the x-axis and is always an integer, as shown in the image below:

    -

    DS grid width

    -

    Syntax:

    -

    ds_grid_width(index);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    indexThis handle of the grid to find the width of.
    -

    -

    Returns:

    -

    -

    -

    Example:

    -

    for (var i = 0; i < ds_grid_width(grid); ++i) -
    - { -
    - for (var j = 0; j < ds_grid_height(grid); ++j) -
    - { -
    - if (ds_grid_get(grid, i, j) == 1) -
    - { -
    - instance_create_layer(i * 32, j * 32, "Walls", obj_Wall); -
    - } -
    - } -
    - }

    -

    The above code will loop through the DS grid indexed in the variable "grid" and if the value found in any specific cell is equal to 1, it will then create an instance of "obj_Wall" at the appropriate position within the room.

    -

    -

    -

    -
    -
    -
    -
    Back: DS Grids
    - -
    + + + ds_grid_width + + + + + + + + + + + +

    ds_grid_width

    +

    This function will return the width of the given grid. This value is the number of cells the grid has along the x-axis and is always an integer, as shown in the image below:

    +

    DS grid width

    +

    Syntax:

    +

    ds_grid_width(index);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    indexDS GridThis handle of the grid to find the width of.
    +

     

    +

    Returns:

    +

    Real

    +

     

    +

    Example:

    +

    for (var i = 0; i < ds_grid_width(grid); ++i)
    + {
    +     for (var j = 0; j < ds_grid_height(grid); ++j)
    +     {
    +         if (ds_grid_get(grid, i, j) == 1)
    +         {
    +             instance_create_layer(i * 32, j * 32, "Walls", obj_Wall);
    +         }
    +     }
    + }

    +

    The above code will loop through the DS grid indexed in the variable "grid" and if the value found in any specific cell is equal to 1, it will then create an instance of "obj_Wall" at the appropriate position within the room.

    +

     

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Grids
    +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_clear.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_clear.htm index 48200ad4c..65bd4f783 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_clear.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_clear.htm @@ -1,68 +1,66 @@ - + - - - ds_list_clear - - - - - - - - - -

    ds_list_clear

    -

    With this function you can clear all data from the given list data-structure. This does NOT destroy the data-structure (for that you should use ds_list_destroy()) it only wipes all data from it and makes the list empty (zero in size). Note that clearing a list will de-reference any data structures stored in it giving a memory leak, so you would need to go through the list and destroy all data structure items manually before clearing it to prevent this. The only time this is not required is when you have flagged any items in the list as another DS list or as a DS map, in which case these items will be destroyed (not cleared!) and their memory cleaned up automatically when the parent is cleared.

    -

    -

    Syntax:

    -

    ds_list_clear(id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idDS List IDThe handle of the data structure to clear.
    -

    -

    Returns:

    -

    N/A

    -

    -

    Example:

    -

    if (count == 15) && (!ds_list_empty(command_list)) -
    - { -
    - ds_list_clear(command_list); -
    - alarm[0] = game_get_speed(gamespeed_fps); -
    - ai_count = 0; -
    - }

    -

    The above code checks a variable to see if it has reached a specific value and if it has it clears the DS list indexed in the variable "command_list", sets an alarm, and resets the variable to 0.

    -

    -

    -
    -
    -
    -
    Back: DS Lists
    - -
    + + + ds_list_clear + + + + + + + + + + +

    ds_list_clear

    +

    With this function you can clear all data from the given list data-structure. This does NOT destroy the data-structure (for that you should use ds_list_destroy()) it only wipes all data from it and makes the list empty (zero in size). Note that clearing a list will de-reference any data structures stored in it giving a memory leak, so you would need to go through the list and destroy all data structure items manually before clearing it to prevent this. The only time this is not required is when you have flagged any items in the list as another DS list or as a DS map, in which case these items will be destroyed (not cleared!) and their memory cleaned up automatically when the parent is cleared.

    +

     

    +

    Syntax:

    +

    ds_list_clear(id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS ListThe handle of the data structure to clear.
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    if (count == 15) && (!ds_list_empty(command_list))
    + {
    +     ds_list_clear(command_list);
    +     alarm[0] = game_get_speed(gamespeed_fps);
    +     ai_count = 0;
    + }

    +

    The above code checks a variable to see if it has reached a specific value and if it has it clears the DS list indexed in the variable "command_list", sets an alarm, and resets the variable to 0.

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Lists
    +
    -
    © Copyright YoYo Games Ltd. 2023 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_copy.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_copy.htm index 3dcdb2ecd..f9cb8fc0b 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_copy.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_copy.htm @@ -45,9 +45,9 @@

    Returns:

    Example:

    if (!ds_list_empty(main_list))
    {
    - old_list = ds_list_create();
    - ds_list_copy(old_list, main_list);
    - ds_list_clear(main_list);
    +     old_list = ds_list_create();
    +     ds_list_copy(old_list, main_list);
    +     ds_list_clear(main_list);
    }

    The above code will check a DS list to see if it is empty. If it is not empty it is copied into another DS list (which has been created previously) and then the original list is cleared.

     

    diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_delete.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_delete.htm index 8177bc34f..b5229050d 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_delete.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_delete.htm @@ -1,76 +1,73 @@ - + - - - ds_list_delete - - - - - - - - - -

    ds_list_delete

    -

    With this function you can remove the value stored at a specific position within the list.

    -

    -

    Syntax:

    -

    ds_list_delete(id, pos);

    - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idThe handle of the list to change.
    posWhere in the list to delete the value.
    -

    -

    Returns:

    -

    -

    -

    Example:

    -

    if (ds_list_size(sc_list) > 10) -
    - { -
    - while (ds_list_size(sc_list) > 10) -
    - { -
    - ds_list_delete(sc_list, 0); -
    - } -
    - }

    -

    The above code checks the size of a DS list and if it is larger than ten, it loops through the list removing the top value (position 0) until the list has only 10 entries.

    -

    -

    -

    -
    -
    -
    -
    Back: DS Lists
    - -
    + + + ds_list_delete + + + + + + + + + + +

    ds_list_delete

    +

    With this function you can remove the value stored at a specific position within the list.

    +

     

    +

    Syntax:

    +

    ds_list_delete(id, pos);

    + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS ListThe handle of the list to change.
    posRealWhere in the list to delete the value.
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    if (ds_list_size(sc_list) > 10)
    + {
    +     while (ds_list_size(sc_list) > 10)
    +     {
    +         ds_list_delete(sc_list, 0);
    +     }
    + }

    +

    The above code checks the size of a DS list and if it is larger than ten, it loops through the list removing the top value (position 0) until the list has only 10 entries.

    +

     

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Lists
    +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_destroy.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_destroy.htm index 54967aaff..5b250f69d 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_destroy.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_destroy.htm @@ -1,70 +1,68 @@ - + - - - ds_list_destroy - - - - - - - - - -

    ds_list_destroy

    -

    This function will remove the given list data structure from memory, freeing up the resources it was using and removing all values that it contained. This function should always be used when you are finished using the DS list to prevent memory leaks that can slow down and crash your game.

    -

    Destroying a list will de-reference any data structures stored in it giving a memory leak, so you would need to go through the list and destroy all data structure items manually before destroying it to prevent this. The only time this is not required is when you have flagged any items in the list as another DS list or as a DS map, in which case these items will be destroyed and their memory cleaned up automatically as well.

    -
    -

    -

    Syntax:

    -

    ds_list_destroy(id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idDS ListThe handle of the data structure to remove.
    -

    -

    Returns:

    -

    N/A

    -

    -

    Example:

    -

    if (lives == 0) -
    - { -
    - ds_list_destroy(AI_list); -
    - AI_list = -1; -
    - room_goto(rm_Menu); -
    - }

    -

    The above code will check the value of the built-in global variable lives and if it is 0, it destroys the DS list indexed in the variable AI_list and then changes rooms.

    -

    -

    -
    -
    -
    -
    Back: DS Lists
    - -
    + + + ds_list_destroy + + + + + + + + + + +

    ds_list_destroy

    +

    This function will remove the given list data structure from memory, freeing up the resources it was using and removing all values that it contained. This function should always be used when you are finished using the DS list to prevent memory leaks that can slow down and crash your game.

    +

    Destroying a list will de-reference any data structures stored in it giving a memory leak, so you would need to go through the list and destroy all data structure items manually before destroying it to prevent this. The only time this is not required is when you have flagged any items in the list as another DS list or as a DS map, in which case these items will be destroyed and their memory cleaned up automatically as well.

    +
    +

     

    +

    Syntax:

    +

    ds_list_destroy(id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS ListThe handle of the data structure to remove.
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    if (lives == 0)
    + {
    +     ds_list_destroy(AI_list);
    +     AI_list = -1;
    +     room_goto(rm_Menu);
    + }

    +

    The above code will check the value of the built-in global variable lives and if it is 0, it destroys the DS list indexed in the variable AI_list and then changes rooms.

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Lists
    +
    -
    © Copyright YoYo Games Ltd. 2024 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_empty.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_empty.htm index a57ad418a..c5850513c 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_empty.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_empty.htm @@ -1,69 +1,67 @@ - + - - - ds_list_empty - - - - - - - - - - -

    ds_list_empty

    -

    With this function you can check the given DS list to see if it is empty (returns true) or not (returns false).

    -

    -

    Syntax:

    -

    ds_list_empty(id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idDS List idThe handle of the data structure to check.
    -

    -

    Returns:

    -

    Boolean

    -

    -

    Example:

    -

    if (count == 15( && (!ds_list_empty(command_list)) -
    - { -
    - ds_list_clear(command_list); -
    - alarm[0] = game_get_speed(gamespeed_fps); -
    - count = 0; -
    - }

    -

    The above code checks a variable to see if it has reached a specific value and if it has it clears the DS list indexed in the variable "command_list", sets an alarm, and resets the variable to 0.

    -

    -

    -
    -
    -
    -
    Back: DS Lists
    - -
    + + + ds_list_empty + + + + + + + + + + + +

    ds_list_empty

    +

    With this function you can check the given DS list to see if it is empty (returns true) or not (returns false).

    +

     

    +

    Syntax:

    +

    ds_list_empty(id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS List idThe handle of the data structure to check.
    +

     

    +

    Returns:

    +

    Boolean

    +

     

    +

    Example:

    +

    if (count == 15( && (!ds_list_empty(command_list))
    + {
    +     ds_list_clear(command_list);
    +     alarm[0] = game_get_speed(gamespeed_fps);
    +     count = 0;
    + }

    +

    The above code checks a variable to see if it has reached a specific value and if it has it clears the DS list indexed in the variable "command_list", sets an alarm, and resets the variable to 0.

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Lists
    +
    -
    © Copyright YoYo Games Ltd. 2023 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_is_list.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_is_list.htm index d1f10a47a..4efdc8b40 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_is_list.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_is_list.htm @@ -1,81 +1,76 @@ - + - - - ds_list_is_list - - - - - - - - - - -

    ds_list_is_list

    -

    With this function you can check to see if another DS list is stored at the given position within a DS list. If the given position contains a DS list ID, then the function will return true otherwise it will return false.

    -

    This will only detect lists that were manually marked using the ds_list_mark_as_list function.

    -

    -

    Syntax:

    -

    ds_list_is_list(id, pos);

    - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idDS ListThe handle of the list to check.
    posRealThe position within the list to check.
    -

    -

    Returns:

    -

    Boolean

    -

    -

    Example:

    -

    var size = ds_list_size(ships); -
    - for (var i = 0; i < size; i++) -
    - { -
    - if (ds_list_is_list(ships, i)) -
    - { -
    - ds_list_destroy(ships[| i]); -
    - } -
    - } -
    - ds_list_destroy(ships);

    -

    The above code loops through a DS list and checks to see if any of the entries contain other list IDs. If they do, then these lists are destroyed, and then the main list is destroyed after the loop is finished.

    -

    -

    -
    -
    -
    -
    Back: DS Lists
    - -
    + + + ds_list_is_list + + + + + + + + + + + +

    ds_list_is_list

    +

    With this function you can check to see if another DS list is stored at the given position within a DS list. If the given position contains a DS list ID, then the function will return true otherwise it will return false.

    +

    This will only detect lists that were manually marked using the ds_list_mark_as_list function.

    +

     

    +

    Syntax:

    +

    ds_list_is_list(id, pos);

    + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS ListThe handle of the list to check.
    posRealThe position within the list to check.
    +

     

    +

    Returns:

    +

    Boolean

    +

     

    +

    Example:

    +

    var size = ds_list_size(ships);
    + for (var i = 0; i < size; i++)
    + {
    +     if (ds_list_is_list(ships, i))
    +     {
    +         ds_list_destroy(ships[| i]);
    +     }
    + }
    + ds_list_destroy(ships);

    +

    The above code loops through a DS list and checks to see if any of the entries contain other list IDs. If they do, then these lists are destroyed, and then the main list is destroyed after the loop is finished.

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Lists
    +
    -
    © Copyright YoYo Games Ltd. 2023 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_is_map.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_is_map.htm index 94fe04058..a61969880 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_is_map.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_is_map.htm @@ -1,81 +1,76 @@ - + - - - ds_list_is_map - - - - - - - - - - -

    ds_list_is_map

    -

    With this function you can check to see if a DS map is stored at the given position within a DS list. If the given position contains a DS map ID, then the function will return true otherwise it will return false.

    -

    This will only detect maps that were manually marked using the ds_list_mark_as_map function.

    -

    -

    Syntax:

    -

    ds_list_is_map(id, pos);

    - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idDS ListThe handle of the list to check.
    posRealThe position within the list to check.
    -

    -

    Returns:

    -

    Boolean

    -

    -

    Example:

    -

    var size = ds_list_size(ships); -
    - for (var i = 0; i < size; i++) -
    - { -
    - if (ds_list_is_map(ships, i)) -
    - { -
    - ds_map_destroy(ships[| i]); -
    - } -
    - } -
    - ds_list_destroy(ships);

    -

    The above code loops through a DS list and checks to see if any of the entries contain map IDs. If they do, then these maps are destroyed, and then the main list is destroyed after the loop is finished.

    -

    -

    -
    -
    -
    -
    Back: DS Lists
    - -
    + + + ds_list_is_map + + + + + + + + + + + +

    ds_list_is_map

    +

    With this function you can check to see if a DS map is stored at the given position within a DS list. If the given position contains a DS map ID, then the function will return true otherwise it will return false.

    +

    This will only detect maps that were manually marked using the ds_list_mark_as_map function.

    +

     

    +

    Syntax:

    +

    ds_list_is_map(id, pos);

    + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS ListThe handle of the list to check.
    posRealThe position within the list to check.
    +

     

    +

    Returns:

    +

    Boolean

    +

     

    +

    Example:

    +

    var size = ds_list_size(ships);
    + for (var i = 0; i < size; i++)
    + {
    +     if (ds_list_is_map(ships, i))
    +     {
    +         ds_map_destroy(ships[| i]);
    +     }
    + }
    + ds_list_destroy(ships);

    +

    The above code loops through a DS list and checks to see if any of the entries contain map IDs. If they do, then these maps are destroyed, and then the main list is destroyed after the loop is finished.

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Lists
    +
    -
    © Copyright YoYo Games Ltd. 2023 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_read.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_read.htm index ad3e7dec8..9329fcab3 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_read.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_read.htm @@ -1,84 +1,80 @@ - + - - - ds_list_read - - - - - - - - - -

    ds_list_read

    -

    With this function you can recreate a saved DS list (one that has previously been written as a string using ds_list_write()). You must first create a new DS list to read the string into, and if the DS list already exists and has information stored in it, then this will be cleared before reading. This function is of vital importance when creating save/load mechanisms for your game.

    -

    Note that if the specified DS string was written by the GameMaker: Studio 1.2.x runtime (or older), you should specify the optional argument "legacy", setting it to true as the string format changed after that.

    -

    -

    Syntax:

    -

    ds_list_read(id, str [, legacy]);

    - - - - - - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idDS List IDThe handle of the data structure to read into.
    strStringThe string to read from.
    legacyBooleanOPTIONAL Can be either true or false or omitted completely.
    -

    -

    Returns:

    -

    N/A

    -

    -

    Example:

    -

    list = ds_list_create(); -
    - ini_open("save.ini"); -
    - var str = ini_read_string("Lists", "0", ""); -
    - if (str != "") -
    - { -
    - ds_list_read(list, str); -
    - } -
    - ini_close();

    -

    The above code creates a list and stores the index in the variable "list". It then opens an ini file and reads a string from that, checking to make sure that the string is not returned as empty first. This string is then read into the newly created ds_list.

    -

    -

    -

    -
    -
    -
    -
    Back: DS Lists
    - -
    + + + ds_list_read + + + + + + + + + + +

    ds_list_read

    +

    With this function you can recreate a saved DS list (one that has previously been written as a string using ds_list_write()). You must first create a new DS list to read the string into, and if the DS list already exists and has information stored in it, then this will be cleared before reading. This function is of vital importance when creating save/load mechanisms for your game.

    +

    Note that if the specified DS string was written by the GameMaker: Studio 1.2.x runtime (or older), you should specify the optional argument "legacy", setting it to true as the string format changed after that.

    +

     

    +

    Syntax:

    +

    ds_list_read(id, str [, legacy]);

    + + + + + + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS ListThe handle of the data structure to read into.
    strStringThe string to read from.
    legacyBooleanOPTIONAL Can be either true or false or omitted completely.
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    list = ds_list_create();
    + ini_open("save.ini");
    + var str = ini_read_string("Lists", "0", "");
    + if (str != "")
    + {
    +     ds_list_read(list, str);
    + }
    + ini_close();

    +

    The above code creates a list and stores the index in the variable "list". It then opens an ini file and reads a string from that, checking to make sure that the string is not returned as empty first. This string is then read into the newly created ds_list.

    +

     

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Lists
    +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_shuffle.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_shuffle.htm index c2f4128c5..d057eab70 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_shuffle.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_shuffle.htm @@ -1,66 +1,66 @@ - + - - - ds_list_shuffle - - - - - - - - - -

    ds_list_shuffle

    -

    With this function you can shuffle a list, which will re-order all the component values into random positions from those in which they were originally added to the list.

    -
    -

    -

    Syntax:

    -

    ds_list_shuffle(id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idDS List IDThe handle of the list to shuffle.
    -

    -

    Returns:

    -

    N/A

    -

    -

    Example:

    -

    if (restart) -
    - { -
    - ds_list_shuffle(card_list); -
    - }

    -

    The above code will shuffle the list indexed in the variable "card_list" if the variable "restart" is flagged as true.

    -

    -

    -

    -
    -
    -
    -
    Back: DS Lists
    - -
    + + + ds_list_shuffle + + + + + + + + + + +

    ds_list_shuffle

    +

    With this function you can shuffle a list, which will re-order all the component values into random positions from those in which they were originally added to the list.

    +
    +

     

    +

    Syntax:

    +

    ds_list_shuffle(id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS ListThe handle of the list to shuffle.
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    if (restart)
    + {
    +     ds_list_shuffle(card_list);
    + }

    +

    The above code will shuffle the list indexed in the variable "card_list" if the variable "restart" is flagged as true.

    +

     

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Lists
    +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_size.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_size.htm index da08eaf51..9fc188dec 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_size.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_size.htm @@ -1,66 +1,66 @@ - + - - - ds_list_size - - - - - - - - - - -

    ds_list_size

    -

    This function will return the "size" of the list, ie: the number of items that have been added into it.

    -

    -

    Syntax:

    -

    ds_list_size(id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idThe handle of the data structure to check.
    -

    -

    Returns:

    -

    -

    -

    Example:

    -

    if (!ds_list_empty(control_list)) -
    - { -
    - num = ds_list_size(control_list); -
    - }

    -

    The above code checks a DS list to see if it is empty or not, and if it is not, it gets the number of items that it contains and stores the value in a variable.

    -

    -

    -

    -
    -
    -
    -
    Back: DS Lists
    - -
    + + + ds_list_size + + + + + + + + + + + +

    ds_list_size

    +

    This function will return the "size" of the list, ie: the number of items that have been added into it.

    +

     

    +

    Syntax:

    +

    ds_list_size(id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS ListThe handle of the data structure to check.
    +

     

    +

    Returns:

    +

    Real

    +

     

    +

    Example:

    +

    if (!ds_list_empty(control_list))
    + {
    +     num = ds_list_size(control_list);
    + }

    +

    The above code checks a DS list to see if it is empty or not, and if it is not, it gets the number of items that it contains and stores the value in a variable.

    +

     

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Lists
    +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_sort.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_sort.htm index fdb9ca3fe..778a442d5 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_sort.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Lists/ds_list_sort.htm @@ -1,70 +1,70 @@ - + - - - ds_list_sort - - - - - - - - - -

    ds_list_sort

    -

    With this function you can sort all the values within a list, either in ascending or descending order. If the list contains strings, these will be sorted alphabetically, based on the English 26 letter alphabet.

    -

    -

    Syntax:

    -

    ds_list_sort(id, ascend);

    - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idThe handle of the list to sort.
    ascendWhether the values should be ascending (true) or descending (false) order.
    -

    -

    Returns:

    -

    -

    -

    Example:

    -

    if (newgame) -
    - { -
    - ds_list_sort(name_list, true); -
    - }

    -

    The above code will sort the list indexed in the variable "name_list" if the variable "newgame" is flagged as true.

    -

    -

    -

    -
    -
    -
    -
    Back: DS Lists
    - -
    + + + ds_list_sort + + + + + + + + + + +

    ds_list_sort

    +

    With this function you can sort all the values within a list, either in ascending or descending order. If the list contains strings, these will be sorted alphabetically, based on the English 26 letter alphabet.

    +

     

    +

    Syntax:

    +

    ds_list_sort(id, ascend);

    + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS ListThe handle of the list to sort.
    ascendBooleanWhether the values should be ascending (true) or descending (false) order.
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    if (newgame)
    + {
    +     ds_list_sort(name_list, true);
    + }

    +

    The above code will sort the list indexed in the variable "name_list" if the variable "newgame" is flagged as true.

    +

     

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Lists
    +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_clear.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_clear.htm index 1e25c3754..f26402101 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_clear.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_clear.htm @@ -1,65 +1,65 @@ - + - - - ds_map_clear - - - - - - - - - -

    ds_map_clear

    -

    This function will clear the (previously created) DS map of all key/value pairs, but it will not delete the DS map itself from memory. For that you should use the function ds_map_destroy(). Note that clearing a map will de-reference any data structures stored in the map giving a memory leak, so you would need to go through it and destroy all data structure items manually before clearing the map to prevent this. The only time this is not required is when you have flagged any items in the map as a DS list or as another DS map, in which case these items will be destroyed (not cleared!) and their memory cleaned up automatically when the parent map is cleared.

    -

    -

    Syntax:

    -

    ds_map_clear(id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idThe handle of the data structure to clear.
    -

    -

    Returns:

    -

    -

    -

    Example:

    -

    if (global.new_game) -
    - { -
    - ds_map_clear(inventory); -
    - }

    -

    The above function will check a global variable to see if it is true and, if it is, then the DS map indexed in the instance variable "inventory" will be cleared of all key/value pairs (but it is not destroyed).

    -

    -

    -

    -
    -
    -
    -
    Back: DS Maps
    - -
    + + + ds_map_clear + + + + + + + + + + +

    ds_map_clear

    +

    This function will clear the (previously created) DS map of all key/value pairs, but it will not delete the DS map itself from memory. For that you should use the function ds_map_destroy(). Note that clearing a map will de-reference any data structures stored in the map giving a memory leak, so you would need to go through it and destroy all data structure items manually before clearing the map to prevent this. The only time this is not required is when you have flagged any items in the map as a DS list or as another DS map, in which case these items will be destroyed (not cleared!) and their memory cleaned up automatically when the parent map is cleared.

    +

     

    +

    Syntax:

    +

    ds_map_clear(id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS MapThe handle of the data structure to clear.
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    if (global.new_game)
    + {
    +     ds_map_clear(inventory);
    + }

    +

    The above function will check a global variable to see if it is true and, if it is, then the DS map indexed in the instance variable "inventory" will be cleared of all key/value pairs (but it is not destroyed).

    +

     

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Maps
    +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_empty.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_empty.htm index ec6a902c8..30fb02010 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_empty.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_empty.htm @@ -1,66 +1,66 @@ - + - - - ds_map_empty - - - - - - - - - - -

    ds_map_empty

    -

    This function will simply return false if the specified (previously created) DS map contains any key/value pairs, or true if it does not.

    -

    -

    Syntax:

    -

    ds_map_empty(id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idThe handle of the data structure to check.
    -

    -

    Returns:

    -

    -

    -

    Example:

    -

    if (ds_map_empty(inventory)) -
    - { -
    - weight = 0; -
    - }

    -

    The above code checks to see if the DS map indexed in the variable "inventory" has any key/value pairs and if it does not it sets the variable "weight" to 0.

    -

    -

    -

    -
    -
    -
    -
    Back: DS Maps
    - -
    + + + ds_map_empty + + + + + + + + + + + +

    ds_map_empty

    +

    This function will simply return false if the specified (previously created) DS map contains any key/value pairs, or true if it does not.

    +

     

    +

    Syntax:

    +

    ds_map_empty(id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS MapThe handle of the data structure to check.
    +

     

    +

    Returns:

    +

    Boolean

    +

     

    +

    Example:

    +

    if (ds_map_empty(inventory))
    + {
    +     weight = 0;
    + }

    +

    The above code checks to see if the DS map indexed in the variable "inventory" has any key/value pairs and if it does not it sets the variable "weight" to 0.

    +

     

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Maps
    +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_exists.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_exists.htm index 5526cab5e..9e44de464 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_exists.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_exists.htm @@ -1,71 +1,71 @@ - + - - - ds_map_exists - - - - - - - - - - -

    ds_map_exists

    -

    This function will return true if the specified key exists in the (previously created) DS map , and false if it does not.

    -

    -

    Syntax:

    -

    ds_map_exists(id, key);

    - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idDS Map IDThe handle of the data structure to check
    keyStringThe key to check for
    -

    -

    Returns:

    -

    Boolean

    -

    -

    Example:

    -

    if (!ds_map_exists(inventory, "potions")) -
    - { -
    - ds_map_add(inventory, "potions", 1); -
    - }

    -

    The above code will check the DS map indexed in the variable "inventory" for the key "potions" and if it doesn't exist it will add it to the map.

    -

    -

    -

    -
    -
    -
    -
    Back: DS Maps
    - -
    + + + ds_map_exists + + + + + + + + + + + +

    ds_map_exists

    +

    This function will return true if the specified key exists in the (previously created) DS map , and false if it does not.

    +

     

    +

    Syntax:

    +

    ds_map_exists(id, key);

    + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS MapThe handle of the data structure to check
    keyStringThe key to check for
    +

     

    +

    Returns:

    +

    Boolean

    +

     

    +

    Example:

    +

    if (!ds_map_exists(inventory, "potions"))
    + {
    +     ds_map_add(inventory, "potions", 1);
    + }

    +

    The above code will check the DS map indexed in the variable "inventory" for the key "potions" and if it doesn't exist it will add it to the map.

    +

     

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Maps
    +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_find_first.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_find_first.htm index 60b542a0c..7055c23eb 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_find_first.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_find_first.htm @@ -1,79 +1,73 @@ - + - - - ds_map_find_first - - - - - - - - - - -

    ds_map_find_first

    -

    This function returns the first key stored in the DS map. This is not the first key in the order you added them! DS maps are not stored in a linear form, for that use DS list, so all this does is find the first key as stored by the computer. This can be useful if your have to iterate through the DS map looking for something, but should be avoided if possible as it can be slow.

    -

    Note that this function will return undefined if the given DS map is empty.

    -

    -

    Syntax:

    -

    ds_map_find_first(id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idThe handle of the map to use.
    -

    -

    Returns:

    -

    Variable or undefined

    -

    -

    Example:

    -

    var size = ds_map_size(inventory) ; -
    - var key = ds_map_find_first(inventory); -
    - for (var i = 0; i < size; i++;) -
    - { -
    - if (key != "gold") -
    - { -
    - key = ds_map_find_next(inventory, key); -
    - } -
    - else break; -
    - }

    -

    The above code creates some temporary variables and then gets the DS map size and finds the first key as stored by the computer in the map. It then uses a for loop to iterate through the DS map looking for the key value "gold". If it finds it, it breaks out the loop.

    -

    -

    -

    -
    -
    -
    -
    Back: DS Maps
    - -
    + + + ds_map_find_first + + + + + + + + + + + +

    ds_map_find_first

    +

    This function returns the first key stored in the DS map. This is not the first key in the order you added them! DS maps are not stored in a linear form, for that use DS list, so all this does is find the first key as stored by the computer. This can be useful if your have to iterate through the DS map looking for something, but should be avoided if possible as it can be slow.

    +

    Note that this function will return undefined if the given DS map is empty.

    +

     

    +

    Syntax:

    +

    ds_map_find_first(id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS MapThe handle of the map to use.
    +

     

    +

    Returns:

    +

    Any or undefined

    +

     

    +

    Example:

    +

    var size = ds_map_size(inventory) ;
    + var key = ds_map_find_first(inventory);
    + for (var i = 0; i < size; i++;)
    + {
    +     if (key != "gold")
    +     {
    +         key = ds_map_find_next(inventory, key);
    +     }
    +     else break;
    + }

    +

    The above code creates some temporary variables and then gets the DS map size and finds the first key as stored by the computer in the map. It then uses a for loop to iterate through the DS map looking for the key value "gold". If it finds it, it breaks out the loop.

    +

     

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Maps
    +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_find_last.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_find_last.htm index 0208a6ab3..dffcc9af1 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_find_last.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_find_last.htm @@ -1,79 +1,73 @@ - + - - - ds_map_find_last - - - - - - - - - - -

    ds_map_find_last

    -

    This function returns the last key stored in the DS map. This is not the last key in the order that you have added them! DS maps are not stored in a linear form, for that use DS lists, so all this does is find the last key as stored by the computer. This can be useful if your have to iterate through the DS map looking for something, but should be avoided if possible as it can be slow.

    -

    Note that this function will return undefined if the given DS map is empty.

    -

    -

    Syntax:

    -

    ds_map_find_last(id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idThe handle of the map to use.
    -

    -

    Returns:

    -

    Variable or undefined

    -

    -

    Example:

    -

    var size = ds_map_size(inventory); -
    - var key = ds_map_find_last(inventory); -
    - for (var i = size; i > 0; i--;) -
    - { -
    - if (key != "gold") -
    - { -
    - key = ds_map_find_previous(inventory, key); -
    - } -
    - else break; -
    - }

    -

    The above code creates some temporary variables and then gets the DS map size and finds the last key as stored by the computer in the map. It then uses a for loop to iterate back through the DS map looking for the key value "gold". If it finds it, it breaks out the loop.

    -

    -

    -

    -
    -
    -
    -
    Back: DS Maps
    - -
    + + + ds_map_find_last + + + + + + + + + + + +

    ds_map_find_last

    +

    This function returns the last key stored in the DS map. This is not the last key in the order that you have added them! DS maps are not stored in a linear form, for that use DS lists, so all this does is find the last key as stored by the computer. This can be useful if your have to iterate through the DS map looking for something, but should be avoided if possible as it can be slow.

    +

    Note that this function will return undefined if the given DS map is empty.

    +

     

    +

    Syntax:

    +

    ds_map_find_last(id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS MapThe handle of the map to use.
    +

     

    +

    Returns:

    +

    Any or undefined

    +

     

    +

    Example:

    +

    var size = ds_map_size(inventory);
    + var key = ds_map_find_last(inventory);
    + for (var i = size; i > 0; i--;)
    + {
    +     if (key != "gold")
    +     {
    +         key = ds_map_find_previous(inventory, key);
    +     }
    +     else break;
    + }

    +

    The above code creates some temporary variables and then gets the DS map size and finds the last key as stored by the computer in the map. It then uses a for loop to iterate back through the DS map looking for the key value "gold". If it finds it, it breaks out the loop.

    +

     

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Maps
    +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_find_next.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_find_next.htm index cb8caf113..649b27cba 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_find_next.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_find_next.htm @@ -1,83 +1,77 @@ - + - - - ds_map_find_next - - - - - - - - - - -

    ds_map_find_next

    -

    This function returns the next key stored in the DS map after the one specified in the function. This can be useful if your have to iterate through the DS map looking for something, but should be avoided if possible as it can be slow. If no such key exists then the function will return undefined. You should always check this using the is_undefined() function.

    -

    -

    Syntax:

    -

    ds_map_find_next(id, key);

    - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idThe handle of the map to use.
    keyThe key to find the next one to.
    -

    -

    Returns:

    -

    Variable or undefined

    -

    -

    Example:

    -

    var size = ds_map_size(inventory); -
    - var key = ds_map_find_first(inventory); -
    - for (var i = 0; i < size; i++;) -
    - { -
    - if (key != "gold") -
    - { -
    - key = ds_map_find_next(inventory, key); -
    - } -
    - else break; -
    - }

    -

    The above code creates some temporary variables and then gets the DS map size and finds the first key as stored by the computer in the map. It then uses a for loop to iterate through the DS map looking for the key value "gold". If it finds it, it breaks out the loop.

    -

    -

    -

    -
    -
    -
    -
    Back: DS Maps
    - -
    + + + ds_map_find_next + + + + + + + + + + + +

    ds_map_find_next

    +

    This function returns the next key stored in the DS map after the one specified in the function. This can be useful if your have to iterate through the DS map looking for something, but should be avoided if possible as it can be slow. If no such key exists then the function will return undefined. You should always check this using the is_undefined() function.

    +

     

    +

    Syntax:

    +

    ds_map_find_next(id, key);

    + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS MapThe handle of the map to use.
    keyStringThe key to find the next one to.
    +

     

    +

    Returns:

    +

    Any or undefined

    +

     

    +

    Example:

    +

    var size = ds_map_size(inventory);
    + var key = ds_map_find_first(inventory);
    + for (var i = 0; i < size; i++;)
    + {
    +     if (key != "gold")
    +     {
    +         key = ds_map_find_next(inventory, key);
    +     }
    +     else break;
    + }

    +

    The above code creates some temporary variables and then gets the DS map size and finds the first key as stored by the computer in the map. It then uses a for loop to iterate through the DS map looking for the key value "gold". If it finds it, it breaks out the loop.

    +

     

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Maps
    +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_find_previous.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_find_previous.htm index 3a48823fa..b4c35dfec 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_find_previous.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_find_previous.htm @@ -1,83 +1,77 @@ - + - - - ds_map_find_previous - - - - - - - - - - -

    ds_map_find_previous

    -

    This function returns the previous key stored in the DS map before the one specified in the function. This can be useful if your have to iterate through the DS map looking for something, but should be avoided if possible as it can be slow. If no such key exists then the function will return undefined. You should always check this using the is_undefined() function.

    -

    -

    Syntax:

    -

    ds_map_find_previous(id, key);

    - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idThe handle of the map to use.
    keyThe key to find the previous one to.
    -

    -

    Returns:

    -

    Variable or undefined

    -

    -

    Example:

    -

    var size = ds_map_size(inventory) - 1; -
    - var key = ds_map_find_last(inventory); -
    - for (var i = size; i > 0; i--;) -
    - { -
    - if (key != "gold") -
    - { -
    - key = ds_map_find_previous(inventory, key); -
    - } -
    - else break; -
    - }

    -

    The above code creates some temporary variables and then gets the ds_map size and finds the last key as stored by the computer in the map. It then uses a for loop to iterate back through the ds_map looking for the key value "gold". If it finds it, it breaks out the loop.

    -

    -

    -

    -
    -
    -
    -
    Back: DS Maps
    - -
    + + + ds_map_find_previous + + + + + + + + + + + +

    ds_map_find_previous

    +

    This function returns the previous key stored in the DS map before the one specified in the function. This can be useful if your have to iterate through the DS map looking for something, but should be avoided if possible as it can be slow. If no such key exists then the function will return undefined. You should always check this using the is_undefined() function.

    +

     

    +

    Syntax:

    +

    ds_map_find_previous(id, key);

    + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS MapThe handle of the map to use.
    keyStringThe key to find the previous one to.
    +

     

    +

    Returns:

    +

    Any or undefined

    +

     

    +

    Example:

    +

    var size = ds_map_size(inventory) - 1;
    + var key = ds_map_find_last(inventory);
    + for (var i = size; i > 0; i--;)
    + {
    +     if (key != "gold")
    +     {
    +         key = ds_map_find_previous(inventory, key);
    +     }
    +     else break;
    + }

    +

    The above code creates some temporary variables and then gets the ds_map size and finds the last key as stored by the computer in the map. It then uses a for loop to iterate back through the ds_map looking for the key value "gold". If it finds it, it breaks out the loop.

    +

     

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Maps
    +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_is_list.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_is_list.htm index e75d87324..b31fa25bb 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_is_list.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_is_list.htm @@ -1,85 +1,81 @@ - + - - - ds_map_is_list - - - - - - - - - - -

    ds_map_is_list

    -

    With this function you can check to see if a DS list is stored in the given map key. If the given key contains a DS list ID, then the function will return true otherwise it will return false.

    -

    This will only detect lists that were added using the ds_map_add_list function.

    -

    -

    Syntax:

    -

    ds_map_is_list(id, key)

    - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idDS MapThe handle of the map to use.
    keyStringThe key to check.
    -

    -

    Returns:

    -

    Boolean

    -

    -

    Example:

    -

    var size = ds_map_size(inventory); -
    - var key = ds_map_find_first(inventory); -
    - for (var i = 0; i < size; i++) -
    - { -
    - if (ds_map_is_list(inventory, key)) -
    - { -
    - ds_list_destroy(inventory[? key]); -
    - } -
    - key = ds_map_find_next(inventory); -
    - } -
    - ds_map_destroy(inventory);

    -

    The above code loops through a DS map and checks to see if any of the keys in it are for a DS list. If they are, then the DS list is destroyed, and the at the end of the loop the DS map is destroyed too.

    -

    -

    -
    -
    -
    -
    Back: DS Maps
    - -
    + + + ds_map_is_list + + + + + + + + + + + +

    ds_map_is_list

    +

    With this function you can check to see if a DS list is stored in the given map key. If the given key contains a DS list ID, then the function will return true otherwise it will return false.

    +

    This will only detect lists that were added using the ds_map_add_list function.

    +

     

    +

    Syntax:

    +

    ds_map_is_list(id, key)

    + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS MapThe handle of the map to use.
    keyStringThe key to check.
    +

     

    +

    Returns:

    +

    Boolean

    +

     

    +

    Example:

    +

    var size = ds_map_size(inventory);
    + var key = ds_map_find_first(inventory);
    + for (var i = 0; i < size; i++)
    + {
    +     if (ds_map_is_list(inventory, key))
    +     {
    +         ds_list_destroy(inventory[? key]);
    +     }
    +    
    +     key = ds_map_find_next(inventory);
    + }
    +
    + ds_map_destroy(inventory); +

    +

    The above code loops through a DS map and checks to see if any of the keys in it are for a DS list. If they are, then the DS list is destroyed, and the at the end of the loop the DS map is destroyed too.

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Maps
    +
    -
    © Copyright YoYo Games Ltd. 2023 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_is_map.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_is_map.htm index 0cc1a781b..d553e75c2 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_is_map.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_is_map.htm @@ -1,85 +1,78 @@ - + - - - ds_map_is_map - - - - - - - - - - -

    ds_map_is_map

    -

    With this function you can check to see if a DS map is stored in the given map key. If the given key contains a DS map ID, then the function will return true otherwise it will return false.

    -

    This will only detect maps that were added using the ds_map_add_map function.

    -

    -

    Syntax:

    -

    ds_map_is_map(id, key)

    - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idDS MapThe handle of the map to use.
    keyStringThe key to replace.
    -

    -

    Returns:

    -

    Boolean

    -

    -

    Example:

    -

    var size = ds_map_size(inventory); -
    - var key = ds_map_find_first(inventory); -
    - for (var i = 0; i < size; i++) -
    - { -
    - if (ds_map_is_map(inventory, key)) -
    - { -
    - ds_map_destroy(inventory[? key]); -
    - } -
    - key = ds_map_find_next(inventory); -
    - } -
    - ds_map_destroy(inventory);

    -

    The above code loops through a DS map and checks to see if any of the keys within it are for other DS maps. If they are, then the stored DS map is destroyed, and the at the end of the loop the main DS map is destroyed too.

    -

    -

    -
    -
    -
    -
    Back: DS Maps
    - -
    + + + ds_map_is_map + + + + + + + + + + + +

    ds_map_is_map

    +

    With this function you can check to see if a DS map is stored in the given map key. If the given key contains a DS map ID, then the function will return true otherwise it will return false.

    +

    This will only detect maps that were added using the ds_map_add_map function.

    +

     

    +

    Syntax:

    +

    ds_map_is_map(id, key)

    + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS MapThe handle of the map to use.
    keyStringThe key to replace.
    +

     

    +

    Returns:

    +

    Boolean

    +

     

    +

    Example:

    +

    var size = ds_map_size(inventory);
    + var key = ds_map_find_first(inventory);
    + for (var i = 0; i < size; i++)
    + {
    +     if (ds_map_is_map(inventory, key))
    +     {
    +         ds_map_destroy(inventory[? key]);
    +     }
    +     key = ds_map_find_next(inventory);
    + }
    + ds_map_destroy(inventory);

    +

    The above code loops through a DS map and checks to see if any of the keys within it are for other DS maps. If they are, then the stored DS map is destroyed, and the at the end of the loop the main DS map is destroyed too.

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Maps
    +
    -
    © Copyright YoYo Games Ltd. 2023 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_read.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_read.htm index 6a22fc88f..3f7541f43 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_read.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_read.htm @@ -1,84 +1,80 @@ - + - - - ds_map_read - - - - - - - - - -

    ds_map_read

    -

    This function will take a string that has previously been created by the function ds_map_write() and then read it into a previously created DS map. If the map that the string is being read into contains any key/value pairs, these will be cleared first before the saved map is re-constructed.

    -

    Note that if the specified DS string was written by the GameMaker: Studio 1.2.x runtime (or older), you should specify the optional argument "legacy", setting it to true as the string format changed after that.

    -

    -

    Syntax:

    -

    ds_map_read(id, str, [legacy]);

    - - - - - - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idDS Map IDThe handle of the data structure to read the string into
    strStringThe string to read
    legacyBooleanOPTIONAL Can be either true or false or omitted completely.
    -

    -

    Returns:

    -

    N/A

    -

    -

    Example:

    -

    inventory = ds_map_create(); -
    - ini_open("map.ini"); -
    - var t_string = ini_read_string("Saved", "0", ""); -
    - if (t_string != "") -
    - { -
    - ds_map_read(inventory, t_string); -
    - } -
    - ini_close();

    -

    The above code creates a new DS map and stores its id index in the variable "inventory". It then opens an ini file and reads a string from that file into the temporary variable "t_string". Finally, it checks to make sure that the string is valid (not the default ini value of "") and if it is it then reads the string into the newly created DS map before closing the ini again.

    -

    -

    -

    -
    -
    -
    -
    Back: DS Maps
    - -
    + + + ds_map_read + + + + + + + + + + +

    ds_map_read

    +

    This function will take a string that has previously been created by the function ds_map_write() and then read it into a previously created DS map. If the map that the string is being read into contains any key/value pairs, these will be cleared first before the saved map is re-constructed.

    +

    Note that if the specified DS string was written by the GameMaker: Studio 1.2.x runtime (or older), you should specify the optional argument "legacy", setting it to true as the string format changed after that.

    +

     

    +

    Syntax:

    +

    ds_map_read(id, str, [legacy]);

    + + + + + + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS MapThe handle of the data structure to read the string into
    strStringThe string to read
    legacyBooleanOPTIONAL Can be either true or false or omitted completely.
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    inventory = ds_map_create();
    + ini_open("map.ini");
    + var t_string = ini_read_string("Saved", "0", "");
    + if (t_string != "")
    + {
    +     ds_map_read(inventory, t_string);
    + }
    + ini_close();

    +

    The above code creates a new DS map and stores its id index in the variable "inventory". It then opens an ini file and reads a string from that file into the temporary variable "t_string". Finally, it checks to make sure that the string is valid (not the default ini value of "") and if it is it then reads the string into the newly created DS map before closing the ini again.

    +

     

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Maps
    +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_size.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_size.htm index 4ed15234b..7dd49ea4d 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_size.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_size.htm @@ -1,66 +1,66 @@ - + - - - ds_map_size - - - - - - - - - - -

    ds_map_size

    -

    With this function you can find how many key/values pairs the (previously created) DS map contains.

    -

    -

    Syntax:

    -

    ds_map_size(id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idThe handle of the data structure to check.
    -

    -

    Returns:

    -

    -

    -

    Example:

    -

    if (ds_map_size(inventory) > 49) -
    - { -
    - full = true; -
    - }

    -

    The above code will check the size of the DS map (ie: number of key/value pairs) and if it is greater than 49 it sets the variable "full" to true.

    -

    -

    -

    -
    -
    -
    -
    Back: DS Maps
    - -
    + + + ds_map_size + + + + + + + + + + + +

    ds_map_size

    +

    With this function you can find how many key/values pairs the (previously created) DS map contains.

    +

     

    +

    Syntax:

    +

    ds_map_size(id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS MapThe handle of the data structure to check.
    +

     

    +

    Returns:

    +

    Real

    +

     

    +

    Example:

    +

    if (ds_map_size(inventory) > 49)
    + {
    +     full = true;
    + }

    +

    The above code will check the size of the DS map (ie: number of key/value pairs) and if it is greater than 49 it sets the variable "full" to true.

    +

     

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Maps
    +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_values_to_array.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_values_to_array.htm index 46e23cbfd..e0f7b2e28 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_values_to_array.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Maps/ds_map_values_to_array.htm @@ -1,81 +1,78 @@ - + - - - ds_map_values_to_array - - - - - - - - - - -

    ds_map_values_to_array

    -

    With this function you can retrieve all of the values that a DS map contains for each key in the map. You supply the DS map ID to get the keys from (as returned by ds_map_create()) and the function will return an array where each entry in the array is a value from the DS map (for example, if the map has 10 keys, then an array of 10 entries will be returned with each entry corresponding to a value for a key). The function has an optional second argument where you can supply an array that you have created, in which case the map key value data will be appended onto any existing data in the array. Note that the function will modify the array supplied directly, but will also return a reference to it (or a reference to a new array if none is supplied).

    -

    -

    Syntax:

    -

    ds_map_values_to_array(id, [array])

    - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idDS Map IDThe handle of the map to use.
    [array]ArrayOPTIONAL The array to append the DS map values to.
    -

    -

    Returns:

    -

    Array

    -

    -

    Example:

    -

    var _values = ds_map_values_to_array(lvl_score); -
    - var _total = 0; -
    - var _length = array_length(_values); -
    -
    - for (var i = 0; i < _length; i ++) -
    - { -
    - _total += _values[i]; -
    - } -
    -
    - draw_text(32, 32, "Total score for all levels: " + string(_total));

    -

    The above retrieves all the values from a DS map for each key in the map and stores them in a local variable as an array. It then loops through the array and adds each of the values to a local variable which is then used to display the total of all the values.

    -

    -

    -

    -
    -
    -
    -
    Back: DS Maps
    - -
    + + + ds_map_values_to_array + + + + + + + + + + + +

    ds_map_values_to_array

    +

    With this function you can retrieve all of the values that a DS map contains for each key in the map. You supply the DS map ID to get the keys from (as returned by ds_map_create()) and the function will return an array where each entry in the array is a value from the DS map (for example, if the map has 10 keys, then an array of 10 entries will be returned with each entry corresponding to a value for a key). The function has an optional second argument where you can supply an array that you have created, in which case the map key value data will be appended onto any existing data in the array. Note that the function will modify the array supplied directly, but will also return a reference to it (or a reference to a new array if none is supplied).

    +

     

    +

    Syntax:

    +

    ds_map_values_to_array(id, [array])

    + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS MapThe handle of the map to use.
    [array]ArrayOPTIONAL The array to append the DS map values to.
    +

     

    +

    Returns:

    +

    Array

    +

     

    +

    Example:

    +

    var _values = ds_map_values_to_array(lvl_score);
    + var _total = 0;
    + var _length = array_length(_values);
    +
    + for (var i = 0; i < _length; i ++)
    + {
    +     _total += _values[i];
    + }
    +
    + draw_text(32, 32, "Total score for all levels: " + string(_total)); +

    +

    The above retrieves all the values from a DS map for each key in the map and stores them in a local variable as an array. It then loops through the array and adds each of the values to a local variable which is then used to display the total of all the values.

    +

     

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Maps
    +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_change_priority.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_change_priority.htm index 3dfbd0752..a6f274c8a 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_change_priority.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_change_priority.htm @@ -1,75 +1,75 @@ - + - - - ds_priority_change_priority - - - - - - - - - -

    ds_priority_change_priority

    -

    This function will take a given value and change its priority within the referenced priority queue. The given value should already exist in the priority queue.

    -

    -

    Syntax:

    -

    ds_priority_change_priority(id, val, priority);

    - - - - - - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idDS Priority IDThe handle of the priority queue to change.
    valVariableThe value to change the priority of.
    priorityRealThe new priority of the value.
    -

    -

    Returns:

    -

    N/A

    -

    -

    Example:

    -

    if (global.Game_Time < 1000) -
    - { -
    - ds_priority_change(ai_priority, AI_Search, 1); -
    - }

    -

    The above code checks a global variable and if it is below a certain value it will then change the priority of the script function index held in the priority queue.

    -

    -

    -

    -
    -
    -
    - - -
    + + + ds_priority_change_priority + + + + + + + + + + +

    ds_priority_change_priority

    +

    This function will take a given value and change its priority within the referenced priority queue. The given value should already exist in the priority queue.

    +

     

    +

    Syntax:

    +

    ds_priority_change_priority(id, val, priority);

    + + + + + + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS PriorityThe handle of the priority queue to change.
    valAnyThe value to change the priority of.
    priorityRealThe new priority of the value.
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    if (global.Game_Time < 1000)
    + {
    +     ds_priority_change(ai_priority, AI_Search, 1);
    + }

    +

    The above code checks a global variable and if it is below a certain value it will then change the priority of the script function index held in the priority queue.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_clear.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_clear.htm index a5a31d75b..7c8b9b1e9 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_clear.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_clear.htm @@ -1,68 +1,66 @@ - + - - - ds_priority_clear - - - - - - - - - -

    ds_priority_clear

    -

    With this function you can clear all data from the given priority queue data-structure. This does NOT destroy the data-structure (for that you should use ds_priority_destroy()) it only wipes all data from it and returns an empty priority queue.

    -

    -

    Syntax:

    -

    ds_priority_clear(id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idDS Priority IDThe handle of the data structure to clear.
    -

    -

    Returns:

    -

    N/A

    -

    -

    Example:

    -

    if (count = 15) && (!ds_priority_empty(command_queue)) -
    - { -
    - ds_priority_clear(command_queue); -
    - alarm[0] = game_get_speed(gamespeed_fps); -
    - ai_count = 0; -
    - }

    -

    The above code checks a variable to see if it has reached a specific value and if it has it clears the DS priority queue indexed in the variable "command_queue", sets an alarm, and resets the variable to 0.

    -

    -

    -
    -
    -
    - - -
    + + + ds_priority_clear + + + + + + + + + + +

    ds_priority_clear

    +

    With this function you can clear all data from the given priority queue data-structure. This does NOT destroy the data-structure (for that you should use ds_priority_destroy()) it only wipes all data from it and returns an empty priority queue.

    +

     

    +

    Syntax:

    +

    ds_priority_clear(id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS PriorityThe handle of the data structure to clear.
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    if (count = 15) && (!ds_priority_empty(command_queue))
    + {
    +     ds_priority_clear(command_queue);
    +     alarm[0] = game_get_speed(gamespeed_fps);
    +     ai_count = 0;
    + }

    +

    The above code checks a variable to see if it has reached a specific value and if it has it clears the DS priority queue indexed in the variable "command_queue", sets an alarm, and resets the variable to 0.

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2023 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_copy.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_copy.htm index 5609a26df..494da4528 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_copy.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_copy.htm @@ -45,8 +45,8 @@

    Returns:

    Example:

    with (instance_create_layer(x, y, "Enemies", obj_Enemy))
    {
    - p_queue = ds_priority_create();
    - ds_priority_copy(p_queue, other.p_queue);
    +     p_queue = ds_priority_create();
    +     ds_priority_copy(p_queue, other.p_queue);
    }

    The above function creates a new instance and then in that instance it creates a new DS priority queue and copies the contents of the priority queue in the instance running the code block, into the newly created instance priority queue.

     

    diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_delete_max.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_delete_max.htm index bab493592..1ecb01f5b 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_delete_max.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_delete_max.htm @@ -1,67 +1,67 @@ - + - - - ds_priority_delete_max - - - - - - - - - - -

    ds_priority_delete_max

    -

    This function will return the value that has the highest priority in the queue and then remove the value (and priority) from the data structure. If more than one value has the same priority, then any one of them could be returned in any order, but all other values with the same priority will still be in the queue.

    -

    If the priority queue is empty, this function will return 0.

    -

    -

    Syntax:

    -

    ds_priority_delete_max(id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idDS Priority IDThe handle of the priority queue to use.
    -

    -

    Returns:

    -

    Any (Data type stored in the priority)

    -

    -

    Example:

    -

    if (ai_move) -
    - { -
    - script_execute(ds_priority_delete_max(ai_priority)); -
    - }

    -

    The above code checks an instance variable and if it returns true it will execute a script indexed in the priority queue with the highest priority value and then remove that script from the queue.

    -

    -

    -

    -
    -
    -
    - - -
    + + + ds_priority_delete_max + + + + + + + + + + + +

    ds_priority_delete_max

    +

    This function will return the value that has the highest priority in the queue and then remove the value (and priority) from the data structure. If more than one value has the same priority, then any one of them could be returned in any order, but all other values with the same priority will still be in the queue.

    +

    If the priority queue is empty, this function will return 0.

    +

     

    +

    Syntax:

    +

    ds_priority_delete_max(id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS PriorityThe handle of the priority queue to use.
    +

     

    +

    Returns:

    +

    Any (Data type stored in the priority)

    +

     

    +

    Example:

    +

    if (ai_move)
    + {
    +     script_execute(ds_priority_delete_max(ai_priority));
    + }

    +

    The above code checks an instance variable and if it returns true it will execute a script indexed in the priority queue with the highest priority value and then remove that script from the queue.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2023 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_delete_min.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_delete_min.htm index a427db81f..72b5db7b4 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_delete_min.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_delete_min.htm @@ -1,67 +1,67 @@ - + - - - ds_priority_delete_min - - - - - - - - - - -

    ds_priority_delete_min

    -

    This function will return the value that has the lowest priority in the queue and then remove the value (and priority) from the data structure. If more than one value has the same priority, then any one of them could be returned in any order, but all other values with the same priority will still be in the queue.

    -

    If the priority queue is empty, this function will return 0.

    -

    -

    Syntax:

    -

    ds_priority_delete_min(id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idDS Priority IDThe handle of the priority queue to use.
    -

    -

    Returns:

    -

    Any (Data type stored in the priority)

    -

    -

    Example:

    -

    if (ai_move) -
    - { -
    - script_execute(ds_priority_delete_min(ai_priority)); -
    - }

    -

    The above code checks an instance variable and if it returns true it will execute a script function indexed in the priority queue with the lowest priority value and then remove that script from the queue.

    -

    -

    -

    -
    -
    -
    - - -
    + + + ds_priority_delete_min + + + + + + + + + + + +

    ds_priority_delete_min

    +

    This function will return the value that has the lowest priority in the queue and then remove the value (and priority) from the data structure. If more than one value has the same priority, then any one of them could be returned in any order, but all other values with the same priority will still be in the queue.

    +

    If the priority queue is empty, this function will return 0.

    +

     

    +

    Syntax:

    +

    ds_priority_delete_min(id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS PriorityThe handle of the priority queue to use.
    +

     

    +

    Returns:

    +

    Any (Data type stored in the priority)

    +

     

    +

    Example:

    +

    if (ai_move)
    + {
    +     script_execute(ds_priority_delete_min(ai_priority));
    + }

    +

    The above code checks an instance variable and if it returns true it will execute a script function indexed in the priority queue with the lowest priority value and then remove that script from the queue.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2023 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_delete_value.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_delete_value.htm index 6c1354092..5fe249dbf 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_delete_value.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_delete_value.htm @@ -1,70 +1,70 @@ - + - - - ds_priority_delete_value - - - - - - - - - -

    ds_priority_delete_value

    -

    This function will simply delete the given value, along with its priority, from the indexed priority queue.

    -

    -

    Syntax:

    -

    ds_priority_delete_value(id,val);

    - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idThe handle of the priority queue to use.
    valThe value to delete from the priority queue.
    -

    -

    Returns:

    -

    -

    -

    Example:

    -

    if (ai_move == false) -
    - { -
    - ds_priority_delete_value(ai_priority, AI_Move); -
    - }

    -

    The above code checks an instance variable and if it returns false it will remove the indexed script function from the priority queue.

    -

    -

    -

    -
    -
    -
    - - -
    + + + ds_priority_delete_value + + + + + + + + + + +

    ds_priority_delete_value

    +

    This function will simply delete the given value, along with its priority, from the indexed priority queue.

    +

     

    +

    Syntax:

    +

    ds_priority_delete_value(id,val);

    + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS PriorityThe handle of the priority queue to use.
    valAnyThe value to delete from the priority queue.
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    if (ai_move == false)
    + {
    +     ds_priority_delete_value(ai_priority, AI_Move);
    + }

    +

    The above code checks an instance variable and if it returns false it will remove the indexed script function from the priority queue.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_empty.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_empty.htm index dc6572393..7130a452a 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_empty.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_empty.htm @@ -1,69 +1,67 @@ - + - - - ds_priority_empty - - - - - - - - - - -

    ds_priority_empty

    -

    With this function you can check the given DS priority queue to see if it is empty (returns true) or not (returns false).

    -

    -

    Syntax:

    -

    ds_priority_empty(id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idDS Priority IDThe handle of the data structure to check.
    -

    -

    Returns:

    -

    Boolean

    -

    -

    Example:

    -

    if (count == 15) && (!ds_priority_empty(command_queue)) -
    - { -
    - ds_priority_clear(command_queue); -
    - alarm[0] = game_get_speed(gamespeed_fps); -
    - ai_count = 0; -
    - }

    -

    The above code checks a variable to see if it has reached a specific value and if it has it clears the DS priority queue indexed in the variable "command_queue", sets an alarm, and resets the variable to 0.

    -

    -

    -
    -
    -
    - - -
    + + + ds_priority_empty + + + + + + + + + + + +

    ds_priority_empty

    +

    With this function you can check the given DS priority queue to see if it is empty (returns true) or not (returns false).

    +

     

    +

    Syntax:

    +

    ds_priority_empty(id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS PriorityThe handle of the data structure to check.
    +

     

    +

    Returns:

    +

    Boolean

    +

     

    +

    Example:

    +

    if (count == 15) && (!ds_priority_empty(command_queue))
    + {
    +     ds_priority_clear(command_queue);
    +     alarm[0] = game_get_speed(gamespeed_fps);
    +     ai_count = 0;
    + }

    +

    The above code checks a variable to see if it has reached a specific value and if it has it clears the DS priority queue indexed in the variable "command_queue", sets an alarm, and resets the variable to 0.

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2023 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_find_max.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_find_max.htm index d94fd868f..ed6b9a16e 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_find_max.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_find_max.htm @@ -1,67 +1,67 @@ - + - - - ds_priority_find_max - - - - - - - - - - -

    ds_priority_find_max

    -

    With this function you can find the value stored in the priority queue with the highest priority, and if more than one value has the same priority then any one of them could be returned in any order. However, unlike ds_priority_delete_max(), this function will not remove the value from the queue.

    -
    -

    -

    Syntax:

    -

    ds_priority_find_max(id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idDS Priority IDThe handle of the priority queue to use.
    -

    -

    Returns:

    -

    Any (Data type stored in the priority)

    -

    -

    Example:

    -

    if (ai_move) -
    - { -
    - script_execute(ds_priority_find_max(ai_priority)); -
    - }

    -

    The above code checks an instance variable and if it returns true it will execute a script function indexed in the priority queue with the highest priority value.

    -

    -

    -

    -
    -
    -
    - - -
    + + + ds_priority_find_max + + + + + + + + + + + +

    ds_priority_find_max

    +

    With this function you can find the value stored in the priority queue with the highest priority, and if more than one value has the same priority then any one of them could be returned in any order. However, unlike ds_priority_delete_max(), this function will not remove the value from the queue.

    +
    +

     

    +

    Syntax:

    +

    ds_priority_find_max(id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS PriorityThe handle of the priority queue to use.
    +

     

    +

    Returns:

    +

    Any (Data type stored in the priority)

    +

     

    +

    Example:

    +

    if (ai_move)
    + {
    +     script_execute(ds_priority_find_max(ai_priority));
    + }

    +

    The above code checks an instance variable and if it returns true it will execute a script function indexed in the priority queue with the highest priority value.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2023 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_find_min.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_find_min.htm index 75d8e9f13..a3d09cf88 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_find_min.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_find_min.htm @@ -1,67 +1,67 @@ - + - - - ds_priority_find_min - - - - - - - - - - -

    ds_priority_find_min

    -

    With this function you can find the value stored in the priority queue with the lowest priority, and if more than one value has the same priority then any one of them could be returned in any order. However, unlike ds_priority_delete_min(), this function will not remove the value from the queue.

    -
    -

    -

    Syntax:

    -

    ds_priority_find_min(id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idDS Priority IDThe handle of the priority queue to use.
    -

    -

    Returns:

    -

    Any (Data type stored in the priority)

    -

    -

    Example:

    -

    if (ai_move) -
    - { -
    - script_execute(ds_priority_find_min(ai_priority)); -
    - }

    -

    The above code checks an instance variable and if it returns true it will execute a script function indexed in the priority queue with the lowest priority value.

    -

    -

    -

    -
    -
    -
    - - -
    + + + ds_priority_find_min + + + + + + + + + + + +

    ds_priority_find_min

    +

    With this function you can find the value stored in the priority queue with the lowest priority, and if more than one value has the same priority then any one of them could be returned in any order. However, unlike ds_priority_delete_min(), this function will not remove the value from the queue.

    +
    +

     

    +

    Syntax:

    +

    ds_priority_find_min(id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS PriorityThe handle of the priority queue to use.
    +

     

    +

    Returns:

    +

    Any (Data type stored in the priority)

    +

     

    +

    Example:

    +

    if (ai_move)
    + {
    +     script_execute(ds_priority_find_min(ai_priority));
    + }

    +

    The above code checks an instance variable and if it returns true it will execute a script function indexed in the priority queue with the lowest priority value.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2023 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_read.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_read.htm index 345674f7d..7b46bf0fd 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_read.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_read.htm @@ -1,84 +1,80 @@ - + - - - ds_priority_read - - - - - - - - - -

    ds_priority_read

    -

    With this function you can recreate a saved DS priority (one that has previously been written as a string using ds_priority_write()). You must first create a new DS priority to read the string into, and if the DS priority already exists and has information stored in it, then this will be cleared before reading. This function is of vital importance when creating save/load mechanisms for your game.

    -

    Note that if the specified DS string was written by the GameMaker: Studio 1.2.x runtime (or older), you should specify the optional argument "legacy", setting it to true as the string format changed after that.

    -

    -

    Syntax:

    -

    ds_priority_read(id, str, [legacy]);

    - - - - - - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idDS Priority IDThe handle of the data structure to write.
    strStringThe string to read from.
    legacyBooleanOPTIONAL Can be either true or false or omitted completely.
    -

    -

    Returns:

    -

    N/A

    -

    -

    Example:

    -

    p_queue = ds_priority_create(); -
    - ini_open("save.ini"); -
    - var str = ini_read_string("P_Queues", "0", ""); -
    - if (str != "") -
    - { -
    - ds_priority_read(p_queue, str); -
    - } -
    - ini_close();

    -

    The above code creates a priority queue and stores the index in the variable "p_queue". It then opens an ini file and reads a string from that, checking to make sure that the string is not returned as empty first. This string is then read into the newly created DS priority.

    -

    -

    -

    -
    -
    -
    - - -
    + + + ds_priority_read + + + + + + + + + + +

    ds_priority_read

    +

    With this function you can recreate a saved DS priority (one that has previously been written as a string using ds_priority_write()). You must first create a new DS priority to read the string into, and if the DS priority already exists and has information stored in it, then this will be cleared before reading. This function is of vital importance when creating save/load mechanisms for your game.

    +

    Note that if the specified DS string was written by the GameMaker: Studio 1.2.x runtime (or older), you should specify the optional argument "legacy", setting it to true as the string format changed after that.

    +

     

    +

    Syntax:

    +

    ds_priority_read(id, str, [legacy]);

    + + + + + + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS PriorityThe handle of the data structure to write.
    strStringThe string to read from.
    legacyBooleanOPTIONAL Can be either true or false or omitted completely.
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    p_queue = ds_priority_create();
    + ini_open("save.ini");
    + var str = ini_read_string("P_Queues", "0", "");
    + if (str != "")
    + {
    +     ds_priority_read(p_queue, str);
    + }
    + ini_close();

    +

    The above code creates a priority queue and stores the index in the variable "p_queue". It then opens an ini file and reads a string from that, checking to make sure that the string is not returned as empty first. This string is then read into the newly created DS priority.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_size.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_size.htm index 693ad41b7..be71782ea 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_size.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Priority_Queues/ds_priority_size.htm @@ -1,66 +1,66 @@ - + - - - ds_priority_size - - - - - - - - - - -

    ds_priority_size

    -

    This function will return the "size" of the priority queue, ie: the number of items that have been prioritized in it.

    -

    -

    Syntax:

    -

    ds_priority_size(id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idThe handle of the data structure to check.
    -

    -

    Returns:

    -

    -

    -

    Example:

    -

    if (!ds_priority_empty(control_priority)) -
    - { -
    - num = ds_priority_size(control_priority); -
    - }

    -

    The above code checks a DS priority queue to see if it is empty or not, and if it is not, it gets the number of items that it contains and stores the value in a variable.

    -

    -

    -

    -
    -
    -
    - - -
    + + + ds_priority_size + + + + + + + + + + + +

    ds_priority_size

    +

    This function will return the "size" of the priority queue, ie: the number of items that have been prioritized in it.

    +

     

    +

    Syntax:

    +

    ds_priority_size(id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS PriorityThe handle of the data structure to check.
    +

     

    +

    Returns:

    +

    Real

    +

     

    +

    Example:

    +

    if (!ds_priority_empty(control_priority))
    + {
    +     num = ds_priority_size(control_priority);
    + }

    +

    The above code checks a DS priority queue to see if it is empty or not, and if it is not, it gets the number of items that it contains and stores the value in a variable.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Queues/ds_queue_clear.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Queues/ds_queue_clear.htm index 21f226c2e..73f1a95eb 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Queues/ds_queue_clear.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Queues/ds_queue_clear.htm @@ -1,69 +1,67 @@ - + - - - ds_queue_clear - - - - - - - - - -

    ds_queue_clear

    -

    With this function you can clear all data from the given queue data-structure. This does NOT destroy the data-structure (for that you should use ds_queue_destroy()) it only wipes all data from it and returns an empty queue.

    -

    -

    Syntax:

    -

    ds_queue_clear(id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idDS Queue IDThe handle of the data structure to clear.
    -

    -

    Returns:

    -

    N/A

    -

    -

    Example:

    -

    if (count = 15) && (!ds_queue_empty(command_queue)) -
    - { -
    - ds_queue_clear(command_queue); -
    - alarm[0] = game_get_speed(gamespeed_fps); -
    - ai_count = 0; -
    - }

    -

    The above code checks a variable to see if it has reached a specific value and if it has it clears the DS queue indexed in the variable "command_queue", sets an alarm, and resets the variable to 0.

    -

    -

    -

    -
    -
    -
    -
    Back: DS Queues
    - -
    + + + ds_queue_clear + + + + + + + + + + +

    ds_queue_clear

    +

    With this function you can clear all data from the given queue data-structure. This does NOT destroy the data-structure (for that you should use ds_queue_destroy()) it only wipes all data from it and returns an empty queue.

    +

     

    +

    Syntax:

    +

    ds_queue_clear(id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS QueueThe handle of the data structure to clear.
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    if (count = 15) && (!ds_queue_empty(command_queue))
    + {
    +     ds_queue_clear(command_queue);
    +     alarm[0] = game_get_speed(gamespeed_fps);
    +     ai_count = 0;
    + }

    +

    The above code checks a variable to see if it has reached a specific value and if it has it clears the DS queue indexed in the variable "command_queue", sets an alarm, and resets the variable to 0.

    +

     

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Queues
    +
    -
    © Copyright YoYo Games Ltd. 2023 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Queues/ds_queue_copy.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Queues/ds_queue_copy.htm index 53c1c4ba5..db7174511 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Queues/ds_queue_copy.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Queues/ds_queue_copy.htm @@ -45,8 +45,8 @@

    Returns:

    Example:

    with (instance_create_layer(x, y, "Enemies", obj_Enemy))
    {
    - queue = ds_queue_create();
    - ds_queue_copy(queue, other.queue);
    +     queue = ds_queue_create();
    +     ds_queue_copy(queue, other.queue);
    }

    The above function creates a new instance and then in that instance it creates a new DS queue and copies the contents of the queue in the instance running the code block, into the newly created instance queue.

     

    diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Queues/ds_queue_dequeue.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Queues/ds_queue_dequeue.htm index 422f7ae1d..5f4685e69 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Queues/ds_queue_dequeue.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Queues/ds_queue_dequeue.htm @@ -1,70 +1,68 @@ - + - - - ds_queue_dequeue - - - - - - - - - -

    ds_queue_dequeue

    -

    This function will dequeue the head value off of the DS queue, removing it from the queue and returning the value to be stored in a variable. If the queue is empty then the function will return the constant undefined, otherwise it will return the value contained in the queue.

    -

    -

    Syntax:

    -

    ds_queue_dequeue(id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idThe handle of the queue to dequeue from.
    -

    -

    -

    Returns:

    -

    Variable (Data type value stored in the queue) or undefined

    -

    -

    Example:

    -

    if (!ds_queue_empty(move_queue)) -
    - { -
    - var xx = ds_queue_dequeue(move_queue); -
    - var yy = ds_queue_dequeue(move_queue); -
    - move_towards_point(xx, yy, 4); -
    - }

    -

    The above code checks the DS queue indexed in the variable "move_queue" to see if it is empty, and if it is not, it then dequeues the two values from the head of the queue and use them to set a direction for movement.

    -

    -

    -

    -
    -
    -
    -
    Back: DS Queues
    - -
    + + + ds_queue_dequeue + + + + + + + + + + +

    ds_queue_dequeue

    +

    This function will dequeue the head value off of the DS queue, removing it from the queue and returning the value to be stored in a variable. If the queue is empty then the function will return the constant undefined, otherwise it will return the value contained in the queue.

    +

     

    +

    Syntax:

    +

    ds_queue_dequeue(id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS QueueThe handle of the queue to dequeue from.
    +

     

    +

     

    +

    Returns:

    +

    Any (Data type value stored in the queue) or undefined

    +

     

    +

    Example:

    +

    if (!ds_queue_empty(move_queue))
    + {
    +     var xx = ds_queue_dequeue(move_queue);
    +     var yy = ds_queue_dequeue(move_queue);
    +     move_towards_point(xx, yy, 4);
    + }

    +

    The above code checks the DS queue indexed in the variable "move_queue" to see if it is empty, and if it is not, it then dequeues the two values from the head of the queue and use them to set a direction for movement.

    +

     

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Queues
    +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Queues/ds_queue_destroy.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Queues/ds_queue_destroy.htm index b1e95eb1c..7f77c87d4 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Queues/ds_queue_destroy.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Queues/ds_queue_destroy.htm @@ -1,69 +1,67 @@ - + - - - ds_queue_destroy - - - - - - - - - -

    ds_queue_destroy

    -

    This function will remove the given queue data structure from memory, freeing up the resources it was using and removing all values that it contained. This function should always be used when you are finished using the DS queue to prevent memory leaks that can slow down and crash your game.

    -
    -

    -

    Syntax:

    -

    ds_queue_destroy(id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idDS QueueThe handle of the data structure to remove.
    -

    -

    Returns:

    -

    N/A

    -

    -

    Example:

    -

    if (lives == 0) -
    - { -
    - ds_queue_destroy(AI_queue); -
    - AI_queue = -1; -
    - room_goto(rm_Menu); -
    - }

    -

    The above code will check the value of the built-in global variable lives and if it is 0, it destroys the DS queue indexed in the variable AI_queue and then changes rooms.

    -

    -

    -
    -
    -
    -
    Back: DS Queues
    - -
    + + + ds_queue_destroy + + + + + + + + + + +

    ds_queue_destroy

    +

    This function will remove the given queue data structure from memory, freeing up the resources it was using and removing all values that it contained. This function should always be used when you are finished using the DS queue to prevent memory leaks that can slow down and crash your game.

    +
    +

     

    +

    Syntax:

    +

    ds_queue_destroy(id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS QueueThe handle of the data structure to remove.
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    if (lives == 0)
    + {
    +     ds_queue_destroy(AI_queue);
    +     AI_queue = -1;
    +     room_goto(rm_Menu);
    + }

    +

    The above code will check the value of the built-in global variable lives and if it is 0, it destroys the DS queue indexed in the variable AI_queue and then changes rooms.

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Queues
    +
    -
    © Copyright YoYo Games Ltd. 2023 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Queues/ds_queue_empty.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Queues/ds_queue_empty.htm index b9bbdcf29..8203554e0 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Queues/ds_queue_empty.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Queues/ds_queue_empty.htm @@ -1,70 +1,68 @@ - + - - - ds_queue_empty - - - - - - - - - - -

    ds_queue_empty

    -

    With this function you can check the given DS queue to see if it is empty (returns true) or not (returns false).

    -

    -

    Syntax:

    -

    ds_queue_empty(id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idDS Queue IDThe handle of the data structure to check.
    -

    -

    Returns:

    -

    Boolean

    -

    -

    Example:

    -

    if (count == 15) && (!ds_queue_empty(command_queue)) -
    - { -
    - ds_queue_clear(command_queue); -
    - alarm[0] = game_get_speed(gamespeed_fps); -
    - ai_count = 0; -
    - }

    -

    The above code checks a variable to see if it has reached a specific value and if it has it clears the DS queue indexed in the variable "command_queue", sets an alarm, and resets the variable to 0.

    -

    -

    -

    -
    -
    -
    -
    Back: DS Queues
    - -
    + + + ds_queue_empty + + + + + + + + + + + +

    ds_queue_empty

    +

    With this function you can check the given DS queue to see if it is empty (returns true) or not (returns false).

    +

     

    +

    Syntax:

    +

    ds_queue_empty(id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS QueueThe handle of the data structure to check.
    +

     

    +

    Returns:

    +

    Boolean

    +

     

    +

    Example:

    +

    if (count == 15) && (!ds_queue_empty(command_queue))
    + {
    +     ds_queue_clear(command_queue);
    +     alarm[0] = game_get_speed(gamespeed_fps);
    +     ai_count = 0;
    + }

    +

    The above code checks a variable to see if it has reached a specific value and if it has it clears the DS queue indexed in the variable "command_queue", sets an alarm, and resets the variable to 0.

    +

     

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Queues
    +
    -
    © Copyright YoYo Games Ltd. 2023 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Queues/ds_queue_read.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Queues/ds_queue_read.htm index e9e9cfc32..787121e09 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Queues/ds_queue_read.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Queues/ds_queue_read.htm @@ -1,84 +1,80 @@ - + - - - ds_queue_read - - - - - - - - - -

    ds_queue_read

    -

    With this function you can recreate a saved DS queue (one that has previously been written as a string using ds_queue_write()). You must first create a new DS queue to read the string into, and if the DS queue already exists and has information stored in it, then this will be cleared before reading. This function is of vital importance when creating save/load mechanisms for your game.

    -

    Note that if the specified DS string was written by the GameMaker: Studio 1.2.x runtime (or older), you should specify the optional argument "legacy", setting it to true as the string format changed after that.

    -

    -

    Syntax:

    -

    ds_queue_read(id, str [, legacy]);

    - - - - - - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idDS Queue IDThe handle of the data structure to read into.
    strStringThe string to read from.
    legacyBooleanOPTIONAL Can be either true or false or omitted completely.
    -

    -

    Returns:

    -

    N/A

    -

    -

    Example:

    -

    queue = ds_queue_create(); -
    - ini_open("save.ini"); -
    - var str = ini_read_string("Queues", "0", ""); -
    - if (str != "") -
    - { -
    - ds_queue_read(queue, str); -
    - } -
    - ini_close();

    -

    The above code creates a queue and stores the index in the variable "queue". It then opens an ini file and reads a string from that, checking to make sure that the string is not returned as empty first. This string is then read into the newly created DS queue.

    -

    -

    -

    -
    -
    -
    -
    Back: DS Queues
    - -
    + + + ds_queue_read + + + + + + + + + + +

    ds_queue_read

    +

    With this function you can recreate a saved DS queue (one that has previously been written as a string using ds_queue_write()). You must first create a new DS queue to read the string into, and if the DS queue already exists and has information stored in it, then this will be cleared before reading. This function is of vital importance when creating save/load mechanisms for your game.

    +

    Note that if the specified DS string was written by the GameMaker: Studio 1.2.x runtime (or older), you should specify the optional argument "legacy", setting it to true as the string format changed after that.

    +

     

    +

    Syntax:

    +

    ds_queue_read(id, str [, legacy]);

    + + + + + + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS QueueThe handle of the data structure to read into.
    strStringThe string to read from.
    legacyBooleanOPTIONAL Can be either true or false or omitted completely.
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    queue = ds_queue_create();
    + ini_open("save.ini");
    + var str = ini_read_string("Queues", "0", "");
    + if (str != "")
    + {
    +     ds_queue_read(queue, str);
    + }
    + ini_close();

    +

    The above code creates a queue and stores the index in the variable "queue". It then opens an ini file and reads a string from that, checking to make sure that the string is not returned as empty first. This string is then read into the newly created DS queue.

    +

     

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Queues
    +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Queues/ds_queue_size.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Queues/ds_queue_size.htm index 2918ccb84..a083ea130 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Queues/ds_queue_size.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Queues/ds_queue_size.htm @@ -1,66 +1,66 @@ - + - - - ds_queue_size - - - - - - - - - - -

    ds_queue_size

    -

    This function will return the "size" of the queue, ie: the number of items that have been queued onto it.

    -

    -

    Syntax:

    -

    ds_queue_size(id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idThe handle of the data structure to check.
    -

    -

    Returns:

    -

    -

    -

    Example:

    -

    if (!ds_queue_empty(control_queue)) -
    - { -
    - num = ds_queue_size(control_queue); -
    - }

    -

    The above code checks a DS queue to see if it is empty or not, and if it is not, it gets the number of items that it contains and stores the value in a variable.

    -

    -

    -

    -
    -
    -
    -
    Back: DS Queues
    - -
    + + + ds_queue_size + + + + + + + + + + + +

    ds_queue_size

    +

    This function will return the "size" of the queue, ie: the number of items that have been queued onto it.

    +

     

    +

    Syntax:

    +

    ds_queue_size(id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS QueueThe handle of the data structure to check.
    +

     

    +

    Returns:

    +

    Real

    +

     

    +

    Example:

    +

    if (!ds_queue_empty(control_queue))
    + {
    +     num = ds_queue_size(control_queue);
    + }

    +

    The above code checks a DS queue to see if it is empty or not, and if it is not, it gets the number of items that it contains and stores the value in a variable.

    +

     

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Queues
    +
    -
    © Copyright YoYo Games Ltd. 2022 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Stacks/ds_stack_clear.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Stacks/ds_stack_clear.htm index 6e8dec85f..473853080 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Stacks/ds_stack_clear.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Stacks/ds_stack_clear.htm @@ -1,69 +1,67 @@ - + - - - ds_stack_clear - - - - - - - - - -

    ds_stack_clear

    -

    With this function you can clear all data from the given stack data-structure. This does NOT destroy the data-structure (for that you should use ds_stack_destroy()) it only wipes all data from it and returns an empty stack.

    -

    -

    Syntax:

    -

    ds_stack_clear(id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idDS Stack IDThe handle of the data structure to clear.
    -

    -

    Returns:

    -

    N/A

    -

    -

    Example:

    -

    if (ai_count = 15 && !ds_stack_empty(AI_stack)) -
    - { -
    - ds_stack_clear(AI_stack); -
    - alarm[0] = game_get_speed(gamespeed_fps); -
    - ai_count = 0; -
    - }

    -

    The above code checks a variable to see if it has reached a specific value and if it has it clears the DS stack indexed in the variable "AI_stack", sets an alarm, and resets the variable to 0.

    -

    -

    -

    -
    -
    -
    -
    Back: DS Stacks
    - -
    + + + ds_stack_clear + + + + + + + + + + +

    ds_stack_clear

    +

    With this function you can clear all data from the given stack data-structure. This does NOT destroy the data-structure (for that you should use ds_stack_destroy()) it only wipes all data from it and returns an empty stack.

    +

     

    +

    Syntax:

    +

    ds_stack_clear(id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS StackThe handle of the data structure to clear.
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    if (ai_count = 15 && !ds_stack_empty(AI_stack))
    + {
    +     ds_stack_clear(AI_stack);
    +     alarm[0] = game_get_speed(gamespeed_fps);
    +     ai_count = 0;
    + }

    +

    The above code checks a variable to see if it has reached a specific value and if it has it clears the DS stack indexed in the variable "AI_stack", sets an alarm, and resets the variable to 0.

    +

     

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Stacks
    +
    -
    © Copyright YoYo Games Ltd. 2023 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Stacks/ds_stack_copy.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Stacks/ds_stack_copy.htm index a6458239f..fbc465e66 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Stacks/ds_stack_copy.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Stacks/ds_stack_copy.htm @@ -45,8 +45,8 @@

    Returns:

    Example:

    with (instance_create_layer(x, y, "Enemies", obj_Enemy))
    {
    - stack = ds_stack_create();
    - ds_stack_copy(stack, other.stack);
    +     stack = ds_stack_create();
    +     ds_stack_copy(stack, other.stack);
    }

    The above function creates a new instance and then in that instance it creates a new DS stack and copies the contents of the stack in the instance running the code block, into the newly created instance stack.

     

    diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Stacks/ds_stack_empty.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Stacks/ds_stack_empty.htm index 2ea188f64..1dca4e2ee 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Stacks/ds_stack_empty.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Stacks/ds_stack_empty.htm @@ -41,9 +41,9 @@

    Returns:

    Example:

    if (ai_count == 15 && !ds_stack_empty(AI_stack))
    {
    - ds_stack_clear(AI_stack);
    - alarm[0] = game_get_speed(gamespeed_fps);
    - ai_count = 0;
    +     ds_stack_clear(AI_stack);
    +     alarm[0] = game_get_speed(gamespeed_fps);
    +     ai_count = 0;
    }

    The above code checks a variable to see if it has reached a specific value and if it has it clears the DS stack indexed in the variable "AI_stack", sets an alarm, and resets the variable to 0.

     

    diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Stacks/ds_stack_pop.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Stacks/ds_stack_pop.htm index ba4da5fd7..a990e0659 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Stacks/ds_stack_pop.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Stacks/ds_stack_pop.htm @@ -1,69 +1,67 @@ - + - - - ds_stack_pop - - - - - - - - - -

    ds_stack_pop

    -

    This function will pop the top value off of the DS stack, removing it from the stack and returning the value to be stored in a variable. If the stack is empty then the function will return the constant undefined, otherwise it will return the real or string value contained in the stack.

    -

    -

    Syntax:

    -

    ds_stack_pop(id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idDS Stack IDThe handle of the data structure to pop from.
    -

    -

    Returns:

    -

    Any (Data type value that is stored in the stack) or undefined

    -

    -

    Example:

    -

    if (!ds_stack_empty(move_stack)) -
    - { -
    - var xx = ds_stack_pop(move_stack); -
    - var yy = ds_stack_pop(move_stack); -
    - move_towards_point(xx, yy, 4); -
    - }

    -

    The above code checks the DS stack indexed in the variable "move_stack" to see if it is empty, and if it is not, it then pops the top two values from the stack and use them to set a direction for movement.

    -

    -

    -

    -
    -
    -
    -
    Back: DS Stacks
    - -
    + + + ds_stack_pop + + + + + + + + + + +

    ds_stack_pop

    +

    This function will pop the top value off of the DS stack, removing it from the stack and returning the value to be stored in a variable. If the stack is empty then the function will return the constant undefined, otherwise it will return the real or string value contained in the stack.

    +

     

    +

    Syntax:

    +

    ds_stack_pop(id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS StackThe handle of the data structure to pop from.
    +

     

    +

    Returns:

    +

    Any (Data type value that is stored in the stack) or undefined

    +

     

    +

    Example:

    +

    if (!ds_stack_empty(move_stack))
    + {
    +     var xx = ds_stack_pop(move_stack);
    +     var yy = ds_stack_pop(move_stack);
    +     move_towards_point(xx, yy, 4);
    + }

    +

    The above code checks the DS stack indexed in the variable "move_stack" to see if it is empty, and if it is not, it then pops the top two values from the stack and use them to set a direction for movement.

    +

     

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Stacks
    +
    -
    © Copyright YoYo Games Ltd. 2023 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Stacks/ds_stack_read.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Stacks/ds_stack_read.htm index 5a035232b..92853bd78 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Stacks/ds_stack_read.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Stacks/ds_stack_read.htm @@ -1,84 +1,80 @@ - + - - - ds_stack_read - - - - - - - - - -

    ds_stack_read

    -

    With this function you can recreate a saved DS stack (one that has previously been written as a string using ds_stack_write()). You must first create a new DS stack to read the string into, and if the DS stack already exists and has information stored in it, then this will be cleared before reading. This function is of vital importance when creating save/load mechanisms for your game.

    -

    Note that if the specified DS string was written by the GameMaker: Studio 1.2.x runtime (or older), you should specify the optional argument "legacy", setting it to true as the string format changed after that.

    -

    -

    Syntax:

    -

    ds_stack_read(id, str [, legacy]);

    - - - - - - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idDS Stack IDThe handle of the data structure to read into.
    strStringThe string to read from.
    legacyBooleanOPTIONAL Can be either true or false or omitted completely.
    -

    -

    Returns:

    -

    N/A

    -

    -

    Example:

    -

    stack = ds_stack_create(); -
    - ini_open("save.ini"); -
    - var str = ini_read_string("Stacks", "0", ""); -
    - if (str != "") -
    - { -
    - ds_stack_read(stack, str); -
    - } -
    - ini_close();

    -

    The above code creates a stack and stores the index in the variable "stack". It then opens an ini file and reads a string from that, checking to make sure that the string is not returned as empty first. This string is then read into the newly created DS stack .

    -

    -

    -

    -
    -
    -
    -
    Back: DS Stacks
    - -
    + + + ds_stack_read + + + + + + + + + + +

    ds_stack_read

    +

    With this function you can recreate a saved DS stack (one that has previously been written as a string using ds_stack_write()). You must first create a new DS stack to read the string into, and if the DS stack already exists and has information stored in it, then this will be cleared before reading. This function is of vital importance when creating save/load mechanisms for your game.

    +

    Note that if the specified DS string was written by the GameMaker: Studio 1.2.x runtime (or older), you should specify the optional argument "legacy", setting it to true as the string format changed after that.

    +

     

    +

    Syntax:

    +

    ds_stack_read(id, str [, legacy]);

    + + + + + + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS StackThe handle of the data structure to read into.
    strStringThe string to read from.
    legacyBooleanOPTIONAL Can be either true or false or omitted completely.
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    stack = ds_stack_create();
    + ini_open("save.ini");
    + var str = ini_read_string("Stacks", "0", "");
    + if (str != "")
    + {
    +     ds_stack_read(stack, str);
    + }
    + ini_close();

    +

    The above code creates a stack and stores the index in the variable "stack". It then opens an ini file and reads a string from that, checking to make sure that the string is not returned as empty first. This string is then read into the newly created DS stack .

    +

     

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Stacks
    +
    -
    © Copyright YoYo Games Ltd. 2023 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Stacks/ds_stack_size.htm b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Stacks/ds_stack_size.htm index 97451daa7..2557eccbd 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Stacks/ds_stack_size.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Data_Structures/DS_Stacks/ds_stack_size.htm @@ -1,66 +1,66 @@ - + - - - ds_stack_size - - - - - - - - - - -

    ds_stack_size

    -

    This function will return the "size" of the stack, ie: the number of items that have been pushed onto it.

    -

    -

    Syntax:

    -

    ds_stack_size(id);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    idDS Stack IDThe handle of the data structure to check.
    -

    -

    Returns:

    -

    Real

    -

    -

    Example:

    -

    if (!ds_stack_empty(control_stack)) -
    - { -
    - num = ds_stack_size(control_stack); -
    - }

    -

    The above code checks a DS stack to see if it is empty or not, and if it is not, it gets the number of items that it contains and stores the value in a variable.

    -

    -

    -

    -
    -
    -
    -
    Back: DS Stacks
    - -
    + + + ds_stack_size + + + + + + + + + + + +

    ds_stack_size

    +

    This function will return the "size" of the stack, ie: the number of items that have been pushed onto it.

    +

     

    +

    Syntax:

    +

    ds_stack_size(id);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    idDS StackThe handle of the data structure to check.
    +

     

    +

    Returns:

    +

    Real

    +

     

    +

    Example:

    +

    if (!ds_stack_empty(control_stack))
    + {
    +     num = ds_stack_size(control_stack);
    + }

    +

    The above code checks a DS stack to see if it is empty or not, and if it is not, it gets the number of items that it contains and stores the value in a variable.

    +

     

    +

     

    +

     

    +
    +
    +
    +
    Back: DS Stacks
    +
    -
    © Copyright YoYo Games Ltd. 2023 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_get_tex_max_aniso_ext.htm b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_get_tex_max_aniso_ext.htm index e5d7e38b6..70c69ee43 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_get_tex_max_aniso_ext.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_get_tex_max_aniso_ext.htm @@ -1,76 +1,76 @@ - + - - - gpu_get_tex_max_aniso_ext - - - - - - - - - - -

    gpu_get_tex_max_aniso_ext

    -

    With this function you can get the current maximum level of anisotropy when using the tf_anisotropic filter mode (see gpu_get_tex_mip_filter() for more information) on a shader sampler. You supply the handle for the shader sampler (as returned by the function shader_get_sampler_index(), and the function will return a value within the range of 1 and 16.

    -

    -

    Syntax:

    -

    gpu_get_tex_max_aniso_ext(sampler_index);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    sampler_indexShader Sampler HandleThe shader sampler to get
    -

    -

    Returns:

    -

    Real (default: 16)

    -

    -

    Example:

    -

    var _sampleIndex = shader_get_sampler_index(shd_Glass, "s_Background"); -
    - var _spriteTex = sprite_get_texture(sprite_index, 0); -
    - shader_set(shd_Glass); -
    - if (gpu_get_tex_max_aniso_ext(_sampleIndex) != 8) -
    - { -
    - gpu_set_tex_max_aniso_ext(_sampleIndex, 8); -
    - } -
    - texture_set_stage(_sampleIndex , _spriteTex); -
    - shader_reset();

    -

    The above code sets the maximum level of anisotropy to 8 for the given shader texture sampler if it has not already been set to 8.

    -

    -

    -

    -
    -
    -
    - - -
    + + + gpu_get_tex_max_aniso_ext + + + + + + + + + + + +

    gpu_get_tex_max_aniso_ext

    +

    With this function you can get the current maximum level of anisotropy when using the tf_anisotropic filter mode (see gpu_get_tex_mip_filter() for more information) on a shader sampler. You supply the handle for the shader sampler (as returned by the function shader_get_sampler_index(), and the function will return a value within the range of 1 and 16.

    +

     

    +

    Syntax:

    +

    gpu_get_tex_max_aniso_ext(sampler_index);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    sampler_indexShader Sampler HandleThe shader sampler to get
    +

     

    +

    Returns:

    +

    Real (default: 16)

    +

     

    +

    Example:

    +

    var _sampleIndex = shader_get_sampler_index(shd_Glass, "s_Background");
    + var _spriteTex = sprite_get_texture(sprite_index, 0);
    +
    + shader_set(shd_Glass);
    +
    + if (gpu_get_tex_max_aniso_ext(_sampleIndex) != 8)
    + {
    +     gpu_set_tex_max_aniso_ext(_sampleIndex, 8);
    + }
    +
    + texture_set_stage(_sampleIndex , _spriteTex);
    +
    + shader_reset(); +

    +

    The above code sets the maximum level of anisotropy to 8 for the given shader texture sampler if it has not already been set to 8.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2024 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_get_tex_max_mip_ext.htm b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_get_tex_max_mip_ext.htm index b489578d3..9aae28581 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_get_tex_max_mip_ext.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_get_tex_max_mip_ext.htm @@ -1,76 +1,71 @@ - + - - - gpu_get_tex_max_mip_ext - - - - - - - - - - -

    gpu_get_tex_max_mip_ext

    -

    With this function you can get the currently set maximum mipmap level which is to be used for a given shader sampler. You supply the handle for the shader sampler (as returned by the function shader_get_sampler_index(), and the function will return the current maximum mipmap level, where a value of 0 is the highest resolution, 1 is to use the first mipmap, 2 is the second etc... Note that this can be quite useful for avoiding bleeding artifacts when rendering textures, for example, setting the texture page border to 8px and then setting the max mipmap level to 3 will ensure you don't get any bleeding problems at greater render distances.

    -

    -

    Syntax:

    -

    gpu_get_tex_max_mip_ext(sampler_index);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    sampler_indexShader Sampler HandleThe shader sampler to get
    -

    -

    Returns:

    -

    Real (default: 16)

    -

    -

    Example:

    -

    var _sampleIndex = shader_get_sampler_index(shd_Glass, "s_Background"); -
    - var _spriteTex = sprite_get_texture(sprite_index, 0); -
    - shader_set(shd_Glass); -
    - if (gpu_get_tex_max_mip_ext(_sampleIndex) != 4) -
    - { -
    - gpu_set_tex_max_mip_ext(_sampleIndex, 4); -
    - } -
    - texture_set_stage(_sampleIndex , _spriteTex); -
    - shader_reset();

    -

    The above code sets the maximum mipmap level to 4 for the given shader texture sampler if it has not already been set to 4.

    -

    -

    -

    -
    -
    -
    - - -
    + + + gpu_get_tex_max_mip_ext + + + + + + + + + + + +

    gpu_get_tex_max_mip_ext

    +

    With this function you can get the currently set maximum mipmap level which is to be used for a given shader sampler. You supply the handle for the shader sampler (as returned by the function shader_get_sampler_index(), and the function will return the current maximum mipmap level, where a value of 0 is the highest resolution, 1 is to use the first mipmap, 2 is the second etc... Note that this can be quite useful for avoiding bleeding artifacts when rendering textures, for example, setting the texture page border to 8px and then setting the max mipmap level to 3 will ensure you don't get any bleeding problems at greater render distances.

    +

     

    +

    Syntax:

    +

    gpu_get_tex_max_mip_ext(sampler_index);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    sampler_indexShader Sampler HandleThe shader sampler to get
    +

     

    +

    Returns:

    +

    Real (default: 16)

    +

     

    +

    Example:

    +

    var _sampleIndex = shader_get_sampler_index(shd_Glass, "s_Background");
    + var _spriteTex = sprite_get_texture(sprite_index, 0);
    + shader_set(shd_Glass);
    + if (gpu_get_tex_max_mip_ext(_sampleIndex) != 4)
    + {
    +     gpu_set_tex_max_mip_ext(_sampleIndex, 4);
    + }
    + texture_set_stage(_sampleIndex , _spriteTex);
    + shader_reset();

    +

    The above code sets the maximum mipmap level to 4 for the given shader texture sampler if it has not already been set to 4.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2024 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_get_tex_min_mip_ext.htm b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_get_tex_min_mip_ext.htm index 4e1aa2512..e6a8e459e 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_get_tex_min_mip_ext.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_get_tex_min_mip_ext.htm @@ -44,7 +44,7 @@

    Example:

    shader_set(shd_Glass);
    if (gpu_get_tex_min_mip_ext(_sampleIndex) != 0)
    {
    - gpu_set_tex_min_mip_ext(_sampleIndex, 0);
    +     gpu_set_tex_min_mip_ext(_sampleIndex, 0);
    }
    texture_set_stage(_sampleIndex , _spriteTex);
    shader_reset();

    diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_get_tex_mip_bias_ext.htm b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_get_tex_mip_bias_ext.htm index 7281ccca4..ad7dcb817 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_get_tex_mip_bias_ext.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_get_tex_mip_bias_ext.htm @@ -1,76 +1,71 @@ - + - - - gpu_get_tex_mip_bias_ext - - - - - - - - - - -

    gpu_get_tex_mip_bias_ext

    -

    With this function you can retrieve the mipmap bias value for a given shader sampler. You supply the handle for the shader sampler (as returned by the function shader_get_sampler_index(), and the function will return a value of 0.0 for no bias, or a greater value where 1 equals the first mipmap, 2 equals the second mipmap etc... This controls the rate at which the mip map is swapped and will generally make the shader textures blurrier the higher the value and the greater the "distance" being viewed. Note that this can return negative values too, in which case shader textures will be sharper over a greater distance the lower the value.

    -

    -

    Syntax:

    -

    gpu_get_tex_mip_bias_ext(sampler_index);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    sampler_indexShader Sampler HandleThe shader sampler to get
    -

    -

    Returns:

    -

    Real (default: 0)

    -

    -

    Example:

    -

    var _sampleIndex = shader_get_sampler_index(shd_Glass, "s_Background"); -
    - var _spriteTex = sprite_get_texture(sprite_index, 0); -
    - shader_set(shd_Glass); -
    - if (gpu_get_tex_mip_bias_ext(_sampleIndex) != 0) -
    - { -
    - gpu_set_tex_mip_bias_ext(_sampleIndex, 0); -
    - } -
    - texture_set_stage(_sampleIndex , _spriteTex); -
    - shader_reset();

    -

    The above code sets the mip filter bias to 0 for the given shader texture sampler if it has not already been set to 0.

    -

    -

    -

    -
    -
    -
    - - -
    + + + gpu_get_tex_mip_bias_ext + + + + + + + + + + + +

    gpu_get_tex_mip_bias_ext

    +

    With this function you can retrieve the mipmap bias value for a given shader sampler. You supply the handle for the shader sampler (as returned by the function shader_get_sampler_index(), and the function will return a value of 0.0 for no bias, or a greater value where 1 equals the first mipmap, 2 equals the second mipmap etc... This controls the rate at which the mip map is swapped and will generally make the shader textures blurrier the higher the value and the greater the "distance" being viewed. Note that this can return negative values too, in which case shader textures will be sharper over a greater distance the lower the value.

    +

     

    +

    Syntax:

    +

    gpu_get_tex_mip_bias_ext(sampler_index);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    sampler_indexShader Sampler HandleThe shader sampler to get
    +

     

    +

    Returns:

    +

    Real (default: 0)

    +

     

    +

    Example:

    +

    var _sampleIndex = shader_get_sampler_index(shd_Glass, "s_Background");
    + var _spriteTex = sprite_get_texture(sprite_index, 0);
    + shader_set(shd_Glass);
    + if (gpu_get_tex_mip_bias_ext(_sampleIndex) != 0)
    + {
    +     gpu_set_tex_mip_bias_ext(_sampleIndex, 0);
    + }
    + texture_set_stage(_sampleIndex , _spriteTex);
    + shader_reset();

    +

    The above code sets the mip filter bias to 0 for the given shader texture sampler if it has not already been set to 0.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2024 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_get_tex_mip_enable_ext.htm b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_get_tex_mip_enable_ext.htm index a70b6f65c..9057c971c 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_get_tex_mip_enable_ext.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_get_tex_mip_enable_ext.htm @@ -1,99 +1,94 @@ - + - - - gpu_get_tex_mip_enable_ext - - - - - - - - - - -

    gpu_get_tex_mip_enable_ext

    -

    With this function you can get whether mipmapping is switched off, switched on for everything or switched on only for texture groups selected in the Texture Group Manager on a shader sampler. You supply the handle for the shader sampler (as returned by the function shader_get_sampler_index(), and the function will return one of the constants listed below.

    -

    -

    Syntax:

    -

    gpu_get_tex_mip_enable_ext(sampler_index);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    sampler_indexShader Sampler HandleThe shader sampler to get
    -

    -

    Returns:

    -

    Constant

    - - - - - - - - - - - - - - - - - - - -
    ConstantDescription
    mip_offMipmapping is disabled.
    mip_onMipmapping for all textures is enabled.
    mip_markedonlyMipmapping is enabled for textures that have it enabled in the Texture Group options.
    -

    -

    Example:

    -

    var _sampleIndex = shader_get_sampler_index(shd_Glass, "s_Background"); -
    - var _spriteTex = sprite_get_texture(sprite_index, 0); -
    - shader_set(shd_Glass); -
    - if (gpu_get_tex_mip_enable_ext(_sampleIndex) != mip_on) -
    - { -
    - gpu_set_tex_mip_enable_ext(_sampleIndex, mip_on); -
    - } -
    - texture_set_stage(_sampleIndex , _spriteTex); -
    - shader_reset();

    -

    The above code enables mipmapping for the given shader texture sampler if it has not already been enabled.

    -

    -

    -

    -
    -
    -
    - - -
    + + + gpu_get_tex_mip_enable_ext + + + + + + + + + + + +

    gpu_get_tex_mip_enable_ext

    +

    With this function you can get whether mipmapping is switched off, switched on for everything or switched on only for texture groups selected in the Texture Group Manager on a shader sampler. You supply the handle for the shader sampler (as returned by the function shader_get_sampler_index(), and the function will return one of the constants listed below.

    +

     

    +

    Syntax:

    +

    gpu_get_tex_mip_enable_ext(sampler_index);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    sampler_indexShader Sampler HandleThe shader sampler to get
    +

     

    +

    Returns:

    +

    Constant

    + + + + + + + + + + + + + + + + + + + +
    ConstantDescription
    mip_offMipmapping is disabled.
    mip_onMipmapping for all textures is enabled.
    mip_markedonlyMipmapping is enabled for textures that have it enabled in the Texture Group options.
    +

     

    +

    Example:

    +

    var _sampleIndex = shader_get_sampler_index(shd_Glass, "s_Background");
    + var _spriteTex = sprite_get_texture(sprite_index, 0);
    + shader_set(shd_Glass);
    + if (gpu_get_tex_mip_enable_ext(_sampleIndex) != mip_on)
    + {
    +     gpu_set_tex_mip_enable_ext(_sampleIndex, mip_on);
    + }
    + texture_set_stage(_sampleIndex , _spriteTex);
    + shader_reset();

    +

    The above code enables mipmapping for the given shader texture sampler if it has not already been enabled.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2024 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_get_tex_mip_filter_ext.htm b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_get_tex_mip_filter_ext.htm index a917087b7..44c1785b9 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_get_tex_mip_filter_ext.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_get_tex_mip_filter_ext.htm @@ -1,100 +1,95 @@ - + - - - gpu_get_tex_mip_filter_ext - - - - - - - - - - -

    gpu_get_tex_mip_filter_ext

    -

    With this function you can get the current mip filter mode for a given shader sampler. You supply the handle for the shader sampler (as returned by the function shader_get_sampler_index(), and the function will return one of the mode value constants listed below.

    -

    -

    Syntax:

    -

    gpu_get_tex_mip_filter_ext(sampler_index);

    - - - - - - - - - - - - - -
    ArgumentTypeDescription
    sampler_indexShader Sampler HandleThe shader sampler to get
    -

    -

    Returns:

    -

    Mipmapping Filter Constant (listed below):

    - - - - - - - - - - - - - - - - - - - -
    ConstantDescription
    tf_pointThis means that blending between mipmap levels is disabled, which can cause visible texture transitions, but gives the best performance.
    tf_linearThis means that blending between mipmap levels is enabled (this is also known as trilinear filtering), which smooths the texture transitions, but it will give a minor hit to performance.
    tf_anisotropicThis means that anisotropic filtering is enabled, which greatly improves texture transition quality and can reduce the blurring visible with other filtering modes, but it has the highest hit on performance.
    -

    -

    -

    Example:

    -

    var _sampleIndex = shader_get_sampler_index(shd_Glass, "s_Background"); -
    - var _spriteTex = sprite_get_texture(sprite_index, 0); -
    - shader_set(shd_Glass); -
    - if (gpu_get_tex_mip_filter_ext(_sampleIndex) != tf_point) -
    - { -
    - gpu_set_tex_mip_filter_ext(_sampleIndex, tf_point); -
    - } -
    - texture_set_stage(_sampleIndex , _spriteTex); -
    - shader_reset();

    -

    The above code sets the mip filter mode to tf_point (disabling mipmapping) for the given shader texture sampler if it has not already been set.

    -

    -

    -

    -
    -
    -
    - - -
    + + + gpu_get_tex_mip_filter_ext + + + + + + + + + + + +

    gpu_get_tex_mip_filter_ext

    +

    With this function you can get the current mip filter mode for a given shader sampler. You supply the handle for the shader sampler (as returned by the function shader_get_sampler_index(), and the function will return one of the mode value constants listed below.

    +

     

    +

    Syntax:

    +

    gpu_get_tex_mip_filter_ext(sampler_index);

    + + + + + + + + + + + + + +
    ArgumentTypeDescription
    sampler_indexShader Sampler HandleThe shader sampler to get
    +

     

    +

    Returns:

    +

    Mipmapping Filter Constant (listed below):

    + + + + + + + + + + + + + + + + + + + +
    ConstantDescription
    tf_pointThis means that blending between mipmap levels is disabled, which can cause visible texture transitions, but gives the best performance.
    tf_linearThis means that blending between mipmap levels is enabled (this is also known as trilinear filtering), which smooths the texture transitions, but it will give a minor hit to performance.
    tf_anisotropicThis means that anisotropic filtering is enabled, which greatly improves texture transition quality and can reduce the blurring visible with other filtering modes, but it has the highest hit on performance.
    +

     

    +

     

    +

    Example:

    +

    var _sampleIndex = shader_get_sampler_index(shd_Glass, "s_Background");
    + var _spriteTex = sprite_get_texture(sprite_index, 0);
    + shader_set(shd_Glass);
    + if (gpu_get_tex_mip_filter_ext(_sampleIndex) != tf_point)
    + {
    +     gpu_set_tex_mip_filter_ext(_sampleIndex, tf_point);
    + }
    + texture_set_stage(_sampleIndex , _spriteTex);
    + shader_reset();

    +

    The above code sets the mip filter mode to tf_point (disabling mipmapping) for the given shader texture sampler if it has not already been set.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2024 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_set_tex_max_aniso_ext.htm b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_set_tex_max_aniso_ext.htm index 0d152cda8..bc10bcbe8 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_set_tex_max_aniso_ext.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_set_tex_max_aniso_ext.htm @@ -1,81 +1,76 @@ - + - - - gpu_set_tex_max_aniso_ext - - - - - - - - - - -

    gpu_set_tex_max_aniso_ext

    -

    With this function you can set the maximum level of anisotropy when using the tf_anisotropic filter mode (see gpu_get_tex_mip_filter() for more information) on a shader sampler. You supply the handle for the shader sampler (as returned by the function shader_get_sampler_index(), and then a value within the range of 1 and 16 to set the level.

    -

    -

    Syntax:

    -

    gpu_set_tex_max_aniso_ext(sampler_index, maxaniso);

    - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    sampler_indexShader Sampler HandleThe shader sampler to get
    maxanisoRealThe maximum anisotropic level to use (default: 16).
    -

    -

    Returns:

    -

    N/A

    -

    -

    Example:

    -

    var _sampleIndex = shader_get_sampler_index(shd_Glass, "s_Background"); -
    - var _spriteTex = sprite_get_texture(sprite_index, 0); -
    - shader_set(shd_Glass); -
    - if (gpu_get_tex_max_aniso_ext(_sampleIndex) != 8) -
    - { -
    - gpu_set_tex_max_aniso_ext(_sampleIndex, 8); -
    - } -
    - texture_set_stage(_sampleIndex , _spriteTex); -
    - shader_reset();

    -

    The above code sets the maximum level of anisotropy to 8 for the given shader texture sampler if it has not already been set to 8.

    -

    -

    -

    -
    -
    -
    - - -
    + + + gpu_set_tex_max_aniso_ext + + + + + + + + + + + +

    gpu_set_tex_max_aniso_ext

    +

    With this function you can set the maximum level of anisotropy when using the tf_anisotropic filter mode (see gpu_get_tex_mip_filter() for more information) on a shader sampler. You supply the handle for the shader sampler (as returned by the function shader_get_sampler_index(), and then a value within the range of 1 and 16 to set the level.

    +

     

    +

    Syntax:

    +

    gpu_set_tex_max_aniso_ext(sampler_index, maxaniso);

    + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    sampler_indexShader Sampler HandleThe shader sampler to get
    maxanisoRealThe maximum anisotropic level to use (default: 16).
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    var _sampleIndex = shader_get_sampler_index(shd_Glass, "s_Background");
    + var _spriteTex = sprite_get_texture(sprite_index, 0);
    + shader_set(shd_Glass);
    + if (gpu_get_tex_max_aniso_ext(_sampleIndex) != 8)
    + {
    +     gpu_set_tex_max_aniso_ext(_sampleIndex, 8);
    + }
    + texture_set_stage(_sampleIndex , _spriteTex);
    + shader_reset();

    +

    The above code sets the maximum level of anisotropy to 8 for the given shader texture sampler if it has not already been set to 8.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2024 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_set_tex_min_mip_ext.htm b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_set_tex_min_mip_ext.htm index 7ba490a0a..6d589593e 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_set_tex_min_mip_ext.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_set_tex_min_mip_ext.htm @@ -1,81 +1,76 @@ - + - - - gpu_set_tex_min_mip_ext - - - - - - - - - - -

    gpu_set_tex_min_mip_ext

    -

    With this function you can set the minimum mipmap level which is currently used for a given shader sampler. You supply the handle for the shader sampler (as returned by the function shader_get_sampler_index(), and then give a value, where 0 is for full resolution, 1 is for the first mipmap, 2 for the second etc...

    -

    -

    Syntax:

    -

    gpu_set_tex_min_mip_ext(sampler_index, minmip);

    - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    sampler_indexShader Sampler HandleThe shader sampler to get
    minmipRealThe minimum mipmap level to use
    -

    -

    Returns:

    -

    N/A

    -

    -

    Example:

    -

    var _sampleIndex = shader_get_sampler_index(shd_Glass, "s_Background"); -
    - var _spriteTex = sprite_get_texture(sprite_index, 0); -
    - shader_set(shd_Glass); -
    - if (gpu_get_tex_min_mip_ext(_sampleIndex) != 0) -
    - { -
    - gpu_set_tex_min_mip_ext(_sampleIndex, 0); -
    - } -
    - texture_set_stage(_sampleIndex , _spriteTex); -
    - shader_reset();

    -

    The above code sets the minimum mipmap level to 0 for the given shader texture sampler if it has not already been set to 0.

    -

    -

    -

    -
    -
    -
    - - -
    + + + gpu_set_tex_min_mip_ext + + + + + + + + + + + +

    gpu_set_tex_min_mip_ext

    +

    With this function you can set the minimum mipmap level which is currently used for a given shader sampler. You supply the handle for the shader sampler (as returned by the function shader_get_sampler_index(), and then give a value, where 0 is for full resolution, 1 is for the first mipmap, 2 for the second etc...

    +

     

    +

    Syntax:

    +

    gpu_set_tex_min_mip_ext(sampler_index, minmip);

    + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    sampler_indexShader Sampler HandleThe shader sampler to get
    minmipRealThe minimum mipmap level to use
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    var _sampleIndex = shader_get_sampler_index(shd_Glass, "s_Background");
    + var _spriteTex = sprite_get_texture(sprite_index, 0);
    + shader_set(shd_Glass);
    + if (gpu_get_tex_min_mip_ext(_sampleIndex) != 0)
    + {
    +     gpu_set_tex_min_mip_ext(_sampleIndex, 0);
    + }
    + texture_set_stage(_sampleIndex , _spriteTex);
    + shader_reset();

    +

    The above code sets the minimum mipmap level to 0 for the given shader texture sampler if it has not already been set to 0.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2024 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_set_tex_mip_bias_ext.htm b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_set_tex_mip_bias_ext.htm index 4cd6319a7..45292316f 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_set_tex_mip_bias_ext.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_set_tex_mip_bias_ext.htm @@ -1,80 +1,75 @@ - + - - - gpu_set_tex_mip_bias_ext - - - - - - - - - -

    gpu_set_tex_mip_bias_ext

    -

    With this function you can set the mipmap bias value for a given shader sampler. You supply the handle for the shader sampler (as returned by the function shader_get_sampler_index(), and then the bias value, where 0 is for no bias, 1 equals the first mipmap, 2 equals the second mipmap etc... This controls the rate at which the mip map is swapped and will generally make the shader textures blurrier the higher the value and the greater the "distance" being viewed. Note that this function can also take negative values too, in which case shader textures will be sharper over a greater distance the lower the value.

    -

    -

    Syntax:

    -

    gpu_set_tex_mip_bias_ext(sampler_index, bias);

    - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    sampler_indexShader Sampler HandleThe shader sampler to get
    biasRealThe mipmap bias value to use (default: 0)
    -

    -

    Returns:

    -

    N/A

    -

    -

    Example:

    -

    var _sampleIndex = shader_get_sampler_index(shd_Glass, "s_Background"); -
    - var _spriteTex = sprite_get_texture(sprite_index, 0); -
    - shader_set(shd_Glass); -
    - if (gpu_get_tex_mip_bias_ext(_sampleIndex) != 0) -
    - { -
    - gpu_set_tex_mip_bias_ext(_sampleIndex, 0); -
    - } -
    - texture_set_stage(_sampleIndex , _spriteTex); -
    - shader_reset();

    -

    The above code sets the mip filter bias to 0 for the given shader texture sampler if it has not already been set to 0.

    -

    -

    -

    -
    -
    -
    - - -
    + + + gpu_set_tex_mip_bias_ext + + + + + + + + + + +

    gpu_set_tex_mip_bias_ext

    +

    With this function you can set the mipmap bias value for a given shader sampler. You supply the handle for the shader sampler (as returned by the function shader_get_sampler_index(), and then the bias value, where 0 is for no bias, 1 equals the first mipmap, 2 equals the second mipmap etc... This controls the rate at which the mip map is swapped and will generally make the shader textures blurrier the higher the value and the greater the "distance" being viewed. Note that this function can also take negative values too, in which case shader textures will be sharper over a greater distance the lower the value.

    +

     

    +

    Syntax:

    +

    gpu_set_tex_mip_bias_ext(sampler_index, bias);

    + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    sampler_indexShader Sampler HandleThe shader sampler to get
    biasRealThe mipmap bias value to use (default: 0)
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    var _sampleIndex = shader_get_sampler_index(shd_Glass, "s_Background");
    + var _spriteTex = sprite_get_texture(sprite_index, 0);
    + shader_set(shd_Glass);
    + if (gpu_get_tex_mip_bias_ext(_sampleIndex) != 0)
    + {
    +     gpu_set_tex_mip_bias_ext(_sampleIndex, 0);
    + }
    + texture_set_stage(_sampleIndex , _spriteTex);
    + shader_reset();

    +

    The above code sets the mip filter bias to 0 for the given shader texture sampler if it has not already been set to 0.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2024 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_set_tex_mip_enable_ext.htm b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_set_tex_mip_enable_ext.htm index 5763f5879..0a7c1f7c4 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_set_tex_mip_enable_ext.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_set_tex_mip_enable_ext.htm @@ -1,103 +1,98 @@ - + - - - gpu_set_tex_mip_enable_ext - - - - - - - - - -

    gpu_set_tex_mip_enable_ext

    -

    With this function you can set whether mipmapping is switched off, switched on for everything or switched on only for texture groups selected in the Texture Group Manager on a shader sampler. You supply the handle for the shader sampler (as returned by the function shader_get_sampler_index(), and then one of the constants listed below.

    - - - - - - - - - - - - - - - - - - - -
    ConstantDescription
    mip_offMipmapping is disabled.
    mip_onMipmapping for all textures is enabled.
    mip_markedonlyMipmapping is enabled for textures that have it enabled in the Texture Group options (default).
    -

    -

    Syntax:

    -

    gpu_set_tex_mip_enable_ext(sampler_index, setting);

    - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    sampler_indexShader Sampler HandleThe shader sampler to get
    settingMipmapping ConstantThe mipmap setting (a constant, default: mip_markedonly)
    -

    -

    Returns:

    -

    N/A

    -

    -

    Example:

    -

    var _sampleIndex = shader_get_sampler_index(shd_Glass, "s_Background"); -
    - var _spriteTex = sprite_get_texture(sprite_index, 0); -
    - shader_set(shd_Glass); -
    - if (gpu_get_tex_mip_enable_ext(_sampleIndex) != mip_on) -
    - { -
    - gpu_set_tex_mip_enable_ext(_sampleIndex, mip_on); -
    - } -
    - texture_set_stage(_sampleIndex , _spriteTex); -
    - shader_reset();

    -

    The above code enables mipmapping for the given shader texture sampler if it has not already been enabled.

    -

    -

    -

    -
    -
    -
    - - -
    + + + gpu_set_tex_mip_enable_ext + + + + + + + + + + +

    gpu_set_tex_mip_enable_ext

    +

    With this function you can set whether mipmapping is switched off, switched on for everything or switched on only for texture groups selected in the Texture Group Manager on a shader sampler. You supply the handle for the shader sampler (as returned by the function shader_get_sampler_index(), and then one of the constants listed below.

    + + + + + + + + + + + + + + + + + + + +
    ConstantDescription
    mip_offMipmapping is disabled.
    mip_onMipmapping for all textures is enabled.
    mip_markedonlyMipmapping is enabled for textures that have it enabled in the Texture Group options (default).
    +

     

    +

    Syntax:

    +

    gpu_set_tex_mip_enable_ext(sampler_index, setting);

    + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    sampler_indexShader Sampler HandleThe shader sampler to get
    settingMipmapping ConstantThe mipmap setting (a constant, default: mip_markedonly)
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    var _sampleIndex = shader_get_sampler_index(shd_Glass, "s_Background");
    + var _spriteTex = sprite_get_texture(sprite_index, 0);
    + shader_set(shd_Glass);
    + if (gpu_get_tex_mip_enable_ext(_sampleIndex) != mip_on)
    + {
    +     gpu_set_tex_mip_enable_ext(_sampleIndex, mip_on);
    + }
    + texture_set_stage(_sampleIndex , _spriteTex);
    + shader_reset();

    +

    The above code enables mipmapping for the given shader texture sampler if it has not already been enabled.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2024 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_set_tex_mip_filter_ext.htm b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_set_tex_mip_filter_ext.htm index b5ebebdaf..e2a2701e3 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_set_tex_mip_filter_ext.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Mipmapping/gpu_set_tex_mip_filter_ext.htm @@ -1,105 +1,100 @@ - + - - - gpu_set_tex_mip_filter_ext - - - - - - - - - -

    gpu_set_tex_mip_filter_ext

    -

    With this function you can set the mip filter mode for a given shader sampler. You supply the handle for the shader sampler (as returned by the function shader_get_sampler_index(), and then one of the mode value constants listed below.

    -

    - - - - - - - - - - - - - - - - - - - -
    ConstantDescription
    tf_pointThis means that blending between mipmap levels is disabled, which can cause visible texture transitions, but gives the best performance.
    tf_linearThis means that blending between mipmap levels is enabled (this is also known as trilinear filtering), which smooths the texture transitions, but it will give a minor hit to performance.
    tf_anisotropicThis means that anisotropic filtering is enabled, which greatly improves texture transition quality and can reduce the blurring visible with other filtering modes, but it has the highest hit on performance.
    -

    -

    Syntax:

    -

    gpu_set_tex_mip_filter_ext(sampler_index, filter);

    -

    - - - - - - - - - - - - - - - - - - -
    ArgumentTypeDescription
    sampler_indexShader Sampler HandleThe shader sampler to get.
    filterMipmapping Filter ConstantThe mip filter mode to use (a constant, default: tf_point).
    -

    -

    Returns:

    -

    N/A

    -

    -

    Example:

    -

    var _sampleIndex = shader_get_sampler_index(shd_Glass, "s_Background"); -
    - var _spriteTex = sprite_get_texture(sprite_index, 0); -
    - shader_set(shd_Glass); -
    - if (gpu_get_tex_mip_filter_ext(_sampleIndex) != tf_point) -
    - { -
    - gpu_set_tex_mip_filter_ext(_sampleIndex, tf_point); -
    - } -
    - texture_set_stage(_sampleIndex, _spriteTex); -
    - shader_reset();

    -

    The above code sets the mip filter mode to tf_point (disabling mipmapping) for the given shader texture sampler if it has not already been set.

    -

    -

    -

    -
    -
    -
    - - -
    + + + gpu_set_tex_mip_filter_ext + + + + + + + + + + +

    gpu_set_tex_mip_filter_ext

    +

    With this function you can set the mip filter mode for a given shader sampler. You supply the handle for the shader sampler (as returned by the function shader_get_sampler_index(), and then one of the mode value constants listed below.

    +

     

    + + + + + + + + + + + + + + + + + + + +
    ConstantDescription
    tf_pointThis means that blending between mipmap levels is disabled, which can cause visible texture transitions, but gives the best performance.
    tf_linearThis means that blending between mipmap levels is enabled (this is also known as trilinear filtering), which smooths the texture transitions, but it will give a minor hit to performance.
    tf_anisotropicThis means that anisotropic filtering is enabled, which greatly improves texture transition quality and can reduce the blurring visible with other filtering modes, but it has the highest hit on performance.
    +

     

    +

    Syntax:

    +

    gpu_set_tex_mip_filter_ext(sampler_index, filter);

    +

     

    + + + + + + + + + + + + + + + + + + +
    ArgumentTypeDescription
    sampler_indexShader Sampler HandleThe shader sampler to get.
    filterMipmapping Filter ConstantThe mip filter mode to use (a constant, default: tf_point).
    +

     

    +

    Returns:

    +

    N/A

    +

     

    +

    Example:

    +

    var _sampleIndex = shader_get_sampler_index(shd_Glass, "s_Background");
    + var _spriteTex = sprite_get_texture(sprite_index, 0);
    + shader_set(shd_Glass);
    + if (gpu_get_tex_mip_filter_ext(_sampleIndex) != tf_point)
    + {
    +     gpu_set_tex_mip_filter_ext(_sampleIndex, tf_point);
    + }
    + texture_set_stage(_sampleIndex, _spriteTex);
    + shader_reset();

    +

    The above code sets the mip filter mode to tf_point (disabling mipmapping) for the given shader texture sampler if it has not already been set.

    +

     

    +

     

    +

     

    +
    +
    +
    + +
    -
    © Copyright YoYo Games Ltd. 2024 All Rights Reserved
    - + +--> + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Particles/Particle_Systems/part_system_position.htm b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Particles/Particle_Systems/part_system_position.htm index f104cc9f6..ff3e372d7 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Particles/Particle_Systems/part_system_position.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Particles/Particle_Systems/part_system_position.htm @@ -52,7 +52,7 @@

    Returns:

    Example:

    if (mouse_check_button_pressed(mb_left))
    {
    - part_system_position(global.Sname, mouse_x, mouse_y);
    +     part_system_position(global.Sname, mouse_x, mouse_y);
    }

    The above code will check for the press of the mouse button and if it detects one, the particle system indexed in the global variable Sname is shifted to the mouse x/y position.

     

    diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Particles/particle_get_info.htm b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Particles/particle_get_info.htm index 325702111..79d062473 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Particles/particle_get_info.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Drawing/Particles/particle_get_info.htm @@ -21,18 +21,18 @@

    particle_get_info

    In a simplified way, the contents of the struct returned by this function look something like the following:

    part_sys_info_struct =
    {
    - emitters:
    - [
    - {
    - parttype:
    - {
    - // Particle type properties...
    - }
    - // All other particle emitter properties...
    - }
    - // More emitters...
    - ]
    - // All other particle system properties...
    +     emitters:
    +     [
    +         {
    +             parttype:
    +             {
    +                 // Particle type properties...
    +             }
    +             // All other particle emitter properties...
    +         }
    +         // More emitters...
    +     ]
    +     // All other particle system properties...
    };

    The tables below list all variables that are available in each of these three structs.

    Particle System Info

    @@ -528,12 +528,12 @@

    Example 1: Particle Type Info

    var _arr_emitters = _particle_info.emitters;
    if (array_length(_arr_emitters) > 0)
    {
    - var _type_info = _arr_emitters[0].parttype;
    +     var _type_info = _arr_emitters[0].parttype;

    - if (_type_info.additive)
    - {
    - show_debug_message("The first emitter in {0} creates shiny particles!", _asset_name);
    - }
    +     if (_type_info.additive)
    +     {
    +         show_debug_message("The first emitter in {0} creates shiny particles!", _asset_name);
    +     }
    }

    The above code first gets information from an existing Particle System Asset ps_Clouds using particle_get_info and assigns the returned struct to a temporary variable _particle_info. It then looks up the emitters in the particle system through the Particle System Info Struct's emitters variable. If the particle system contains any emitters (i.e. the array's length is greater than 0), the first emitter's parttype variable is assigned to a temporary variable _type_info and checked for additive blending (bm_add). Finally a debug message is shown if additive blending is used for the particle type.