Port code examples to C# of classes beginning with A and B #40978

HaSa1002 · 2020-08-02T18:19:17Z

First PR in my code example port effort.
See #40613 for more details.
Since there are a lot classes (and a lot less having examples) I group the changes together, but I don't really know what is practical so ¯\(ツ)/¯

I created this code translation tool to speed up the conversion process.

I left the sort as it is, because I don't know how and if it is done in C#

doc/classes/ArrayMesh.xml

HaSa1002 · 2020-08-03T21:35:39Z

Fixed issue in Animation.xml

Does anybody have an idea, how to parse $Node["some/property"]using static analysis? I might use the $ as strong indication and/or if there is a slash in the subscription operator. Anyhow I updated the codetranslator again and made it more reliable as well as adding some features

doc/classes/Button.xml

doc/classes/AESContext.xml

doc/classes/AStar.xml

doc/classes/Animation.xml

doc/classes/Array.xml

doc/classes/bool.xml

doc/classes/Array.xml

HaSa1002 · 2020-09-04T12:15:38Z

fixed a ton of codeblock which should have been codeblocks
fixed suggestions and reviewed the code again.

doc/classes/AcceptDialog.xml

doc/classes/Animation.xml

doc/classes/Array.xml

doc/classes/ArrayMesh.xml

doc/classes/Array.xml

doc/classes/Button.xml

doc/classes/bool.xml

aaronfranke · 2020-09-13T06:49:24Z

@HaSa1002 Since #42000 was merged, you can add array concatentation. I suggest adding these lines:

// Array concatenation is not possible with C# arrays, but is with Godot.Collections.Array.
var array1 = new Godot.Collections.Array("One", 2);
var array2 = new Godot.Collections.Array(3, "Four");
GD.Print(array1 + array2); // Prints [One, 2, 3, Four]

HaSa1002 · 2020-09-13T10:40:24Z

@aaronfranke Added the array concatentation example and did another review pass. All code examples should compile. I removed the wrong example for Array.sort Godot.Collections.Array has no support for it.

HaSa1002 · 2020-09-13T10:44:42Z

doc/classes/AnimationNodeStateMachinePlayback.xml

@@ -6,10 +6,16 @@
 	<description>
 		Allows control of [AnimationTree] state machines created with [AnimationNodeStateMachine]. Retrieve with [code]$AnimationTree.get("parameters/playback")[/code].


Maybe remove the "Retrieve with .." line, since the codeblock shows how to get it. (Or just remove the code tag)

HaSa1002 · 2020-09-13T10:45:33Z

doc/classes/AnimationNodeStateMachine.xml

-		[codeblock]
+		[codeblocks]
+		[gdscript]
 		var state_machine = $AnimationTree.get("parameters/playback")
 		state_machine.travel("some_state")
-		[/codeblock]
+		[/gdscript]
+		[csharp]
+		var stateMachine = GetNode&lt;AnimationTree&gt;("AnimationTree").Get("parameters/playback") as AnimationNodeStateMachinePlayback;
+		stateMachine.Travel("some_state");
+		[/csharp]
+		[/codeblocks]


What has this example to do with the class?

aaronfranke

Looks really good, found one more problem though.

aaronfranke · 2020-09-24T23:28:15Z

doc/classes/AStar.xml

+				astar.AddPoint(1, new Vector3(0, 0, 0));
+				astar.AddPoint(2, new Vector3(0, 5, 0));
+				astar.ConnectPoints(1, 2);
+				Vector3 res = astar.getClosestPositionInSegment(new Vector3(3, 3, 0)); // Returns (0, 3, 0)


Suggested change

Vector3 res = astar.getClosestPositionInSegment(new Vector3(3, 3, 0)); // Returns (0, 3, 0)

Vector3 res = astar.GetClosestPositionInSegment(new Vector3(3, 3, 0)); // Returns (0, 3, 0)

aaronfranke

This should be good now. The CI failure is unrelated to this PR.

akien-mga · 2020-09-25T17:55:10Z

It would need a last rebase so that we can get CI to pass (the error is on the master commit this PR is currently based on).

HaSa1002 · 2020-09-26T09:46:06Z

rebased

doc/classes/AcceptDialog.xml

Only existing GDScript code examples are converted and added to the docs. This is the first batch include classes beginning with A and B. Included classes: * AcceptDialog * AESContext * Animation * AnimationNodeStateMachine * AnimationNodeStateMachinePlayback * AnimationNodeStateMachineTransition * Array * ArrayMesh * AStar * AStar2D * Bool * Button

akien-mga · 2020-09-26T10:42:48Z

Thanks a ton!

aaronfranke · 2021-03-23T19:13:51Z

doc/classes/Array.xml

+		var array1 = new Godot.Collections.Array("One", 2);
+		var array2 = new Godot.Collections.Array(3, "Four");


Neikeq pointed out that we can also use { and }, which may be preferred...?

Yeah, I switched to that syntax in later PRs

aaronfranke · 2021-03-23T19:14:18Z

doc/classes/Array.xml

