From f1632532b9d3e136d464639b661a32dac020fa31 Mon Sep 17 00:00:00 2001 From: gurpreetsinghmatharoo Date: Tue, 24 Dec 2024 11:40:46 +0530 Subject: [PATCH 01/10] docs(feature): initial (unfinished) work on ce2 new snippets --- .../Code_Editor_Properties/Code_Snippets.htm | 32 ++++++++++++++----- 1 file changed, 24 insertions(+), 8 deletions(-) diff --git a/Manual/contents/The_Asset_Editors/Code_Editor_Properties/Code_Snippets.htm b/Manual/contents/The_Asset_Editors/Code_Editor_Properties/Code_Snippets.htm index 54afa58f3..96a7db03a 100644 --- a/Manual/contents/The_Asset_Editors/Code_Editor_Properties/Code_Snippets.htm +++ b/Manual/contents/The_Asset_Editors/Code_Editor_Properties/Code_Snippets.htm @@ -19,29 +19,48 @@

Code Snippets

A very handy tool you have at your disposal when editing your code is the use of Code Snippets.

These are pre-made blocks of code you can insert into your code at any time. A snippet can have placeholders, where you can insert expressions while entering the snippet.

Using Snippets

-

In The Code Editor, code snippets are inserted through Code Completion. For example, writing for will show its snippet in the Candidate Window, and pressing enter will insert that snippet.

+

In The Code Editor (Beta), code snippets are inserted through Code Completion. For example, writing for will show its snippet in the Candidate Window, and pressing enter will insert that snippet.

Inserting a snippet will highlight its first placeholder. After entering text into that placeholder, press tab to cycle through each placeholder until you have gone through all of them.

Custom Snippets

-

You can also define your own code snippets if you want to. Before doing this, you'll need to create a file called "snippets.txt" in one of the following directories:

+

You can also define your own code snippets if you want to. Before doing this, you'll need to create a file with the extension .tmSnippet in one of the following directories:

This folder is not modified during any update to GameMaker, so your edited file will remain intact (but any edits to the base snippets file in the install directory will be reverted).

-

Once the file is created in the User directory, you can edit it with any text editor following these rules:

+

Each .tmSnippet file must contain one snippet. The following rules must be followed for the file:

+ + +

These snippets must follow a specific format where:

+ +

More rules about the snippet syntax can be found here. If the legacy snippets.txt file (described in the section below) is found in the User directory, all contained snippets will automatically be converted to .tmSnippet files when the IDE is started.

+

Legacy Code Editor

+

When using the Legacy Code Editor, you can press F4 to open the code snippet pop-up:

+

Code Snippets WindowFrom this window you can select with the mouse the snippet to use, or you can press the associated hotkey listed on the right. This will add the snippet to your code for editing.

+

Snippets for the Legacy Code Editor can be created in the same directories listed above, but instead in a snippets.txt file.

+

The following rules must be followed for the snippets file:

Instance Create:

After the colon you add your snippet of code:

-

Instance Create:instance_create_layer(x, y, |layer|, object);

+

Instance Create:instance_create_layer(x, y, {$0:layer}, object);

-

The code that you add must also follow a specific format where:

+

These snippets must follow a specific format where:

Code Snippets Example

-

Legacy Code Editor

-

When using the Legacy Code Editor, you can press F4 to open the code snippet pop-up:

-

Code Snippets WindowFrom this window you can select with the mouse the snippet to use, or you can press the associated hotkey listed on the right. This will add the snippet to your code for editing.

 

 

From 39880d42e7c1d674864ed2faeb665c94a18b5773 Mon Sep 17 00:00:00 2001 From: James Krill <62894991+james-kennedy-krill@users.noreply.github.com> Date: Sat, 28 Dec 2024 09:57:05 -0800 Subject: [PATCH 02/10] Update What_Is_Programming_.htm - Spelling Corrections Corrected a few spelling mistakes. --- .../contents/Quick_Start_Guide/What_Is_Programming_.htm | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Manual/contents/Quick_Start_Guide/What_Is_Programming_.htm b/Manual/contents/Quick_Start_Guide/What_Is_Programming_.htm index 8efcb56ab..80df07698 100644 --- a/Manual/contents/Quick_Start_Guide/What_Is_Programming_.htm +++ b/Manual/contents/Quick_Start_Guide/What_Is_Programming_.htm @@ -26,12 +26,12 @@

What Is Programming?

 

Variables

-

