Godot Engine

https://docs.godotengine.org/en/4.5
Admin
Godot Engine is a free and open-source game engine that provides a comprehensive suite of tools for...
Tokens:4,949,940
Snippets:48,818
Trust Score:10
Update:8 hours ago
Show doc for...
Tokens:
Raw
### Initialize submodules for a cloned example

Source: https://docs.godotengine.org/en/4.5/tutorials/scripting/cpp/gdextension_cpp_example.html

Run these commands if you cloned the example from the introduction link, as submodules are not automatically initialized.

```shell
cd gdextension_cpp_example
git submodule update --init
```

--------------------------------

### _begin_handle_action

Source: https://docs.godotengine.org/en/4.5/classes/class_editornode3dgizmoplugin.html

Virtual method called when a handle action begins. Override to perform setup when the user starts interacting with a handle.

```APIDOC
## _begin_handle_action

### Description
Virtual method called when a handle action begins. Override to perform setup when the user starts interacting with a handle.

### Signature
void _begin_handle_action(gizmo: EditorNode3DGizmo, handle_id: int, secondary: bool) virtual

### Parameters
- **gizmo** (EditorNode3DGizmo) - The gizmo that contains the handle.
- **handle_id** (int) - The ID of the handle.
- **secondary** (bool) - Whether the handle is secondary.

### Notes
There is currently no description for this method. Please help us by contributing one!
```

--------------------------------

### _begin_handle_action

Source: https://docs.godotengine.org/en/4.5/classes/class_editornode3dgizmo.html

Virtual method called when a handle action begins. Override to perform setup when the user starts interacting with a handle.

```APIDOC
## _begin_handle_action

### Description
Virtual method called when a handle action begins. Override to perform setup when the user starts interacting with a handle.

### Method
`void _begin_handle_action(id: int, secondary: bool) virtual`

### Parameters
- **id** (int) - The identifier of the handle.
- **secondary** (bool) - Whether the handle is secondary.

### Notes
There is currently no description for this method. Please help us by contributing one!
```

--------------------------------

### C-style for loop examples

Source: https://docs.godotengine.org/en/4.5/tutorials/scripting/gdscript/gdscript_advanced.html

Examples of C-style for loops with different start, end, and step values.

```cpp
for (int i = 0; i < 10; i++) {}

for (int i = 5; i < 10; i++) {}

for (int i = 5; i < 10; i += 2) {}
```

--------------------------------

### Print Hello World in C#

Source: https://docs.godotengine.org/en/4.5/about/introduction.html

A basic C# example that prints 'Hello world!' when the node is ready. Use this as a starting point for scripting in Godot with C#.

```csharp
public override void _Ready()
{
    GD.Print("Hello world!");
}
```

--------------------------------

### Print Hello World in GDScript

Source: https://docs.godotengine.org/en/4.5/about/introduction.html

A basic GDScript example that prints 'Hello world!' when the node is ready. Use this as a starting point for scripting in Godot with GDScript.

```gdscript
func _ready():
    print("Hello world!")
```

--------------------------------

### _initialize

Source: https://docs.godotengine.org/en/4.5/classes/class_mainloop.html

Called once during the initialization of the main loop. Override this method to perform setup tasks before the main loop starts processing frames.

```APIDOC
## _initialize

### Description
Called once during the initialization of the main loop. Override this method to perform setup tasks before the main loop starts processing frames.

### Method
_initialize()

### Parameters
None.

### Return Value
None.

### Example
```gdscript
func _initialize():
    print("Initialized:")
    print("  Starting time: %s" % str(time_elapsed))
```
```

--------------------------------

### Run another instance of the project in C#

Source: https://docs.godotengine.org/en/4.5/classes/class_os.html

Example from the OS.create_process() documentation showing how to launch a new instance of the current project using C#.

```csharp
var pid = OS.CreateProcess(OS.GetExecutablePath(), []);
```

--------------------------------

### GDExtension project file structure overview

Source: https://docs.godotengine.org/en/4.5/tutorials/scripting/cpp/gdextension_cpp_example.html

Shows the expected directory layout for the GDExtension C++ example, including the demo, godot-cpp bindings, and src folders.

```text
gdextension_cpp_example/
|
+--demo/                  # game example/demo to test the extension
|   |
|   +--main.tscn
|   |
|   +--bin/
|       |
|       +--gdexample.gdextension
|
+--godot-cpp/             # C++ bindings
|
+--src/                   # source code of the extension we are building
|   |
|   +--register_types.cpp
|   +--register_types.h
|   +--gdexample.cpp
|   +--gdexample.h
```

--------------------------------

### Create HMAC with HMACContext in GDScript

Source: https://docs.godotengine.org/en/4.5/classes/class_hmaccontext.html

Demonstrates how to use HMACContext to compute an HMAC-SHA256 hash of a message split into two parts. The example shows starting the context with a key, updating with message chunks, and finishing to get the HMAC.

