Godot Engine

https://github.com/godotengine/godot-docs
Admin
This repository contains the source files for the Godot Engine's documentation, written in...
Tokens:5,312,530
Snippets:45,886
Trust Score:9.9
Update:11 hours ago
Show doc for...
Tokens:
Raw
### get_is_setup() -> bool / set_is_setup(is_setup: bool)

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_skeletonmodification2d.rst

Gets or sets whether the modification has been initialized and setup.

```APIDOC
## get_is_setup / set_is_setup

### Description
Checks or sets the setup state of the modification.

### Syntax
```gdscript
func get_is_setup() -> bool
func set_is_setup(is_setup: bool) -> void
```

### Parameters
- **is_setup** (`bool`) - True if the modification is setup, false otherwise.

### Return Value
- `bool` (for getter) - True if the modification is setup.
```

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

### AudioStreamWAV.loop_begin

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_audiostreamwav.rst

Gets or sets the loop starting sample position.

```APIDOC
### Property: `loop_begin`

**Type:** `int`
**Default:** `0`

#### Methods
- `void set_loop_begin(value: int)`
- `int get_loop_begin()`

#### Description
The loop start point (in number of samples, relative to the beginning of the stream).
```

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

### get_is_setup() -> bool / set_is_setup(is_setup: bool)

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_skeletonmodification2d.rst

Gets or sets whether this modification has been successfully setup.

```APIDOC
### get_is_setup / set_is_setup

```gdscript
func get_is_setup() -> bool
func set_is_setup(is_setup: bool) -> void
```

#### Description
`get_is_setup` returns whether this modification has been successfully setup or not. `set_is_setup` manually allows setting the setup state; it should rarely be used since the modification stack handles setup automatically.

#### Parameters
- `is_setup` (bool) - The setup state to apply.
```

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

### setup

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_skeletonmodificationstack2d.rst

Initializes and sets up the modification stack.

```APIDOC
### setup

```gdscript
void setup()
```

Sets up the modification stack.
```

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

### start(one_time: bool = false)

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_skeletonik3d.rst

Starts the IK solver calculations for the skeleton bone chain.

```APIDOC
## start

### Description
Starts the IK solver. If `one_time` is `true`, the solver calculates transformations once and stops immediately.

### Signature
`void start(one_time: bool = false)`

### Parameters
- **one_time** (`bool`, optional, default = `false`) - If `true`, the IK solver executes only once instead of running continuously every frame.
```

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

### setup(server_options)

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_dtlsserver.rst

Initializes and configures the DTLS server state with the specified TLS options (private key and certificate). Upon setup, the server is ready to accept incoming DTLS connections.

```APIDOC
### Method
`setup(server_options: TLSOptions)`

### Description
Configures the DTLS server with TLS settings, such as certificates and private keys via `TLSOptions`.

### Parameters
- **server_options** (`TLSOptions`) - Required - The TLS configuration options for the server.

### Example (GDScript)
```gdscript
var dtls = DTLSServer.new()
var key = load("key.key")
var cert = load("cert.crt")
dtls.setup(TlsOptions.server(key, cert))
```

### Example (C#)
```csharp
var dtls = new DtlsServer();
var key = GD.Load<CryptoKey>("key.key");
var cert = GD.Load<X509Certificate>("cert.crt");
dtls.Setup(TlsOptions.Server(key, cert));
```
```

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

### Start game with Engine.prototype.startGame

Source: https://github.com/godotengine/godot-docs/blob/master/tutorials/platform/web/customizing_html5_shell.rst

Initializes and starts the game using the exported configuration. Returns a Promise that resolves when the game finishes loading.

```javascript
const engine = new Engine($GODOT_CONFIG);
engine.startGame({
    // Optional override configuration, for example:
    // unloadAfterInit: false,
    // canvasResizePolicy: 0,
    // ...
});
```

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

### Install mold on Fedora

Source: https://github.com/godotengine/godot-docs/blob/master/engine_details/development/compiling/compiling_for_linuxbsd.rst

Installs the mold linker on Fedora systems using dnf.

```shell
sudo dnf install -y mold
```

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

### Install build dependencies on NetBSD

Source: https://github.com/godotengine/godot-docs/blob/master/engine_details/development/compiling/compiling_for_linuxbsd.rst

Configures pkgin and installs pkg-config, SCons, Wayland, and PulseAudio on NetBSD.

```shell
pkg_add pkgin
pkgin -y install \
  pkg-config \
  py313-scons \
  wayland \
  pulseaudio
```

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

### void start(one_time: bool = false)

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_skeletonik3d.rst

Starts applying IK effects to the Skeleton3D bones. Can be configured to run continuously or apply once immediately.

```APIDOC
## void start(one_time: bool = false)

### Description
Starts applying IK effects on each frame to the Skeleton3D bones but will only take effect starting on the next frame. If one_time is true, this will take effect immediately but also reset on the next frame.

### Parameters
- **one_time** (bool, optional, default: false) - If true, applies IK effect immediately and resets on next frame instead of continuous execution.
```

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

### start(from_pos: float = 0.0)

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_audiostreamplayback.rst

Starts playing the audio stream from the specified position in seconds.

```APIDOC
### Method Signature
```gdscript
func start(from_pos: float = 0.0) -> void
```

### Parameters
- **from_pos** (float) - Optional. The starting position in seconds (default: 0.0).
```

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

### Install build dependencies on openKylin