+				var array = new Godot.Collections.Array{2, 4, 6, 8};
+				if (array.Contains(2))
+				{
+				    GD.Print("Containes!");


Typo, Containes -> Contains

Includes: * Variant * Viewport and two fixes in Array that were pointed out in godotengine#40978 VisualScript classes are skipped on purpose. That is the final commit of the inital code porting to C#. :)

HaSa1002 requested a review from a team as a code owner August 2, 2020 18:19

clayjohn reviewed Aug 2, 2020

View reviewed changes

doc/classes/ArrayMesh.xml Outdated Show resolved Hide resolved

Calinou added documentation enhancement topic:dotnet labels Aug 2, 2020

Calinou added this to the 4.0 milestone Aug 2, 2020

HaSa1002 changed the title ~~Convert code examples of classes beginning with A and B~~ Port code examples to C# of classes beginning with A and B Aug 3, 2020

HaSa1002 force-pushed the docs-code-1 branch from 25eb1a0 to 22e4196 Compare August 3, 2020 21:22

Duroxxigar reviewed Aug 6, 2020

View reviewed changes

doc/classes/Button.xml Outdated Show resolved Hide resolved

HaSa1002 force-pushed the docs-code-1 branch from 22e4196 to 908b0a2 Compare August 7, 2020 16:54

aaronfranke requested changes Aug 30, 2020

View reviewed changes

HaSa1002 force-pushed the docs-code-1 branch 2 times, most recently from 7a00675 to 7f7520e Compare September 4, 2020 10:54

akien-mga requested a review from neikeq September 4, 2020 11:00

HaSa1002 force-pushed the docs-code-1 branch 2 times, most recently from d7b10fb to 2d5cac6 Compare September 4, 2020 12:02

HaSa1002 commented Sep 4, 2020

View reviewed changes

doc/classes/Array.xml Outdated Show resolved Hide resolved

HaSa1002 force-pushed the docs-code-1 branch from 2d5cac6 to 614c891 Compare September 4, 2020 12:14

HaSa1002 force-pushed the docs-code-1 branch 2 times, most recently from f2d8e2e to 68cc31a Compare September 4, 2020 13:13

aaronfranke requested changes Sep 12, 2020

View reviewed changes

HaSa1002 force-pushed the docs-code-1 branch 4 times, most recently from 4d0ec68 to aba05db Compare September 12, 2020 20:07

HaSa1002 mentioned this pull request Sep 12, 2020

Translate GDScript Code Examples to C# (Classes beginning with C) #42016

Merged

HaSa1002 force-pushed the docs-code-1 branch from aba05db to 255ac85 Compare September 13, 2020 10:36

HaSa1002 commented Sep 13, 2020

View reviewed changes

aaronfranke requested changes Sep 24, 2020

View reviewed changes

HaSa1002 force-pushed the docs-code-1 branch 2 times, most recently from d331fef to 37a3cf4 Compare September 25, 2020 13:03

aaronfranke approved these changes Sep 25, 2020

View reviewed changes

HaSa1002 force-pushed the docs-code-1 branch from 37a3cf4 to 584fc2b Compare September 26, 2020 09:45

akien-mga reviewed Sep 26, 2020

View reviewed changes

doc/classes/AcceptDialog.xml Outdated Show resolved Hide resolved

HaSa1002 force-pushed the docs-code-1 branch from 584fc2b to c5aded5 Compare September 26, 2020 10:32

akien-mga merged commit 84cec77 into godotengine:master Sep 26, 2020

aaronfranke reviewed Mar 23, 2021

View reviewed changes

HaSa1002 mentioned this pull request Apr 2, 2021

Port code examples to C# (V) #47584

Merged

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Port code examples to C# of classes beginning with A and B #40978

Port code examples to C# of classes beginning with A and B #40978

HaSa1002 commented Aug 2, 2020 •

edited

Loading

HaSa1002 commented Aug 3, 2020 •

edited

Loading

HaSa1002 commented Sep 4, 2020

aaronfranke commented Sep 13, 2020

HaSa1002 commented Sep 13, 2020

HaSa1002 Sep 13, 2020

HaSa1002 Sep 13, 2020

aaronfranke left a comment

aaronfranke Sep 24, 2020

HaSa1002 Sep 25, 2020

aaronfranke left a comment

akien-mga commented Sep 25, 2020

HaSa1002 commented Sep 26, 2020

akien-mga commented Sep 26, 2020

aaronfranke Mar 23, 2021

HaSa1002 Mar 23, 2021

aaronfranke Mar 23, 2021

		@@ -6,10 +6,16 @@
		<description>
		Allows control of [AnimationTree] state machines created with [AnimationNodeStateMachine]. Retrieve with [code]$AnimationTree.get("parameters/playback")[/code].

	Vector3 res = astar.getClosestPositionInSegment(new Vector3(3, 3, 0)); // Returns (0, 3, 0)
	Vector3 res = astar.GetClosestPositionInSegment(new Vector3(3, 3, 0)); // Returns (0, 3, 0)

		var array1 = new Godot.Collections.Array("One", 2);
		var array2 = new Godot.Collections.Array(3, "Four");

Port code examples to C# of classes beginning with A and B #40978

Port code examples to C# of classes beginning with A and B #40978

Conversation

HaSa1002 commented Aug 2, 2020 • edited Loading

HaSa1002 commented Aug 3, 2020 • edited Loading

HaSa1002 commented Sep 4, 2020

aaronfranke commented Sep 13, 2020

HaSa1002 commented Sep 13, 2020

HaSa1002 Sep 13, 2020

Choose a reason for hiding this comment

HaSa1002 Sep 13, 2020

Choose a reason for hiding this comment

aaronfranke left a comment

Choose a reason for hiding this comment

aaronfranke Sep 24, 2020

Choose a reason for hiding this comment

HaSa1002 Sep 25, 2020

Choose a reason for hiding this comment

aaronfranke left a comment

Choose a reason for hiding this comment

akien-mga commented Sep 25, 2020

HaSa1002 commented Sep 26, 2020

akien-mga commented Sep 26, 2020

aaronfranke Mar 23, 2021

Choose a reason for hiding this comment

HaSa1002 Mar 23, 2021

Choose a reason for hiding this comment

aaronfranke Mar 23, 2021

Choose a reason for hiding this comment

HaSa1002 commented Aug 2, 2020 •

edited

Loading

HaSa1002 commented Aug 3, 2020 •

edited

Loading