stan220/godot-docs
1
0
Fork 0
mirror of https://github.com/stan220/godot-docs.git synced 2026-09-08 17:28:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update some C# examples for 4.0 (#6693)

Browse Source 
* Update some C# examples

- Rename members that have been renamed in Godot's C# API for 4.0.
- Change `delta` parameter type to `double`.
- Ensure parameters match base declaration.
- Other minor code fixes.

---------

Co-authored-by: Paul Joannon <437025+paulloz@users.noreply.github.com>
This commit is contained in:
Raul Santos
2023-02-04 17:03:03 +01:00
committed by GitHub
co-authored by Paul Joannon
parent d6b4fe8ab9
commit b319da3f07
30 changed files with 236 additions and 219 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tutorials/inputs/handling_quit_requests.rst
+1 -1
View File
@@ -82,7 +82,7 @@ program termination, you should send the notification yourself:
.. code-tab:: csharp
GetTree().Root.PropagateNotification((int)NotificationWmCloseRequest)
GetTree().Root.PropagateNotification((int)NotificationWmCloseRequest);
Sending this notification will inform all nodes about the program termination,
but will not terminate the program itself *unlike in 3.X*. In order to achieve
tutorials/inputs/input_examples.rst
+30 -30
View File
@@ -43,20 +43,20 @@ Examples:
.. code-tab:: csharp
public override void _Input(InputEvent inputEvent)
public override void _Input(InputEvent @event)
{
if (inputEvent.IsActionPressed("jump"))
if (@event.IsActionPressed("jump"))
{
Jump();
}
}
public override void _PhysicsProcess(float delta)
public override void _PhysicsProcess(double delta)
{
if (Input.IsActionPressed("move_right"))
{
// Move as long as the key/button is pressed.
position.x += speed * delta;
position.X += speed * (float)delta;
}
}
@@ -89,9 +89,9 @@ attach the following script:
public partial class Node : Godot.Node
{
public override void _Input(InputEvent inputEvent)
public override void _Input(InputEvent @event)
{
GD.Print(inputEvent.AsText());
GD.Print(@event.AsText());
}
}
@@ -136,9 +136,9 @@ avoid this, make sure to test the event type first:
.. code-tab:: csharp
public override void _Input(InputEvent inputEvent)
public override void _Input(InputEvent @event)
{
if (inputEvent is InputEventMouseButton mouseEvent)
if (@event is InputEventMouseButton mouseEvent)
{
GD.Print("mouse button event at ", mouseEvent.Position);
}
@@ -172,9 +172,9 @@ the action you're looking for:
.. code-tab:: csharp
public override void _Input(InputEvent inputEvent)
public override void _Input(InputEvent @event)
{
if (inputEvent.IsActionPressed("my_action"))
if (@event.IsActionPressed("my_action"))
{
GD.Print("my_action occurred!");
}
@@ -198,11 +198,11 @@ the :kbd:`T`:
.. code-tab:: csharp
public override void _Input(InputEvent inputEvent)
public override void _Input(InputEvent @event)
{
if (inputEvent is InputEventKey keyEvent && keyEvent.Pressed)
if (@event is InputEventKey keyEvent && keyEvent.Pressed)
{
if ((KeyList)keyEvent.Keycode == KeyList.T)
if (keyEvent.Keycode == Key.T)
{
GD.Print("T was pressed");
}
@@ -247,13 +247,13 @@ different when it's :kbd:`Shift + T`:
.. code-tab:: csharp
public override void _Input(InputEvent inputEvent)
public override void _Input(InputEvent @event)
{
if (inputEvent is InputEventKey keyEvent && keyEvent.Pressed)
if (@event is InputEventKey keyEvent && keyEvent.Pressed)
{
switch ((KeyList)keyEvent.Keycode)
switch (keyEvent.Keycode)
{
case KeyList.T:
case Key.T:
GD.Print(keyEvent.Shift ? "Shift+T was pressed" : "T was pressed");
break;
}
@@ -292,9 +292,9 @@ also counts as a button - two buttons, to be precise, with both
.. code-tab:: csharp
public override void _Input(InputEvent inputEvent)
public override void _Input(InputEvent @event)
{
if (inputEvent is InputEventMouseButton mouseEvent && mouseEvent.Pressed)
if (@event is InputEventMouseButton mouseEvent && mouseEvent.Pressed)
{
switch (mouseEvent.ButtonIndex)
{
@@ -346,12 +346,12 @@ node:
using Godot;
public partial class Node2D : Godot.Node2D
public partial class MyNode2D : Node2D
{
private bool dragging = false;
private int clickRadius = 32; // Size of the sprite.
private bool _dragging = false;
private int _clickRadius = 32; // Size of the sprite.
public override void _Input(InputEvent inputEvent)
public override void _Input(InputEvent @event)
{
Sprite2D sprite = GetNodeOrNull<Sprite2D>("Sprite2D");
if (sprite == null)
@@ -359,25 +359,25 @@ node:
return; // No suitable node was found.
}
if (inputEvent is InputEventMouseButton mouseEvent && (ButtonList)mouseEvent.ButtonIndex == ButtonList.Left)
if (@event is InputEventMouseButton mouseEvent && mouseEvent.ButtonIndex == MouseButton.Left)
{
if ((mouseEvent.Position - sprite.Position).Length() < clickRadius)
if ((mouseEvent.Position - sprite.Position).Length() < _clickRadius)
{
// Start dragging if the click is on the sprite.
if (!dragging && mouseEvent.Pressed)
if (!_dragging && mouseEvent.Pressed)
{
dragging = true;
_dragging = true;
}
}
// Stop dragging if the button is released.
if (dragging && !mouseEvent.Pressed)
if (_dragging && !mouseEvent.Pressed)
{
dragging = false;
_dragging = false;
}
}
else
{
if (inputEvent is InputEventMouseMotion motionEvent && dragging)
if (@event is InputEventMouseMotion motionEvent && _dragging)
{
// While dragging, move the sprite with the mouse.
sprite.Position = motionEvent.Position;
tutorials/inputs/inputevent.rst
+2 -2
View File
@@ -27,7 +27,7 @@ Here is a quick example, closing your game if the escape key is hit:
public override void _UnhandledInput(InputEvent @event)
{
if (@event is InputEventKey eventKey)
if (eventKey.Pressed && eventKey.Keycode == (int)KeyList.Escape)
if (eventKey.Pressed && eventKey.Keycode == Key.Escape)
GetTree().Quit();
}
@@ -48,7 +48,7 @@ You can set up your InputMap under **Project > Project Settings > Input Map** an
.. code-tab:: csharp
public override void _Process(float delta)
public override void _Process(double delta)
{
if (Input.IsActionPressed("ui_right"))
{