Godot Engine 4.6

https://docs.godotengine.org/en/4.6
Admin
Godot Engine is a free and open-source, all-inclusive game engine that provides a comprehensive set...
Tokens:4,347,465
Snippets:42,558
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### start(one_time)

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

Starts the IK solver process.

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

### Description
Starts solving the IK chain. If `one_time` is `true`, the solver calculates the bone chain transformations only once and then stops.

### Parameters
- **one_time** (`bool`, optional) - If `true`, the IK calculation occurs once instead of running every frame. Default is `false`.
```

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

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

Source: https://docs.godotengine.org/en/4.6/classes/class_skeletonmodification2d.html

Gets or sets the setup state of the modification.

```APIDOC
## get_is_setup / set_is_setup

### Description
Inspects or overrides whether this modification has been successfully initialized and setup.

### Signature
```gdscript
bool get_is_setup() const
void set_is_setup(is_setup: bool)
```

### Parameters (set_is_setup)
- **is_setup** (`bool`) - Manually defines the setup state.

### Return Value (get_is_setup)
- `bool` - `true` if setup is complete, `false` otherwise.
```

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

### start()

Source: https://docs.godotengine.org/en/4.6/classes/class_animationnodestatemachineplayback.html

Starts playing the given animation state with an option to reset to the beginning.

```APIDOC
### Method Signature
```gdscript
void start(node: StringName, reset: bool = true)
```

### Description
Starts playing the given animation. If `reset` is `true`, the animation is played from the beginning.

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

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

### setup()

Source: https://docs.godotengine.org/en/4.6/classes/class_skeletonmodificationstack2d.html

Initializes the modification stack for execution.

```APIDOC
## setup

### Description
Sets up the modification stack so it can execute. This function should be called by Skeleton2D and shouldn't be manually called unless you know what you are doing.

### Syntax
```gdscript
void setup()
```
```

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

### start(from_pos: float = 0.0) -> void

Source: https://docs.godotengine.org/en/4.6/classes/class_audiostreamplayback.html

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

```APIDOC
### start

```gdscript
void start(from_pos: float = 0.0)
```

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

#### Parameters
- `from_pos` (float, optional) - Playback start offset in seconds (default is `0.0`).
```

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

### Start game with Engine.startGame and configuration overrides

Source: https://docs.godotengine.org/en/4.6/tutorials/platform/web/customizing_html5_shell.html

Automatically loads and initializes the engine before starting the game. Returns a Promise that resolves when the game has loaded.

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

```

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

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

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

Starts applying inverse kinematics effects to the Skeleton3D bones.

```APIDOC
### Method: start

```gdscript
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) - Defaults to `false`. If `true`, applies the IK effect immediately for a single frame and resets on the next frame.
```

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

### Synchronize procedural NavigationServer3D map setup and path query

Source: https://docs.godotengine.org/en/4.6/tutorials/navigation/navigation_using_navigationservers.html

Demonstrates creating a procedural navigation map and region, assigning a navigation mesh, and awaiting a physics frame before querying a path. A deferred call ensures all scene tree nodes are ready, preventing awaits in ready callbacks from getting stuck.

```gdscript
extends Node3D

func _ready():
	# Use call deferred to make sure the entire scene tree nodes are setup
	# else await on 'physics_frame' in a _ready() might get stuck.
	custom_setup.call_deferred()

func custom_setup():

	# Create a new navigation map.
	var map: RID = NavigationServer3D.map_create()
	NavigationServer3D.map_set_up(map, Vector3.UP)
	NavigationServer3D.map_set_active(map, true)

	# Create a new navigation region and add it to the map.
	var region: RID = NavigationServer3D.region_create()
	NavigationServer3D.region_set_transform(region, Transform3D())
	NavigationServer3D.region_set_map(region, map)

	# Create a procedural navigation mesh for the region.
	var new_navigation_mesh: NavigationMesh = NavigationMesh.new()
	var vertices: PackedVector3Array = PackedVector3Array([
		Vector3(0, 0, 0),
		Vector3(9.0, 0, 0),
		Vector3(0, 0, 9.0)
	])
	new_navigation_mesh.set_vertices(vertices)
	var polygon: PackedInt32Array = PackedInt32Array([0, 1, 2])
	new_navigation_mesh.add_polygon(polygon)
	NavigationServer3D.region_set_navigation_mesh(region, new_navigation_mesh)

	# Wait for NavigationServer sync to adapt to made changes.
	await get_tree().physics_frame

	# Query the path from the navigation server.
	var start_position: Vector3 = Vector3(0.1, 0.0, 0.1)
	var target_position: Vector3 = Vector3(1.0, 0.0, 1.0)
	var optimize_path: bool = true

	var path: PackedVector3Array = NavigationServer3D.map_get_path(
		map,
		start_position,
		target_position,
		optimize_path
	)

	print("Found a path!")
	print(path)

```