```gdscript
extends Node
var ctx = HMACContext.new()

func _ready():
    var key = "supersecret".to_utf8_buffer()
    var err = ctx.start(HashingContext.HASH_SHA256, key)
    assert(err == OK)
    var msg1 = "this is ".to_utf8_buffer()
    var msg2 = "super duper secret".to_utf8_buffer()
    err = ctx.update(msg1)
    assert(err == OK)
    err = ctx.update(msg2)
    assert(err == OK)
    var hmac = ctx.finish()
    print(hmac.hex_encode())
```

--------------------------------

### Create HMAC with HMACContext in C#

Source: https://docs.godotengine.org/en/4.5/classes/class_hmaccontext.html

Demonstrates how to use HMACContext to compute an HMAC-SHA256 hash of a message split into two parts in C#. The example shows starting the context with a key, updating with message chunks, and finishing to get the HMAC.

```csharp
using Godot;
using System.Diagnostics;

public partial class MyNode : Node
{
    private HmacContext _ctx = new HmacContext();

    public override void _Ready()
    {
        byte[] key = "supersecret".ToUtf8Buffer();
        Error err = _ctx.Start(HashingContext.HashType.Sha256, key);
        Debug.Assert(err == Error.Ok);
        byte[] msg1 = "this is ".ToUtf8Buffer();
        byte[] msg2 = "super duper secret".ToUtf8Buffer();
        err = _ctx.Update(msg1);
        Debug.Assert(err == Error.Ok);
        err = _ctx.Update(msg2);
        Debug.Assert(err == Error.Ok);
        byte[] hmac = _ctx.Finish();
        GD.Print(hmac.HexEncode());
    }
}
```

--------------------------------

### Open directory and create subdirectory using DirAccess

Source: https://docs.godotengine.org/en/4.5/classes/class_diraccess.html

Shows how to open a directory with DirAccess.open and create a subdirectory using the instance method make_dir, compared to the static alternative make_dir_absolute.

```gdscript
# Standard
var dir = DirAccess.open("user://levels")
dir.make_dir("world1")
# Static
DirAccess.make_dir_absolute("user://levels/world1")
```

--------------------------------

### setup

Source: https://docs.godotengine.org/en/4.5/classes/class_openxrbindingmodifiereditor.html

Sets up this editor for the provided action map and binding modifier.

```APIDOC
## setup

### Description
Setup this editor for the provided `action_map` and `binding_modifier`.

### Method
`void setup(action_map: OpenXRActionMap, binding_modifier: OpenXRBindingModifier)`

### Parameters
- **action_map** (OpenXRActionMap) - The action map to use for this editor.
- **binding_modifier** (OpenXRBindingModifier) - The binding modifier to edit.
```

--------------------------------

### Build iOS static xcframework for GDExtension plugin

Source: https://docs.godotengine.org/en/4.5/tutorials/scripting/cpp/gdextension_cpp_example.html

Use these commands to compile simulator and device modules and assemble xcframeworks for iOS. The example uses debug builds; for optimized builds, use target=template_release.

```shell
# compile simulator and device modules
scons arch=universal ios_simulator=yes platform=ios target=<target>
scons arch=arm64 ios_simulator=no platform=ios target=<target>

# assemble xcframeworks
xcodebuild -create-xcframework -library demo/bin/libgdexample.ios.<target>.a -library demo/bin/libgdexample.ios.<target>.simulator.a -output demo/bin/libgdexample.ios.<target>.xcframework
xcodebuild -create-xcframework -library godot-cpp/bin/libgodot-cpp.ios.<target>.arm64.a -library godot-cpp/bin/libgodot-cpp.ios.<target>.universal.simulator.a  -output demo/bin/libgodot-cpp.ios.<target>.xcframework
```

--------------------------------

### surface_begin

Source: https://docs.godotengine.org/en/4.5/classes/class_immediatemesh.html

Begin a new surface.

```APIDOC
## surface_begin

### Description
Begin a new surface.

### Method
void

### Parameters
- **primitive** (PrimitiveType) - The primitive type.
- **material** (Material) - Optional. The material to use.

### Return Value
void
```

--------------------------------

### Absolute NodePath examples

Source: https://docs.godotengine.org/en/4.5/classes/class_nodepath.html

Examples of absolute node paths, which start from the SceneTree root. Use these to reference nodes from the scene root.

```gdscript
^\"/root\"            # Points to the SceneTree's root Window.
^\"/root/Title\"      # May point to the main scene's root node named \"Title\".
^\"/root/Global\"     # May point to an autoloaded node or scene named \"Global\".
```

--------------------------------

### Use FromCurrent() to start from current position

Source: https://docs.godotengine.org/en/4.5/classes/class_propertytweener.html

FromCurrent() uses the current property value as the starting point. This example shows that From(Position) and FromCurrent() are equivalent.