Source: https://github.com/godotengine/godot-docs/blob/master/engine_details/development/compiling/compiling_for_linuxbsd.rst

Installs system dependencies using `apt`, then installs SCons via `pip` on openKylin.

```shell
sudo apt update
sudo apt install -y \
  python3-pip \
  build-essential \
  pkg-config \
  libx11-dev \
  libxcursor-dev \
  libxinerama-dev \
  libgl1-mesa-dev \
  libglu1-mesa-dev \
  libasound2-dev \
  libpulse-dev \
  libudev-dev \
  libxi-dev \
  libxrandr-dev \
  libwayland-dev
sudo pip install scons
```

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

### start()

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_godotinstance.rst

Finishes the initialization and startup sequence of the instance. Returns true on success.

```APIDOC
## start

### Description
Finishes this instance's startup sequence. Returns `true` on success.

### Signature
`bool start()`

### Return Value
- **bool** - `true` on successful completion of startup sequence.
```

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

### start(from_pos: float = 0.0)

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_audiostreamplayback.rst

Starts playing the stream from a specified position.

```APIDOC
### Method Signature
`void start(from_pos: float = 0.0)`

### Description
Starts the stream from the given `from_pos`, in seconds.

### Parameters
- **from_pos** (`float`, optional) - Position to start playback from, in seconds. Default value is `0.0`.
```

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

### Install mold on Debian or Ubuntu

Source: https://github.com/godotengine/godot-docs/blob/master/engine_details/development/compiling/compiling_for_linuxbsd.rst

Installs the mold linker on Debian and Ubuntu distributions using apt-get.

```shell
sudo apt-get update
sudo apt-get install -y mold
```

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

### Install build dependencies on Solus

Source: https://github.com/godotengine/godot-docs/blob/master/engine_details/development/compiling/compiling_for_linuxbsd.rst

Installs the Solus system development component along with SCons and the required media/graphics libraries using `eopkg`.

```shell
eopkg install -y \
  -c system.devel \
  scons \
  libxcursor-devel \
  libxinerama-devel \
  libxi-devel \
  libxrandr-devel \
  wayland-devel \
  mesalib-devel \
  libglu \
  alsa-lib-devel \
  pulseaudio-devel
```

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

### Install build dependencies on FreeBSD

Source: https://github.com/godotengine/godot-docs/blob/master/engine_details/development/compiling/compiling_for_linuxbsd.rst

Uses `pkg install` on FreeBSD to fetch SCons, pkgconf, X.org libraries, Wayland, ALSA, and PulseAudio.

```shell
pkg install -y \
  devel/scons \
  pkgconf \
  xorg-libraries \
  libXcursor \
  libXrandr \
  libXi \
  xorgproto \
  libGLU \
  alsa-lib \
  pulseaudio \
  wayland
```

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

### Install build dependencies on OpenBSD

Source: https://github.com/godotengine/godot-docs/blob/master/engine_details/development/compiling/compiling_for_linuxbsd.rst

Installs SCons, Wayland, and PulseAudio on OpenBSD via `pkg_add`.

```shell
pkg_add -I \
  scons \
  wayland \
  pulseaudio
```

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

### Install mold on Arch Linux

Source: https://github.com/godotengine/godot-docs/blob/master/engine_details/development/compiling/compiling_for_linuxbsd.rst

Installs the mold linker on Arch Linux using pacman.

```shell
pacman -Sy --noconfirm --needed mold
```

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

### Engine.prototype.startGame(override)

Source: https://github.com/godotengine/godot-docs/blob/master/tutorials/platform/web/html5_shell_classref.rst

Initializes, loads, and starts the game instance, preloading the main pack file.

```APIDOC
### Engine.prototype.startGame(override)

Start the game instance using the given configuration override (if any). This will initialize the instance if it is not initialized, load the engine if it is not loaded, and preload the main pck.

#### Arguments
- **override** (`EngineConfig`, optional) - An optional configuration override.

#### Returns
- **Promise** - A Promise that resolves once the game started.
```

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

### Engine.prototype.start(override)

Source: https://github.com/godotengine/godot-docs/blob/master/tutorials/platform/web/html5_shell_classref.rst

Starts the engine instance with optional configuration overrides.

```APIDOC
### Engine.prototype.start(override)

Start the engine instance using the given override configuration (if any). This will initialize the instance if it is not initialized. The engine must be loaded beforehand. Fails if a canvas cannot be found on the page or is not specified in configuration.

#### Arguments
- **override** (`EngineConfig`, optional) - An optional configuration override.

#### Returns
- **Promise** - A Promise that resolves once the engine started.
```

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

### Documenting multi-language examples with [codeblocks]

Source: https://github.com/godotengine/godot-docs/blob/master/engine_details/class_reference/index.rst

Use `[codeblocks]` containing `[gdscript]` and `[csharp]` tags to provide language-specific code tabs. GDScript examples must always be written first.

```bbcode
[codeblocks]
[gdscript]
func _ready():
    var sprite = get_node("Sprite2D")
    print(sprite.get_pos())
[/gdscript]
[csharp]
public override void _Ready()
{
    var sprite = GetNode("Sprite2D");
    GD.Print(sprite.GetPos());
}
[/csharp]
[/codeblocks]
```

```gdscript
func _ready():
    var sprite = get_node("Sprite2D")
    print(sprite.get_pos())
```

```csharp
public override void _Ready()
{
    var sprite = GetNode("Sprite2D");
    GD.Print(sprite.GetPos());
}
```

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