```csharp
using Godot;

public partial class MyNode3D : Node3D
{
    public override void _Ready()
    {
        // Use call deferred to make sure the entire scene tree nodes are setup
        // else await on 'physics_frame' in a _Ready() might get stuck.
        CallDeferred(MethodName.CustomSetup);
    }

    private async void CustomSetup()
    {
        // Create a new navigation map.
        Rid map = NavigationServer3D.MapCreate();
        NavigationServer3D.MapSetUp(map, Vector3.Up);
        NavigationServer3D.MapSetActive(map, true);

        // Create a new navigation region and add it to the map.
        Rid region = NavigationServer3D.RegionCreate();
        NavigationServer3D.RegionSetTransform(region, Transform3D.Identity);
        NavigationServer3D.RegionSetMap(region, map);

        // Create a procedural navigation mesh for the region.
        var newNavigationMesh = new NavigationMesh()
        {
            Vertices =
            [
                new Vector3(0.0f, 0.0f, 0.0f),
                new Vector3(9.0f, 0.0f, 0.0f),
                new Vector3(0.0f, 0.0f, 9.0f),
            ],
        };
        int[] polygon = [0, 1, 2];
        newNavigationMesh.AddPolygon(polygon);
        NavigationServer3D.RegionSetNavigationMesh(region, newNavigationMesh);

        // Wait for NavigationServer sync to adapt to made changes.
        await ToSignal(GetTree(), SceneTree.SignalName.PhysicsFrame);

        // Query the path from the navigation server.
        var startPosition = new Vector3(0.1f, 0.0f, 0.1f);
        var targetPosition = new Vector3(1.0f, 0.0f, 1.0f);

        Vector3[] path = NavigationServer3D.MapGetPath(map, startPosition, targetPosition, optimize: true);

        GD.Print("Found a path!");
        GD.Print((Variant)path);
    }
}

```

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

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

Source: https://docs.godotengine.org/en/4.6/classes/class_animationnodestatemachineplayback.html

Starts playing the specified state immediately, bypassing standard transition paths.

```APIDOC
### Method: `start`

```gdscript
void start(node: StringName, reset: bool = true)
```

Starts playback directly at the given node.

#### Parameters
- **node** (`StringName`) - The name of the animation state node to play.
- **reset** (`bool`, default: `true`) - Whether to reset playback to the beginning.
```

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

### Install mold on Fedora

Source: https://docs.godotengine.org/en/4.6/engine_details/development/compiling/compiling_for_linuxbsd.html

Installs the mold linker package on Fedora systems using DNF.

```bash
sudo dnf install -y mold

```

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

### Install build dependencies on openSUSE with zypper

Source: https://docs.godotengine.org/en/4.6/engine_details/development/compiling/compiling_for_linuxbsd.html

Installs SCons, pkgconfig, X11/Wayland/Mesa/ALSA/PulseAudio/udev development headers, GCC C++, and libGLU1 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

```

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

### Example StateMachine class following GDScript style guide

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

Demonstrates recommended GDScript code structure, including class declarations, doc comments, signals, exports, variables with property setters, lifecycle callbacks, custom methods, and inner classes.

```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!")

```

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

### Manually initialize, preload assets, and start with engine.start

Source: https://docs.godotengine.org/en/4.6/tutorials/platform/web/customizing_html5_shell.html

Gives full control over the engine startup process by manually loading WASM and preloading PCK files concurrently before starting with custom arguments. Note that engine.start does not automatically preload the PCK file.

```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!');
});

