Godot Engine 3.6

https://docs.godotengine.org/en/3.6
Admin
Godot Engine is a free, open-source game engine that supports 2D and 3D game development with...
Tokens:3,260,229
Snippets:60,897
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### setup

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

Initializes the pathfinder with points and connections.

```APIDOC
## void setup(PoolVector2Array points, PoolIntArray connections)

### Description
Initializes the internal structure of the pathfinder using the provided points and connection indices.
```

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

### start(float time_sec=-1)

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

Starts the timer. If time_sec is greater than 0, it updates the wait_time before starting.

```APIDOC
## void start(float time_sec=-1)

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

### Parameters
- **time_sec** (float) - Optional - The duration in seconds to set the timer to.
```

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

### start

Source: https://docs.godotengine.org/en/3.6/classes/class_tween.html

Starts the tween.

```APIDOC
## bool start()

### Description
Starts the tween. You can define animations both before and after this.
```

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

### Create a new project

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

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

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

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

### start

Source: https://docs.godotengine.org/en/3.6/classes/class_tween.html

Starts the Tween animation.

```APIDOC
## start()

### Description
Starts the Tween animation. Returns false if the operation cannot be completed.
```

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

### Create and Save ConfigFile

Source: https://docs.godotengine.org/en/3.6/classes/class_configfile.html

Demonstrates initializing a ConfigFile, setting values, and saving to the filesystem.

```gdscript
# Create new ConfigFile object.
var config = ConfigFile.new()

# Store some values.
config.set_value("Player1", "player_name", "Steve")
config.set_value("Player1", "best_score", 10)
config.set_value("Player2", "player_name", "V3geta")
config.set_value("Player2", "best_score", 9001)

# Save it to a file (overwrite if already exists).
config.save("user://scores.cfg")

```

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

### Install dependencies via Scoop

Source: https://docs.godotengine.org/en/3.6/development/compiling/compiling_for_windows.html

Use this command to install GCC, Python, SCons, and make if you have the Scoop package manager installed.

```bash
scoop install gcc python scons make
```

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

### Library Initialization Entry Point

Source: https://docs.godotengine.org/en/3.6/tutorials/scripting/gdnative/gdnative_c_example.html

Initializes the library and retrieves API pointers from the provided options struct.

```c
void GDN_EXPORT godot_gdnative_init(godot_gdnative_init_options *p_options) {
    api = p_options->api_struct;

    // Now find our extensions.
    for (int i = 0; i < api->num_extensions; i++) {
        switch (api->extensions[i]->type) {
            case GDNATIVE_EXT_NATIVESCRIPT: {
                nativescript_api = (godot_gdnative_ext_nativescript_api_struct *)api->extensions[i];
            }; break;
            default: break;
        }
    }
}
```

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

### pck_start

Source: https://docs.godotengine.org/en/3.6/classes/class_pckpacker.html

Initializes a new PCK package file.

```APIDOC
## Error pck_start(String pck_name, int alignment=0)

### Description
Creates a new PCK file with the specified name. The .pck extension should be included in the name if desired.

### Parameters
- **pck_name** (String) - Required - The name of the PCK file to create.
- **alignment** (int) - Optional - The alignment for the package.
```

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

### start

Source: https://docs.godotengine.org/en/3.6/classes/class_skeletonik.html

Starts the inverse kinematics processing.

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

### Description
Starts applying IK effects on each frame. If one_time is true, the effect takes place immediately and resets on the next frame.

### Parameters
- **one_time** (bool) - Optional - If true, applies the effect immediately for a single frame.
```

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

### Implement a UDP server

Source: https://docs.godotengine.org/en/3.6/classes/class_udpserver.html

Example of setting up a server that listens on a port and processes incoming packets from peers.

```GDScript
# server.gd
extends Node

var server := UDPServer.new()
var peers = []

func _ready():
	server.listen(4242)

func _process(delta):
	server.poll() # Important!
	if server.is_connection_available():
		var peer : PacketPeerUDP = server.take_connection()
		var pkt = peer.get_packet()
		print("Accepted peer: %s:%s" % [peer.get_packet_ip(), peer.get_packet_port()])
		print("Received data: %s" % [pkt.get_string_from_utf8()])
		# Reply so it knows we received the message.
		peer.put_packet(pkt)
		# Keep a reference so we can keep contacting the remote peer.
		peers.append(peer)

	for i in range(0, peers.size()):
		pass # Do something with the connected peers.
```

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

### start

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

Starts playing the specified animation node.

```APIDOC
### Method
void start(String node)
```

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

### Engine.prototype.startGame(override)

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

Starts the game instance.

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

### Description
Start the game instance using the given configuration override. Expects executable and mainPack properties to be set.

### Parameters
- **override** (EngineConfig) - Optional - An optional configuration override.

### Returns
- **Promise** - Resolves once the game started.
```

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

### Install MinGW-w64 on macOS

Source: https://docs.godotengine.org/en/3.6/development/compiling/compiling_for_windows.html

Install the MinGW-w64 toolchain using Homebrew.

```bash
brew install mingw-w64
```

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

### Create and initialize nodes via scripts

Source: https://docs.godotengine.org/en/3.6/tutorials/best_practices/scenes_versus_scripts.html

Demonstrates the procedural approach to creating a node, assigning a script, and setting ownership.

```GDScript
# Main.gd
extends Node

func _init():
	var child = Node.new()
	child.name = "Child"
	child.script = preload("Child.gd")
	child.owner = self
	add_child(child)
```

```C#
using System;
using Godot;

public class Main : Resource
{
    public Node Child { get; set; }

    public Main()
    {
        Child = new Node();
        Child.Name = "Child";
        Child.Script = ResourceLoader.Load<Script>("child.gd");
        Child.Owner = this;
        AddChild(Child);
    }
}
```

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

### Install dependencies for Gentoo

Source: https://docs.godotengine.org/en/3.6/development/compiling/compiling_for_x11.html

Use emerge to install required packages.

```bash
emerge -an dev-util/scons x11-libs/libX11 x11-libs/libXcursor x11-libs/libXinerama x11-libs/libXi \
    media-libs/mesa media-libs/glu media-libs/alsa-lib media-sound/pulseaudio dev-lang/yasm
```

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

### listen

Source: https://docs.godotengine.org/en/3.6/classes/class_websocketserver.html

Starts the WebSocket server.

```APIDOC
## listen(int port, PoolStringArray protocols=PoolStringArray(), bool gd_mp_api=false)

### Description
Starts listening on the given port.

### Parameters
- **port** (int) - Required - The port to listen on.
- **protocols** (PoolStringArray) - Optional - Desired subprotocols.
- **gd_mp_api** (bool) - Optional - Whether to behave as a network peer for the MultiplayerAPI.
```

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

### Example Output

Source: https://docs.godotengine.org/en/3.6/tutorials/networking/webrtc.html

Expected console output after running the chat example.

```text
/root/main/@@3 received: Hi from /root/main/@@2
/root/main/@@2 received: Hi from /root/main/@@3
```
Tokens:
Raw