typed-factorio/runtime/generated/global-objects.d.ts

Featureful typescript definitions for the Factorio modding api.

// This is an auto-generated file. Do not edit directly!

/** @noSelfInFile */

import type {
  LuaBootstrap,
  LuaCommandProcessor,
  LuaGameScript,
  LuaRCON,
  LuaRemote,
  LuaRendering,
} from "factorio:runtime"

declare global {
  /**
   * The main scripting interface through which most of the API is accessed.
   * @see {@link https://lua-api.factorio.com/1.1.110/index-runtime.html Online documentation}
   */
  const game: LuaGameScript
  /**
   * Provides an interface for registering game event handlers.
   * @see {@link https://lua-api.factorio.com/1.1.110/index-runtime.html Online documentation}
   */
  const script: LuaBootstrap
  /**
   * Allows registration and use of functions to communicate between mods.
   * @see {@link https://lua-api.factorio.com/1.1.110/index-runtime.html Online documentation}
   */
  const remote: LuaRemote
  /**
   * Allows registration of custom commands for the in-game console.
   * @see {@link https://lua-api.factorio.com/1.1.110/index-runtime.html Online documentation}
   */
  const commands: LuaCommandProcessor
  //The "settings" global is declared in common/settings-global.d.ts; its runtime type is handled below.
  /**
   * Allows printing messages to the calling RCON instance, if any.
   * @see {@link https://lua-api.factorio.com/1.1.110/index-runtime.html Online documentation}
   */
  const rcon: LuaRCON
  /**
   * Allows rendering of geometric shapes, text and sprites in the game world.
   * @see {@link https://lua-api.factorio.com/1.1.110/index-runtime.html Online documentation}
   */
  const rendering: LuaRendering
}