```

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

### Install build dependencies on Gentoo with emerge

Source: https://docs.godotengine.org/en/4.6/engine_details/development/compiling/compiling_for_linuxbsd.html

Synchronizes Portage trees and installs SCons, X11 libraries, wayland-scanner, Mesa, GLU, ALSA, and PulseAudio.

```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 build dependencies on NetBSD with pkgin

Source: https://docs.godotengine.org/en/4.6/engine_details/development/compiling/compiling_for_linuxbsd.html

Installs pkg-config and SCons for Python 3.13 on NetBSD. Optionally install pulseaudio for audio support.

```shell
pkgin install \
  pkg-config \
  py313-scons

```

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

### Install build dependencies on FreeBSD with pkg

Source: https://docs.godotengine.org/en/4.6/engine_details/development/compiling/compiling_for_linuxbsd.html

Installs SCons, pkgconf, Xorg libraries, GLU, ALSA, PulseAudio, and Wayland on FreeBSD.

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

```

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

### Install mold on Debian and Ubuntu

Source: https://docs.godotengine.org/en/4.6/engine_details/development/compiling/compiling_for_linuxbsd.html

Installs the mold linker package on Debian-based distributions via APT.

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

```

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

### Install build dependencies on openKylin with apt and pip

Source: https://docs.godotengine.org/en/4.6/engine_details/development/compiling/compiling_for_linuxbsd.html

Installs development packages, graphics/audio libraries, and pip via apt, followed by SCons via pip.

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

```

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

### Install mold on Arch Linux

Source: https://docs.godotengine.org/en/4.6/engine_details/development/compiling/compiling_for_linuxbsd.html

Installs the mold linker package on Arch Linux using pacman.

```bash
pacman -Sy --noconfirm --needed mold

```

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

### Install Vulkan validation layers on Solus with eopkg

Source: https://docs.godotengine.org/en/4.6/engine_details/development/debugging/vulkan/vulkan_validation_layers.html

Installs the validation layers component on Solus using eopkg.

```bash
eopkg install -c vulkan-validation-layers

```

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

### from

Source: https://docs.godotengine.org/en/4.6/classes/class_physicstestmotionparameters2d.html

Sets or gets the global space starting transform for the motion test.

```APIDOC
### Property: from

- **Type:** `Transform2D`
- **Default:** `Transform2D(1, 0, 0, 1, 0, 0)`
- **Setter:** `set_from(value: Transform2D)`
- **Getter:** `get_from() -> Transform2D`

Transform in global space where the motion should start. Usually set to `Node2D.global_transform` for the current body's transform.
```

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

### RDVertexAttribute.stride

Source: https://docs.godotengine.org/en/4.6/classes/class_rdvertexattribute.html

Sets or gets the number of bytes between the starts of consecutive instances of this attribute.

```APIDOC
## Property: stride

### Type
- `int` (default: `0`)

### Methods
- `void set_stride(value: int)`
- `int get_stride()`

### Description
The number of bytes between the starts of consecutive instances of this attribute.
```

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

### setup(action_map: OpenXRActionMap, interaction_profile: OpenXRInteractionProfile) -> void

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

Initializes and configures the editor for the specified action map and interaction profile.

```APIDOC
### Method: setup

```gdscript
void setup(action_map: OpenXRActionMap, interaction_profile: OpenXRInteractionProfile)
```

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

#### Parameters
- **action_map** (`OpenXRActionMap`): The action map to associate with this editor.
- **interaction_profile** (`OpenXRInteractionProfile`): The interaction profile to configure for editing.

#### Returns
- `void`: This method does not return a value.
```

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

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

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

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

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

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

### Parameters
- **action_map** (`OpenXRActionMap`): The action map context.
- **binding_modifier** (`OpenXRBindingModifier`): The binding modifier to configure the editor for.

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

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

### GLTFAccessor.byte_offset

Source: https://docs.godotengine.org/en/4.6/classes/class_gltfaccessor.html

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

```APIDOC
### Property: byte_offset

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

#### Methods
```gdscript
void set_byte_offset(value: int)
int get_byte_offset()
```

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

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

### Install Git LFS

Source: https://docs.godotengine.org/en/4.6/tutorials/best_practices/version_control_systems.html

Initializes Git LFS support in the repository to manage large binary assets.