### set_start_position / get_start_position

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_navigationpathqueryparameters3d.rst

Sets or gets the pathfinding start position in global 3D coordinates.

```APIDOC
### start_position

```gdscript
void set_start_position(value: Vector3)
Vector3 get_start_position()
```

#### Parameters
- **value** (`Vector3`): The starting position in global coordinates. Default is `Vector3(0, 0, 0)`.

#### Returns
- `Vector3`: The current start position.

#### Description
The pathfinding start position in global coordinates.
```

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

### Install Godot via Scoop on Windows

Source: https://github.com/godotengine/godot-docs/blob/master/tutorials/editor/command_line_tutorial.rst

Installs the standard Godot editor or the C# support version (`godot-mono`) on Windows to make the binary available in `PATH`.

```sh
# Add "Extras" bucket
scoop bucket add extras

# Standard editor:
scoop install godot

# Editor with C# support (will be available as `godot-mono` in `PATH`):
scoop install godot-mono
```

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

### Implement entry point in src/init.c

Source: https://github.com/godotengine/godot-docs/blob/master/engine_details/engine_api/gdextension/gdextension_c_example.rst

Implement gdexample_library_init to configure callbacks and set the minimum initialization level to GDEXTENSION_INITIALIZATION_SCENE.

```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;
}
```

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

### byte_offset

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_gltfaccessor.rst

Gets or sets the byte offset relative to the start of the referenced buffer view.

```APIDOC
### byte_offset

```gdscript
var byte_offset: int
func set_byte_offset(value: int) -> void
func get_byte_offset() -> int
```

The offset relative to the start of the buffer view in bytes.
```

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

### Install build dependencies on openSUSE

Source: https://github.com/godotengine/godot-docs/blob/master/engine_details/development/compiling/compiling_for_linuxbsd.rst

Uses `zypper` to install SCons, GCC C++, Wayland, X11, Mesa, and audio development packages on openSUSE.

```shell
sudo zypper install -y \
  scons \
  pkgconfig \
  libX11-devel \
  libXcursor-devel \
  libXrandr-devel \
  libXinerama-devel \
  libXi-devel \
  wayland-devel \
  Mesa-libGL-devel \
  alsa-devel \
  libpulse-devel \
  libudev-devel \
  gcc-c++ \
  libGLU1
```

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

### void submit()

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_renderingdevice.rst

Pushes the frame setup and draw command buffers, marking the local device as processing.

```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.

### Signature
```gdscript
void submit()
```

### Parameters
None.

### Return Value
- `void`
```

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

### sparse_indices_byte_offset

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_gltfaccessor.rst

Gets or sets the offset relative to the start of the sparse indices buffer view in bytes.

```APIDOC
### sparse_indices_byte_offset

```gdscript
var sparse_indices_byte_offset: int
func set_sparse_indices_byte_offset(value: int) -> void
func get_sparse_indices_byte_offset() -> int
```

The offset relative to the start of the buffer view in bytes.
```

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

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

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_openxrbindingmodifiereditor.rst

Initializes and configures the editor with the provided action map and binding modifier instances.

```APIDOC
### setup

```gdscript
func setup(action_map: OpenXRActionMap, binding_modifier: OpenXRBindingModifier) -> void
```

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

#### Parameters
- **action_map** (`OpenXRActionMap`): The action map associated with the binding modifier.
- **binding_modifier** (`OpenXRBindingModifier`): The binding modifier to be edited.
```

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

### Install build dependencies on Gentoo

Source: https://github.com/godotengine/godot-docs/blob/master/engine_details/development/compiling/compiling_for_linuxbsd.rst

Syncs repositories and installs required build and graphical libraries on Gentoo using `emerge`.

```shell
emerge --sync
emerge -an \
  dev-build/scons \
  x11-libs/libX11 \
  x11-libs/libXcursor \
  x11-libs/libXinerama \
  x11-libs/libXi \
  dev-util/wayland-scanner \
  media-libs/mesa \
  media-libs/glu \
  media-libs/alsa-lib \
  media-sound/pulseaudio
```

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

### Install Perfetto SDK via Python script

Source: https://github.com/godotengine/godot-docs/blob/master/engine_details/development/profiling/perfetto.rst

Run this script from the Godot root directory to install the latest version of the Perfetto SDK under `thirdparty/perfetto`.

```shell
python misc/scripts/install_perfetto.py
```

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

### setup_local_to_scene() -> void

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_resource.rst

Initializes the resource for local scene usage. Typically called when a scene instance with local resources is created.

```APIDOC
### Method Signature
`setup_local_to_scene() -> void`

### Description
Configures and initializes the resource for local scene instantiation.
```

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

### bool start_passthrough()

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_xrinterface.rst

Starts passthrough rendering on the XR interface. Returns false if passthrough could not be started.

```APIDOC
## start_passthrough

### Description
Starts passthrough, will return `false` if passthrough couldn't be started.

**Deprecated:** Set the `environment_blend_mode` to `XR_ENV_BLEND_MODE_ALPHA_BLEND`, instead.

**Note:** The viewport used for XR must have a transparent background, otherwise passthrough may not properly render.

### Method Signature
`bool start_passthrough()`

### Return Value
- **bool** - Returns `true` if passthrough was successfully started, or `false` otherwise.
```

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

### start(node: StringName, reset: bool = true) -> void

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_animationnodestatemachineplayback.rst

Directly starts playback from the specified animation state node. Can optionally reset the node's playback state to the beginning.

