From 1fe5f730861bccc82f94acd79f189cc096cdeb73 Mon Sep 17 00:00:00 2001 From: YYBartT Date: Tue, 3 Oct 2023 10:52:37 +0200 Subject: [PATCH 001/116] [Feature]Feature Request #1318 * Added new function page using batch script and added item to ToC, updated links * Added new See Also that lists all functions that add assets at runtime and linked it on the page --- .../Assets_And_Tags/Assets_And_Tags.htm | 37 +++++----- .../Assets_And_Tags/asset_get_ids.htm | 72 +++++++++++++++++++ .../Assets_And_Tags/asset_get_index.htm | 8 +-- .../Assets_And_Tags/asset_get_tags.htm | 4 +- .../Assets_And_Tags/tag_get_assets.htm | 12 ++-- .../Object_Properties/Parent_Objects.htm | 60 +++++----------- Manual/contents/assets/scripts/gml.js | 2 + Manual/seealso/keywords.seealso | 2 +- Manual/toc/Default.toc | 1 + 9 files changed, 123 insertions(+), 75 deletions(-) create mode 100644 Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Assets_And_Tags/asset_get_ids.htm diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Assets_And_Tags/Assets_And_Tags.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Assets_And_Tags/Assets_And_Tags.htm index 7da4edc34..9eb716dfa 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Assets_And_Tags/Assets_And_Tags.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Assets_And_Tags/Assets_And_Tags.htm @@ -4,7 +4,7 @@ Assets And Tags - + @@ -15,32 +15,33 @@

Assets And Tags

-

The functions listed here are specifically designed for getting information from any of the assets defined in the Asset Browser, as well as the tags that have been assigned to them. Tags are a very powerful tool, both in the Asset Browser and in your actual game code, as they can be read and created at run time, giving you additional ways to filter assets when your game is running and create conditional checks or "parent"-type systems outside of the object-based system.

-

For assets in general we have the following functions:

+

The functions listed here are specifically designed for getting information from any of the assets defined in The Asset Browser, as well as the tags that have been assigned to them.

+

Tags are a very powerful tool, both in The Asset Browser and in your actual game code, as they can be read and created at runtime, giving you additional ways to filter assets when your game is running and create conditional checks or "parent"-type systems outside of the object-based system.

+

Function Reference

+

General

-

 

-

For dealing with the Asset browser "tags" system, we have the following functions:

+

Tags

 

 

-

 

-
Back: Asset Management
-
Next: Animation Curves
+
Back: Asset Management
+
Next: Animation Curves
© Copyright YoYo Games Ltd. 2023 All Rights Reserved
diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Assets_And_Tags/asset_get_ids.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Assets_And_Tags/asset_get_ids.htm new file mode 100644 index 000000000..f2384d9a3 --- /dev/null +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Assets_And_Tags/asset_get_ids.htm @@ -0,0 +1,72 @@ + + + + + + asset_get_ids + + + + + + + + + + +

asset_get_ids

+

This function gets an array of references to assets of the given asset type.

+

 The returned array contains assets that you added through The Asset Browser as well as assets that you added dynamically at runtime.

+
+

See Also (placeholder)

+
    +
  1. Topic List
    2. +
+
+

Syntax:

+

asset_get_ids(asset_type);

+ + + + + + + + + + + + + + + + + + +
ArgumentTypeDescription
asset_typeAsset Type ConstantThe type of asset to return in the array
+

 

+

Returns:

+

Array of Asset

+

 

+

Example:

+

var _arr_ids = asset_get_ids(asset_sprite);

+

The code above gets all sprites in the game at the time the function is called and stores them in a temporary variable _arr_ids. Sprites that you added before using the sprite_add_* functions are also included.

+

 

+

 

+
+
+
+ + +
+
+
© 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/Assets_And_Tags/asset_get_index.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Assets_And_Tags/asset_get_index.htm index 23accf67e..c1b71a48e 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Assets_And_Tags/asset_get_index.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Assets_And_Tags/asset_get_index.htm @@ -4,7 +4,7 @@ asset_get_index - + @@ -15,12 +15,12 @@ -