```shell
git lfs install

```

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

### get_frames_drawn

Source: https://docs.godotengine.org/en/4.6/classes/class_engine.html

Gets the total number of frames rendered since the engine started.

```APIDOC
### get_frames_drawn

```gdscript
int get_frames_drawn()
```

#### Description
Returns the total number of frames drawn since the engine started. On headless platforms, or if rendering is disabled with `--disable-render-loop` via command line, this method returns `0`.

#### Returns
- `int`: Total drawn frame count.
```

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

### Create a project from the command line

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

Initializes a new Godot project by creating a directory and an empty project.godot file.

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

```

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

### start(time_sec: float = -1)

Source: https://docs.godotengine.org/en/4.6/classes/class_timer.html

Starts the timer. An optional time_sec parameter can be passed to override the wait_time for this run.

```APIDOC
### start

```gdscript
void start(time_sec: float = -1)
```

Starts the timer. Sets `wait_time` to `time_sec` if `time_sec > 0`. This also resets the remaining time to `wait_time`.
```

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

### Install build dependencies on OpenBSD with pkg_add

Source: https://docs.godotengine.org/en/4.6/engine_details/development/compiling/compiling_for_linuxbsd.html

Installs Python, SCons, and LLVM packages on OpenBSD.

```shell
pkg_add \
  python \
  scons \
  llvm

```

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

### void play(from_position: float = 0.0)

Source: https://docs.godotengine.org/en/4.6/classes/class_audiostreamplayer2d.html

Queues the audio stream to start playing on the next physics frame. Accepts an optional starting position in seconds.

```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 to start playback from. Default is `0.0`.

### Returns
- `void`
```

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

### bool start()

Source: https://docs.godotengine.org/en/4.6/classes/class_godotinstance.html

Completes the startup sequence for the embedded Godot instance. Returns true if startup succeeds.

```APIDOC
### start

```gdscript
bool start()
```

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

#### Return Value
- `bool`: `true` on success, `false` otherwise.
```

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

### get_section_start_time() const -> float

Source: https://docs.godotengine.org/en/4.6/classes/class_animationplayer.html

Gets the start time of the active playback section.

```APIDOC
### Method Signature
`float get_section_start_time() const`

### Return Value
- `float` - Start time in seconds.
```

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

### fog_depth_begin

Source: https://docs.godotengine.org/en/4.6/classes/class_environment.html

Sets or gets the starting distance for depth fog from the camera in FOG_MODE_DEPTH mode.

```APIDOC
### Property: fog_depth_begin

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

#### Methods
- `void set_fog_depth_begin(value: float)`
- `float get_fog_depth_begin()`

#### Description
The fog's depth starting distance from the camera. Only available when `fog_mode` is set to `FOG_MODE_DEPTH`.
```

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

### Install Vulkan validation layers on OpenBSD with pkg_add

Source: https://docs.godotengine.org/en/4.6/engine_details/development/debugging/vulkan/vulkan_validation_layers.html

Installs the validation layers package on OpenBSD using pkg_add.

```bash
pkg_add graphics/vulkan-validation-layers

```

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

### Set up GDExtension directory structure

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

Establish the project layout containing the demo project, godot-cpp bindings, and extension source files in the top-level module folder.

```text
gdextension_cpp_example/
|
+--project/                  # game example/demo to test the extension
|
+--godot-cpp/             # C++ bindings
|
+--src/                   # source code of the extension we are building

```

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

### Install Vulkan validation layers on FreeBSD with pkg

Source: https://docs.godotengine.org/en/4.6/engine_details/development/debugging/vulkan/vulkan_validation_layers.html

Installs the validation layers port on FreeBSD using the pkg package manager.

```bash
pkg install graphics/vulkan-validation-layers

```

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

### void submit()

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

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

```APIDOC
## submit

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

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

### Parameters
None.

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

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

### RDVertexAttribute.offset

Source: https://docs.godotengine.org/en/4.6/classes/class_rdvertexattribute.html

Sets or gets the number of bytes between the start of the vertex buffer and the first instance of this attribute.

```APIDOC
## Property: offset

### Type
- `int` (default: `0`)

### Methods
- `void set_offset(value: int)`
- `int get_offset()`

### Description
The number of bytes between the start of the vertex buffer and the first instance of this attribute.
```

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