```APIDOC
### Method: start

#### Parameters
- **node** (`StringName`) - The target state node to start playing.
- **reset** (`bool`, optional, default: `true`) - Whether to reset the animation playback position to the start.

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

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

### path_return_max_radius

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_navigationagent2d.rst

Gets or sets the maximum allowed radius in world units that the returned path can be from the path start. A sphere clip is performed considering actual navigation mesh path points with the path start as the center.

```APIDOC
### Property: path_return_max_radius

- **Type:** `float`
- **Default Value:** `0.0`

#### Methods
- `void set_path_return_max_radius(value: float)`
- `float get_path_return_max_radius()`

#### Description
The maximum allowed radius in world units that the returned path can be from the path start. The path will be clipped when going over this radius. Compared to `path_return_max_length`, this allows the agent to go that much further if they need to walk around a corner.

**Note:** This will perform a sphere clip considering only the actual navigation mesh path points with the first path position being the sphere's center.
```

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

### Get node and resource with C#

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_node.rst

Shows how GetNodeAndResource returns the node, resource, and subpath for different NodePath formats in C#. The examples print the node name, resource class, and remaining subpath.

```csharp
var a = GetNodeAndResource(NodePath("Area2D/Sprite2D"));
GD.Print(a[0].Name); // Prints Sprite2D
GD.Print(a[1]);      // Prints <null>
GD.Print(a[2]);      // Prints ^"

var b = GetNodeAndResource(NodePath("Area2D/Sprite2D:texture:atlas"));
GD.Print(b[0].name);        // Prints Sprite2D
GD.Print(b[1].get_class()); // Prints AtlasTexture
GD.Print(b[2]);             // Prints ^""

var c = GetNodeAndResource(NodePath("Area2D/Sprite2D:texture:atlas:region"));
GD.Print(c[0].name);        // Prints Sprite2D
GD.Print(c[1].get_class()); // Prints AtlasTexture
GD.Print(c[2]);             // Prints ^":region"
```

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

### fog_height

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_environment.rst

Gets or sets the starting height coordinate for height-based fog effects. Controls the elevation where height fog begins.

```APIDOC
### Property: fog_height

- **Type:** `float`
- **Default Value:** `0.0`
- **Setter:** `set_fog_height(value: float)`
- **Getter:** `get_fog_height() -> float`

#### Description
The height at which the height fog effect begins.
```

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

### Install Python and MinGW using Scoop

Source: https://github.com/godotengine/godot-docs/blob/master/engine_details/development/compiling/compiling_for_windows.rst

Installs Python and the MinGW compiler toolchain via Scoop. SCons must still be installed separately via pip.

```shell
scoop install python mingw
```

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

### Create a Godot project from the command line

Source: https://github.com/godotengine/godot-docs/blob/master/tutorials/editor/command_line_tutorial.rst

Navigate to the target directory and create a project.godot file to initialize a new project.

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

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

### radius

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_navigationagent2d.rst

Gets or sets the avoidance agent body radius in world units. This controls the avoidance body size rather than the maneuver start radius.

```APIDOC
### Property: radius

- **Type:** `float`
- **Default Value:** `10.0`

#### Methods
- `void set_radius(value: float)`
- `float get_radius()`

#### Description
The radius of the avoidance agent. This is the "body" of the avoidance agent and not the avoidance maneuver starting radius (which is controlled by `neighbor_distance`). Does not affect normal pathfinding.
```

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

### start_passthrough()

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_xrinterface.rst

Starts passthrough mode on the XR interface if supported. Returns true if passthrough was successfully started, or false otherwise.

```APIDOC
### bool start_passthrough()

Starts the passthrough feature on the XR interface.

#### Returns
- **bool**: Returns `true` if passthrough mode was successfully started, or `false` on failure.
```

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

### Install SCons using Homebrew

Source: https://github.com/godotengine/godot-docs/blob/master/engine_details/development/compiling/compiling_for_macos.rst

Installs the SCons build system on macOS using Homebrew. Installing Homebrew also automatically fetches Command Line Tools for Xcode if not already installed.

```shell
brew install scons
```

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

### Example of Project File System Layout

Source: https://github.com/godotengine/godot-docs/blob/master/tutorials/scripting/filesystem.rst

Demonstrates a typical Godot project directory structure with project.godot located at the project root.

```none
/project.godot
/enemy/enemy.tscn
/enemy/enemy.gd
/enemy/enemysprite.png
/player/player.gd
```

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

### set_constant_id(value: int) / get_constant_id() -> int

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_rdpipelinespecializationconstant.rst

Sets or gets the identifier of the specialization constant. This value starts from 0 and increments for each distinct specialization constant in a shader.

```APIDOC
### constant_id

- **Type**: `int`
- **Default**: `0`
- **Setter**: `set_constant_id(value: int)`
- **Getter**: `get_constant_id() -> int`

#### Description
The identifier of the specialization constant. This is a value starting from `0` and that increments for every different specialization constant for a given shader.
```

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

### Install system library dependencies on Debian or Ubuntu

Source: https://github.com/godotengine/godot-docs/blob/master/engine_details/development/compiling/compiling_for_linuxbsd.rst

Installs development packages for third-party libraries on Debian or Ubuntu. Install these on top of the base distribution build dependencies before compiling with system libraries.

```shell
sudo apt-get update
sudo apt-get install -y \
  libembree-dev \
  libenet-dev \
  libfreetype-dev \
  libpng-dev \
  zlib1g-dev \
  libgraphite2-dev \
  libharfbuzz-dev \
  libogg-dev \
  libtheora-dev \
  libvorbis-dev \
  libwebp-dev \
  libmbedtls-dev \
  libminiupnpc-dev \
  libpcre2-dev \
  libsdl3-dev \
  libzstd-dev \
  libsquish-dev \
  libicu-dev
