@3dsource/types-unreal

A comprehensive collection of TypeScript type definitions for Unreal Engine integration. This library provides type safety for communication between web applications and Unreal Engine.

Overview

The types-unreal library offers:

• Type definitions for Unreal Engine commands and responses
• TypeScript interfaces for communication protocols
• Type-safe interaction with Unreal Engine from web applications
• Auto-generated types from Unreal Engine Commands API specifications

Installation

Prerequisites

• Node.js 20+

Library Installation

The package has no peer dependencies:

npm install @3dsource/types-unreal

Usage

Basic Import

Import the types you need in your TypeScript files:

import type { FLoopBackCommand, MetaBoxCommandList, MetaBoxCommandPacket, UnrealCommands } from '@3dsource/types-unreal';

Available Types

The library provides the following key type categories:

• Command Types — types for sending commands to Unreal Engine
• Response Types — types for handling responses from Unreal Engine
• Event Types — types for Unreal Engine events
• Data Structure Types — types for complex data structures used in communication

Example Usage

import { MetaBoxCommand, type FLoopBackCommand, type MetaBoxCommandPacket } from '@3dsource/types-unreal';

// Type-safe command creation
const command: FLoopBackCommand = {
  command: MetaBoxCommand.FLoopBackCommand,
};

// Send command to Unreal Engine
function sendToUnreal(packet: MetaBoxCommandPacket): void {
  // Implementation
}

sendToUnreal(command);

Updating Types

Types in this package are auto-generated from the Unreal Engine Commands API. The parser is repository tooling installed at the workspace root; consumers of @3dsource/types-unreal do not need it.

Run generation commands from the repository root:

• Production API → generates src/lib/struct.ts:

pnpm types-unreal:generate:commands:prod

• QA API → generates src/lib/struct.qa.ts:

pnpm types-unreal:generate:commands:qa

• Dev API → generates src/lib/struct.dev.ts:

pnpm types-unreal:generate:commands:dev

Only src/lib/struct.ts is exported by the package public API (src/public-api.ts). The QA/Dev structures are intended for development purposes and are not exported.

Integration with Angular

The generated packet types can be passed directly to UnrealCommunicatorService from @3dsource/angular-unreal-module:

import { inject } from '@angular/core';
import { UnrealCommunicatorService } from '@3dsource/angular-unreal-module';
import { MetaBoxCommand } from '@3dsource/types-unreal';

const unreal = inject(UnrealCommunicatorService);
unreal.sendCommandToUnreal({
  command: MetaBoxCommand.FLoopBackCommand,
});

Documentation

For detailed documentation of all available types, see the source code and comments in the type definition files.

Repository development

pnpm types-unreal:build
pnpm types-unreal:docs
pnpm types-unreal:release:patch

Generation fetches the selected remote Commands API and rewrites the matching struct*.ts file. Review that diff before building or releasing.

The release command performs verification, changes the package version and publishes the verified tarball to npm. tslib is the package's only runtime dependency.