### Install Vulkan validation layers on openSUSE with zypper

Source: https://docs.godotengine.org/en/4.6/engine_details/development/debugging/vulkan/vulkan_validation_layers.html

Installs the validation layers package from openSUSE repositories using zypper.

```bash
zypper install vulkan-validationlayers

```

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

### set_sub_emitter_amount_at_start / get_sub_emitter_amount_at_start

Source: https://docs.godotengine.org/en/4.6/classes/class_particleprocessmaterial.html

Sets or gets the number of particles to spawn from the subemitter node when a particle starts.

```APIDOC
### int sub_emitter_amount_at_start

- `void set_sub_emitter_amount_at_start(value: int)`
- `int get_sub_emitter_amount_at_start()`

The amount of particles to spawn from the subemitter node when the particle starts.
```

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

### Engine.prototype.startGame(override)

Source: https://docs.godotengine.org/en/4.6/tutorials/platform/web/html5_shell_classref.html

Starts the full game instance, automatically loading the engine, initializing, and preloading the main pack file. Expects executable and mainPack properties to be configured.

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

### Description
Start the game instance using the given configuration override (if any). Initializes the instance if not initialized, loads the engine if not loaded, and preloads the main pack file.

### Parameters
- **override** (`EngineConfig`, optional) - An optional configuration override. Requires `executable` and `mainPack` properties set either initially or in the override.

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

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

### GLTFAccessor.sparse_values_byte_offset

Source: https://docs.godotengine.org/en/4.6/classes/class_gltfaccessor.html

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

```APIDOC
### Property: sparse_values_byte_offset

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

#### Methods
```gdscript
void set_sparse_values_byte_offset(value: int)
int get_sparse_values_byte_offset()
```

#### Description
The offset relative to the start of the bufferView in bytes.
```

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

### Example Godot project file system layout

Source: https://docs.godotengine.org/en/4.6/tutorials/scripting/filesystem.html

Demonstrates a typical project structure containing scenes, scripts, textures, and the required root project.godot file.

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

```

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

### Install Vulkan validation layers on Debian/Ubuntu with apt

Source: https://docs.godotengine.org/en/4.6/engine_details/development/debugging/vulkan/vulkan_validation_layers.html

Installs the validation layers package from Debian and Ubuntu repositories using apt.

```bash
apt install vulkan-validationlayers

```

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

### Install build dependencies on Solus with eopkg

Source: https://docs.godotengine.org/en/4.6/engine_details/development/compiling/compiling_for_linuxbsd.html

Installs system development components, SCons, X11 libraries, Wayland, Mesa, GLU, ALSA, and PulseAudio development packages on Solus.

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

```

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

### GLTFAccessor.sparse_indices_byte_offset

Source: https://docs.godotengine.org/en/4.6/classes/class_gltfaccessor.html

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

```APIDOC
### Property: sparse_indices_byte_offset

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

#### Methods
```gdscript
void set_sparse_indices_byte_offset(value: int)
int get_sparse_indices_byte_offset()
```

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

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

### Install Festival library and voices on Linux via APT

Source: https://docs.godotengine.org/en/4.6/engine_details/engine_api/binding_to_external_libraries.html

Installs the Festival development libraries and voice packages needed for text-to-speech on Linux systems.

```bash
sudo apt-get install festival festival-dev  # Installs festival and speech_tools libraries
apt-cache search festvox-*  # Displays list of voice packages
sudo apt-get install festvox-don festvox-rablpc16k festvox-kallpc16k festvox-kdlpc16k  # Installs voices

```

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

### AudioStreamWAV.loop_begin

Source: https://docs.godotengine.org/en/4.6/classes/class_audiostreamwav.html

Gets or sets the loop start point in number of samples relative to the beginning of the stream.

```APIDOC
## AudioStreamWAV.loop_begin

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

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

### Parameters
- **value** (`int`): The loop start sample index.

### Returns
- `int`: The loop start point in samples.
```

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

### goto_help(topic: String) -> void

Source: https://docs.godotengine.org/en/4.6/classes/class_scripteditor.html

Opens the documentation help for the specified topic encoded 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
```gdscript
void goto_help(topic: String)
```

### Parameters
- **topic** (`String`) - Encoded topic string. 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`

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

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