```C#
tween.TweenProperty(this, "position", new Vector2(200.0f, 100.0f), 1.0f).From(Position);
tween.TweenProperty(this, "position", new Vector2(200.0f, 100.0f), 1.0f).FromCurrent();
```

--------------------------------

### setup

Source: https://docs.godotengine.org/en/4.5/classes/class_openxrinteractionprofileeditorbase.html

Initializes the editor with the provided action map and interaction profile. This method must be called to set up the editor for editing a specific interaction profile.

```APIDOC
## setup

### Description

Setup this editor for the provided `action_map` and `interaction_profile`.

### Method

void setup(action_map: OpenXRActionMap, interaction_profile: OpenXRInteractionProfile)

### Parameters

- **action_map** (OpenXRActionMap) - The action map to use for editing.
- **interaction_profile** (OpenXRInteractionProfile) - The interaction profile to edit.

### Return Value

void
```

--------------------------------

### Use from_current() to start from current position

Source: https://docs.godotengine.org/en/4.5/classes/class_propertytweener.html

from_current() uses the current property value as the starting point. This example shows that from(position) and from_current() are equivalent.

```GDScript
tween.tween_property(self, "position", Vector2(200, 100), 1).from(position)
tween.tween_property(self, "position", Vector2(200, 100), 1).from_current()
```

--------------------------------

### submit

Source: https://docs.godotengine.org/en/4.5/classes/class_renderingdevice.html

Pushes the frame setup and draw command buffers and marks the local device as currently processing. Only available in local RenderingDevices.

```APIDOC
## submit

### Description
Pushes the frame setup and draw command buffers then marks the local device as currently processing (which allows calling sync()).

**Note:** Only available in local RenderingDevices.

### Method
submit

### Returns
- **void**
```

--------------------------------

### Comment spacing in GDScript

Source: https://docs.godotengine.org/en/4.5/tutorials/scripting/gdscript/gdscript_styleguide.html

Regular and documentation comments should start with a space, but commented-out code should not. Region comments must not start with a space.

```gdscript
# This is a comment.
#print("This is disabled code")
```

```gdscript
#This is a comment.
# print("This is disabled code")
```

--------------------------------

### Run another instance of the project in GDScript

Source: https://docs.godotengine.org/en/4.5/classes/class_os.html

Example from the OS.create_process() documentation showing how to launch a new instance of the current project using GDScript.

```gdscript
var pid = OS.create_process(OS.get_executable_path(), [])
```

--------------------------------

### emitting

Source: https://docs.godotengine.org/en/4.5/classes/class_cpuparticles2d.html

Sets or gets whether particles are being emitted. Can be used to start and stop emission.

```APIDOC
## emitting

### Description
If `true`, particles are being emitted. emitting can be used to start and stop particles from emitting. However, if one_shot is `true` setting emitting to `true` will not restart the emission cycle until after all active particles finish processing. You can use the finished signal to be notified once all active particles finish processing.

### Methods
- void set_emitting(value: bool)
- bool is_emitting()

### Parameters
- **value** (bool) - Whether to emit particles. Default is `true`.

### Returns
- **bool** - Whether particles are currently emitting.

### Example
```gdscript
$CPUParticles2D.emitting = false
var is_emitting = $CPUParticles2D.is_emitting()
```
```

--------------------------------

### Bad indentation example

Source: https://docs.godotengine.org/en/4.5/tutorials/shaders/shaders_style_guide.html

Shows incorrect indentation with extra spaces.

```glsl
void fragment() {
        COLOR = vec3(1.0, 1.0, 1.0);
}
```

--------------------------------

### Run HTTPClient script with godot -s

Source: https://docs.godotengine.org/en/4.5/tutorials/networking/http_client_class.html

Run the HTTPClient example script from the command line using the godot -s flag. The script connects to and fetches a website.

```shell
c:\godot> godot -s http_test.gd
```

```shell
c:\godot> godot -s HTTPTest.cs
```

--------------------------------

### Create gdexample.gdextension configuration file

Source: https://docs.godotengine.org/en/4.5/tutorials/scripting/gdextension/gdextension_c_example.html

Place this file in the demo folder to describe the extension. The entry_symbol must match the function defined in init.c, and compatibility_minimum is set to 4.2. The [libraries] section provides debug library paths for macOS, Linux, and Windows.

```ini
[configuration]

entry_symbol = "gdexample_library_init"
compatibility_minimum = "4.2"

[libraries]
macos.debug = "res://bin/libgdexample.dylib"
linux.debug = "res://bin/libgdexample.so"
windows.debug = "res://bin/libgdexample.dll"
```

--------------------------------

### AStar3D GetPointConnections example in C#

Source: https://docs.godotengine.org/en/4.5/classes/class_astar3d.html

Demonstrates how to retrieve the connections of a point using GetPointConnections. The example adds points, connects them bidirectionally, and gets the connections of point 1, which returns [2, 3].

