Signals#

Signals are custom stage-wide events. Define the signal in the editor signal manager before using it; injection fails when a generated graph references a signal that does not exist in the map.

Basic Usage#

String-based usage is still supported. It is useful for no-parameter signals or code that does not need type hints:

import { g } from 'genshin-ts/runtime/core'

g.server({ id: 1073741825 }).on('whenEntityIsCreated', (_evt, f) => {
  f.sendSignal('ready')
})

g.server({ id: 1073741826 }).onSignal('ready', (_evt, f) => {
  f.printString('ready')
})

The global helper can also send a signal:

send('ready')

Using Extracted Signal Definitions#

When inject is configured, the compiler extracts signal definitions from the map into src/resources/signals.ts. Import Signal from that file to get typed parameters for both sendSignal and onSignal.

import { g } from 'genshin-ts/runtime/core'
import { Signal } from './resources/signals'

g.server({ id: 1073741825 }).on('whenEntityIsCreated', (_evt, f) => {
  f.sendSignal(Signal.signal_param_literal, 7n, 'ready', true)
})

g.server({ id: 1073741826 }).onSignal(Signal.signal_param_literal, (evt, f) => {
  const amount = evt.params.参数_1
  const label = evt.params.参数_2
  const enabled = evt.params.参数_3

  f.printString(f.dataTypeConversion(amount, 'str'))
  f.printString(label)
  f.printString(f.dataTypeConversion(enabled, 'str'))
})

Signal.xxx carries the signal name, parameter names, and parameter types. TypeScript checks the argument count and types when sending, and evt.params.<paramName> exposes typed parameters when listening.

Literal and Wired Parameters#

Signal parameters can mix literal values and wired node outputs:

g.server({ id: 1073741825 }).on('whenEntityIsCreated', (_evt, f) => {
  const amount = f.addition(2n, 3n)
  f.sendSignal(Signal.signal_param_literal, amount, 'ready', true)
})

In this example, the first parameter is a node output and the other two are literals. The compiler writes all of them to the corresponding parameter pins on the same send-signal node.

Notes#

• Signal.xxx comes from the extracted map data; after editing signals in the editor, save the map first, then rerun compilation to extract the updated signal information.
• String-based usage does not provide parameter names or parameter type hints.