Added recipe for Inspector Plugin #48

snatvb · 2024-06-09T12:58:31Z

Implementation for docs of official Godot Docs on gdnext (godot rust)

fpdotmonkey · 2024-06-09T13:22:02Z

src/recipes/editor-plugin/index.md

+advanced GUI you want to implement.
+
+```admonish hint title="Gameplay-only code"
+Use an [`is_editor_hint` guard][api-engine-iseditorhint] if you don't want some code executing during runtime of the game.


When is this relevant now? my understanding is that #[class(tool)] takes care of this for you, but I could be wrong

I don't know actually, I just moved this file - added only close for the codeblock
@Bromeon could you help with it?

I didn't do it and didn't get any extra calls

Yes, this is no longer needed. Would be good to remove!

src/recipes/editor-plugin/inspector-plugins.md

fpdotmonkey · 2024-06-09T13:38:42Z

src/recipes/editor-plugin/index.md

+Plugins written in GDScript are automatically disabled if they have a code error, but because Rust is a compiled language,
+you cannot introduce compile-time errors.
+


Maybe a better way to say this is that errors that that would cause Gdscript-based plugins to be disabled are caught at compile time

Maybe such:

Plugins written in GDScript are disabled if an error occurs during compilation. Since Rust is a compiled language, your plugin will be registered with the engine immediately, and you won't see it in the list of plugins. An error at runtime or connection can lead to editor crash.

your plugin will be registered with the engine immediately

Immediately when? On load/reload of the dynamic library?

, and you won't see it in the list of plugins.

I think this misses the connection to the error, e.g. "won't see it ... if an error occurs".

An error at runtime or connection can lead to editor crash.

What do you mean with "connection" here?

ok, you can change it later as you wish, this is not mine text :)

src/recipes/editor-plugin/inspector-plugins.md

Bromeon · 2024-06-09T15:15:02Z

Thanks, also to @fpdotmonkey for the review!

Regarding oxipng, the intention was that it would commit the updated PNG files directly, but it seems there's a permission problem since your branch is from another repo. Would need to see how to configure this...

Bromeon

Thanks a lot 😊

There are some more occurrences of the to_variant().to() pattern, which is never needed. Check the parameter type and try to convert directly; I've made some examples.

Bromeon · 2024-06-10T17:11:05Z

src/recipes/editor-plugin/inspector-plugins.md

+```rust
+use godot::{
+    engine::{
+        Button, EditorInspectorPlugin, EditorPlugin, EditorProperty, IEditorInspectorPlugin,
+        IEditorPlugin, IEditorProperty,
+    },
+    global,
+    prelude::*,
+};
+use rand::Rng;
+```


Please use flat imports. Also, godot::engine has been renamed to godot::classes.

This is not addressed, please make sure only conversations are resolved that are actually fixed. It's a lot of effort if I have to double-check 20 parallel conversations.

src/recipes/editor-plugin/inspector-plugins.md

Bromeon · 2024-06-10T17:15:21Z

src/SUMMARY.md

+  - [Editor plugins](recipes/editor-plugin/index.md)
+    - [Inspector plugins](recipes/editor-plugin/inspector-plugins.md)


I would probably keep those in one page, as they are closely related and the current page is very short. Just use a h2 for the inspector plugins.

Then, you also wouldn't need a new folder. The images could be named inspector-before/after.png.

I thought it could be extended with others exmaples 🤔

Ah you mean others from this list? Good point, then maybe leave it.

Can you add a HTML comment (which isn't rendered) on the main editor plugin site, like



?

yep, have a look

src/recipes/editor-plugin/inspector-plugins.md

Co-authored-by: Jan Haller <[email protected]>

Bromeon

Thanks a lot for the update! Just a small request, please don't mark comments as resolved if you haven't fixed them.

src/recipes/editor-plugin/inspector-plugins.md

Bromeon · 2024-06-10T20:51:36Z

src/recipes/editor-plugin/inspector-plugins.md

+The [example](https://docs.godotengine.org/en/stable/tutorials/plugins/editor/inspector_plugins.html) in the Godot docs in Rust.
+
+Before:
+
+![Before](./images/before.png)
+
+After:
+
+![After](./images/after.png)


If you add a newline, it's still part of the same paragraph. The sentence just continues.

If you add an empty line in between (like <-- here), then it's rendered as new paragraph.

Not exactly sure with images, but the text and image should definitely not be on the same line.

src/recipes/editor-plugin/inspector-plugins.md

Bromeon · 2024-06-10T20:53:37Z

src/recipes/editor-plugin/inspector-plugins.md

+```rust
+use godot::{
+    engine::{
+        Button, EditorInspectorPlugin, EditorPlugin, EditorProperty, IEditorInspectorPlugin,
+        IEditorPlugin, IEditorProperty,
+    },
+    global,
+    prelude::*,
+};
+use rand::Rng;
+```


This is not addressed, please make sure only conversations are resolved that are actually fixed. It's a lot of effort if I have to double-check 20 parallel conversations.

src/recipes/editor-plugin/inspector-plugins.md

Co-authored-by: Jan Haller <[email protected]>

…t-book into inspector-plugin-recipe

snatvb · 2024-06-10T21:53:35Z

Thanks a lot for the update! Just a small request, please don't mark comments as resolved if you haven't fixed them.

I probably misunderstood you on this matter

Co-authored-by: Jan Haller <[email protected]>

…t-book into inspector-plugin-recipe

Bromeon · 2024-06-11T19:28:49Z

I pushed a commit to reduce the PNG size, CI is now green 🌳

Feel free to squash the commits later and remove my authorship.

snatvb · 2024-06-11T19:35:33Z

I can't merge because I don't have write access :)
If it's ok to merge - I am ready)

Bromeon · 2024-06-11T19:43:32Z

I meant squash (combine all commits to one), not merge 😉 But it's fine, I should be able to do so upon merge (or manually).

I'll give it another review round in the coming days. Meanwhile, maybe @fpdotmonkey or @lilizoey have something to add 🙂

snatvb · 2024-06-11T20:03:41Z

@Bromeon maybe I don't know something, but to do squash I have to do force push. It could be used as a merge strategy(where is merge button). 😊

Bromeon · 2024-06-11T20:15:10Z

Yes, I can do it upon merge. But force-pushing is also no problem, contributors regularly do it to clean up.

It's really up to you. For the main repo, we'd need some level of squashing/force-pushing as I can't do it on merge there 👌

fpdotmonkey

You know, I was wondering why you weren't responding to my review comments from a couple days ago. Turns out I forgot to hit the Submit review button. Sigh, Bromeon covered most of it though.

src/recipes/editor-plugin/inspector-plugins.md

snatvb · 2024-06-12T20:37:03Z

You know, I was wondering why you weren't responding to my review comments from a couple days ago. Turns out I forgot to hit the Submit review button. Sigh, Bromeon covered most of it though.

Sorry, it's really hard to read comments that haven't been posted 🤣

Co-authored-by: Fletcher Porter <[email protected]>

Bromeon · 2024-06-19T19:00:47Z

Thanks a lot! 🙂

snatvb added 3 commits June 9, 2024 15:58

Added recipe for Inspector Plugin

18c9c79

Fixed linting issue

d39fcac

Removed old file that has been moved before

0bd2254

fpdotmonkey reviewed Jun 9, 2024

View reviewed changes

Bromeon added the new-topic New content added to the book label Jun 9, 2024

Fixed review issues

a2b16ae

snatvb requested a review from fpdotmonkey June 9, 2024 19:52

Bromeon reviewed Jun 10, 2024

View reviewed changes

snatvb and others added 7 commits June 10, 2024 21:52

Update src/recipes/editor-plugin/inspector-plugins.md

ca10439

Co-authored-by: Jan Haller <[email protected]>

Update src/recipes/editor-plugin/inspector-plugins.md

cbbd82a

Co-authored-by: Jan Haller <[email protected]>

Update src/recipes/editor-plugin/inspector-plugins.md

97328e5

Co-authored-by: Jan Haller <[email protected]>

Update src/recipes/editor-plugin/inspector-plugins.md

f064316

Co-authored-by: Jan Haller <[email protected]>

Update src/recipes/editor-plugin/inspector-plugins.md

3396c79

Co-authored-by: Jan Haller <[email protected]>

Update src/recipes/editor-plugin/inspector-plugins.md

aca53e8

Co-authored-by: Jan Haller <[email protected]>

Fixed comment in review: rid of incorrect casts, added more explainings

5643083

snatvb requested review from Bromeon and lilizoey June 10, 2024 20:23

Bromeon reviewed Jun 10, 2024

View reviewed changes

snatvb and others added 3 commits June 11, 2024 00:51

Fixed review comments

b23cb7a

Update src/recipes/editor-plugin/inspector-plugins.md

ee67c9d

Co-authored-by: Jan Haller <[email protected]>

Merge branch 'inspector-plugin-recipe' of github.com:snatvb/godot-rus…

65be4dd

…t-book into inspector-plugin-recipe

snatvb and others added 7 commits June 11, 2024 00:55

Added comment TODO for note that necessary to add more plugin examples

5fb6cfd

Fixed imports - converted into flat structure

3656f17

Fixed formatting strings in exmaples

4a86681

Update src/recipes/editor-plugin/inspector-plugins.md

a387b49

Co-authored-by: Jan Haller <[email protected]>

Added more information for implementation of inspector editor line

3a15aa7

Added breckets for codeline

4b0b4ea

Merge branch 'inspector-plugin-recipe' of github.com:snatvb/godot-rus…

f675b54

…t-book into inspector-plugin-recipe

snatvb and others added 2 commits June 11, 2024 21:23

Removed unnecessary cast number after to_variant

d61995b

Reduce PNG size with oxipng

26e7513

fpdotmonkey reviewed Jun 12, 2024

View reviewed changes

src/recipes/editor-plugin/inspector-plugins.md Show resolved Hide resolved

src/recipes/editor-plugin/inspector-plugins.md Outdated Show resolved Hide resolved

Update src/recipes/editor-plugin/inspector-plugins.md

efdc336

Co-authored-by: Fletcher Porter <[email protected]>

Bromeon merged commit 8fdcccb into godot-rust:master Jun 19, 2024
4 checks passed

snatvb deleted the inspector-plugin-recipe branch June 22, 2024 12:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added recipe for Inspector Plugin #48

Added recipe for Inspector Plugin #48

snatvb commented Jun 9, 2024 •

edited

Loading

fpdotmonkey Jun 9, 2024

snatvb Jun 9, 2024 •

edited

Loading

Bromeon Jun 10, 2024

fpdotmonkey Jun 9, 2024

snatvb Jun 9, 2024

Bromeon Jun 10, 2024

snatvb Jun 11, 2024

Bromeon commented Jun 9, 2024

Bromeon left a comment

Bromeon Jun 10, 2024

Bromeon Jun 10, 2024

Bromeon Jun 10, 2024

snatvb Jun 10, 2024

Bromeon Jun 10, 2024

snatvb Jun 10, 2024

Bromeon left a comment •

edited

Loading

Bromeon Jun 10, 2024

Bromeon Jun 10, 2024

snatvb commented Jun 10, 2024

Bromeon commented Jun 11, 2024 •

edited

Loading

snatvb commented Jun 11, 2024 •

edited

Loading

Bromeon commented Jun 11, 2024

snatvb commented Jun 11, 2024

Bromeon commented Jun 11, 2024 •

edited

Loading

fpdotmonkey left a comment

snatvb commented Jun 12, 2024

Bromeon commented Jun 19, 2024

		Plugins written in GDScript are automatically disabled if they have a code error, but because Rust is a compiled language,
		you cannot introduce compile-time errors.

		- [Editor plugins](recipes/editor-plugin/index.md)
		- [Inspector plugins](recipes/editor-plugin/inspector-plugins.md)

Added recipe for Inspector Plugin #48

Added recipe for Inspector Plugin #48

Conversation

snatvb commented Jun 9, 2024 • edited Loading

Choose a reason for hiding this comment

snatvb Jun 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Bromeon commented Jun 9, 2024

Bromeon left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Bromeon left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

snatvb commented Jun 10, 2024

Bromeon commented Jun 11, 2024 • edited Loading

snatvb commented Jun 11, 2024 • edited Loading

Bromeon commented Jun 11, 2024

snatvb commented Jun 11, 2024

Bromeon commented Jun 11, 2024 • edited Loading

fpdotmonkey left a comment

Choose a reason for hiding this comment

snatvb commented Jun 12, 2024

Bromeon commented Jun 19, 2024

snatvb commented Jun 9, 2024 •

edited

Loading

snatvb Jun 9, 2024 •

edited

Loading

Bromeon left a comment •

edited

Loading

Bromeon commented Jun 11, 2024 •

edited

Loading

snatvb commented Jun 11, 2024 •

edited

Loading

Bromeon commented Jun 11, 2024 •

edited

Loading