```csharp
var astar = new AStar3D();
astar.AddPoint(1, new Vector3(0, 0, 0));
astar.AddPoint(2, new Vector3(0, 1, 0));
astar.AddPoint(3, new Vector3(1, 1, 0));
astar.AddPoint(4, new Vector3(2, 0, 0));
astar.ConnectPoints(1, 2, true);
astar.ConnectPoints(1, 3, true);

long[] neighbors = astar.GetPointConnections(1); // Returns [2, 3]
```

--------------------------------

### AStar3D get_point_connections example in GDScript

Source: https://docs.godotengine.org/en/4.5/classes/class_astar3d.html

Demonstrates how to retrieve the connections of a point using get_point_connections. The example adds points, connects them bidirectionally, and gets the connections of point 1, which returns [2, 3].

```gdscript
var astar = AStar3D.new()
astar.add_point(1, Vector3(0, 0, 0))
astar.add_point(2, Vector3(0, 1, 0))
astar.add_point(3, Vector3(1, 1, 0))
astar.add_point(4, Vector3(2, 0, 0))

astar.connect_points(1, 2, true)
astar.connect_points(1, 3, true)

var neighbors = astar.get_point_connections(1) # Returns [2, 3]
```

--------------------------------

### Create a new Godot project from the command line

Source: https://docs.godotengine.org/en/4.5/tutorials/editor/command_line_tutorial.html

Create a project directory and an empty project.godot file. The project can then be opened with Godot.

```shell
mkdir newgame
cd newgame
touch project.godot
```

--------------------------------

### init.c implementation for GDExtension C example

Source: https://docs.godotengine.org/en/4.5/tutorials/scripting/gdextension/gdextension_c_example.html

Create this file in the src folder. It implements the initialization functions and sets the initialization level to SCENE, which is sufficient for adding a custom node.

```c
#include "init.h"

void initialize_gdexample_module(void *p_userdata, GDExtensionInitializationLevel p_level)
{
}

void deinitialize_gdexample_module(void *p_userdata, GDExtensionInitializationLevel p_level)
{
}

GDExtensionBool GDE_EXPORT gdexample_library_init(GDExtensionInterfaceGetProcAddress p_get_proc_address, GDExtensionClassLibraryPtr p_library, GDExtensionInitialization *r_initialization)
{
    r_initialization->initialize = initialize_gdexample_module;
    r_initialization->deinitialize = deinitialize_gdexample_module;
    r_initialization->userdata = NULL;
    r_initialization->minimum_initialization_level = GDEXTENSION_INITIALIZATION_SCENE;

    return true;
}

```

--------------------------------

### Get Point Connections with AStar2D in C#

Source: https://docs.godotengine.org/en/4.5/classes/class_astar2d.html

Example of using AStar2D to retrieve the connections of a point. The code adds points, connects them, and gets the connections of point 1, which returns [2, 3].

```csharp
var astar = new AStar2D();
astar.AddPoint(1, new Vector2(0, 0));
astar.AddPoint(2, new Vector2(0, 1));
astar.AddPoint(3, new Vector2(1, 1));
astar.AddPoint(4, new Vector2(2, 0));

astar.ConnectPoints(1, 2, true);
astar.ConnectPoints(1, 3, true);

long[] neighbors = astar.GetPointConnections(1); // Returns [2, 3]
```

--------------------------------

### _initialize

Source: https://docs.godotengine.org/en/4.5/classes/class_mainloop.html

Virtual method called when the MainLoop is initialized. Override to perform setup.

```APIDOC
## _initialize

### Description
Virtual method called when the MainLoop is initialized. Override to perform setup.

### Method
_initialize() virtual

### Parameters
None

### Return Value
void
```

--------------------------------

### Get Point Connections with AStar2D in GDScript

Source: https://docs.godotengine.org/en/4.5/classes/class_astar2d.html

Example of using AStar2D to retrieve the connections of a point. The code adds points, connects them, and gets the connections of point 1, which returns [2, 3].

```gdscript
var astar = AStar2D.new()
astar.add_point(1, Vector2(0, 0))
astar.add_point(2, Vector2(0, 1))
astar.add_point(3, Vector2(1, 1))
astar.add_point(4, Vector2(2, 0))

astar.connect_points(1, 2, true)
astar.connect_points(1, 3, true)

var neighbors = astar.get_point_connections(1) # Returns [2, 3]
```

--------------------------------

### _run

Source: https://docs.godotengine.org/en/4.5/classes/class_editorexportplatformextension.html

This method is called when a device one-click deploy menu option is selected. Implementation should export the project to a temporary location, upload and run it on the specific device, or perform another action associated with the menu item.

```APIDOC
## _run

### Description
This method is called when a device one-click deploy menu option is selected. Implementation should export the project to a temporary location, upload and run it on the specific device, or perform another action associated with the menu item.

### Method
Error _run(preset: EditorExportPreset, device: int, debug_flags: BitField[DebugFlags]) virtual

### Parameters
- **preset** (EditorExportPreset) - The export preset to use.
- **device** (int) - The device index selected.
- **debug_flags** (BitField[DebugFlags]) - Debug flags for the export.

### Returns
- **Error** - An error code indicating success or failure.
```

