Skip to content

Fix C# issues in inspector-plugin tutorial #7223

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 26, 2023
Merged

Fix C# issues in inspector-plugin tutorial #7223

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a1ebb28
Fixed C# EditorInspectorPlugin _CanHandle parameter type
wlsnmrk Apr 25, 2023
1552bc3
Eliminated horizontal scroll in C# for inspector-plugin tutorial
wlsnmrk Apr 25, 2023
10061a5
Fixed _ParseProperty() method signature and undeclared variable
wlsnmrk Apr 25, 2023
6c92c17
Fixed override method name in EditorProperty example
wlsnmrk Apr 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions tutorials/plugins/editor/inspector_plugins.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,20 +143,22 @@ specifically add :ref:`class_EditorProperty`-based controls.

public partial class MyInspectorPlugin : EditorInspectorPlugin
{
public override bool _CanHandle(Variant @object)
public override bool _CanHandle(GodotObject @object)
{
// We support all objects in this example.
return true;
}

public override bool _ParseProperty(GodotObject @object, int type, string name, int hintType, string hintString, int usageFlags, bool wide)
public override bool _ParseProperty(GodotObject @object, Variant.Type type,
string name, PropertyHint hintType, string hintString,
PropertyUsageFlags usageFlags, bool wide)
Comment on lines +152 to +154
Copy link
Member

@raulsntos raulsntos Apr 26, 2023

Choose a reason for hiding this comment

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

I don't think we usually split long method signature lines in the documentation, but I think it's fine to start doing it. I'm not sure what should be the maximum character length though.

Copy link
Contributor Author

@wlsnmrk wlsnmrk Apr 26, 2023

Choose a reason for hiding this comment

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

No worries either way - I was asked to break lines that were causing horizontal scroll (in both C# and GDScript) on an earlier PR, so I assumed that was the preferred approach.

The C# style guide suggests 100 characters, but I had to break this at around 90 to avoid scroll.

{
// We handle properties of type integer.
if (type == (int)Variant.Type.Int)
if (type == Variant.Type.Int)
{
// Create an instance of the custom property editor and register
// it to a specific property path.
AddPropertyEditor(path, new RandomIntEditor());
AddPropertyEditor(name, new RandomIntEditor());
// Inform the editor to remove the default property editor for
// this property type.
return true;
Expand Down Expand Up @@ -283,7 +285,7 @@ followed by ``set_bottom_editor()`` to position it below the name.
EmitChanged(GetEditedProperty(), _currentValue);
}

public override void UpdateProperty()
public override void _UpdateProperty()
{
// Read the current value from the property.
var newValue = (int)GetEditedObject().Get(GetEditedProperty());
Expand Down