```

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

### path_search_max_distance

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_navigationagent2d.rst

Gets or sets the maximum distance a searched polygon can be away from the start polygon before canceling the search. When cancelled, builds a path to the closest found polygon.

```APIDOC
### Property: path_search_max_distance

- **Type:** `float`
- **Default Value:** `0.0`

#### Methods
- `void set_path_search_max_distance(value: float)`
- `float get_path_search_max_distance()`

#### Description
The maximum distance a searched polygon can be away from the start polygon before the pathfinding cancels the search for a path to the (possibly unreachable or very far away) target position polygon. In this case the pathfinding resets and builds a path from the start polygon to the polygon that was found closest to the target position so far. A value of `0` or below counts as unlimited.
```

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

### Configure iceServers with STUN and TURN for initialize()

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_webrtcpeerconnection.rst

Dictionary of valid configuration options passed to WebRTCPeerConnection.initialize(). Includes one or more STUN and TURN server URLs, with optional TURN username and credential.

```gdscript
{
    "iceServers": [
        {
            "urls": [ "stun:stun.example.com:3478" ], # One or more STUN servers.
        },
        {
            "urls": [ "turn:turn.example.com:3478" ], # One or more TURN servers.
            "username": "a_username", # Optional username for the TURN server.
            "credential": "a_password", # Optional password for the TURN server.
        }
    ]
}
```

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

### Get node and resource with GDScript

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_node.rst

Shows how get_node_and_resource returns the node, resource, and subpath for different NodePath formats. The examples print the node name, resource class, and remaining subpath.

```gdscript
var a = get_node_and_resource("Area2D/Sprite2D")
print(a[0].name) # Prints Sprite2D
print(a[1])      # Prints <null>
print(a[2])      # Prints ^""

var b = get_node_and_resource("Area2D/Sprite2D:texture:atlas")
print(b[0].name)        # Prints Sprite2D
print(b[1].get_class()) # Prints AtlasTexture
print(b[2])             # Prints ^""

var c = get_node_and_resource("Area2D/Sprite2D:texture:atlas:region")
print(c[0].name)        # Prints Sprite2D
print(c[1].get_class()) # Prints AtlasTexture
print(c[2])             # Prints ^":region"
```

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

### Install Android SDK components using the Android CLI

Source: https://github.com/godotengine/godot-docs/blob/master/tutorials/export/exporting_for_android.rst

Run this command in the terminal after installing the Android CLI to install the required platform tools, build tools, platforms, command-line tools, NDK, and CMake versions.

```shell
android sdk install platform-tools build-tools/36.1.0 platforms/android-36 cmdline-tools/latest ndk/29.0.14206865 cmake/3.22.1
```

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

### setup(action_map: OpenXRActionMap, interaction_profile: OpenXRInteractionProfile)

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_openxrinteractionprofileeditorbase.rst

Initializes and sets up the editor with the provided action map and interaction profile. This is used by the OpenXR action map editor when configuring interaction profile UI components.

```APIDOC
## setup

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

### Syntax
```gdscript
func setup(action_map: OpenXRActionMap, interaction_profile: OpenXRInteractionProfile) -> void
```

### Parameters
- **action_map** (`OpenXRActionMap`) - The OpenXR action map instance to be edited.
- **interaction_profile** (`OpenXRInteractionProfile`) - The OpenXR interaction profile to configure.
```

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

### Find custom element index in GDScript

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_array.rst

Use find_custom() with a callable to get the index of the first element that satisfies the condition. The example prints 2 for both cases.

```gdscript
func is_even(number):
    return number % 2 == 0

func _ready():
    print([1, 3, 4, 7].find_custom(is_even.bind())) # Prints 2

# Another example using `bind()` to pass an additional parameter:
func is_specific_number(number, expected):
    return number == expected

func _ready():
    print([1, 3, 4, 7].find_custom(is_specific_number.bind(4))) # Prints 2
```

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

### Install MinGW-w64 on Debian or Ubuntu

Source: https://github.com/godotengine/godot-docs/blob/master/engine_details/development/compiling/compiling_for_windows.rst

Installs the MinGW-w64 toolchain package on Debian and Ubuntu distributions.

```shell
apt install mingw-w64
```

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

### set_path_search_max_distance / get_path_search_max_distance

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_navigationpathqueryparameters3d.rst

Sets or gets the maximum distance a searched polygon can be from the start polygon before pathfinding cancels the search. A value of 0 or below indicates an unlimited search distance.

```APIDOC
### path_search_max_distance

```gdscript
void set_path_search_max_distance(value: float)
float get_path_search_max_distance()
```

#### Parameters
- **value** (`float`): The maximum search distance in world units. Default is `0.0`.

#### Returns
- `float`: The maximum search distance.

#### Description
The maximum distance a searched polygon can be away from the start polygon before the pathfinding cancels the search for a path to the target position polygon. When canceled, the search resets and builds a path to the closest polygon found so far. A value of `0` or below counts as unlimited.
```

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

### setup

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_drawabletexture2d.rst

Initializes the DrawableTexture with the given dimensions, format, initial fill color, and mipmap configuration.

```APIDOC
### setup

