From e6fb8b69c85894994d649b4c7c59a6a1fa606c34 Mon Sep 17 00:00:00 2001 From: David Luevano Alvarado Date: Tue, 29 Aug 2023 04:17:09 -0600 Subject: add godot layer notes --- db/db_blog.psv | 3 +- live/blog/g/flappybird_godot_devlog_2.html | 10 +- live/blog/g/godot_layers_and_masks_notes.html | 164 ++++++++++++++++++++++++++ live/blog/index.html | 1 + live/blog/rss.xml | 26 +++- live/blog/sitemap.xml | 8 +- live/blog/tag/@english.html | 1 + live/blog/tag/@gamedev.html | 1 + live/blog/tag/@gdscript.html | 1 + live/blog/tag/@godot.html | 1 + src/blog/g/flappybird_godot_devlog_2.md | 2 +- src/blog/g/godot_layers_and_masks_notes.md | 25 ++++ src/blog/temp/godot_collision_layers_notes.md | 12 -- 13 files changed, 237 insertions(+), 18 deletions(-) create mode 100644 live/blog/g/godot_layers_and_masks_notes.html create mode 100644 src/blog/g/godot_layers_and_masks_notes.md delete mode 100644 src/blog/temp/godot_collision_layers_notes.md diff --git a/db/db_blog.psv b/db/db_blog.psv index cd255e5..16f2921 100644 --- a/db/db_blog.psv +++ b/db/db_blog.psv @@ -27,4 +27,5 @@ a/arch_logs_flooding_disk.md|1686824540.5338242|1686824666.933781|261eeee98ecbb2 a/torrenting_with_qbittorrent.md|1690164384.3800702|1690170668.4089742|413b7f2764a40fea97f2a22a942ff305|code,english,server,tools,tutorial a/jellyfin_server_with_sonarr_radarr.md|1690173014.2185652|1690173137.3785434|831c3b7c4183648dbc3be4547fe50686|code,english,server,tools,tutorial a/pastebin_alt_with_privatebin.md|1692524793.86829|1692527331.9501805|7605e02fc2b613617be56fdf43471664|code,english,server,tools,tutorial -g/flappybird_godot_devlog_2.md|1693178890.8924305|1693183054.9629443|f4e75adc747b9bf150a7126667185039|english,gamedev,gdscript,godot +g/flappybird_godot_devlog_2.md|1693178890.8924305|1693304066.9573946|a1b0a6483829aea59a6251b47da210c6|english,gamedev,gdscript,godot +g/godot_layers_and_masks_notes.md|1693303806.3574584|0.0|407b8f66cdde17ac2f8c113921805d98|english,gamedev,gdscript,godot diff --git a/live/blog/g/flappybird_godot_devlog_2.html b/live/blog/g/flappybird_godot_devlog_2.html index b7a5047..d4f764b 100644 --- a/live/blog/g/flappybird_godot_devlog_2.html +++ b/live/blog/g/flappybird_godot_devlog_2.html @@ -116,7 +116,7 @@

Porting to Godot 4

-

Disclaimer: I started the port back in Godot 4.0 something and left the project for a while, then opened the project again in Godot 4.1, and it didn’t ask to convert anything so probably nowadays the conversion is better.

+

Disclaimer: I started the port back in Godot 4.0 something and left the project for a while, then opened the project again in Godot 4.1, and it didn’t ask to convert anything so probably nowadays the conversion is better. Godot’s documentation is pretty useful, I looked at the GDScript reference and GDScript exports and that helped a lot.

General changes

These include the first changes for fixing some of the conflicting code to at least make it run (no gameplay) as well as project settings adjustments.

+ + + + Next + + @@ -299,7 +305,7 @@ AudioServer.set_bus_mute(_bus, true) # false to unmute

By David Luévano

Created: Sun, Aug 27, 2023 @ 23:28 UTC

-

Modified: Mon, Aug 28, 2023 @ 00:37 UTC

+

Modified: Tue, Aug 29, 2023 @ 10:14 UTC

Tags: english, gamedev, gdscript, godot

diff --git a/live/blog/g/godot_layers_and_masks_notes.html b/live/blog/g/godot_layers_and_masks_notes.html new file mode 100644 index 0000000..f13805e --- /dev/null +++ b/live/blog/g/godot_layers_and_masks_notes.html @@ -0,0 +1,164 @@ + + + + + + +Godot layers and masks notes -- Luévano's Blog + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ +
+
+ +
+

Godot layers and masks notes

+ +

The first time I learned about Godot’s collision layers and masks (will refer to them just as layers) I thought I understood them only to find out that they’re a bit confusing when trying to figure out interactions between objects that are supposed to detect each other. On my last entry where I ported the FlappyBird clone to Godot 4.1 I stumbled upon an issue with the bird not colliding properly with the pipes and the ceiling detector not… well, detecting.