--------------------------------

### Access and modify editor settings in GDScript

Source: https://docs.godotengine.org/en/4.5/classes/class_editorsettings.html

Use this snippet to access the EditorSettings singleton and set or get settings. The example shows setting a value with set_setting, getting it with get_setting, and retrieving the property list. Note that set and get also work due to internal overrides.

```gdscript
var settings = EditorInterface.get_editor_settings()
# `settings.set("some/property", 10)` also works as this class overrides `_set()` internally.
settings.set_setting("some/property", 10)
# `settings.get("some/property")` also works as this class overrides `_get()` internally.
settings.get_setting("some/property")
var list_of_settings = settings.get_property_list()
```

--------------------------------

### Vertical alignment example

Source: https://docs.godotengine.org/en/4.5/tutorials/shaders/shaders_style_guide.html

Shows that spaces should not be used to align expressions vertically.

```glsl
ALBEDO.r   = 1.0;
EMISSION.r = 1.0;
```

--------------------------------

### Set up a PolygonPathFinder in C#

Source: https://docs.godotengine.org/en/4.5/classes/class_polygonpathfinder.html

Use this example to set up a PolygonPathFinder with an array of points and connections. The connections array must have an even length.

```csharp
var polygonPathFinder = new PolygonPathFinder();
Vector2[] points =
[
    new Vector2(0.0f, 0.0f),
    new Vector2(1.0f, 0.0f),
    new Vector2(0.0f, 1.0f)
];
int[] connections = [0, 1, 1, 2, 2, 0];
polygonPathFinder.Setup(points, connections);
```

--------------------------------

### Bad whitespace example

Source: https://docs.godotengine.org/en/4.5/tutorials/shaders/shaders_style_guide.html

Shows incorrect spacing around operators and after commas.

```glsl
COLOR.r=5.0;
COLOR.r = COLOR.g+0.1;
COLOR.b = some_function (1.0,2.0);
```

--------------------------------

### Example Windows binary output

Source: https://docs.godotengine.org/en/4.5/engine_details/development/compiling/introduction_to_the_buildsystem.html

A Windows build with the same configuration produces a binary with this name in the bin/ directory.

```shell
C:\godot> dir bin/
godot.windows.editor.64.exe
```

--------------------------------

### Good whitespace example

Source: https://docs.godotengine.org/en/4.5/tutorials/shaders/shaders_style_guide.html

Shows correct spacing around operators and after commas.

```glsl
COLOR.r = 5.0;
COLOR.r = COLOR.g + 0.1;
COLOR.b = some_function(1.0, 2.0);
```

--------------------------------

### init.h header for GDExtension C example

Source: https://docs.godotengine.org/en/4.5/tutorials/scripting/gdextension/gdextension_c_example.html

Create this file in the src folder. It declares the functions with signatures expected by the GDExtension API and includes defs.h for the GDE_EXPORT macro.

```c
#pragma once

#include "defs.h"

#include "gdextension_interface.h"

void initialize_gdexample_module(void *p_userdata, GDExtensionInitializationLevel p_level);
void deinitialize_gdexample_module(void *p_userdata, GDExtensionInitializationLevel p_level);
GDExtensionBool GDE_EXPORT gdexample_library_init(GDExtensionInterfaceGetProcAddress p_get_proc_address, GDExtensionClassLibraryPtr p_library, GDExtensionInitialization *r_initialization);

```

--------------------------------

### Example of a simple drawing operation using RenderingDevice

Source: https://docs.godotengine.org/en/4.5/classes/class_renderingdevice.html

This example shows how to begin a draw list, bind a render pipeline, set push constants, and draw geometry. It is not a complete example but illustrates the typical sequence of calls for a drawing operation.

```gdscript
var rd = RenderingDevice.new()
var clear_colors = PackedColorArray([Color(0, 0, 0, 0), Color(0, 0, 0, 0), Color(0, 0, 0, 0)])
var draw_list = rd.draw_list_begin(framebuffers[i], RenderingDevice.CLEAR_COLOR_ALL, clear_colors, true, 1.0f, true, 0, Rect2(), RenderingDevice.OPAQUE_PASS)

# Draw opaque.
rd.draw_list_bind_render_pipeline(draw_list, raster_pipeline)
rd.draw_list_bind_uniform_set(draw_list, raster_base_uniform, 0)
rd.draw_list_set_push_constant(draw_list, raster_push_constant, raster_push_constant.size())
rd.draw_list_draw(draw_list, false, 1, slice_triangle_count[i] * 3)
# Draw wire.
rd.draw_list_bind_render_pipeline(draw_list, raster_pipeline_wire)
rd.draw_list_bind_uniform_set(draw_list, raster_base_uniform, 0)
rd.draw_list_set_push_constant(draw_list, raster_push_constant, raster_push_constant.size())
rd.draw_list_draw(draw_list, false, 1, slice_triangle_count[i] * 3)

rd.draw_list_end()
```