```gdscript
setup(width: int, height: int, format: DrawableFormat, color: Color = Color(1, 1, 1, 1), use_mipmaps: bool = false)
```

#### Description
Initializes the DrawableTexture to a White texture of the given `width`, `height`, and `format`.

*Note: This method is experimental and may be changed or removed in future versions.*

#### Parameters
- **width** (`int`) - Texture width in pixels.
- **height** (`int`) - Texture height in pixels.
- **format** (`DrawableFormat`) - Texture format enumeration value.
- **color** (`Color`, optional) - Initial texture color. Default: `Color(1, 1, 1, 1)`.
- **use_mipmaps** (`bool`, optional) - Whether to enable mipmaps. Default: `false`.
```

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

### audio_track_get_key_start_offset(track_idx: int, key_idx: int) -> float

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_animation.rst

Gets the start offset for a key in an audio track. Defines how many seconds into the audio stream playback should begin.

```APIDOC
### Method: audio_track_get_key_start_offset

```gdscript
float audio_track_get_key_start_offset(track_idx: int, key_idx: int)
```

#### Parameters
- **track_idx** (`int`) - The index of the audio track.
- **key_idx** (`int`) - The index of the key.

#### Returns
- `float` - The start offset in seconds.
```

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

### setup(points: PackedVector2Array, connections: PackedInt32Array)

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_polygonpathfinder.rst

Initializes the pathfinder with a set of polygon points and their corresponding connections.

```APIDOC
## setup

### Description
Configures the pathfinder with polygon vertices and edge connection data.

### Syntax
```gdscript
void setup(points: PackedVector2Array, connections: PackedInt32Array)
```

### Parameters
- **points** (`PackedVector2Array`) - The array of 2D points forming the pathfinding graph.
- **connections** (`PackedInt32Array`) - The array of index pairs defining connections between points.

### Return Value
- `void`
```

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

### Set custom starting property value with From in C#

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_propertytweener.rst

Sets a custom initial value for the PropertyTweener. In this example, the node is moved from position (100, 100) to (200, 100).

```csharp
Tween tween = GetTree().CreateTween();
tween.TweenProperty(this, "position", new Vector2(200.0f, 100.0f), 1.0f).From(new Vector2(100.0f, 100.0f));
```

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

### int raytracing_list_begin()

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_renderingdevice.rst

Begins recording a list of raytracing commands.

```APIDOC
## raytracing_list_begin

### Description
Begins recording a list of raytracing commands and returns the list ID.

### Signature
`int raytracing_list_begin()`

### Parameters
*None*

### Return Value
- `int` - The ID of the started raytracing command list.
```

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

### Install MinGW-w64 on macOS using Homebrew

Source: https://github.com/godotengine/godot-docs/blob/master/engine_details/development/compiling/compiling_for_windows.rst

Installs the MinGW-w64 cross-compiler on macOS systems using Homebrew.

```shell
brew install mingw-w64
```

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

### goto_help(topic: String)

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_scripteditor.rst

Navigates to and displays the help documentation for the given encoded topic string.

```APIDOC
## goto_help

### Description
Opens help for the given topic. The `topic` is an encoded string that controls which class, method, constant, signal, annotation, property, or theme item should be focused.

### Signature
`void goto_help(topic: String)`

### Parameters
- **topic** (`String`) - An encoded string representing the target help item. Supported formats include:
  - `class_name:class`
  - `class_method:class:method`
  - `class_constant:class:constant`
  - `class_signal:class:signal`
  - `class_annotation:class:@annotation`
  - `class_property:class:property`
  - `class_theme_item:class:item`
```

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

### Set custom starting property value with from in GDScript

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_propertytweener.rst

Sets a custom initial value for the PropertyTweener. In this example, the node is moved from position (100, 100) to (200, 100).

```gdscript
var tween = get_tree().create_tween()
tween.tween_property(self, "position", Vector2(200, 100), 1).from(Vector2(100, 100))
```

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

### Install SCons via Homebrew

Source: https://github.com/godotengine/godot-docs/blob/master/engine_details/development/compiling/compiling_for_ios.rst

Installs the SCons build system using Homebrew on macOS. Installing Homebrew also automatically fetches Xcode Command Line Tools if they are not already installed.

```shell
brew install scons
```

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

### Engine.prototype.installServiceWorker()

Source: https://github.com/godotengine/godot-docs/blob/master/tutorials/platform/web/html5_shell_classref.rst

Installs the progressive web app service worker.

```APIDOC
### Engine.prototype.installServiceWorker()

Install the progressive-web app service worker.

#### Returns
- **Promise** - The service worker registration promise.
```

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

### start(node: StringName, reset: bool = true)

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_animationnodestatemachineplayback.rst

Starts playing the specified animation node. Allows resetting the animation to the beginning if configured.

```APIDOC
## start

### Description
Starts playing the given animation.

### Signature
`start(node: StringName, reset: bool = true)`

