KairoRouter

import { router } from '@kairo-js/router'

router 싱글턴으로 내보내지는 클래스입니다. kairo-router의 핵심 기능인 애드온 초기화, API 호출, 이벤트 구독 등을 제공합니다.

프로퍼티

afterEvents

readonly afterEvents: KairoAfterEvents

after 이벤트를 구독합니다.

---

beforeEvents

readonly beforeEvents: KairoBeforeEvents

before 이벤트를 구독합니다.

---

currentTick

readonly currentTick: number

활성화 이후의 현재 틱 카운트 (getter).

---

systemInfo

readonly systemInfo: KairoContext

애드온 컨텍스트 정보 (getter).

---

메서드

• clearRun
• emit
• getAddonId
• getHookDeclarations
• init
• request
• runInterval
• runTimeout
• send
• waitForWorldLoad

clearRun

clearRun(runId: number): void

runInterval() 또는 runTimeout()으로 예약한 실행을 취소합니다.

매개변수	타입	설명
runId	number	취소할 실행의 ID

반환값: void

---

emit

emit(eventName: string, payload?: unknown): void

커스텀 이벤트를 발행합니다. AddonEventRegistry.on()으로 구독된 핸들러에 전달됩니다.

매개변수	타입	설명
eventName	string	발행할 이벤트의 이름
payload	unknown	이벤트에 첨부할 데이터 (선택 사항)

반환값: void

---

getAddonId

getAddonId(): string | undefined

이 애드온의 addonId를 반환합니다. 애드온이 등록되기 전에는 undefined를 반환합니다.

반환값: string | undefined

---

getHookDeclarations

getHookDeclarations(): readonly InternalHookDeclaration[]

등록된 모든 훅 선언을 반환합니다.

반환값: readonly InternalHookDeclaration[]

---

init

init(properties: AddonProperties): void

애드온을 초기화합니다.

매개변수	타입	설명
properties	AddonProperties	애드온의 설정

반환값: void

---

request

request<TReturn>(
  targetAddonId: string,
  apiName: string,
  args?: unknown,
  options?: { timeout?: number },
): Promise<TReturn | CancelledResult>

API를 호출하고 결과를 기다립니다. timeout은 틱 단위이며 기본값은 20틱입니다.

매개변수	타입	설명
targetAddonId	string	대상 애드온의 ID
apiName	string	호출할 API의 이름
args	unknown	API에 전달할 인수 (선택 사항)
options.timeout	number	타임아웃 (틱 단위, 기본값 20)

반환값: Promise<TReturn | CancelledResult>

const result = await router.request<{ balance: number }>(
  'economy-addon',
  'economy/getBalance',
  { playerId: 'abc123' },
)

if ('cancelled' in result) {
  console.warn('Request cancelled:', result.reason)
} else {
  console.log('Balance:', result.balance)
}

---

runInterval

runInterval(callback: () => void, tickInterval?: number): number

지정한 틱 간격으로 콜백을 반복 실행하도록 예약합니다. clearRun()에 전달할 runId를 반환합니다.

매개변수	타입	설명
callback	() => void	반복 실행할 함수
tickInterval	number	틱 단위 간격 (선택 사항)

반환값: number — runId

---

runTimeout

runTimeout(callback: () => void, tickDelay?: number): number

지정한 틱 지연 후 콜백을 한 번 실행하도록 예약합니다. clearRun()에 전달할 runId를 반환합니다.

매개변수	타입	설명
callback	() => void	한 번 실행할 함수
tickDelay	number	틱 단위 지연 (선택 사항)

반환값: number — runId

---

send

send(targetAddonId: string, apiName: string, args?: unknown): void

API를 fire-and-forget 방식으로 호출합니다. 응답을 기다리지 않습니다. 대상 애드온이 존재하지 않거나 비활성 상태인 경우 조용히 무시됩니다.

매개변수	타입	설명
targetAddonId	string	대상 애드온의 ID
apiName	string	호출할 API의 이름
args	unknown	API에 전달할 인수 (선택 사항)

반환값: void

router.send('economy-addon', 'onTransaction', { amount: 50 })

---

waitForWorldLoad

waitForWorldLoad(): Promise<void>

월드 로딩이 완료되면 resolve됩니다.

반환값: Promise<void>