audio_create_play_queue
-This function prepares a buffer queue for audio. You pass data format (only buffer_u8 or buffer_s16 are currently supported), the sample rate (which can be between 1000hz and 48000hz), and the channels that the audio requires from one of the constants listed below:
+This function prepares a buffer queue for audio. You pass the data format (only buffer_u8 or buffer_s16 are currently supported), the sample rate (which can be between 1000Hz and 48000Hz), and the channels that the audio requires from one of the constants listed below:
| queueIndex | -Audio Queue ID | +Audio Queue ID | The index of the queue to free. |
| Argument | Type | +Argument | +Type | Description | -
|---|---|---|---|---|
| camera_id | + | camera_id | +Camera ID | The unique camera ID value returned when you created the camera. | -
| width | + | width | +Real | The width of the camera view in pixels | -
| height | + | height | +Real | The height of the camera view in pixels | -
Returns:
-+
N/A
Example:
-camera_set_view_size(view_camera[0], view_wport[0], view_hport[0]);
+camera_set_view_size(view_camera[0], view_wport[0], view_hport[0]);
The above code will set the view camera size for the camera assigned to view port[0].
-
-
debug_mode
-This read only variable returns true when the game is being played in debug mode and false when being played as normal.
+debug_mode
+This read-only variable returns true when the game is being run in debug mode and false when being played as normal.
Syntax:
-debug_mode
+debug_mode
Returns:
- +
Example:
-if (debug_mode)
+
if (debug_mode)
{
ini_open("Cheats.ini");
}
@@ -32,18 +32,17 @@
Example:
{ini_open("Game.ini");
} -
The above code opens a different ini file depending on the value of the read-only variable debug_mode.
-+
The above code opens a different INI file depending on the value of the read-only variable debug_mode.
-
highscore_value
+highscore_value
With this function you can retrieve the score value that has been stored in the high score list at the given position. If no score has been entered, the function will return 0.
Syntax:
-highscore_value(place);
+highscore_value(place);
| Argument | Type | +Argument | +Type | Description | -
|---|---|---|---|---|
| place | + | place | +Real | The place on the table (1-10). | -
Returns:
-+
Example:
var i = 9;
@@ -49,11 +51,11 @@
Example:
\ No newline at end of file diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Physics/Physics_Variables/Physics_Variables.htm b/Manual/contents/GameMaker_Language/GML_Reference/Physics/Physics_Variables/Physics_Variables.htm index d9a8b7209..608d57ca7 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Physics/Physics_Variables/Physics_Variables.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Physics/Physics_Variables/Physics_Variables.htm @@ -64,7 +64,7 @@Physics Variables
© Copyright YoYo Games Ltd. 2023 All Rights Reserved
+© Copyright YoYo Games Ltd. 2024 All Rights Reserved
Sound Mixer
-
While creating any project it can be useful to check and set volumes of groups of sounds together, so that you can be sure that in-game they all sound correct. This can be tricky when you have to open each individual sound editor within the workspace, and so GameMaker permits you to open a Sound Mixer window where you can play multiple sounds all from the same place and tweak their volume levels accordingly. This window can be opened from the Sound Editor (which will add that selected sound to the mixer view) or from the Tools Menu.
To add sounds to the mixer, you can use 
/ 
+
to select sounds in the Asset Browser and then open the right click 
menu and select Open In Sound Mixer. Alternatively, you can click on a sound asset and drag it into the mixer.
While creating any project it can be useful to check and set volumes of groups of sounds together, so that you can be sure that in-game they all sound correct. This can be tricky when you have to open each individual sound editor within the workspace, and so GameMaker permits you to open a Sound Mixer window where you can play multiple sounds all from the same place and tweak their volume levels accordingly. This window can be opened from The Sound Editor (which will add that selected sound to the mixer view) or from The Tools Menu.
To add sounds to the mixer, you can use / + to select sounds in The Asset Browser and then open the right-click menu and select Open In Sound Mixer. Alternatively, you can click on a sound asset and drag it into the mixer.
The mixer itself is split into the following sections:
- Column Controls: This section contains the controls for the column of sounds. You can choose to play back all sounds in the column, as well as set them to loop or rewind to the start. You can also set the volume that they should be played back at, and changing this value will change it for all sounds in the group in real time. -
- Audio Group: If you have assigned sound resources to different Audio Groups then you can select the group from this drop-down menu and all the sounds will be added to the current sound mixer column. -
- Sound Assets: This part of the column view shows each of the sounds that have been added to the mixer. You can set the overall volume for all sounds for the column at the top of the mixer, then use the individual sound volume controllers to change it as required, and you can also playback and loop individual sounds. To remove a sound from the column view, simply click the close button
for the sound, and you can also expand/collapse the individual sound playback and volume controls to make the view more compact.
+ - Audio Group: If you have assigned sound assets to different Audio Groups then you can select the group from this drop-down menu and all the sounds will be added to the current sound mixer column. +
- Sound Assets: This part of the column view shows each of the sounds that have been added to the mixer. You can set the overall volume for the column at the top of the mixer, then use the individual sound volume controllers to change it as required, and you can also play back and loop individual sounds. Note that moving volume sliders updates the volume at which sounds are heard in real time. To remove a sound from the column view, simply click the close button for the sound, and you can also expand/collapse the individual sound playback and volume controls to make the view more compact.
- Link Columns: The Link Columns button
will link adjacent columns meaning that their volume and playback controls will now be linked. So, any sounds that are in either of the linked columns will have their volume affected by changes to either column control. - Extra Column / Add Column: You can add as many extra columns to the sound mixer as required by clicking the large button to the right of the mixer. Each extra column will be added to he right-most column and can then be linked the previous one, and you can add sounds or audio groups as you would normally. If you need to remove a column from the mixer, then you can find the Remove Sound Group button found beside the Audio Group drop down menu.
-
Event Order
-When considering Events in GameMaker, it should be noted that the exact order that ALL the events are going to occur in each step cannot be clearly stated, simply because it depends on the internal workings of GameMaker and this is subject to change as the software develops or based on the platform where the game is running. However there are certain events that will always run in the same order.
+When considering Events in GameMaker, it should be noted that the exact order that ALL the events are going to occur in each step cannot be clearly stated, simply because it depends on the internal workings of GameMaker and this is subject to change as the software develops or based on the platform where the game is running. However, there are certain events that will always run in the same order.
Upon Entering a Room
The first set of events that will always happen the same way are those that occur when a room is first entered. The order that the different events will fire is:
-
@@ -34,9 +34,8 @@
- Room Creation Code - this is the one-off code written in The Room Editor for when a room is first entered.
- Room Start Event of all instances - one of the "Other" category of events and will fire for all instances, persistent or otherwise.
Upon Entering a Room
You can also set the order in which specific instances are created within The Room Editor itself by moving them up or down the list of the Instance Layer Properties window.
Every Step/Frame
-Other than those specific events, events in a game step also always occur in the same order. However, the order of the instances within an event is not always guaranteed, and may vary between different Event Order versions and target platforms.
+Other than those specific events, events in a game step also always occur in the same order. However, the order of the instances within an event is not always guaranteed, it may vary between different Event Order versions and target platforms and may also not correspond to the order in which the instances were created (see Instance Creation Order).
As a general rule, you can rely on the order of the events listed below, but not on the order in which the instances in the room execute one event.
For example, you will see below that the "Step" event always executes after the "Begin Step" event, however you cannot guarantee that, for example, Object2 will always execute its Step event after Object1. If you require such an execution order, then making use of a different event is recommended (e.g. putting Object2's Step code in End Step, if you need it to execute after Object1's Step).
So when you have code that relies on specific timing during each step of your game, make use of the events as listed below. To put it simply, first all Begin Step events are executed, then all Step events are executed, after that all End Step events are executed, then all Draw events, etc.
diff --git a/Manual/contents/The_Asset_Editors/Room_Properties/Room_Properties.htm b/Manual/contents/The_Asset_Editors/Room_Properties/Room_Properties.htm index 9a34784cd..3c464f59c 100644 --- a/Manual/contents/The_Asset_Editors/Room_Properties/Room_Properties.htm +++ b/Manual/contents/The_Asset_Editors/Room_Properties/Room_Properties.htm @@ -22,20 +22,21 @@Clear Display Buffer
After that you have the option to Clear Display Buffer. This option, when checked, pre-fills the display buffer with a colour before drawing anything else for a particular frame. If you know that your views are going to be covering the whole screen at all times or that you have a fullscreen, opaque background being drawn, then you can un-check this, which saves a redraw and so helps optimise your game.
However if you have multiple views that, when on-screen leave open spaces, or your background has transparent parts - you can check this so any empty areas are filled in with the draw colour of your choice. Currently this colour can only be set through code using window_set_colour().
For clearing views, please see Clear Viewport Background.
-NOTE If you are using automatic aspect ratio correction (as set in the Game Options), then you should always have this checked otherwise you can get odd effects over the "letterbox" that your game is drawn in. If you do not use this option then you can un-check this and get a small boost to your games performance (especially noticeable on Android and other mobile platforms).
+If you are using automatic aspect ratio correction (as set in the Game Options), then you should always have this checked otherwise you can get odd effects over the "letterbox" that your game is drawn in. If you do not use this option then you can un-check this and get a small boost to your games performance (especially noticeable on Android and other mobile platforms).
Width, Height & Other Options
A room has to have a size and this is defined by the values that you input for its width and height in pixels.
-You can then add the Room Creation Code, should you require it. Creation code is added from the button at the bottom (along with the inherit toggle to say whether the room should inherit it's creation code or not), and if you click it you will open a code or visual editor. This editor allows you to input functions/actions and code that will be run at the start of the room, after the create event of all instances but before their room start event (for more information on event order, please see here). This code will run every time you enter the room, unless the room is flagged as persistent, in which case it will only be run once when the room is first entered, but not on subsequent visits to the room.
+You can then add the Room Creation Code, should you require it. Creation code is added from the button at the bottom (along with the inherit toggle to say whether the room should inherit it's creation code or not), and if you click it you will open a code or visual editor. This editor allows you to input functions/actions and code that will be run at the start of the room, after the Create event of all instances but before their Room Start event (for more information on event order, please see Event Order). This code will run every time you enter the room, unless the room is flagged as persistent, in which case it will only be run once when the room is first entered, but not on subsequent visits to the room.
Instance Creation Order
The final button in the Room Properties permits you to open the Instance Creation Order window:
-
This window lists all the instances in the room in the order that they will be created (from top to bottom). Should you require a specific instance to be created before any other, you can simply click 
and drag it to the position your require. Note that instances will be created in the order given from top to bottom of the list.
+
Cameras And Viewports
The next set of properties for the room that you can define are those relating to the room Camera and Viewports. Camera views give a mechanism for drawing different parts of your room at different places on the screen, or for drawing just a part of your room to cover the whole screen. For example, in most platform games, the camera view follows the main character, as, if you could see the whole level on the screen, your character would be too small to see and there would be no surprises for the player. Camera views can also be used in multi-player games or co-op games, as they permit you to create a split-screen setup in which in one part of the screen you see one player and in another part you see the other player. This can all be easily achieved in GameMaker using camera views.
At the top of the view properties there is a box labeled Enable Viewports. This must be flagged before any of the camera views can be used in your game.
NOTE You can toggle inheritance on or off for the three main viewport settings, and then you can toggle inheritance on or off for each individual camera view.
+You can toggle inheritance on or off for the three main viewport settings, and then you can toggle inheritance on or off for each individual camera view.
The next checkbox is the one that says Clear Viewport Background, which is similar to the Clear Display Buffer option given above but for viewports specifically. When enabled, it clears the application surface with the window colour before drawing each frame. This ensures that you don't see any unintended graphics through transparent areas in your background, such as the contents of any previous frames. It's important to enable this option (along with "Enable Viewports") if your background contains any transparency.
Cameras, Views and View Ports
A camera view is defined by two different sets of values, the camera view itself and the port on the screen where this view is to be drawn. This can sometimes cause confusion so let's explain this a bit before explaining how we define each of them:
@@ -46,7 +47,7 @@Cameras, Views and View Ports
So, for example, this means that you can have a 640x480 camera view into your room, and then set the port to 320x240, which will display the view scaled down to that sized port on the screen, and you can also do the same and set the view to a smaller value and the port to larger making the image scale up to fit the port size and be shown on the screen larger than it is. In this way you can maintain a screen (port) size while changing the camera view to display more or less of the room in the same area of the screen.
Camera and View Port Properties
-The camera view is always defined as a rectangular area in the room, where you specify the position of the top-left corner, the width and the height of this area. Then you must specify where this area is shown in the window on the screen by defining the view port, where again you specify the position of the top-left corner and the size (note that anything other than 0,0 for the top left corner can give strange results). You can have more than one port and they can overlap, in which case they are drawn in the indicated order one on top of the other.
+The camera view is always defined as a rectangular area in the room, where you specify the position of the top-left corner, the width and the height of this area. Then you must specify where this area is shown in the window on the screen by defining the view port, where again you specify the position of the top-left corner and the size (note that anything other than 0, 0 for the top left corner can give strange results). You can have more than one port and they can overlap, in which case they are drawn in the indicated order one on top of the other.
Please realise that the overall screen area is always defined as a rectangular area, so your ports, even when offset, will form a rectangle, with any empty spaces being filled in by the window colour of the display buffer, meaning that in these circumstances you should always have Clear Display Buffer checked or else you will get odd artefacts drawn in the spaces between ports. The image below illustrates this, where there are two offset view ports visible, yet they make a square window, and "underneath" there are lines being drawn to the display buffer:
Object Following
@@ -56,10 +57,10 @@Object Following
Room Physics
-Before you can use the built in physics functions in your games, you must tell GameMaker that the room is a physics room. To do this, you must tick the option to Enable Physics at the top of the Room Physics section (you can also toggle the inheritance of this section independently of the rest of the room settings). Once you have done that you can then continue on to set up the physics world properties, which are some basic properties that you must have pre-defined before your room will allow physics instances to work as such. For a more precise control over the world you can use code (see the Physics Functions for more information).
-
The next thing you must do is set up the Gravity of the world. The strength and direction of this is calculated as a vector of the x/y position that you set around a (0, 0) point. So, an x of 0 and a y of 1 will set the gravity direction as being down with a force of 1 meter per second (for a more detailed explanation see - The Physics World).
Before you can use the built-in physics functions in your games, you must tell GameMaker that the room is a physics room. To do this, you must tick the option to Enable Physics at the top of the Room Physics section (you can also toggle the inheritance of this section independently of the rest of the room settings). Once you have done that you can then continue on to set up the physics world properties, which are some basic properties that you must have pre-defined before your room will allow physics instances to work as such. For a more precise control over the world you can use code (see the Physics Functions for more information).
+The next thing you must do is set up the Gravity of the world. The strength and direction of this is calculated as a vector of the x/y position that you set around a (0, 0) point. So, an x of 0 and a y of 1 will set the gravity direction as being down with a force of 1 meter per second (for a more detailed explanation see - The Physics World).
Finally you must set the ratio of Pixels To Meters for GameMaker to use as a base for all its physics calculations. This is because the physics functions work on real-world measurements, which is why we must set this value, and you'll want to adjust this setting until the average pixel size of the objects you are using translates roughly into simulated physics objects of an appropriate size.
-It should be noted that enabling physics in a room means that all physics enabled instances in the room must use the physics functions and variables to move. Basically, you have "traditional" movement, where you can set the X/Y position of an instance or set its speed and direction, and then you have the "physics" movement, which requires physical forces and impulses to move around. These systems are mutually exlusive, and you cannot move a physics instance using non-physics functions and you cannot move a non-physics instance using the physics functions.
+It should be noted that enabling physics in a room means that all physics enabled instances in the room must use the physics functions and variables to move. Basically, you have "traditional" movement, where you can set the X/Y position of an instance or set its speed and direction, and then you have the "physics" movement, which requires physical forces and impulses to move around. These systems are mutually exclusive, and you cannot move a physics instance using non-physics functions and you cannot move a non-physics instance using the physics functions.
@@ -67,7 +68,7 @@
Room Physics
© Copyright YoYo Games Ltd. 2024 All Rights Reserved
diff --git a/Manual/contents/The_Asset_Editors/Rooms.htm b/Manual/contents/The_Asset_Editors/Rooms.htm index 2eec0b6a5..e48b2391d 100644 --- a/Manual/contents/The_Asset_Editors/Rooms.htm +++ b/Manual/contents/The_Asset_Editors/Rooms.htm @@ -17,9 +17,9 @@The Room Editor
The Room Editor is where you create your game rooms. Every game requires at least one room to run, and in the room you can place instances, sprites, tiles, paths, backgrounds, sequences, text and particle systems. Each of these different assets can be placed on their own unique layer which can then be ordered however you wish in the Layer Editor. Due to the complexity of the Room Editor, we'll give you first a brief overview of the most important features, and then you can find more in-depth details from the section links listed below.
-When you create a room asset, you can right click on it in The Asset Browser to open the context menu, which will permit you to create child rooms (see the page on Room Inheritance for more information), open up the room for editing, add a new asset group to better organise the rooms, rename the room or delete it. Note that to change the room order and/or inheritance you need to use The Room Manager, which you can open using the menu in the top right of the Asset Browser.
When you create a room asset, you can right-click on it in The Asset Browser to open the context menu, which will permit you to create child rooms (see the page on Room Inheritance for more information), open up the room for editing, add a new asset group to better organise the rooms, rename the room or delete it. Note that to change the room order and/or inheritance you need to use The Room Manager, which you can open using the menu in the top right of the Asset Browser.
The Room Editor is itself a workspace and as such you can click on the tab and drag it off of the main window into a new window of its own - perhaps in another display, for example. You can also place it back into the main window by dragging the tab to the top of the IDE and releasing the mouse button.
The user interface for the Room Editor is simple to navigate and split in various discrete sections. Those parts of the editor that are docked - The Inspector that shows the room or layer properties and the Layer Editor - can also be removed from the dock by simply dragging them out into the workspace, and they can be added back into the docks again by dragging them to the sides or the bottom of the workspace.
+The user interface for the Room Editor is simple to navigate and split into various discrete sections. Those parts of the editor that are docked - The Inspector that shows the room or layer properties and the Layer Editor - can also be removed from the dock by simply dragging them out into the workspace, and they can be added back into the docks again by dragging them to the sides or the bottom of the workspace.
Below is a brief overview of each of the Room Editor sections:
The Room Editor
The Element List appears when a valid type of layer (i.e. one that holds elements) is selected. This includes Instance Layers that hold Object Instances, and Asset Layers that hold visual assets of various types.
-This list will show you all the elements present in the selected layer. Each entry in the list contains a 
checkbox that enables/disables that element. It then shows its icon, asset name and the identifier of that element.
This list will show you all the elements present on the selected layer. Each entry in the list contains a checkbox that enables/disables that element. It then shows its icon, asset name and the identifier of that element.
Clicking on any element in the list will show you its properties in the Inspector:
-
Elements in this list can be re-ordered by clicking and dragging them to the position required. For instances, this is purely for organisational purposes within the Room Editor and if you want to set a specific creation order, use the Instance Creation Order menu, which can be opened from the Room Properties in the Inspector, or from the Room context menu.
At the top of the list, you can filter the list with a search string. This string is checked against both the instance identifiers and the asset names.
+Elements in this list can be reordered by clicking and dragging them to the position required. For instances, this is purely for organisational purposes within the Room Editor and if you want to set a specific creation order, use the Instance Creation Order menu, which can be opened from the Room Properties in the Inspector, or from the Room context menu.
At the top of the list, you can filter the list with a search string. This string is checked against both the instance identifiers and the asset names.
The 
menu can be used to detach the list or attach it to any of the four sides of the Room Canvas. You can resize the sidebar by dragging its edge facing the Room Canvas, and clicking on the edge will close the sidebar.
Room Menu
- Layer View: This will re-open the Layer Editor window should you have closed it at any time.
- Instance Creation Order: This will open the Instance Creation Order Window (which can also be opened by using the button in the Room Properties window):
-
This window lists all the instances in the room in the order that they will be created (from top to bottom). Should you require a specific instance to be created before any other, you can simply click and drag it to the position you require.
+
- Reset Windows On Current Desktop: This will reset the Room Editor window layout to its default values for the desktop workspace currently focused.
- Disable Filters Preview: Selecting this will disable the preview of all Filters/Effects in the current Room Editor and change the option to "Enable Filters Preview" which enables the FX previews again. This setting is not carried over to other open Room Editors and is reset upon closing the current Editor. diff --git a/Manual/contents/assets/Images/Asset_Editors/Editor_Images.png b/Manual/contents/assets/Images/Asset_Editors/Editor_Images.png index a417a6425..45898feef 100644 Binary files a/Manual/contents/assets/Images/Asset_Editors/Editor_Images.png and b/Manual/contents/assets/Images/Asset_Editors/Editor_Images.png differ diff --git a/Manual/contents/assets/Images/IDE Tools/Audio_Mixer.png b/Manual/contents/assets/Images/IDE Tools/Audio_Mixer.png index cb82381a8..5eb4f7393 100644 Binary files a/Manual/contents/assets/Images/IDE Tools/Audio_Mixer.png and b/Manual/contents/assets/Images/IDE Tools/Audio_Mixer.png differ diff --git a/Manual/contents/assets/Images/IDE_Input/Help_Menu_Report_Bug_Window.png b/Manual/contents/assets/Images/IDE_Input/Help_Menu_Report_Bug_Window.png index b5648c4ca..738638cfc 100644 Binary files a/Manual/contents/assets/Images/IDE_Input/Help_Menu_Report_Bug_Window.png and b/Manual/contents/assets/Images/IDE_Input/Help_Menu_Report_Bug_Window.png differ diff --git a/Manual/contents/assets/Images/Settings/Android_General1_Options.png b/Manual/contents/assets/Images/Settings/Android_General1_Options.png index 40e587a33..ff48cd4ac 100644 Binary files a/Manual/contents/assets/Images/Settings/Android_General1_Options.png and b/Manual/contents/assets/Images/Settings/Android_General1_Options.png differ diff --git a/Manual/contents/assets/Images/Settings/Android_Graphics_Options.png b/Manual/contents/assets/Images/Settings/Android_Graphics_Options.png index c846fbebd..5fb087f66 100644 Binary files a/Manual/contents/assets/Images/Settings/Android_Graphics_Options.png and b/Manual/contents/assets/Images/Settings/Android_Graphics_Options.png differ diff --git a/Manual/contents/assets/Images/Settings/iOS_Graphics_Options.png b/Manual/contents/assets/Images/Settings/iOS_Graphics_Options.png index 96dbecbf8..e68404914 100644 Binary files a/Manual/contents/assets/Images/Settings/iOS_Graphics_Options.png and b/Manual/contents/assets/Images/Settings/iOS_Graphics_Options.png differ diff --git a/Manual/contents/assets/Images/Setup_And_Version/Preferences/ImageEditor_Tools_Prefs.png b/Manual/contents/assets/Images/Setup_And_Version/Preferences/ImageEditor_Tools_Prefs.png index c30c67c16..3969bfb64 100644 Binary files a/Manual/contents/assets/Images/Setup_And_Version/Preferences/ImageEditor_Tools_Prefs.png and b/Manual/contents/assets/Images/Setup_And_Version/Preferences/ImageEditor_Tools_Prefs.png differ diff --git a/Manual/contents/assets/snippets/Instance_Creation_Order_Description.hts b/Manual/contents/assets/snippets/Instance_Creation_Order_Description.hts new file mode 100644 index 000000000..7c60ddf50 --- /dev/null +++ b/Manual/contents/assets/snippets/Instance_Creation_Order_Description.hts @@ -0,0 +1,17 @@ + + + + + + + +
- sprite_index +
- sprite_width +
- sprite_height +
- sprite_xoffset +
- sprite_yoffset +
- image_alpha +
- image_angle +
- image_blend +
- image_index +
- image_number +
- image_speed +
- image_xscale +
- image_yscale +
- mask_index +
- bbox_bottom +
- bbox_left +
- bbox_right +
- bbox_top +
This window lists all the instances in the room in the order that they will be created (from top to bottom of the list). By default, this corresponds to the order in which you add the instances to the room in the Room Editor, as new instances are added to the end of this list. Should you require a specific instance to be created before any other, you can simply click 
and drag it to the position you require.
+
+ Instance creation order doesn't guarantee execution order within the same event. For example, if one instance is created before another one it may not mean it runs its Step event, Draw event, etc., before the other instance as well.
+
These variables are all related to the sprite assigned to the instance and can be used to change what is drawn and how:
+-
+
+ +
These variables deal with the collision mask:
+-
+