### Print Hello World in _ready lifecycle method

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

Demonstrates how to print a message to the console on node initialization using the _ready lifecycle method in GDScript and C#.

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

```

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

```

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

### Vector3 get_global_start_position() const / void set_global_start_position(position: Vector3)

Source: https://docs.godotengine.org/en/4.6/classes/class_navigationlink3d.html

Gets or sets the starting position of the link in global 3D coordinates.

```APIDOC
### get_global_start_position

```gdscript
Vector3 get_global_start_position() const
```

Returns the global start position of the navigation link.

---

### set_global_start_position

```gdscript
void set_global_start_position(position: Vector3)
```

Sets the starting position of the link using global coordinates.

#### Parameters
- **position** (`Vector3`): The world-space start position.
```

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

### int get_tab_offset() const

Source: https://docs.godotengine.org/en/4.6/classes/class_tabbar.html

Gets the current scroll offset index for tabs in the TabBar. Defines which tab is positioned at the start of the visible view.

```APIDOC
### Method Signature
`int get_tab_offset() const`

### Description
Returns the current scroll offset index of the tab bar.

### Parameters
None.

### Returns
- `int` - The tab offset index.
```

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

### get_is_setup() const

Source: https://docs.godotengine.org/en/4.6/classes/class_skeletonmodificationstack2d.html

Checks whether the modification stack has been set up and is ready to execute.

```APIDOC
## get_is_setup

### Description
Returns a boolean that indicates whether the modification stack is setup and can execute.

### Syntax
```gdscript
bool get_is_setup() const
```

### Return Value
- `bool` - `true` if the modification stack is setup and ready to execute, `false` otherwise.
```

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

### Install system library dependencies on Fedora

Source: https://docs.godotengine.org/en/4.6/engine_details/development/compiling/compiling_for_linuxbsd.html

Installs third-party development packages via dnf for compiling Godot with system-provided libraries.

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

```

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

### set_radial_initial_angle(value: float) / get_radial_initial_angle() -> float

Source: https://docs.godotengine.org/en/4.6/classes/class_textureprogressbar.html

Sets or gets the starting angle for radial fill modes. The angle is wrapped between 0 and 360 degrees inclusive.

```APIDOC
## set_radial_initial_angle / get_radial_initial_angle

### Description
Starting angle for the fill of texture_progress if fill_mode is FILL_CLOCKWISE, FILL_COUNTER_CLOCKWISE, or FILL_CLOCKWISE_AND_COUNTER_CLOCKWISE. When `value` increases, the texture fills towards radial_fill_degrees. Wrapped between `0` and `360` degrees.

### Signatures
- `void set_radial_initial_angle(value: float)`
- `float get_radial_initial_angle()`

### Property
- **radial_initial_angle**: `float` (default: `0.0`)

### Parameters
- **value** (`float`) - The starting angle in degrees.
```

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

### Define Specific Array Property Hints with Examples

Source: https://docs.godotengine.org/en/4.6/classes/class_%40globalscope.html

Provides concrete examples for configuring hint strings for 1D and 2D arrays containing integers, ranges, enums, file paths, multiline strings, and textures.

```gdscript
hint_string = "%d:" % [TYPE_INT] # Array of integers.
hint_string = "%d/%d:1,10,1" % [TYPE_INT, PROPERTY_HINT_RANGE] # Array of integers (in range from 1 to 10).
hint_string = "%d/%d:Zero,One,Two" % [TYPE_INT, PROPERTY_HINT_ENUM] # Array of integers (an enum).
hint_string = "%d/%d:Zero,One,Three:3,Six:6" % [TYPE_INT, PROPERTY_HINT_ENUM] # Array of integers (an enum).
hint_string = "%d/%d:*.png" % [TYPE_STRING, PROPERTY_HINT_FILE] # Array of strings (file paths).
hint_string = "%d/%d:Texture2D" % [TYPE_OBJECT, PROPERTY_HINT_RESOURCE_TYPE] # Array of textures.

