C# Wrapper (Beta)

[ramokz]

New Features

C# Wrapper (Beta)

Important

This is a pre-release version of the addon, and so will not be available through the addon's updater until it has been fully released.
So try out this pre-release, download the zip file at the bottom of the release document and extract the addon from it and add it to your project.

Following the proposal in #286 and with the stellar work from two contributors, Phantom Camera now has a C# wrapper, which should make using the addon in C# files feel a lot more native.

Massive thanks to @sircodemane, who initially made a PR for this (#351) and set up pretty much all the work for the structure, system and wrapper codebase, and @GabCoolDude who worked on top of the existing work and got the feature pushed over the finish line (#512).

How to use

Note

The documentation will be added to the documentation site once the wrapper has been added to a stable addon release post-beta.

About the wrapper

PCam nodes can be referenced using the PhantomCamera namespace, which then allows for assigning the appropriate types to variables. The property and method names are the same as the GDScript version, but are here Pascal Cased to follow the common C# naming convention.

Note, that due to some technical constraints with how adding a wrapper to custom GDScript declared nodes like PhantomCamera2D and PhantomCameraHost, referencing the addon nodes works a bit differently than one might initially expect.

Example

using Godot;
using PhantomCamera;
using PhantomCamera.Manager;

public partial class MyClassName : Node
{

  private PhantomCamera2D _pcam;
  private PhantomCameraHost _pcamHost;

  public override void _Ready()
  {
    // PhantomCamera reference
    _pcam = GetNode<Node2D>("%PhantomCamera2D").AsPhantomCamera2D();
    _pcam.Priority = 40; // Changes the priority of the PCam to 40

    // PhantomCameraHost reference using the PhantomCameraManager singleton
    _pcamHost = PhantomCameraManager.PhantomCameraHosts[0]; // Fetches the first PCamHost through the PCamManager singleton
    GD.Print(_pcamHost.HostLayers); // Outputs the host_layer value of the PCamHost
  }
}

You may notice the perhaps slightly odd inclusion of .AsPhantomCamera2D() and the usage of <GetNode2D>. What it is doing is essentially casting the Node2D as a PhantomCamera2D class, which allows for referencing the various public properties, methods, and signals available from the PhantomCamera GDScript class. Due to how nodes are registered in Godot with GDScript, we could unfortunately not find a way to avoid this without adding compromises in other areas of the developer experience.

The same approach is also needed for other addon nodes:

_pcam2D = GetNode<Node2D>("PathToNode").AsPhantomCamera2D(); // PhantomCamera2D
_pcam3D = GetNode<Node3D>("PathToNode").AsPhantomCamera3D(); // PhantomCamera3D
_pcamHost = GetNode<Node>("PathToNode").AsPhantomCameraHost(); // PhantomCameraHost
_pcamNoiseEmitter2D = GetNode<Node2D>("PathToNode").AsPhantomCameraNoiseEmitter2D(); // PhantomCameraNoiseEmitter2D
_pcamNoiseEmitter3D = GetNode<Node3D>("PathToNode").AsPhantomCameraNoiseEmitter3D(); // PhantomCameraNoiseEmitter3D

What this also means, is that to change the properties inherited from the Node2D class, you would need to explicitly reference the Node2D class before getting/setting or calling any methods from it.
For example, to change the visibility of the Node2D property that the _pcam variable above is based on, you can do that with:

_pcam.Node2D.Visible = false; // Sets the Visible property of the Node2D class to false

Bug reports and Feedback

If you spot anything that is missing or not working as intended, please submit an issue.

Questions

If you have any questions about the C# wrapper, feel free to make a sub-post in the GitHub discussion post for this beta release.

---

This discussion was created from the release C# Wrapper (Beta).

[madisodr]

First, this is awesome! I had been working on my own wrapper but it wasn't nearly as comprehensive as this, so thank you to everyone who worked on this.

Second, I hope this is the right place to raise an issue I found during an initial setup and test.

I think some of the functions relating to setting the rotation or quaternion on a PhantomCamera3D object are missing parameters. I wasn't sure if wasn't using these correctly but modifying all three of these setters to take in the relevant values and then pass them through to the GDScript call fixed it for me.

Here is the diff of my changes.

diff --git a/addons/phantom_camera/scripts/phantom_camera/PhantomCamera3D.cs b/addons/phantom_camera/scripts/phantom_camera/PhantomCamera3D.cs
index 74dbe677..a7cb4a17 100644
--- a/addons/phantom_camera/scripts/phantom_camera/PhantomCamera3D.cs
+++ b/addons/phantom_camera/scripts/phantom_camera/PhantomCamera3D.cs
@@ -62,20 +62,20 @@ public static class PhantomCamera3DExtensions
 	public static Vector3 GetThirdPersonRotation(this PhantomCamera3D pCam3D) =>
 		(Vector3)pCam3D.Node3D.Call(PhantomCamera3D.MethodName.GetThirdPersonRotation);

-	public static void SetThirdPersonRotation(this PhantomCamera3D pCam3D) =>
-		pCam3D.Node3D.Call(PhantomCamera3D.MethodName.SetThirdPersonRotation); 
+	public static void SetThirdPersonRotation(this PhantomCamera3D pCam3D, Vector3 rotation) =>
+		pCam3D.Node3D.Call(PhantomCamera3D.MethodName.SetThirdPersonRotation, rotation);
 
 	public static Vector3 GetThirdPersonRotationDegrees(this PhantomCamera3D pCam3D) =>
 		(Vector3)pCam3D.Node3D.Call(PhantomCamera3D.MethodName.GetThirdPersonRotationDegrees);
 

-	public static void SetThirdPersonDegrees(this PhantomCamera3D pCam3D) =>
-		pCam3D.Node3D.Call(PhantomCamera3D.MethodName.SetThirdPersonRotationDegrees);
+	public static void SetThirdPersonDegrees(this PhantomCamera3D pCam3D, Vector3 rotation) =>
+		pCam3D.Node3D.Call(PhantomCamera3D.MethodName.SetThirdPersonRotationDegrees, rotation);
 
 	public static Quaternion GetThirdPersonQuaternion(this PhantomCamera3D pCam3D) =>
 		(Quaternion)pCam3D.Node3D.Call(PhantomCamera3D.MethodName.GetThirdPersonQuaternion);
 
-	public static void SetThirdPersonQuaternion(this PhantomCamera3D pCam3D) =>
-		pCam3D.Node3D.Call(PhantomCamera3D.MethodName.SetThirdPersonQuaternion);
+	public static void SetThirdPersonQuaternion(this PhantomCamera3D pCam3D, Quaternion quaternion) =>
+		pCam3D.Node3D.Call(PhantomCamera3D.MethodName.SetThirdPersonQuaternion, quaternion);
 
 }

Hope this helps and I'll raise any other issues I run into as I test things out. Thank you.

[GabCoolDude]

Oh yeah, seems like i forgot to add those parameters, nice catch ! Should there be a PR made to fix this or is this going to get fixed another way ?

[ramokz]

I hope this is the right place to raise an issue I found during an initial setup and test.

@madisodr Yeah, either here or making a new issue works great.
Thanks for testing and sharing this!

Should there be a PR made to fix this or is this going to get fixed another way?

@GabCoolDude Yes, at this point we would need individual PRs for changes, given the original PR has been closed and merged into a branch now. So feel free to make a new PR based on that c-sharp wrapper branch and then use that same branch as the merge target.

[ramokz]

Should be merged into the branch now from @GabCoolDude's PR (#534)

[exiskra]

Just wanted to say that the wrapper is awesome