Skip to content

Conversation

@a2937
Copy link
Contributor

@a2937 a2937 commented Nov 7, 2023

Renames the class Sprite back to MySprite2D in the player input lesson plan.

Closes #8417

Copy link
Contributor

@skyace65 skyace65 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A more comprehensive fix needs to be done for this issue. the C# name doesn't match the GDScript name, and the GDScript name doesn't match the image for creating the script, and instructions should be given to give it a specific name. Also having people just add a underscore to make the script name not the node name is probably bad practice.

Would you like to update this PR to do those changes? If not I can make a separate PR fixing them.

@skyace65 skyace65 added bug area:getting started Issues and PRs related to the Getting Started section of the documentation labels Nov 9, 2023
@a2937
Copy link
Contributor Author

a2937 commented Nov 9, 2023

Oh my. You're right. I'll see what I can do. But I would like some clarifications.

  1. What should the GD script name be?
  2. What should the C# class name be?
  3. Will we need to make any new images for the guide?

@Piralein
Copy link
Member

Piralein commented Nov 9, 2023

The script name should be snake_case: sprite_2d.gd, please note our image format guidelines, the image should be in .webp format.
The image file in question

I believe the c# name change is correct, as it is already named like this in the previous guide setting up the script.

@a2937
Copy link
Contributor Author

a2937 commented Nov 9, 2023

sprite_2d
How did I do Piralein?
I am aware I need to crop it some more, but I wanna make sure the necessary information is there.

@Piralein
Copy link
Member

@a2937 The template needs to be set to Object: Empty, as instructed in the step by step guide.

Adding the yellow outline for the "Template" input would be great. (it isn't necessary for the path)
The color definition can be found in the image guideline (fffb44 with like 2px width)

Copy link
Contributor

@skyace65 skyace65 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR is good now that Piralein updated the image in #8558

@skyace65 skyace65 merged commit ba3973d into godotengine:master Dec 2, 2023
@skyace65
Copy link
Contributor

skyace65 commented Dec 2, 2023

Thanks!

@a2937 a2937 deleted the fix/use-consistent-script-name branch December 2, 2023 18:40
@mhilbrunner
Copy link
Member

Cherry-picked to 4.2.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:getting started Issues and PRs related to the Getting Started section of the documentation bug cherrypick:4.1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Getting Started: Listening to Player Input has the wrong script name

4 participants