godotjs / godotjs/javascript

generate strong types for engine signals and connections

Open
#30 4 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
C++
Stars
1.1k
Forks
80
PR merge metrics
No merged PRs in 30d

Description

is there any interest in generating strong types for connections such as:

(this is probably a poor example, I'd need to dig in and make a PR to do it correctly)

```ts
declare module godot {
interface SceneTree implements MainLoop {
//overload 1 for network_peer_connected signal
function connect(
signal: "network_peer_connected",
target: T,
method: Extract | (...args: Parameters) => void, //could use e.g. MethodOf,
binds: Tail>,
flags: number = 0,
): number;
// more overloads, one per signal for discriminating union
}
}
```

Contributor guide

Open the contributing guide

Research direction

The issue names no files, tests, or type-generation entry point and presents only a tentative example. Start by locating how Godot engine signals and connections are currently exposed, then determine the generation scope and define tests that verify the resulting TypeScript types for representative signals and connections.

Written by the indexing model from the issue text.

Assessment

Tech stack
godot, typescript
Domain
developer-experience, game-dev
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.