Variables are the cornerstone of programing, along with functions (which we'll cover briefly in a moment). A variable is simply a named value, and in the case above the variable is called "x". Now, "x" can be any value, like -126, or 583, or even 1.56378, but the actual value of "x" is irrelevant as it can vary (hence the name "variable"). What is important is that we take "x" and add 2 to it. It's worth noting that in this case "x" is a built-in variable, which means that it's a variable that is create by GameMaker for all objects, but you can create your own variables too.

-

To create a variable, it must be declared before it can be used. Declaring a variable is telling GameMaker that this new variable exists and it has an initial value. To decalre a variable you would simply do something like this:

+

Variables are the cornerstone of programming, along with functions (which we'll cover briefly in a moment). A variable is simply a named value, and in the case above the variable is called "x". Now, "x" can be any value, like -126, or 583, or even 1.56378, but the actual value of "x" is irrelevant as it can vary (hence the name "variable"). What is important is that we take "x" and add 2 to it. It's worth noting that in this case "x" is a built-in variable, which means that it's a variable that is create by GameMaker for all objects, but you can create your own variables too.

+

To create a variable, it must be declared before it can be used. Declaring a variable is telling GameMaker that this new variable exists and it has an initial value. To declare a variable you would simply do something like this:

Declare GML VisualVariables

or:

points = 0;

-

Once a variable has been declared, then it can be used in further programed code or actions. The great thing about variables is that it permits you to "re-use" a value in multiple places, without actually having to worry about what the value is. For example, say you have a "damage" variable and you use it in various places to tell GameMaker to deal a certain amount of damage to other objects in the game. We may declare "damage" as 20, but later on decide that this is too great a value and want to change it to 10. If we'd used the value 20 instead of a variable, we'd need to go through all our code or actions and change 20 to 10, which is time consuming and error prone. However, using a variable means we only have to change it once to 10 when we declare it and the rest of the code or actions will use this new value.

+

Once a variable has been declared, then it can be used in further programmed code or actions. The great thing about variables is that it permits you to "re-use" a value in multiple places, without actually having to worry about what the value is. For example, say you have a "damage" variable and you use it in various places to tell GameMaker to deal a certain amount of damage to other objects in the game. We may declare "damage" as 20, but later on decide that this is too great a value and want to change it to 10. If we'd used the value 20 instead of a variable, we'd need to go through all our code or actions and change 20 to 10, which is time consuming and error prone. However, using a variable means we only have to change it once to 10 when we declare it and the rest of the code or actions will use this new value.

It is worth noting that there are many different types of variables, and each one has slightly different ways it can be used. We won't be covering this here, but you can find out more information from the GameMaker Language Overview section of the manual.

However, variables are only the first part of the story. The next part is the use of Functions...

 

@@ -146,4 +146,4 @@
© Copyright YoYo Games Ltd. 2022 All R qs_programming --> - \ No newline at end of file + From 839f10713f19de42cb7cf1d6f061cf64f27e776a Mon Sep 17 00:00:00 2001 From: James Krill <62894991+james-kennedy-krill@users.noreply.github.com> Date: Sat, 28 Dec 2024 10:04:17 -0800 Subject: [PATCH 03/10] Update What_Is_Programming_.htm Additional spelling corrections. --- Manual/contents/Quick_Start_Guide/What_Is_Programming_.htm | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Manual/contents/Quick_Start_Guide/What_Is_Programming_.htm b/Manual/contents/Quick_Start_Guide/What_Is_Programming_.htm index 80df07698..808e53dd7 100644 --- a/Manual/contents/Quick_Start_Guide/What_Is_Programming_.htm +++ b/Manual/contents/Quick_Start_Guide/What_Is_Programming_.htm @@ -38,7 +38,7 @@

What Is Programming?

Functions

-

The next main important part of programing is the use of functions along with variables. A function is simply an instruction to the computer to do something, and it can have input values as well as output values (ie: you can give a value to it, and it will do some operation and then return a different value), although not all functions require input, nor do they have an output. To better understand this, let's look at a built-in function in GameMaker.

+

The next main important part of programming is the use of functions along with variables. A function is simply an instruction to the computer to do something, and it can have input values as well as output values (ie: you can give a value to it, and it will do some operation and then return a different value), although not all functions require input, nor do they have an output. To better understand this, let's look at a built-in function in GameMaker.

The function we'll look at is instance_number(), which in GML Visual is the Get Instance Count action. This function/action will retrieve the number of instances of a given object in the game room, and you would use it like this:

Get Instance Count GML VisualAction

or:

@@ -95,7 +95,7 @@

What Is Programming?

Don't worry too much about the actual instance creation part of the above code, as we'll cover that in more detail in the following sections. The important thing to understand here is that you can create conditional expressions that check if something is true or false and have your program respond in different ways. This may seem a very simple thing, but it's actually incredibly powerful and will form the basis for almost everything you do when programming in GameMaker.

 

-

So, to answer our question of "What is programming?", we can say that programming is using a combination of statements  - which can use variable s to form expressions, functions to perform tasks, and conditional s to ask questions - and then run these statements concurrently to achieve an objective. Below you can see a slightly more complex program in GML Visual and GML. Can you guess what it does?

+

So, to answer our question of "What is programming?", we can say that programming is using a combination of statements  - which can use variabless to form expressions, functions to perform tasks, and conditionals to ask questions - and then run these statements concurrently to achieve an objective. Below you can see a slightly more complex program in GML Visual and GML. Can you guess what it does?

GML VisualFinal Code Example

or:

if (mouse_check_button_pressed(mb_left) == true)
From 852297a45c6a811a121bbbea25332dd9f439081e Mon Sep 17 00:00:00 2001 From: gurpreetsinghmatharoo Date: Wed, 8 Jan 2025 16:55:08 +0530 Subject: [PATCH 04/10] docs(general): window_set_size and set_position not working on same frame https://github.com/YoYoGames/GameMaker-Bugs/issues/8960 --- .../The_Game_Window/window_set_position.htm | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/Manual/contents/GameMaker_Language/GML_Reference/Cameras_And_Display/The_Game_Window/window_set_position.htm b/Manual/contents/GameMaker_Language/GML_Reference/Cameras_And_Display/The_Game_Window/window_set_position.htm index 8b50c6c7e..4d522793e 100644 --- a/Manual/contents/GameMaker_Language/GML_Reference/Cameras_And_Display/The_Game_Window/window_set_position.htm +++ b/Manual/contents/GameMaker_Language/GML_Reference/Cameras_And_Display/The_Game_Window/window_set_position.htm @@ -15,7 +15,8 @@

window_set_position

-

With this function you can set the game window to a specific position within the display (on macOS, Linux(Ubuntu) and Windows) or within the browser (HTML5).

+

With this function you can set the game window to a specific position within the display (on macOS, Ubuntu and Windows) or within the browser (HTML5).

+

 Calling this function on the same frame as a call to window_set_size might make it fail to set the window position correctly. Call this function in a different frame (e.g. by setting an alarm for a few frames later to set the position of the window) to prevent issues.

If your HTML5 game uses a custom index.html and that sets the canvas to a fixed position then this function will have no effect on the window position.

 

Syntax:

@@ -29,12 +30,12 @@

Syntax:

x - Real + Real The x coordinate of where to position the window. y - Real + Real The y coordinate of where to position the window. @@ -56,7 +57,7 @@

Example:

Next: window_set_size
-
© Copyright YoYo Games Ltd. 2023 All Rights Reserved
+
© Copyright YoYo Games Ltd. 2024 All Rights Reserved
-

Code Editor Preferences

+

Code Editor 2 Preferences

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

Mini TOC (placeholder)

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

Code Editor Preferences

Main

The main section contains the following options:

@@ -88,7 +88,7 @@

Editing

Theme

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

-

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

+

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

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

Theme Selector

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

diff --git a/Manual/contents/The_Asset_Editors/The_Text_Editor.htm b/Manual/contents/The_Asset_Editors/The_Text_Editor.htm index 34211fc77..7f421a033 100644 --- a/Manual/contents/The_Asset_Editors/The_Text_Editor.htm +++ b/Manual/contents/The_Asset_Editors/The_Text_Editor.htm @@ -4,7 +4,7 @@ - The Code Editor (Beta) + Code Editor 2 (Beta) @@ -12,8 +12,8 @@ -

The Code Editor (Beta)

-

The Code Editor is used to edit text files in your GameMaker projects.

+

Code Editor 2 (Beta)

+

Code Editor 2 is used to edit text files in your GameMaker projects.

You will mostly use this to edit Object Events and Scripts, however it is also used for:

-

If your game contains any Included Files or Extension files of the formats given below, they will be editable in the Code Editor through the right-click menu:

+

If your game contains any Included Files or Extension files of the formats given below, they will be editable in Code Editor 2 through the right-click menu:

Included Files Supported Formats

    @@ -46,13 +46,13 @@

    The Code Editor (Beta)

Editor Frame

-

The Code Editor always opens in a new workspace tab, containing the editor itself, with a frame around it:

+

Code Editor 2 always opens in a new workspace tab, containing the editor itself, with a frame around it:

 Closing an editor window will automatically save any unsaved changes in open documents.

This page covers all parts of the Editor Frame. For information on writing code inside the editor, see Editing Code and Code Completion.

Workspace Tab Menu

-

 Right-clicking the workspace tab for the Code Editor will display the following options:

-

These are the Code Editor-specific options:

+

 Right-clicking the workspace tab for Code Editor 2 will display the following options:

+

These are the Code Editor 2-specific options:

 Changing the active document when you have split views open will remove those split views and reset the editor to a single view.

@@ -117,13 +117,13 @@

Horizontal Scrollbar

The horizontal scrollbar appears at the bottom of the frame, to scroll left or right. This has the following parts:

Further Reading

-

Read these pages to learn more about writing code in the Code Editor:

+

Read these pages to learn more about writing code in Code Editor 2:

 

-

So, to answer our question of "What is programming?", we can say that programming is using a combination of statements  - which can use variabless to form expressions, functions to perform tasks, and conditionals to ask questions - and then run these statements concurrently to achieve an objective. Below you can see a slightly more complex program in GML Visual and GML. Can you guess what it does?

+

So, to answer our question of "What is programming?", we can say that programming is using a combination of statements  - which can use variables to form expressions, functions to perform tasks, and conditionals to ask questions - and then run these statements concurrently to achieve an objective. Below you can see a slightly more complex program in GML Visual and GML. Can you guess what it does?

GML VisualFinal Code Example

or:

if (mouse_check_button_pressed(mb_left) == true)