### Parameters
- **node** (`StringName`) - The name of the animation node state to play.
- **reset** (`bool`, optional, default = `true`) - If `true`, the animation is played from the beginning.
```

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

### Manually initialize and start engine with engine.start

Source: https://github.com/godotengine/godot-docs/blob/master/tutorials/platform/web/customizing_html5_shell.rst

Provides full control over startup by manually initializing the WASM module, preloading the PCK file concurrently, and passing custom runtime arguments.

```javascript
const myWasm = 'mygame.wasm';
const myPck = 'mygame.pck';
const engine = new Engine();
Promise.all([
    // Load and init the engine
    engine.init(myWasm),
    // And the pck concurrently
    engine.preloadFile(myPck),
]).then(() => {
    // Now start the engine.
    return engine.start({ args: ['--main-pack', myPck] });
}).then(() => {
    console.log('Engine has started!');
});
```

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

### set_min_lod_override(value: int) / get_min_lod_override() -> int

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_streamedtexture2d.rst

Sets or gets the minimum LOD (mipmap level) this texture starts at when loaded. Higher values result in lower initial resolution.

```APIDOC
### Property: `min_lod_override`

#### Description
Overrides the minimum LOD (mipmap level) this texture starts at when loaded. Higher values result in lower initial resolution. A value of `0` uses the global setting (`rendering/textures/streaming/min_lod`). Values `1` to `14` correspond to LOD levels `0` to `13`.

#### Signatures
```gdscript
func set_min_lod_override(value: int) -> void
func get_min_lod_override() -> int
```

#### Parameters
- **value** (`int`) - The minimum LOD level override (range: `0` to `14`).

#### Return Value
- **int** - The current minimum LOD override value.
```

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

### String get_delimiter_start_key(delimiter_index: int)

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_codeedit.rst

Gets the start key string associated with a specific string or comment region index. Allows inspecting defined region open delimiters.

```APIDOC
### Method Signature
```gdscript
String get_delimiter_start_key(delimiter_index: int)
```

### Description
Gets the start key for a string or comment region index.

### Parameters
- **delimiter_index** (`int`): Index of the delimiter region.

### Return Value
- **String**: The delimiter start key string.
```

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

### play(from_position: float = 0.0)

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_audiostreamplayer2d.rst

Queues the audio stream to start playing on the next physics frame from a specified start position.

```APIDOC
### Method Signature
```gdscript
void play(from_position: float = 0.0)
```

### Description
Queues the audio to play on the next physics frame, from the given position `from_position`, in seconds.

### Parameters
- **from_position** (float) - Optional. The position in seconds from which playback should start. Defaults to `0.0`.
```

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

### ConcavePolygonShape2D.segments

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_concavepolygonshape2d.rst

Gets or sets the array of points that form the line segments of the ConcavePolygonShape2D. The array length must be divisible by two, where each pair represents the start and end point of a segment.

```APIDOC
### Property: segments

- **Type:** `PackedVector2Array`
- **Default Value:** `PackedVector2Array()`
- **Setter:** `set_segments(value: PackedVector2Array)`
- **Getter:** `get_segments() -> PackedVector2Array`

#### Description
The array of points that make up the `ConcavePolygonShape2D`'s line segments. The array (of length divisible by two) is naturally divided into pairs (one pair for each segment); each pair consists of the starting point of a segment and the endpoint of a segment.
```

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

### Install MinGW and build dependencies using MSYS2 pacman

Source: https://github.com/godotengine/godot-docs/blob/master/engine_details/development/compiling/compiling_for_windows.rst

Installs 32-bit and 64-bit MinGW-w64 GCC compilers, make, and python-pip on MSYS2. Run pip3 install scons in the subsystem shell afterwards.

```shell
pacman -S mingw-w64-x86_64-gcc mingw-w64-i686-gcc make python-pip
```

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

### Get Word and Line Break Boundaries with string_get_word_breaks

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_textserver.rst

Returns an array of start and end offsets for word boundaries. When chars_per_line is greater than zero, returns line break boundaries instead.

```gdscript
var ts = TextServerManager.get_primary_interface()
# Corresponds to the substrings "The", "Godot", "Engine", and "4".
print(ts.string_get_word_breaks("The Godot Engine, 4")) # Prints [0, 3, 4, 9, 10, 16, 18, 19]
# Corresponds to the substrings "The", "Godot", "Engin", and "e, 4".
print(ts.string_get_word_breaks("The Godot Engine, 4", "en", 5)) # Prints [0, 3, 4, 9, 10, 15, 15, 19]
# Corresponds to the substrings "The Godot" and "Engine, 4".
print(ts.string_get_word_breaks("The Godot Engine, 4", "en", 10)) # Prints [0, 9, 10, 19]
```

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

### Install build dependencies on Mageia

Source: https://github.com/godotengine/godot-docs/blob/master/engine_details/development/compiling/compiling_for_linuxbsd.rst

Installs SCons, C++ development tasks, and specific pkgconfig dependencies via `urpmi` on Mageia.

```shell
sudo urpmi --auto \
  scons \
  task-c++-devel \
  wayland-devel \
  "pkgconfig(alsa)" \
  "pkgconfig(glu)" \
  "pkgconfig(libpulse)" \
  "pkgconfig(udev)" \
  "pkgconfig(x11)" \
  "pkgconfig(xcursor)" \
  "pkgconfig(xinerama)" \
  "pkgconfig(xi)" \
  "pkgconfig(xrandr)"
```

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

### start(type: HashType) -> Error

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_hashingcontext.rst

Starts a new cryptographic hash computation using the specified algorithm type.

```APIDOC
## start

### Description
Starts a new hash computation of the given `type`.

### Signature
```gdscript
func start(type: HashType) -> Error
```

### Parameters
- **type** (`HashType`) - The hashing algorithm to use. Available options:
  - `HASH_MD5` (`0`): MD5 algorithm.
  - `HASH_SHA1` (`1`): SHA-1 algorithm.
  - `HASH_SHA256` (`2`): SHA-256 algorithm.