+

At the end of the day the issue wasn’t that the layers weren’t properly setup but rather that the API to change the state of the collision layers changed between Godot 3 and Godot 4: when calling set_collision_layer_value (or .._mask) instead of specifying the bit which starts at 0, the layer_number is required that happens to start at 1. This was a headache for like an hour and made me realise that I didn’t understand layers that well or else I would’ve picked the error almost instantly.

+

While researching I found two really good short explainations that helped me grasp the concepts better in the same post, the first a bit technical (by Bojidar Marinov):

+
    +
  • If enemy’s mask and object’s mask are set to 0 (i.e. no layers), they will still collide with the player, because the player’s mask still includes their respective layers.
    • +
  • Overall, if the objects are A and B, the check for collision is A.mask & B.layers || B.mask & A.layers, where & is bitwise-and, and || is the or operator. I.e. it takes the layers that correspond to the other object’s mask, and checks if any of them is on in both places. It will then proceed to check it the other way around, and if any of the two tests passes, it would report the collision.
    • +
+

And the second, shorter and less technical but still powerful (in the same post linking back to Godot 3.0: Using KinematicBody2D):

+
    +
  • collision_layer describes the layers that the object appears in. By default, all bodies are on layer 1.
    • +
  • collision_mask describes what layers the body will scan for collisions. If an object isn’t in one of the mask layers, the body will ignore it. By default, all bodies scan layer 1.
    • +
+

While the complete answer is the first, as that is how layers work, the second can be used like a rule: 1) the layer is where the object lives, while 2) the mask is what the object will detect.

+ +
+ + + + + Index + + + + + + + Previous + + +
+ + +
+
+

By David Luévano

+

Created: Tue, Aug 29, 2023 @ 10:10 UTC

+
+

Tags: +english, gamedev, gdscript, godot

+
+ +
+
+ +
+ + + Contact + + + + + Donate + + + + + RSS + + +
+ + + Created with pyssg + + +
+ + Copyright 2023 David Luévano Alvarado + + +
+ + \ No newline at end of file diff --git a/live/blog/index.html b/live/blog/index.html index 62e68e7..6b32ad9 100644 --- a/live/blog/index.html +++ b/live/blog/index.html @@ -88,6 +88,7 @@

Articles

    2023

    +
  • Aug 29 - Godot layers and masks notes
  • Aug 27 - Porting the FlappyBird clone to Godot 4.1 devlog 2
  • Aug 20 - Set up a pastebin alternative with PrivateBin and YOURLS
  • Jul 24 - Set up a media server with Jellyfin, Sonarr and Radarr
    • diff --git a/live/blog/rss.xml b/live/blog/rss.xml index 82a3256..e646e8e 100644 --- a/live/blog/rss.xml +++ b/live/blog/rss.xml @@ -22,6 +22,30 @@ Luévano's Blog https://blog.luevano.xyz + + Godot layers and masks notes + https://blog.luevano.xyz/g/godot_layers_and_masks_notes.html + https://blog.luevano.xyz/g/godot_layers_and_masks_notes.html + Tue, 29 Aug 2023 10:10:06 GMT + English + Gamedev + Gdscript + Godot + Some notes I took regarding Godot's confusing collision layers and masks. + The first time I learned about Godot’s collision layers and masks (will refer to them just as layers) I thought I understood them only to find out that they’re a bit confusing when trying to figure out interactions between objects that are supposed to detect each other. On my last entry where I ported the FlappyBird clone to Godot 4.1 I stumbled upon an issue with the bird not colliding properly with the pipes and the ceiling detector not… well, detecting.

    +

    At the end of the day the issue wasn’t that the layers weren’t properly setup but rather that the API to change the state of the collision layers changed between Godot 3 and Godot 4: when calling set_collision_layer_value (or .._mask) instead of specifying the bit which starts at 0, the layer_number is required that happens to start at 1. This was a headache for like an hour and made me realise that I didn’t understand layers that well or else I would’ve picked the error almost instantly.

    +

    While researching I found two really good short explainations that helped me grasp the concepts better in the same post, the first a bit technical (by Bojidar Marinov):

    +
      +
    • If enemy’s mask and object’s mask are set to 0 (i.e. no layers), they will still collide with the player, because the player’s mask still includes their respective layers.
      • +
    • Overall, if the objects are A and B, the check for collision is A.mask & B.layers || B.mask & A.layers, where & is bitwise-and, and || is the or operator. I.e. it takes the layers that correspond to the other object’s mask, and checks if any of them is on in both places. It will then proceed to check it the other way around, and if any of the two tests passes, it would report the collision.
      • +
    +

    And the second, shorter and less technical but still powerful (in the same post linking back to Godot 3.0: Using KinematicBody2D):

    +
      +
    • collision_layer describes the layers that the object appears in. By default, all bodies are on layer 1.
      • +
    • collision_mask describes what layers the body will scan for collisions. If an object isn’t in one of the mask layers, the body will ignore it. By default, all bodies scan layer 1.
      • +
    +

    While the complete answer is the first, as that is how layers work, the second can be used like a rule: 1) the layer is where the object lives, while 2) the mask is what the object will detect.

    ]]>     +     Porting the FlappyBird clone to Godot 4.1 devlog 2 https://blog.luevano.xyz/g/flappybird_godot_devlog_2.html @@ -60,7 +84,7 @@