asset_get_index

+

asset_get_index

This function gets the unique identifying index for a game asset from its name.

-

If the asset is not found, the function will return a value of -1, otherwise it will return the unique index id for the asset being checked. This id can then be used in other functions as you would any other index value, like the sprite_index or the path_index, for example. Please note that although this function can be used to reference assets from strings (see example below), you should always make sure that the asset exists before using it otherwise you may get errors that will crash your game.

+

If the asset is not found, the function will return a value of -1, otherwise it will return the unique index ID for the asset being checked. This ID can then be used in other functions as you would any other index value, like the sprite_index or the path_index, for example. Please note that although this function can be used to reference assets from strings (see example below), you should always make sure that the asset exists before using it otherwise you may get errors that will crash your game.

 

Syntax:

-

asset_get_index(name);

+

asset_get_index(name);

diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Assets_And_Tags/asset_get_tags.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Assets_And_Tags/asset_get_tags.htm index 9cd84ce8f..b2fb3e993 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Assets_And_Tags/asset_get_tags.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Assets_And_Tags/asset_get_tags.htm @@ -4,7 +4,7 @@ asset_get_tags - + @@ -17,7 +17,7 @@

asset_get_tags

This function retrieves all tags assigned to an asset from The Asset Browser.

-

You supply either the asset name (as a string) or its asset index, and the function will return an array of tags for that asset. If no tags are found or there is an error (ie: the name string given doesn't exist) then the returned array will be empty. If you supply an asset index value, then you will need to supply the optional asset type argument (a constant), as assets of different types can have the same index, even though they cannot have the same name. The available asset types are listed in the table below:

+

You supply either the asset name (as a string) or its asset index, and the function will return an array of tags for that asset. If no tags are found or there is an error (i.e.: the name string given doesn't exist) then the returned array will be empty. If you supply an asset index value, then you will need to supply the optional asset type argument (a constant), as assets of different types can have the same index, even though they cannot have the same name. The available asset types are listed in the table below:

 

Syntax:

diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Assets_And_Tags/tag_get_assets.htm b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Assets_And_Tags/tag_get_assets.htm index 2b9355dce..4e842e3e8 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Assets_And_Tags/tag_get_assets.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Asset_Management/Assets_And_Tags/tag_get_assets.htm @@ -4,7 +4,7 @@ tag_get_assets - + @@ -15,12 +15,12 @@ -

tag_get_assets

+

tag_get_assets

This function retrieves the names of all assets that have been assigned the given tag or tags.

-

You supply either a single tag string or an array, where each item in the array is a tag string. The function will return an array where each entry is the name (as a string) of the asset with the given tag. If you need the unique index for the asset, then you can use the function asset_get_index() along with the returned name. If there are no assets with the given tag(s), or if there is an error (eg: the given tags do not exist), then an empty array will be returned.

+

You supply either a single tag string or an Array, where each item in the array is a tag string. The function will return an array where each entry is the name (as a string) of the asset with the given tag. If you need the unique index for the asset, then you can use the function asset_get_index along with the returned name. If there are no assets with the given tag(s), or if there is an error (e.g.: the given tags don't exist), then an empty array will be returned.

 

Syntax:

-

tag_get_assets(tags);

+

tag_get_assets(tags);

@@ -55,8 +55,8 @@

Example:

- - + +
© Copyright YoYo Games Ltd. 2023 All Rights Reserved
diff --git a/Manual/contents/The_Asset_Editors/Object_Properties/Parent_Objects.htm b/Manual/contents/The_Asset_Editors/Object_Properties/Parent_Objects.htm index ff8128e6b..64164d79c 100644 --- a/Manual/contents/The_Asset_Editors/Object_Properties/Parent_Objects.htm +++ b/Manual/contents/The_Asset_Editors/Object_Properties/Parent_Objects.htm @@ -4,7 +4,7 @@ Parent Objects - + @@ -14,48 +14,20 @@ -

Parent Objects

-

When working with objects in the GameMaker IDE, you can set up Parent / Child hierarchies. This is done by clicking the "Parent" button in the object editor and then choosing another object from the Asset Browser - to be the "parent" of the one being edited:

-

Adding A ParentSo, every object in your game project can have a parent object, but what does this mean? Well, when an object has a parent assigned it can - share code, actions and events with that parent. This sharing is called "inheritance" and an object that has a parent is called a "child" object. Not only can a child share code with its parent, but you can do checks and run code - on parent objects and it will automatically include the child objects too, which saves a lot of time and energy.

-

If that sounds complicated, then another way to look at a parent object is as a way to "group" objects together under the same umbrella and have them share certain things without losing their own unique identity. Maybe that still doesn't - clarify things too much, so let's give some examples...

-

Say you have a "player" object and four different "enemy" objects. Now, you want the player to die if he touches any of these four objects and this would normally entail four different collision events with four different sets of - actions or code, one for each of the enemy objects. BUT if we make a parent object for all the enemies, then we can create one collision event with the parent object only and it will trigger no matter which one of the four "child" enemy - objects touch the player. Handy stuff! In the actual GameMaker object you would see something like this:

-

Parenting For CollisionsOn the left we have four separate collision events and on the right we have a single collision event, as we have created a - "parent" object and assigned all the enemy objects to it. Note that a parent object doesn't have to have any events or code in it...

-

Another example of parenting would be if you have a game where you want to create 10 different looking objects and have them all behave in the same way. For that you would create one parent object and in that have all your behaviour actions or code - in the required events, and then you would create your ten objects with no actions or code, but different sprites, and assign them your parent object. Now, when you place these instances in a room they will all behave the same, but look different, - since they will "inherit" the events of the parent.

-

Finally you can use parenting to "mix and match" events and behaviours. We'll illustrate this with one final example... Say you want two monsters: one that moves up and down, while another that moves left and right, but you also want the - two of them to have the same health, shoot at the player and hurt the player if they collide with them. In this case you can see that almost all events should have the same actions except for one or two that govern movement. So, again, we can make - one object the parent of the other, but in this case we also define certain events for the child object. These events "override" the parent events, meaning that whenever an event for the child object contains actions, these are executed - instead of the actions contained in the event of the parent. If you also want to execute the parent event you can call the so-called "inherited" event using the function event_inherited(), - or the GML Visual action Call Parent Event.

-

Inheriting EventsOn the left above is the parent object with 5 events in it, and on the right you can see the "child" object. The child object - also has 5 events in it, but two of them override the inherited events from the parent (the Step and Draw events) and the other three are greyed out as they are the events inherited from the parent. Inherited events - will also have the "parent override" icon beside them in the Event Editor:

-

Parent OverrideWhen you click LMB Icon on an event that has been inherited, - it will open the code editor to show the inherited parent code, but you will not be able to edit this code as you can only edit it in the parent object itself. You can click the right mouse button RMB Icon on any of the parent events to open the following menu of options:

-

Parent Event RMB MenuHere you can choose two Open the parent event to inspect the code, or you can choose to Inherit the - event or Override the event. If you choose Inherit then the code editor will open with the function event_inherited() already - added to it (or the Call Parent Event action if using GML Visual). Any further code you place in this event will now be run as well as the code that the parent object - has. If you choose to Override the event, then the code window will also open, only now the event_inherited() function won't be called, so anything you add here will be run instead of the code - in the parent object.

-

NOTE: From the code editor you can quickly navigate to the parent object by clicking the right mouse button RMB Icon and selecting Go To Object from the pop-up menu, or (if the event has been overridden) you can select Open Inherited Event to go directly to a code editor with the parent event code in it.

-

Whenever you target a parent object in code, the code will also apply to the "children" of the parent object too. This happens when, in an action, you indicate that the action must be applied to instances of a certain object, and in code it - happens when you use the with() statement. It will work like this too when you call code functions, like instance_position(), - instance_number(), etc... where - if you supply a parent object - all instances of the parent and child instances - will be included in the checks. Finally, parenting works when you refer to variables in other objects too, like in the above monster example if I set the enemy 1 speed to 10, then the enemy 2 speed will also go to ten as it is a child object of enemy - 1.

-

It is generally considered good practice in most cases to create one base parent object and have this base object contain all the default behaviour but never use an instance of it in the game. Rather use all child objects and only use the parent in - situations like those I have outlined above, for collisions, for referencing variables, etc... You should also realise that parents can have parents too! Obviously you can't create a cycle of "parent 1 is child of parent 2 is child of parent - 1" but you can create what is called "object hierarchy" where "parent3 is child of parent2 is child of parent1". This is extremely useful to keep your game structured and you are strongly advised - to learn to use this mechanism.

+

Parent Objects

+

When working with objects in the GameMaker IDE, you can set up Parent / Child hierarchies. This is done by clicking the "Parent" button in the object editor and then choosing another object from the Asset Browser to be the "parent" of the one being edited:

+

Adding A ParentSo, every object in your game project can have a parent object, but what does this mean? Well, when an object has a parent assigned it can share code, actions and events with that parent. This sharing is called "inheritance" and an object that has a parent is called a "child" object. Not only can a child share code with its parent, but you can do checks and run code on parent objects and it will automatically include the child objects too, which saves a lot of time and energy.

+

If that sounds complicated, then another way to look at a parent object is as a way to "group" objects together under the same umbrella and have them share certain things without losing their own unique identity. Maybe that still doesn't clarify things too much, so let's give some examples...

+

Say you have a "player" object and four different "enemy" objects. Now, you want the player to die if he touches any of these four objects and this would normally entail four different collision events with four different sets of actions or code, one for each of the enemy objects. BUT if we make a parent object for all the enemies, then we can create one collision event with the parent object only and it will trigger no matter which one of the four "child" enemy objects touch the player. Handy stuff! In the actual GameMaker object you would see something like this:

+

Parenting For CollisionsOn the left we have four separate collision events and on the right we have a single collision event, as we have created a "parent" object and assigned all the enemy objects to it. Note that a parent object doesn't have to have any events or code in it...

+

Another example of parenting would be if you have a game where you want to create 10 different looking objects and have them all behave in the same way. For that you would create one parent object and in that have all your behaviour actions or code in the required events, and then you would create your ten objects with no actions or code, but different sprites, and assign them your parent object. Now, when you place these instances in a room they will all behave the same, but look different, since they will "inherit" the events of the parent.

+

Finally you can use parenting to "mix and match" events and behaviours. We'll illustrate this with one final example... Say you want two monsters: one that moves up and down, while another that moves left and right, but you also want the two of them to have the same health, shoot at the player and hurt the player if they collide with them. In this case you can see that almost all events should have the same actions except for one or two that govern movement. So, again, we can make one object the parent of the other, but in this case we also define certain events for the child object. These events "override" the parent events, meaning that whenever an event for the child object contains actions, these are executed instead of the actions contained in the event of the parent. If you also want to execute the parent event you can call the so-called "inherited" event using the function event_inherited(), or the GML Visual action Call Parent Event.

+

Inheriting EventsOn the left above is the parent object with 5 events in it, and on the right you can see the "child" object. The child object also has 5 events in it, but two of them override the inherited events from the parent (the Step and Draw events) and the other three are greyed out as they are the events inherited from the parent. Inherited events will also have the "parent override" icon beside them in the Event Editor:

+

Parent OverrideWhen you click LMB Icon on an event that has been inherited, it will open the code editor to show the inherited parent code, but you will not be able to edit this code as you can only edit it in the parent object itself. You can click the right mouse button RMB Icon on any of the parent events to open the following menu of options:

+

Parent Event RMB MenuHere you can choose two Open the parent event to inspect the code, or you can choose to Inherit the event or Override the event. If you choose Inherit then the code editor will open with the function event_inherited() already added to it (or the Call Parent Event action if using GML Visual). Any further code you place in this event will now be run as well as the code that the parent object has. If you choose to Override the event, then the code window will also open, only now the event_inherited() function won't be called, so anything you add here will be run instead of the code in the parent object.

+

NOTE: From the code editor you can quickly navigate to the parent object by clicking the right mouse button RMB Icon and selecting Go To Object from the pop-up menu, or (if the event has been overridden) you can select Open Inherited Event to go directly to a code editor with the parent event code in it.

+

Whenever you target a parent object in code, the code will also apply to the "children" of the parent object too. This happens when, in an action, you indicate that the action must be applied to instances of a certain object, and in code it happens when you use the with() statement. It will work like this too when you call code functions, like instance_position(), instance_number(), etc... where - if you supply a parent object - all instances of the parent and child instances will be included in the checks. Finally, parenting works when you refer to variables in other objects too, like in the above monster example if I set the enemy 1 speed to 10, then the enemy 2 speed will also go to ten as it is a child object of enemy 1.

+

It is generally considered good practice in most cases to create one base parent object and have this base object contain all the default behaviour but never use an instance of it in the game. Rather use all child objects and only use the parent in situations like those I have outlined above, for collisions, for referencing variables, etc... You should also realise that parents can have parents too! Obviously you can't create a cycle of "parent 1 is child of parent 2 is child of parent 1" but you can create what is called "object hierarchy" where "parent3 is child of parent2 is child of parent1". This is extremely useful to keep your game structured and you are strongly advised to learn to use this mechanism.

 

 

 

@@ -66,7 +38,7 @@

Parent Objects

Next: Physics Objects
-
© Copyright YoYo Games Ltd. 2021 All Rights Reserved
+
© Copyright YoYo Games Ltd. 2023 All Rights Reserved
-

Instance Variables

-

An instance variable is created within an instance of an object and is considered unique to that instance - ie: many instances of the same object can have the same variable, but each variable can hold a different value as they are unique to - each instance. But how is an instance variable created? Well, you create new variables by simply assigning a value to them as shown in this small example (this is called declaring the variable):

-

potions = 12;
life = 100;
name = "Jock MacSweeney";
strength = 5.5;
armour = -2;

-

As you can see you just have to give the name and then a value (the value can be any data type) to set that variable and have it ready for use within an instance of the object you are coding for (note that the value can - come from the return value of a function or the result of an operation between other variables, etc...). These variables can then be used and modified in a number of ways from within the instance, for example this code could be in a collision event - and used to take an amount off of the variable "life":

+

Instance Variables

+

An instance variable is created within an instance of an object and is considered unique to that instance - i.e.: many instances of the same object can have the same variable, but each variable can hold a different value as they are unique to each instance. But how is an instance variable created? Well, you create new variables by simply assigning a value to them as shown in this small example (this is called declaring the variable):

+

potions = 12;
+ life = 100;
+ name = "Jock MacSweeney";
+ strength = 5.5;
+ armour = -2;

+

As you can see you just have to give the name and then a value (the value can be any data type) to set that variable and have it ready for use within an instance of the object you are coding for (note that the value can come from the return value of a function or the result of an operation between other variables, etc.). These variables can then be used and modified in a number of ways from within the instance, for example this code could be in a collision event and used to take an amount off of the variable "life":

life -= 5 + armour;

-

If "life" is at 100 it will now have a value of 97 (100 - (5 + -2) = 97). Now, that's a simple example, and you could replace "armour" for the actual value of -2, - but what happens if that value is hard-coded in multiple places and then you decide to change it? You would have to go through ALL your code and change every -2 to whatever the new value - is, which is time consuming and very error prone! But if you use a variable, all you have to do is reassign it a new value and the code will automatically use that new value from then onwards, making things far more flexible and far easier to fix - should there be a problem. It should also be noted that even if a value is not going to change it is far easier to remember what a variable called "life" means rather than just looking at a number.

-

GameMaker has a collection of "built in" instance variables too, so you should be aware of them as you may name one of your own instance variables the same or wish to have your own global variable with the same name and wonder why - you are getting errors. They are easy to spot, however, as they are shown in a different colour in the code editor and also come up in auto-complete and are shown in bar at the bottom of the code editor.

+

If "life" is at 100 it will now have a value of 97 (100 - (5 + -2) = 97). Now, that's a simple example, and you could replace "armour" for the actual value of -2, but what happens if that value is hard-coded in multiple places and then you decide to change it? You would have to go through ALL your code and change every -2 to whatever the new value is, which is time consuming and very error prone! But if you use a variable, all you have to do is reassign it a new value and the code will automatically use that new value from then onwards, making things far more flexible and far easier to fix should there be a problem. It should also be noted that even if a value is not going to change it is far easier to remember what a variable called "life" means rather than just looking at a number.

+

GameMaker has a collection of "built in" instance variables too, so you should be aware of them as you may name one of your own instance variables the same or wish to have your own global variable with the same name and wonder why you are getting errors. They are easy to spot, however, as they are shown in a different colour in the code editor and also come up in auto-complete and are shown in bar at the bottom of the code editor.

There are quite a few runtime functions designed to help you when dealing with instance variables, which are all listed in the following section:

@@ -30,44 +32,43 @@

Syntax:

- + - + - - + + - - + +
pathPath AssetPath Asset The path index to start.
speedRealReal The speed of which to follow the path in pixels per step, negative meaning going backwards.
endactionPath End Action ConstantWhat to do when the end of the path is reached (see the constants listed above).Path End Action ConstantWhat to do when the end of the path is reached.
absoluteBooleanWhether the calling instance should follow the absolute path as it is in the editor (true) or a relative path to its current position (false).BooleanWhether the calling instance should follow the absolute path as it is defined in The Path Editor (true) or a relative path to its current position (false).

 

Returns:

-

N/A

+

N/A

 

Example:

-

path_start(path, 4, path_action_reverse, 0);

+

path_start(path, 4, path_action_reverse, false);

This will make the calling instance follow the path indexed in the variable "path" at a speed of 4 pixels per step. It will follow the path relative to its own position, and when it reaches the end it will reverse direction and go back the way it came.

 

 

-

 

-
Back: Paths
-
Next: path_end
+
Back: Paths
+
Next: path_end
-
© Copyright YoYo Games Ltd. 2022 All Rights Reserved
+
© Copyright YoYo Games Ltd. 2023 All Rights Reserved
-

buffer_seek

-

This function can be used to move through a buffer, finding the start, the end, or a position relative to that which was last used when reading or writing data. This seek position is where new values are written, and from where values are read. It also moves automatically when you read from or write to a buffer.

-

The "offset" value is the offset (in bytes) to add to the given seek position, for example, if the base is relative and the offset is 4, then the buffer position will move along 4 bytes from its current position. Please note the following:

-

buffer_base64_decode_ext

-

With this function you can decode a base64 encoded string (created using the buffer_base64_encode() function) into a buffer. Unlike the function buffer_base64_decode(), - this will not create a buffer for you, but rather you should already have created the buffer (see buffer_create()), the id of which you would then use with this function. The "offset" is the - position within the buffer to decode the given string (in bytes).

+

With this function you can decode a base64 encoded string (created using the buffer_base64_encode() function) into a buffer. Unlike the function buffer_base64_decode(), this will not create a buffer for you, but rather you should already have created the buffer (see buffer_create()), the id of which you would then use with this function. The "offset" is the position within the buffer to decode the given string (in bytes).

 

Syntax:

buffer_base64_decode_ext(buffer, string, offset);

- + + - + - + + - + - + + - + - + + - +
ArgumentTypeArgumentType Description
bufferbufferBuffer ID The index of the buffer to decode the string into.
stringstringString The base64 encoded string to decode.
offsetoffsetReal The data offset value.

 

Returns:

-

+

N/A

 

Example:

-

buff = buffer_create(16384, buffer_grow, 2);
ini_open("Save.ini"); -
var str = ini_read_string("Save", "Slot1", "");
buffer_base64_decode_ext(buff, str, 0);
ini_close(); -

-

The above code will create a buffer and store the unique id for it in the variable "buff", then open an ini file and read a string from it into the local variable "str". This string is then decoded into the newly created buffer before - closing the ini file again.

+

buff = buffer_create(16384, buffer_grow, 2);
+ ini_open("Save.ini");
+ var str = ini_read_string("Save", "Slot1", "");
+ buffer_base64_decode_ext(buff, str, 0);
+ ini_close();

+

The above code will create a buffer and store the unique id for it in the variable "buff", then open an ini file and read a string from it into the local variable "str". This string is then decoded into the newly created buffer before closing the ini file again.

 

 

 

@@ -59,10 +62,10 @@

Example:

Back: Buffers
-
Next: buffer_set_used_size
+
Next: game_load_buffer
-
© Copyright YoYo Games Ltd. 2021 All Rights Reserved
+
© Copyright YoYo Games Ltd. 2023 All Rights Reserved
+ + + \ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Buffers/buffer_get_size.htm b/Manual/contents/GameMaker_Language/GML_Reference/Buffers/buffer_get_size.htm index f9d7fec4e..12511612b 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Buffers/buffer_get_size.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Buffers/buffer_get_size.htm @@ -4,7 +4,7 @@ buffer_get_size - + @@ -29,14 +29,14 @@

Syntax:

buffer - Buffer ID + Buffer ID The index of the buffer to get the size of.

 

Returns:

-

Real

+

Real

 

Example:

var _size = buffer_get_size(player_data);
@@ -49,10 +49,10 @@

Example:

Back: Buffers
-
Next: buffer_get_surface
+
Next: buffer_resize
-
© Copyright YoYo Games Ltd. 2022 All Rights Reserved
+
© Copyright YoYo Games Ltd. 2023 All Rights Reserved

buffer_set_used_size

This function is primarily for use within extensions, and allows you to set the "used" size of the given buffer, which is the number of bytes that have been written to it.

-

When you write data to a buffer from an extension, GameMaker does not know how much of the buffer was filled by the extension code and is not able to read that data. This function can be called by the extension to tell the engine how many bytes of data - was written to the buffer, so the engine can read that data.

+

When you write data to a buffer from an extension, GameMaker does not know how much of the buffer was filled by the extension code and is not able to read that data. This function can be called by the extension to tell the engine how many bytes of data was written to the buffer, so the engine can read that data.

 

Syntax:

buffer_set_used_size(buffer, size);

- + + - + - + + - + - + + - +
ArgumentTypeArgumentType Description
bufferbufferBuffer ID The index of the buffer to use.
sizesizeReal The number of bytes to set as the "used" size.

 

Returns:

-

+

N/A

 

Example:

-

buffer_write(_bufferAddress, buffer_u8, 1);
buffer_write(_bufferAddress, buffer_u8, 2);
buffer_write(_bufferAddress, buffer_u16, 400);
-
buffer_set_used_size(_bufferAddress, 4);

+

buffer_write(_bufferAddress, buffer_u8, 1);
+ buffer_write(_bufferAddress, buffer_u8, 2);
+ buffer_write(_bufferAddress, buffer_u16, 400);
+
+ buffer_set_used_size(_bufferAddress, 4); +

The above functions would be called in an extension to write some data to a GameMaker buffer (through its memory address), and then set the number of bytes that were written to it so the engine can read that data.

 

 

@@ -51,10 +57,10 @@

Example:

Back: Buffers
-
Next: buffer_exists
+
Next: buffer_copy
-
© Copyright YoYo Games Ltd. 2021 All Rights Reserved
+
© Copyright YoYo Games Ltd. 2023 All Rights Reserved

buffer_sizeof

-

This function will return the size (in bytes) of the given Buffer Data Type Constant (listed here).

+

This function will return the size (in bytes) of the given Buffer Data Type Constant (listed here).

 

Syntax:

buffer_sizeof(type);

@@ -29,14 +29,14 @@

Syntax:

type - Buffer Data Type Constant + Buffer Data Type Constant The type of data that is to be checked (see the list of constants here).

 

Returns:

-

Real

+

Real

 

Example:

var b = 12 * buffer_sizeof(buffer_u8);
@@ -49,10 +49,10 @@

Example:

Back: Buffers
-
Next: buffer_md5
+
Next: buffer_set_used_size
-
© Copyright YoYo Games Ltd. 2022 All Rights Reserved
+
© Copyright YoYo Games Ltd. 2023 All Rights Reserved
-

Asset Management

-

The following sections explain the functions and variables that you have available to you for manipulating the different assets used in your project, including creating new dynamic assets or editing and changing those that are added into your game through the Asset Browser in the room editor or sequence editor.

+

Asset Management

+

The following sections explain the functions and variables that you have available to you for manipulating the different assets used in your project, including creating new dynamic assets or editing and changing those that are added into your game through The Asset Browser in The Room Editor or The Sequence Editor.

-

 

+

Dynamically Added Assets

+

Functions for Particle Systems can be found here: Particle Systems

There are also extra functions related to the handling of game assets and tags added from the Asset Browser. These functions can be found in the following section:

You get a handle when you create a new resource (with a _create() function) or reference an existing resource in your code (like referencing an object, getting an instance through a function, etc.).

diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Buffers/Buffers.htm b/Manual/contents/GameMaker_Language/GML_Reference/Buffers/Buffers.htm index bf15a1258..735975e91 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Buffers/Buffers.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Buffers/Buffers.htm @@ -24,14 +24,14 @@

Usage Notes

  • The "alignment" argument refers to how data is stored within a buffer. If your alignment is set to say, 4, and you write a single piece of data which is 1 byte in size then do a buffer_tell, you'll get an offset of 1. However, if you write another piece of data, also 1 byte in size, then do a buffer_tell, you'll get an offset of 5 as the alignment has "padded" the data to that size. Alignment only affects where things are written to, so if you do a buffer_tell after you write something, it'll return the current write position which immediately follows the data you've written. Note, however, that if you then write another piece of data, internally the buffer will move the write position along to the next multiple of the alignment size before actually writing the piece of data.
  • When dealing with "offset", this is the value in bytes to offset the data by within the given buffer. So if your buffer is 2 byte aligned and you want to skip the first 4 aligned places, you would have an offset of 2 * 4 bytes.
  • Some of the buffer functions also create a new buffer (like buffer_load for example). Remember that these buffers will also need to be removed from memory when not in use using the buffer_delete function.
    • -
  • The memory used for creating buffers is system memory so even when the game doesn't have focus, any data stored in a buffer should be safe, however if the app is closed or re-started then it will be lost.
    • +
  • The memory used for creating buffers is system memory so even when the game doesn't have focus, any data stored in a buffer should be safe, however if the app is closed or restarted then it will be lost.

    • The following pages explain how buffers work within the context of GameMaker and contain a couple of code examples for those users that are unsure of how to use them:

    -

    When you create a buffer, the index value used to identify it is an integer value starting at 0. These indices are re-used by GameMaker, so a destroyed buffer index value may be used by a newly created one afterwards, and we recommend that you set any variable that holds a buffer index to -1 after having destroyed the buffer.

    +

    When you create a buffer, a reference to the new buffer is returned. After the buffer is destroyed, we recommend that you set the variable that holds a buffer reference to -1.

    Function Reference

    General