--------------------------------

### Access and modify editor settings in C#

Source: https://docs.godotengine.org/en/4.5/classes/class_editorsettings.html

Use this snippet to access the EditorSettings singleton in C# and set or get settings. The example shows setting a value with SetSetting, getting it with GetSetting, and retrieving the property list. Note that set and get also work due to internal overrides.

```csharp
EditorSettings settings = EditorInterface.Singleton.GetEditorSettings();
// `settings.set("some/property", value)` also works as this class overrides `_set()` internally.
settings.SetSetting("some/property", Value);
// `settings.get("some/property", value)` also works as this class overrides `_get()` internally.
settings.GetSetting("some/property");
Godot.Collections.Array<Godot.Collections.Dictionary> listOfSettings = settings.GetPropertyList();
```

--------------------------------

### Run Godot with prime-run using %command% placeholder

Source: https://docs.godotengine.org/en/4.5/classes/class_projectsettings.html

Use the %command% placeholder to run Godot through another executable. Program-specific arguments go before the placeholder; Godot-specific arguments go after. This example forces the project to run on the dedicated GPU in an NVIDIA Optimus system on Linux.

```shell
prime-run %command%
```

--------------------------------

### Complete GDScript class example following style guide conventions

Source: https://docs.godotengine.org/en/4.5/tutorials/scripting/gdscript/gdscript_styleguide.html

A complete StateMachine class demonstrating the style guide's conventions, including class_name, extends, doc comments, signals, exports, property setters, onready variables, and various methods.

```gdscript
class_name StateMachine
extends Node
## Hierarchical State machine for the player.
##
## Initializes states and delegates engine callbacks ([method Node._physics_process],
## [method Node._unhandled_input]) to the state.

signal state_changed(previous, new)

@export var initial_state: Node
var is_active = true:
    set = set_is_active

@onready var _state = initial_state:
    set = set_state
@onready var _state_name = _state.name


func _init():
    add_to_group("state_machine")


func _enter_tree():
    print("this happens before the ready method!")


func _ready():
    state_changed.connect(_on_state_changed)
    _state.enter()


func _unhandled_input(event):
    _state.unhandled_input(event)


func _physics_process(delta):
    _state.physics_process(delta)


func transition_to(target_state_path, msg={}):
    if not has_node(target_state_path):
        return

    var target_state = get_node(target_state_path)
    assert(target_state.is_composite == false)

    _state.exit()
    self._state = target_state
    _state.enter(msg)
    Events.player_state_changed.emit(_state.name)


func set_is_active(value):
    is_active = value
    set_physics_process(value)
    set_process_unhandled_input(value)
    set_block_signals(not value)


func set_state(value):
    _state = value
    _state_name = _state.name


func _on_state_changed(previous, new):
    print("state changed")
    state_changed.emit()


class State:
    var foo = 0

    func _init():
        print("Hello!")
```

--------------------------------

### shaped_text_get_range

Source: https://docs.godotengine.org/en/4.5/classes/class_textserver.html

Returns the character range of the shaped text. This method is used to get the start and end positions.

```APIDOC
## shaped_text_get_range

### Description
Returns the character range of the shaped text. This method is used to get the start and end positions.

### Method
shaped_text_get_range

### Parameters
- **shaped** (RID) - Required - The shaped text resource ID.

### Returns
Vector2i - The start and end positions.
```

--------------------------------

### Bad comment spacing example

Source: https://docs.godotengine.org/en/4.5/tutorials/shaders/shaders_style_guide.html

Shows incorrect spacing for comments and commented-out code.

```glsl
//This is a comment.
// return;
```

--------------------------------

### start

Source: https://docs.godotengine.org/en/4.5/classes/class_skeletonik3d.html

Starts the IK solver. If one_time is true, the solver will run only once and then stop. Otherwise, it will continue running until stop() is called.

```APIDOC
## start

### Description
Starts the IK solver. If one_time is true, the solver will run only once and then stop. Otherwise, it will continue running until stop() is called.

### Method
`start(one_time: bool = false)`

### Parameters
- **one_time** (bool) - Optional - If true, the solver runs only once. Default is false.

### Example
```gdscript
# Start the IK solver continuously
skeleton_ik.start()

# Start the IK solver for a single update
skeleton_ik.start(true)
```
```

--------------------------------

### Good comment spacing example

Source: https://docs.godotengine.org/en/4.5/tutorials/shaders/shaders_style_guide.html

Shows correct spacing for comments and commented-out code.

```glsl
// This is a comment.
//return;
```

--------------------------------

### Include new headers in init.c

Source: https://docs.godotengine.org/en/4.5/tutorials/scripting/gdextension/gdextension_c_example.html