Porting to Godot 4

-

Disclaimer: I started the port back in Godot 4.0 something and left the project for a while, then opened the project again in Godot 4.1, and it didn’t ask to convert anything so probably nowadays the conversion is better.

+

Disclaimer: I started the port back in Godot 4.0 something and left the project for a while, then opened the project again in Godot 4.1, and it didn’t ask to convert anything so probably nowadays the conversion is better. Godot’s documentation is pretty useful, I looked at the GDScript reference and GDScript exports and that helped a lot.

General changes

These include the first changes for fixing some of the conflicting code to at least make it run (no gameplay) as well as project settings adjustments.

    diff --git a/live/blog/sitemap.xml b/live/blog/sitemap.xml index 0f0ece6..7131e1d 100644 --- a/live/blog/sitemap.xml +++ b/live/blog/sitemap.xml @@ -45,9 +45,15 @@ 1.0 + + https://blog.luevano.xyz/g/godot_layers_and_masks_notes.html + 2023-08-29 + weekly + 1.0 + https://blog.luevano.xyz/g/flappybird_godot_devlog_2.html - 2023-08-28 + 2023-08-29 weekly 1.0 diff --git a/live/blog/tag/@english.html b/live/blog/tag/@english.html index 2f98448..10f4aef 100644 --- a/live/blog/tag/@english.html +++ b/live/blog/tag/@english.html @@ -78,6 +78,7 @@

    Articles

      2023

      +
    • Aug 29 - Godot layers and masks notes
    • Aug 27 - Porting the FlappyBird clone to Godot 4.1 devlog 2
    • Aug 20 - Set up a pastebin alternative with PrivateBin and YOURLS
    • Jul 24 - Set up a media server with Jellyfin, Sonarr and Radarr
      • diff --git a/live/blog/tag/@gamedev.html b/live/blog/tag/@gamedev.html index 512bd9c..b4141f6 100644 --- a/live/blog/tag/@gamedev.html +++ b/live/blog/tag/@gamedev.html @@ -78,6 +78,7 @@

      Articles

        2023

        +
      • Aug 29 - Godot layers and masks notes
      • Aug 27 - Porting the FlappyBird clone to Godot 4.1 devlog 2

        • 2022

      • Jun 10 - Creating my Go Godot Jam 3 entry using Godot 3.5 devlog 1
        • diff --git a/live/blog/tag/@gdscript.html b/live/blog/tag/@gdscript.html index f004012..3866b7c 100644 --- a/live/blog/tag/@gdscript.html +++ b/live/blog/tag/@gdscript.html @@ -78,6 +78,7 @@

        Articles

          2023

          +
        • Aug 29 - Godot layers and masks notes
        • Aug 27 - Porting the FlappyBird clone to Godot 4.1 devlog 2

          • 2022

        • Jun 10 - Creating my Go Godot Jam 3 entry using Godot 3.5 devlog 1
          • diff --git a/live/blog/tag/@godot.html b/live/blog/tag/@godot.html index fd622f7..a5f2d67 100644 --- a/live/blog/tag/@godot.html +++ b/live/blog/tag/@godot.html @@ -78,6 +78,7 @@

          Articles

            2023

            +
          • Aug 29 - Godot layers and masks notes
          • Aug 27 - Porting the FlappyBird clone to Godot 4.1 devlog 2

            • 2022

          • Jun 10 - Creating my Go Godot Jam 3 entry using Godot 3.5 devlog 1
            • diff --git a/src/blog/g/flappybird_godot_devlog_2.md b/src/blog/g/flappybird_godot_devlog_2.md index 3363f0e..4532cc5 100644 --- a/src/blog/g/flappybird_godot_devlog_2.md +++ b/src/blog/g/flappybird_godot_devlog_2.md @@ -19,7 +19,7 @@ The source code can be found at [luevano/flappybirdgodot](https://github.com/lue # Porting to Godot 4 -**Disclaimer:** I started the port back in *Godot 4.0* something and left the project for a while, then opened the project again in *Godot 4.1*, and it didn't ask to convert anything so probably nowadays the conversion is better. +**Disclaimer:** I started the port back in *Godot 4.0* something and left the project for a while, then opened the project again in *Godot 4.1*, and it didn't ask to convert anything so probably nowadays the conversion is better. Godot's documentation is pretty useful, I looked at the [GDScript reference](https://docs.godotengine.org/en/stable/tutorials/scripting/gdscript/gdscript_basics.html) and [GDScript exports](https://docs.godotengine.org/en/stable/tutorials/scripting/gdscript/gdscript_exports.html) and that helped a lot. ## General changes diff --git a/src/blog/g/godot_layers_and_masks_notes.md b/src/blog/g/godot_layers_and_masks_notes.md new file mode 100644 index 0000000..5c3efd5 --- /dev/null +++ b/src/blog/g/godot_layers_and_masks_notes.md @@ -0,0 +1,25 @@ +title: Godot layers and masks notes +author: David Luévano +lang: en +summary: Some notes I took regarding Godot's confusing collision layers and masks. +tags: gamedev + godot + gdscript + english + +The first time I learned about Godot's collision layers and masks (will refer to them just as layers) I thought I understood them only to find out that they're a bit confusing when trying to figure out interactions between objects that are supposed to detect each other. On my last entry where I [ported the FlappyBird clone to *Godot 4.1*](https://blog.luevano.xyz/g/flappybird_godot_devlog_2.html) I stumbled upon an issue with the bird not colliding properly with the pipes and the ceiling detector not... well, detecting. + +At the end of the day the issue wasn't that the layers weren't properly setup but rather that the API to change the state of the collision layers changed between *Godot 3* and *Godot 4*: when calling `set_collision_layer_value` (or `.._mask`) instead of specifying the `bit` which starts at `0`, the `layer_number` is required that happens to start at `1`. This was a headache for like an hour and made me realise that I didn't understand layers that well or else I would've picked the error almost instantly. + +While researching I found two really good short explainations that helped me grasp the concepts better in the same [post](https://ask.godotengine.org/4010/whats-difference-between-collision-layers-collision-masks), the first a bit technical (by [Bojidar Marinov](https://ask.godotengine.org/user/Bojidar+Marinov)): + +- If enemy's mask and object's mask are set to `0` (i.e. no layers), they will still collide with the player, because the player's mask still includes their respective layers. +- Overall, if the objects are `A` and `B`, the check for collision is `A.mask & B.layers || B.mask & A.layers`, where `&` is bitwise-and, and `||` is the or operator. I.e. it takes the layers that correspond to the other object's mask, and checks if any of them is on in both places. It will then proceed to check it the other way around, and if any of the two tests passes, it would report the collision. + +And the second, shorter and less technical but still powerful (in the same post linking back to [Godot 3.0: Using KinematicBody2D](https://kidscancode.org/blog/2018/02/godot3_kinematic2d/)): + +- `collision_layer` describes the layers that the object appears in. By default, all bodies are on layer `1`. +- `collision_mask` describes what layers the body will scan for collisions. If an object isn’t in one of the mask layers, the body will ignore it. By default, all bodies scan layer `1`. + +While the complete answer is the first, as that is how layers work, the second can be used like a rule: 1) the `layer` is where the object lives, while 2) the `mask` is what the object will detect. + diff --git a/src/blog/temp/godot_collision_layers_notes.md b/src/blog/temp/godot_collision_layers_notes.md deleted file mode 100644 index a8df1da..0000000 --- a/src/blog/temp/godot_collision_layers_notes.md +++ /dev/null @@ -1,12 +0,0 @@ -# Notes on layers and masks - -Taken from a comment from https://ask.godotengine.org/4010/whats-difference-between-collision-layers-collision-masks: - -1. If enemy's mask and object's mask are set to 0 (i.e. no layers), they will still collide with the player, because the player's mask still includes their respective layers. -2. Overall, if the objects are `A` and `B`, the check for collision is `A.mask & B.layers || B.mask & A.layers`, where `&` is bitwise-and, and `||` is the or operator. I.e. it takes the layers that correspond to the other object's mask, and checks if any of them is on in both places. It will they proceed to check it the other way around, and if any of the two tests passes, it would report the collision. - -Also, in the same link (which in turn is taken from https://kidscancode.org/blog/2018/02/godot3_kinematic2d/): - -1. `collision_layer` describes the layers that the object appears in. By default, all bodies are on layer `1`. -2. `collision_mask` describes what layers the body will scan for collisions. If an object isn’t in one of the mask layers, the body will ignore it. By default, all bodies scan layer `1`. - -- cgit v1.2.3-54-g00ecf