### Returns
- **Error** (`Error`) - Status code indicating whether the hash computation started successfully.
```

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

### start(one_time: bool = false)

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_skeletonik3d.rst

Starts applying the inverse kinematics effect to the skeleton. Can be set to apply continuously on every frame or only for the current frame.

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

### Description
Starts the IK solver. By default, it applies the IK effect automatically on every new frame. If `one_time` is set to `true`, the IK effect is applied only once on the current frame.

### Parameters
- **one_time** (bool) - Optional - If `true`, applies the IK effect only to the current frame instead of running every frame.

### Usage Example
```gdscript
# Apply IK effect automatically on every new frame
skeleton_ik_node.start()

# Apply IK effect only on the current frame
skeleton_ik_node.start(true)
```
```

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

### Error pck_start(pck_path: String, alignment: int = 32, key: String = "0000000000000000000000000000000000000000000000000000000000000000", encrypt_directory: bool = false)

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_pckpacker.rst

Initializes a new PCK package file for writing. Configures the output path, alignment, encryption key, and whether the directory should be encrypted.

```APIDOC
### Method Signature
`Error pck_start(pck_path: String, alignment: int = 32, key: String = "0000000000000000000000000000000000000000000000000000000000000000", encrypt_directory: bool = false)`

### Description
Starts creating a new PCK file at the specified `pck_path`.

### Parameters
- **pck_path** (`String`) - Required. The path where the package file will be created.
- **alignment** (`int`) - Optional. Byte alignment (default: `32`).
- **key** (`String`) - Optional. Encryption key string (default: 64-character zero string).
- **encrypt_directory** (`bool`) - Optional. Whether to encrypt the package directory index (default: `false`).

### Return Value
- **Error** - Returns an Error enum code indicating success (`OK`) or failure.
```

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

### Get child node by index using get_child

Source: https://github.com/godotengine/godot-docs/blob/master/classes/class_node.rst

Fetches a child node by its index. Negative indices start from the end; if no child exists at the index, returns null and generates an error.

```gdscript
# Assuming the following are children of this node, in order:
# First, Middle, Last.

var a = get_child(0).name  # a is "First"
var b = get_child(1).name  # b is "Middle"
var b = get_child(2).name  # b is "Last"
var c = get_child(-1).name # c is "Last"
```

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

### Install build dependencies on Fedora

Source: https://github.com/godotengine/godot-docs/blob/master/engine_details/development/compiling/compiling_for_linuxbsd.rst

Installs SCons, pkgconfig, C++ compiler libraries, and Wayland development packages on Fedora via `dnf`.

```shell
sudo dnf install -y \
  scons \
  pkgconfig \
  gcc-c++ \
  libstdc++-static \
  wayland-devel
```

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

### Install system library dependencies on Fedora

Source: https://github.com/godotengine/godot-docs/blob/master/engine_details/development/compiling/compiling_for_linuxbsd.rst

Installs development packages for third-party libraries on Fedora. Run this command prior to building Godot with dynamically linked system libraries.

```shell
sudo dnf install -y \
  embree-devel \
  enet-devel \
  glslang-devel \
  graphite2-devel \
  harfbuzz-devel \
  libicu-devel \
  libsquish-devel \
  libtheora-devel \
  libvorbis-devel \
  libwebp-devel \
  libzstd-devel \
  mbedtls-devel \
  miniupnpc-devel \
  SDL3-devel
```

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

### Cut Video Duration with FFmpeg

Source: https://github.com/godotengine/godot-docs/blob/master/tutorials/animation/creating_movies.rst

Trims unwanted sections from a recorded video by specifying a start timestamp and duration. In this example, footage before 12.1 seconds is discarded and 5.2 seconds of video is preserved.

```gdscript
ffmpeg -i input.avi -ss 00:00:12.10 -t 00:00:05.20 -crf 15 output.mp4
```

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

### Configure Build Paths from Alternative Working Directories

Source: https://github.com/godotengine/godot-docs/blob/master/tutorials/scripting/cpp/build_system/cmake.rst

Demonstrates equivalent ways to specify source and build directories depending on the current working directory.

```shell
# Current working directory is the godot-cpp source root.
cmake . -B build-dir

# Current working directory is an empty godot-cpp/build-dir.
cmake ../

# Current working directory is an existing build path.
cmake .
```

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

### Complete Shader Example Following Style Guidelines

Source: https://github.com/godotengine/godot-docs/blob/master/tutorials/shaders/shaders_style_guide.rst

Demonstrates a screen-space 2D canvas_item shader configured to adjust brightness, contrast, and saturation using uniforms and textureLod.

```glsl
shader_type canvas_item;
// Screen-space shader to adjust a 2D scene's brightness, contrast
// and saturation. Taken from
// https://github.com/godotengine/godot-demo-projects/blob/master/2d/screen_space_shaders/shaders/BCS.gdshader

uniform sampler2D screen_texture : hint_screen_texture, filter_linear_mipmap;
uniform float brightness = 0.8;
uniform float contrast = 1.5;
uniform float saturation = 1.8;

void fragment() {
    vec3 c = textureLod(screen_texture, SCREEN_UV, 0.0).rgb;

    c.rgb = mix(vec3(0.0), c.rgb, brightness);
    c.rgb = mix(vec3(0.5), c.rgb, contrast);
    c.rgb = mix(vec3(dot(vec3(1.0), c.rgb) * 0.33333), c.rgb, saturation);

    COLOR.rgb = c;
}
```