Add the api.h and gdexample.h headers to init.c so the new API wrapper and custom class are available.

```c
#include "init.h"

#include "api.h"
#include "gdexample.h"
...
```

--------------------------------

### void popup_quick_open(callback: Callable, base_types: Array[StringName] = [])

Source: https://docs.godotengine.org/en/4.5/classes/class_editorinterface.html

Pops up an editor dialog for quick selecting a resource file. The callback must take a single argument of type String which will contain the path of the selected resource or be empty if the dialog is canceled.

```APIDOC
## void popup_quick_open(callback: Callable, base_types: Array[StringName] = [])

### Description
Pops up an editor dialog for quick selecting a resource file. The `callback` must take a single argument of type String which will contain the path of the selected resource or be empty if the dialog is canceled. If `base_types` is provided, the dialog will only show resources that match these types. Only types deriving from Resource are supported.

### Method
void

### Parameters
- **callback** (Callable) - Required - The callback to call with the selected resource path.
- **base_types** (Array[StringName]) - Optional - List of base types to filter. Defaults to [].
```

--------------------------------

### Bad brace placement example

Source: https://docs.godotengine.org/en/4.5/tutorials/shaders/shaders_style_guide.html

Shows incorrect brace placement on a new line.

```glsl
void fragment()
{
    if (true)
        // ...
}
```

--------------------------------

### Implement a DTLS server in C#

Source: https://docs.godotengine.org/en/4.5/classes/class_dtlsserver.html

This C# example demonstrates setting up a DTLS server using DtlsServer and UdpServer. It listens on port 4242, loads a private key and certificate, and handles incoming connections. It also polls connected peers and echoes received messages.

```csharp
// ServerNode.cs
using Godot;

public partial class ServerNode : Node
{
    private DtlsServer _dtls = new DtlsServer();
    private UdpServer _server = new UdpServer();
    private Godot.Collections.Array<PacketPeerDtls> _peers = [];

    public override void _Ready()
    {
        _server.Listen(4242);
        var key = GD.Load<CryptoKey>("key.key"); // Your private key.
        var cert = GD.Load<X509Certificate>("cert.crt"); // Your X509 certificate.
        _dtls.Setup(TlsOptions.Server(key, cert));
    }

    public override void _Process(double delta)
    {
        while (_server.IsConnectionAvailable())
        {
            PacketPeerUdp peer = _server.TakeConnection();
            PacketPeerDtls dtlsPeer = _dtls.TakeConnection(peer);
            if (dtlsPeer.GetStatus() != PacketPeerDtls.Status.Handshaking)
            {
                continue; // It is normal that 50% of the connections fails due to cookie exchange.
            }
            GD.Print("Peer connected!");
            _peers.Add(dtlsPeer);
        }

        foreach (var p in _peers)
        {
            p.Poll(); // Must poll to update the state.
            if (p.GetStatus() == PacketPeerDtls.Status.Connected)
            {
                while (p.GetAvailablePacketCount() > 0)
                {
                    GD.Print($"Received Message From Client: {p.GetPacket().GetStringFromUtf8()}");
                    p.PutPacket("Hello DTLS Client".ToUtf8Buffer());
                }
            }
        }
    }
}
```

--------------------------------

### HTTPClient GET request example in GDScript

Source: https://docs.godotengine.org/en/4.5/tutorials/networking/http_client_class.html

A SceneTree script that uses HTTPClient to connect to www.php.net, send a GET request, and read the response. It must be polled while connecting, requesting, and reading the body.

```gdscript
extends SceneTree

# HTTPClient demo
# This simple class can do HTTP requests; it will not block, but it needs to be polled.

func _init():
    var err = 0
    var http = HTTPClient.new() # Create the Client.

    err = http.connect_to_host("www.php.net", 80) # Connect to host/port.
    assert(err == OK) # Make sure connection is OK.

    # Wait until resolved and connected.
    while http.get_status() == HTTPClient.STATUS_CONNECTING or http.get_status() == HTTPClient.STATUS_RESOLVING:
        http.poll()
        print("Connecting...")
        await get_tree().process_frame

    assert(http.get_status() == HTTPClient.STATUS_CONNECTED) # Check if the connection was made successfully.

    # Some headers
    var headers = [
        "User-Agent: Pirulo/1.0 (Godot)",
        "Accept: */*"
    ]

    err = http.request(HTTPClient.METHOD_GET, "/ChangeLog-5.php", headers) # Request a page from the site (this one was chunked..)
    assert(err == OK) # Make sure all is OK.

    while http.get_status() == HTTPClient.STATUS_REQUESTING:
        # Keep polling for as long as the request is being processed.
        http.poll()
        print("Requesting...")
        await get_tree().process_frame

    assert(http.get_status() == HTTPClient.STATUS_BODY or http.get_status() == HTTPClient.STATUS_CONNECTED) # Make sure request finished well.

    print("response? ", http.has_response()) # Site might not have a response.

    if http.has_response():
        # If there is a response...

        headers = http.get_response_headers_as_dictionary() # Get response headers.
        print("code: ", http.get_response_code()) # Show response code.
        print("**headers:\n", headers) # Show headers.

        # Getting the HTTP Body

        if http.is_response_chunked():
            # Does it use chunks?
            print("Response is Chunked!")
        else:
            # Or just plain Content-Length
            var bl = http.get_response_body_length()
            print("Response Length: ", bl)

        # This method works for both anyway

        var rb = PackedByteArray() # Array that will hold the data.

        while http.get_status() == HTTPClient.STATUS_BODY:
            # While there is body left to be read
            http.poll()
            # Get a chunk.
            var chunk = http.read_response_body_chunk()
            if chunk.size() == 0:
                await get_tree().process_frame
            else:
                rb = rb + chunk # Append to read buffer.
        # Done!

        print("bytes got: ", rb.size())
        var text = rb.get_string_from_ascii()
        print("Text: ", text)

    quit()
```