hint_string = "%d:%d:" % [TYPE_ARRAY, TYPE_FLOAT] # Two-dimensional array of floats.
hint_string = "%d:%d/%d:" % [TYPE_ARRAY, TYPE_STRING, PROPERTY_HINT_MULTILINE_TEXT] # Two-dimensional array of multiline strings.
hint_string = "%d:%d/%d:-1,1,0.1" % [TYPE_ARRAY, TYPE_FLOAT, PROPERTY_HINT_RANGE] # Two-dimensional array of floats (in range from -1 to 1).
hint_string = "%d:%d/%d:Texture2D" % [TYPE_ARRAY, TYPE_OBJECT, PROPERTY_HINT_RESOURCE_TYPE] # Two-dimensional array of textures.

```

```csharp
hintString = $"{Variant.Type.Int:D}/{PropertyHint.Range:D}:1,10,1"; // Array of integers (in range from 1 to 10).
hintString = $"{Variant.Type.Int:D}/{PropertyHint.Enum:D}:Zero,One,Two"; // Array of integers (an enum).
hintString = $"{Variant.Type.Int:D}/{PropertyHint.Enum:D}:Zero,One,Three:3,Six:6"; // Array of integers (an enum).
hintString = $"{Variant.Type.String:D}/{PropertyHint.File:D}:*.png"; // Array of strings (file paths).
hintString = $"{Variant.Type.Object:D}/{PropertyHint.ResourceType:D}:Texture2D"; // Array of textures.

hintString = $"{Variant.Type.Array:D}:{Variant.Type.Float:D}:"; // Two-dimensional array of floats.
hintString = $"{Variant.Type.Array:D}:{Variant.Type.String:D}/{PropertyHint.MultilineText:D}:"; // Two-dimensional array of multiline strings.
hintString = $"{Variant.Type.Array:D}:{Variant.Type.Float:D}/{PropertyHint.Range:D}:-1,1,0.1"; // Two-dimensional array of floats (in range from -1 to 1).
hintString = $"{Variant.Type.Array:D}:{Variant.Type.Object:D}/{PropertyHint.ResourceType:D}:Texture2D"; // Two-dimensional array of textures.

```

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

### void show()

Source: https://docs.godotengine.org/en/4.6/classes/class_window.html

Makes the Window appear and enables user interactions without modifying other properties.

```APIDOC
## void show()

### Description
Makes the **Window** appear. This enables interactions with the **Window** and doesn't change any of its property other than visibility (unlike e.g. popup()).
```

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

### PackedInt32Array color_attachments

Source: https://docs.godotengine.org/en/4.6/classes/class_rdframebufferpass.html

Sets or gets the list of color attachment indices for this framebuffer pass starting from 0. Pass ATTACHMENT_UNUSED (-1) to skip an unused attachment.

```APIDOC
## Property: color_attachments

### Description
Color attachments in order starting from 0. If this attachment is not used by the shader, pass `ATTACHMENT_UNUSED` (-1) to skip. The returned array is copied and changes will not update the original property value.

### Type
`PackedInt32Array`

### Default Value
`PackedInt32Array()`

### Accessor Methods
- **Setter**: `void set_color_attachments(value: PackedInt32Array)`
- **Getter**: `PackedInt32Array get_color_attachments()`
```

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

### Install system library dependencies on Debian and Ubuntu

Source: https://docs.godotengine.org/en/4.6/engine_details/development/compiling/compiling_for_linuxbsd.html

Installs third-party development packages using apt-get to build Godot against dynamically linked system libraries.

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

```

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

### Install Godot on Windows using Scoop

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

Installs Godot on Windows using Scoop to automatically make it available in PATH. Supports standard and C# (Mono) editions.

```shell
# 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

```

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

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

Source: https://docs.godotengine.org/en/4.6/classes/class_animation.html

Gets the audio cutoff duration at the start of an audio stream key on an audio track. Measured in seconds.

```APIDOC
## audio_track_get_key_start_offset

### Signature
```gdscript
float audio_track_get_key_start_offset(track_idx: int, key_idx: int) const
```

### Description
Returns the start offset of the key identified by `key_idx`. The `track_idx` must be the index of an Audio Track. Start offset is the number of seconds cut off at the beginning of the audio stream.

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

### Return Value
- `float` - The start offset in seconds.
```
Tokens:
Raw