--------------------------------

### Bad floating-point numbers example

Source: https://docs.godotengine.org/en/4.5/tutorials/shaders/shaders_style_guide.html

Shows incorrect formatting of floating-point numbers missing digits.

```glsl
void fragment() {
    ALBEDO.rgb = vec3(5., .1, .2);
}
```

--------------------------------

### Simple compute operation using compute_list_begin

Source: https://docs.godotengine.org/en/4.5/classes/class_renderingdevice.html

This example demonstrates a basic compute operation using compute_list_begin and related methods. It binds a compute pipeline and uniform sets, then dispatches compute work for each atlas slice. Note that this is not a complete example.

```gdscript
var rd = RenderingDevice.new()
var compute_list = rd.compute_list_begin()

rd.compute_list_bind_compute_pipeline(compute_list, compute_shader_dilate_pipeline)
rd.compute_list_bind_uniform_set(compute_list, compute_base_uniform_set, 0)
rd.compute_list_bind_uniform_set(compute_list, dilate_uniform_set, 1)

for i in atlas_slices:
    rd.compute_list_set_push_constant(compute_list, push_constant, push_constant.size())
    rd.compute_list_dispatch(compute_list, group_size.x, group_size.y, group_size.z)
    # No barrier, let them run all together.

rd.compute_list_end()
```

--------------------------------

### Single-line multiline comment example

Source: https://docs.godotengine.org/en/4.5/tutorials/shaders/shaders_style_guide.html

Shows that multiline comment syntax should not be used for single-line comments.

```glsl
/* This is another comment. */
```

--------------------------------

### _initialize

Source: https://docs.godotengine.org/en/4.5/classes/class_mainloop.html

Called once during initialization. This virtual method can be overridden to perform setup tasks when the main loop is initialized.

```APIDOC
## _initialize

### Description
Called once during initialization.

### Method
void _initialize() virtual

### Parameters
None.

### Return Value
None.
```

--------------------------------

### Initialize OpenXR in _Ready (C#)

Source: https://docs.godotengine.org/en/4.5/tutorials/xr/a_better_xr_start_script.html

Finds and initializes OpenXR, enables XR on the viewport, disables v-sync, enables VRS, connects session signals, and quits on failure. Use for VR-only applications.

```csharp
...

    /// <summary>
    /// Called when the node enters the scene tree for the first time.
    /// </summary>
    public override void _Ready()
    {
        _xrInterface = (OpenXRInterface)XRServer.FindInterface("OpenXR");
        if (_xrInterface != null && _xrInterface.IsInitialized())
        {
            GD.Print("OpenXR instantiated successfully.");
            var vp = GetViewport();

            // Enable XR on our viewport
            vp.UseXR = true;

            // Make sure v-sync is off, v-sync is handled by OpenXR
            DisplayServer.WindowSetVsyncMode(DisplayServer.VSyncMode.Disabled);

            // Enable VRS
            if (RenderingServer.GetRenderingDevice() != null)
            {
                vp.VrsMode = Viewport.VrsModeEnum.XR;
            }
            else if ((int)ProjectSettings.GetSetting("xr/openxr/foveation_level") == 0)
            {
                GD.PushWarning("OpenXR: Recommend setting Foveation level to High in Project Settings");
            }

            // Connect the OpenXR events
            _xrInterface.SessionBegun += OnOpenXRSessionBegun;
            _xrInterface.SessionVisible += OnOpenXRVisibleState;
            _xrInterface.SessionFocussed += OnOpenXRFocusedState;
            _xrInterface.SessionStopping += OnOpenXRStopping;
            _xrInterface.PoseRecentered += OnOpenXRPoseRecentered;
        }
        else
        {
            // We couldn't start OpenXR.
            GD.Print("OpenXR not instantiated!");
            GetTree().Quit();
        }
    }

...
```
Tokens:
Raw