API Reference

Complete reference for all classes, functions, interfaces, and types exported by flixel-pixi.

Core & Lifecycle

Game container, states, loop execution, context, and basic entities.

Symbol	Kind	Description
FixedStepAccumulator	Class	Converts variable display-frame durations into deterministic simulation updates. Rendering may consume alpha, but simulation must not.
FixedStepAccumulatorOptions	Interface	Configuration for a deterministic fixed-step accumulator.
FLX_ASSETS_SERVICE	Variable	Context service token for a FlxAssets instance.
FLX_ATLAS_SERVICE	Variable	Service token for the atlas registry.
FLX_AUDIO_SERVICE	Variable	Service token for the audio manager.
FLX_CAMERA_HOST_SERVICE	Variable	Service token for the active camera renderer adapter.
FLX_INPUT_SERVICE	Variable	Service token for deterministic keyboard and pointer input.
FLX_LOG_SERVICE	Variable	Service token for the log service in FlxContext.
FLX_STORAGE_SERVICE	Variable	Service token for the storage backend.
FLX_VIRTUAL_INPUT_SERVICE	Variable	Service token for controls that expose deterministic virtual input.
FLX_WATCH_SERVICE	Variable	Service token for the watch service in FlxContext.
FlxBasic	Class	Base lifecycle object shared by gameplay objects, groups, and plugins.
FlxContainer	Class	Exclusive logical group. A member can belong to only one FlxContainer; adding it elsewhere reparents it synchronously.
FlxContext	Class	Explicit owner of mutable engine state and replaceable services.
FlxGame	Class	Headless game controller and atomic state boundary.
FlxSignal	Class	Small mutation-safe signal used by state lifecycle events.
FlxState	Class	Base game state; initialize state-owned objects in create.
FlxSubState	Class	A state that can be layered over another state, including another substate.
libraryName	Variable	Current library name.
upstreamBaseline	Variable	The immutable upstream source baseline for compatibility work.
UpstreamBaseline	Interface	Metadata for the ActionScript 3 source baseline used by this port.

Game Objects & Sprites

Visual entities, sprites, groups, graphics, and emitters.

Symbol	Kind	Description
FlxBackdrop	Class	Infinitely repeating, independently scrolling texture region. The authoritative state stays renderer-neutral while the Pixi adapter uses one TilingSprite, avoiding duplicate gameplay objects and wrap seams.
FlxBackdropRenderHandle	Class	Pixi tiling-sprite projection for one link.
FlxEmitter	Class	Deterministic burst/stream emitter backed by FlxGroup recycling.
FlxEmitterRenderHandle	Class	Pixi projection of an authoritative, group-backed emitter pool.
FlxEmitterRenderOptions	Interface	Selects the renderer-only projection used by an emitter.
FlxGradient	Class	Immutable renderer-neutral local gradient descriptor.
FlxGradientStop	Interface	One RGBA color stop in a local gradient.
FlxGraphics	Class	Stable renderer-neutral vector drawing object. Commands are tessellated per camera only when the revision changes. Use a mesh for shapes whose geometry changes every frame.
FlxGraphicsFill	TypeAlias	Solid RGBA color or gradient fill.
FlxGraphicsRenderHandle	Class	Camera-local Pixi materialization of stable vector commands.
FlxGraphicsStroke	Interface	Renderer-neutral vector stroke style.
FlxGraphicsStyle	Interface	Fill/stroke pair applied to one vector primitive.
FlxObject	Class	Authoritative world-space motion and collision object.
FlxObjectInspector	Class	Optional debugger adapter for CPU-authoritative pointer selection. It never relies on Pixi hit testing and only intercepts matching debug clicks.
FlxObjectInspectorModifier	TypeAlias	Pointer modifier required to activate debugger picking.
FlxObjectInspectorOptions	Interface	Configuration for the optional pointer object inspector.
FlxParticle	Class	Sprite with lifespan and gravity-contact behavior for emitters.
FlxParticleConstructor	TypeAlias	Constructor for custom particles created and recycled by an emitter.
FlxParticleEmitter	Class	Renders a validated particle preset through Flixel-Pixi's existing emitter and camera pipeline while delegating simulation to the deterministic runtime.
FlxParticleEmitterAssetOptions	Interface	Options for resolving a preset's preloaded asset through link.
FlxParticleEmitterSource	TypeAlias	A preloaded image or named frame collection used by a particle preset.
FlxSprite	Class	Renderer-neutral Flixel sprite state with adapter-owned Pixi views.
FlxSpriteContainer	Class	Sprite composite whose backing group enforces exclusive ownership.
FlxSpriteGroup	Class	A transformable sprite composite backed by a logical FlxGroup. Members use world-space x/y while owned. add() interprets an incoming member position as local to the composite and translates it into world space; remove() converts it back to local space. Collision expands to the member AABBs rather than treating the composite as one rectangle.
FlxSpriteGroupRenderHandle	Class	Adapter-owned Pixi container branch for one logical sprite composite.
FlxSpriteRenderHandle	Class	Pixi container/sprite pair synchronized from one FlxSprite.
FlxSpriteTransform	TypeAlias	Function applied to one direct sprite-group member.
FlxStrip	Class	Textured triangle geometry with Flixel object/camera semantics. Geometry inputs are cloned. Prefer link / link for animation. If you mutate a typed-array view directly, call link once after the edits.
FlxStripGeometry	Interface	Geometry accepted by link.
FlxStripRenderHandle	Class	Camera-local Pixi materialization of renderer-neutral strip geometry.
FlxStripTopology	TypeAlias	Supported renderer-neutral triangle connectivity.
FlxTileblock	Class	Generated, immovable block filled from random sprite-sheet frames.

Animation & Atlases

Texture atlases, frame animations, and sprite controllers.

Symbol	Kind	Description
FlxAnim	Class	Named frame sequence used by FlxSprite.
FlxAnimationCallback	TypeAlias	Called whenever a sprite materializes a new animation frame.
FlxAnimationController	Class	HaxeFlixel-style animation API backed by a deterministic FlxSprite clock.
FlxAnimationFrameEvent	Interface	Payload dispatched whenever an animation materializes a new frame.
FlxAnimationPlayOptions	Interface	Options for FlxSprite.play when using the object-form overload.
FlxAtlas	Class	A loaded texture atlas with named frame lookup and ordered pickers. Obtain instances via FlxG.atlas.load(...) / FlxG.atlas.get(...).
FlxAtlasAnimationOptions	Interface	Options when registering an animation from link.
FlxAtlasAssetSource	Interface	Already-loaded asset aliases used to construct a non-owning atlas.
FlxAtlasFrame	Interface	A named region inside a shared atlas texture. index is the stable 0-based insertion order within this atlas.
FlxAtlasFrameList	TypeAlias	An ordered, immutable list of atlas frames.
FlxAtlasFrameRect	Interface	Raw axis-aligned bounding rect for one atlas sub-image. Produced by the three parsers; consumed by FlxAtlas to build textures.
FlxAtlasGridMeta	Interface	Grid-based atlas descriptor. Frames are named "0", "1", … in row-major (left-to-right, top-to-bottom) order.
FlxAtlasMeta	TypeAlias	Third argument to link. - A string ending in .json (or whose content parses as JSON) → TexturePacker/Pixi JSON. - A string ending in .xml (or any other string) → TextureAtlas XML. - A FlxAtlasGridMeta object → uniform fixed-size grid.
FlxAtlasPrefixOptions	Interface	Options for link.
FlxAtlasRegistry	Class	Registry that loads and stores named FlxAtlas instances. Access the singleton via FlxG.atlas.
FlxFrame	Class	One named animation frame backed by a lazily resolved Pixi texture view.
FlxFramesCollection	Class	Ordered frame views shared by sprite animation and atlas workflows.

Input & Controls

Keyboard, mouse, touch gestures, gamepads, virtual pads, and actions.

Symbol	Kind	Description
FlxActions	Class	Maps logical actions to keyboard, pointer, and gamepad sources. The legacy bind(action, ...keys) helper remains a keyboard-only shorthand.
FlxGamepad	Class	One stable logical controller, retained across disconnect/reconnect.
FlxGamepadButton	Enum	Standard Web Gamepad button indices.
FlxGamepadButtonLike	Interface	Minimal browser gamepad button shape used by the injectable provider.
FlxGamepadFrameRecord	Interface	Serializable authoritative gamepad state for one replay frame.
FlxGamepadLike	Interface	Browser-neutral gamepad snapshot accepted by the manager.
FlxGamepadManager	Class	Fixed-step Web Gamepad poller with reconnect-stable logical IDs.
FlxGamepadProvider	TypeAlias	Function polled exactly once at each authoritative simulation step.
FlxInputManager	Class	Owns DOM listeners and publishes their events only on simulation steps.
FlxInputManagerOptions	Interface	Browser event targets used by link.
FlxInputService	Interface	Input service consumed by the fixed-step game loop.
FlxInputText	Class	Flixel text field backed by a native browser input for selection, IME, and mobile keyboard behavior. DOM changes become authoritative on fixed updates.
FlxInputTextChangeCallback	TypeAlias	Callback published after a DOM edit is consumed by a fixed update.
FlxInputTextOptions	Interface	Optional construction settings for link.
FlxInputTextSubmitCallback	TypeAlias	Callback published after a single-line Enter submission on a fixed update.
FlxInputTextType	TypeAlias	Browser text-entry types supported by link.
FlxKeyRecord	Interface	A recorded key transition compatible with the AS3 replay shape.
FlxMouseRecord	Interface	A recorded pointer snapshot compatible with deterministic replay.
FlxSwipe	Interface	A swipe published for the simulation step in which its touch ends.
FlxSwipeDirection	TypeAlias	Cardinal direction of a recognized swipe.
FlxTouch	Class	State of one browser touch pointer.
FlxTouchEventLike	Interface	Minimal touch-pointer event accepted by the deterministic input queue.
FlxTouchFrameRecord	Interface	Serializable touch state for one simulation frame.
FlxTouchManager	Class	Deterministic multi-touch tracker with step-based swipe recognition.
FlxTouchOptions	Interface	Swipe recognition thresholds measured in logical pixels and simulation steps.
FlxVirtualActionMode	TypeAlias	Action-button layouts for a virtual pad.
FlxVirtualButton	Class	Deterministic touch/pointer button that can be bound through link.
FlxVirtualButtonOptions	Interface	Options for one texture-free virtual action or direction button.
FlxVirtualButtonRenderHandle	Class	Texture-free Pixi projection for one link.
FlxVirtualButtonState	Interface	Read-only digital state published by one virtual control.
FlxVirtualDPadMode	TypeAlias	Direction layouts compatible with the common HaxeFlixel virtual-pad modes.
FlxVirtualInput	Class	Registry used by link to resolve serializable virtual sources.
FlxVirtualPad	Class	HUD-aligned collection of deterministic direction and action buttons.
FlxVirtualPadActionMap	Interface	Optional logical action names bound by link.
FlxVirtualPadAxisMap	Interface	Optional scalar action names bound from the pad's directional pairs.
FlxVirtualPadOptions	Interface	Layout and naming options for link.
FlxVirtualStick	Class	Texture-free HUD analog stick derived from authoritative fixed-step pointer state.
FlxVirtualStickAxisMap	Interface	Maps the stick's normalized axes to scalar action names.
FlxVirtualStickOptions	Interface	Visual and response configuration for link.
FlxVirtualStickRenderHandle	Class	Pixi projection for a texture-free virtual analog stick.
FlxVirtualStickState	Interface	Read-only two-axis state published by one virtual stick.
Input	Class	Deterministic named digital-input state machine.
Keyboard	Class	AS3-compatible keyboard names backed by physical DOM code mappings.
Mouse	Class	Deterministic pointer/mouse state with camera-aware coordinates.
MouseRecord	Class	Represents a mouse input snapshot within a single replay frame.

Collision & Math

Spatial quadtree, collision separation, vectors, rects, and RNG.

Symbol	Kind	Description
clamp	Function	Restricts a number to an inclusive, ordered range.
clamp01	Function	Restricts a number to the inclusive unit range from 0 to 1.
FlxPoint	Class	Stores a two-dimensional floating-point coordinate.
FlxPointerEventLike	Interface	Minimal browser pointer event shape accepted by the deterministic queue.
FlxQuadTree	Class	Flixel-compatible broad-phase quadtree with single/dual-list operation.
FlxRandom	Class	Mutable deterministic random source compatible with FlxG.globalSeed.
FlxRect	Class	Stores a mutable axis-aligned rectangle.
FlxU	Class	Math, color, formatting, and motion helpers from the AS3 FlxU surface.
nextFlixelSeed	Function	Advances the original Flixel seeded-random recurrence.
PointLike	Interface	A mutable point shape accepted by Flash-compatibility copy helpers.
RectangleLike	Interface	A mutable rectangle shape accepted by Flash-compatibility helpers.

Audio System

WebAudio backend, spatial audio, sound groups, and volume control.

Symbol	Kind	Description
FlxAudioBackend	Interface	Replaceable audio backend. The browser implementation wraps Web Audio API; the null implementation enables headless testing.
FlxAudioControls	Class	Accessible, dependency-free DOM controls for master game audio.
FlxAudioControlsOptions	Interface	Options for link.
FlxAudioControlsPosition	TypeAlias	Corner used by the optional browser audio controls.
FlxAudioManager	Class	Owns the audio backend, the music singleton, and the sound-effects group. Registered on the FlxContext service map via FLX_AUDIO_SERVICE. FlxG resolves it to expose FlxG.music, FlxG.sounds, FlxG.play(), FlxG.playMusic(), FlxG.stream(), FlxG.volume, FlxG.mute, FlxG.pauseSounds(), and FlxG.resumeSounds().
FlxAudioService	Interface	Audio service interface consumed by FlxG and FlxGame.
FlxAudioState	Interface	Serializable master audio preferences.
FlxSound	Class	Port of org.flixel.FlxSound. Extends FlxBasic and drives playback through a FlxSoundHandle obtained from the active FlxAudioBackend. All authoritative state (volume, fade, proximity, loop, alive/exists) lives on this object; the handle is a platform-specific playback delegate.
FlxSoundAttachmentOptions	Interface	Configuration for link.
FlxSoundGroup	Class	A hierarchical volume and mute bus for link instances.
FlxSoundHandle	Interface	Low-level handle to a single playing sound, owned by a backend. FlxSound drives playback through this interface.
FlxSoundOffscreenBehavior	TypeAlias	Behavior used by an attached sound after its source leaves the viewport.
NullAudioBackend	Class	No-op audio backend for headless unit tests. Always unlocked, never suspended, all methods are inert.
WebAudioBackend	Class	Browser AudioContext implementation of FlxAudioBackend. Creates the AudioContext lazily on first play or unlockAudio(). Handles autoplay policy via a queue: sounds played before unlock are recorded and replayed on the first user gesture. By default, hiding the document suspends the context and returning resumes it.
WebAudioBackendOptions	Interface	Options for link.
WebAudioVisibilityPolicy	TypeAlias	Policy used by link when document visibility changes.

Tweens & Motion

Interpolation, easing formulas, motion curves, and tween management.

Symbol	Kind	Description
FlxAngleTween	Class	Tweens a numeric angle and optionally writes it to an object.
FlxCircularMotion	Class	Motion around one complete circle. Angles are supplied in degrees.
FlxColorTween	Class	Interpolates packed ARGB colors and optionally updates a sprite-like target.
FlxColorTweenTarget	Interface	Minimal sprite-like target accepted by color tweens.
FlxCubicMotion	Class	Motion along a cubic Bézier curve.
FlxEase	Class	HaxeFlixel-compatible easing functions.
FlxEaseFunction	TypeAlias	Function used to transform normalized tween progress.
FlxFlickerTween	Class	Flickers a lifecycle object's visibility using deterministic game time.
FlxFlickerTweenOptions	Interface	Flicker-specific options layered onto normal tween options.
FlxLinearMotion	Class	Motion along a straight line.
FlxLinearPath	Class	Constant-speed motion through a polyline.
FlxMotion	Class	Base tween for moving an optional physics object through world space.
FlxNumTween	Class	Standalone numeric tween created by FlxTween.num.
FlxPath	Class	Mutable path data followed by a FlxObject.
FlxQuadMotion	Class	Motion along a quadratic Bézier curve.
FlxQuadPath	Class	Constant-speed traversal of connected quadratic Bézier segments.
FlxShakeTween	Class	Applies deterministic random offset shake to a sprite.
FlxTween	Class	Base deterministic tween. Use the static factories for common tweens.
FlxTweenAxes	TypeAlias	Axes accepted by sprite shake tweens.
FlxTweenCallback	TypeAlias	Callback invoked with its owning tween.
FlxTweenColor	Interface	A Pixi-compatible RGB color with an explicit normalized alpha channel.
FlxTweenColorValue	TypeAlias	Numeric RGB/ARGB color or an explicit RGB-and-alpha value.
FlxTweenManager	Class	Owns and advances deterministic game-time tweens.
FlxTweenOptions	Interface	Common tween configuration.
FlxTweenType	TypeAlias	Tween completion behavior.
FlxVarTween	Class	Numeric property tween created by FlxTween.tween.

UI & Typography

Buttons, 9-slice sprites, progress bars, and high-performance text.

Symbol	Kind	Description
FlxBar	Class	Deterministic value bar with renderer-owned fill geometry. The optional parent/property binding is read once per fixed update. Rendering never regenerates textures when the value changes.
FlxBarCallback	TypeAlias	Callback invoked when a bar first reaches one of its range limits.
FlxBarFillDirection	TypeAlias	Supported FlxBar fill directions.
FlxBarParentLike	Interface	Parent object followed for position and optional scroll factor.
FlxBarRenderHandle	Class	Pixi projection for a texture-free link.
FlxBarValueProvider	TypeAlias	Numeric value provider used by a bound bar.
FlxBitmapFont	Class	Bitmap glyph font backed by a Pixi BitmapFont and registered for BitmapText.
FlxBitmapFontPageSource	TypeAlias	Texture or engine graphic supplying one AngelCode bitmap-font page.
FlxBitmapText	Class	Bitmap-font text rendered through Pixi BitmapText.
FlxBitmapTextRenderHandle	Class	Pixi BitmapText projection for one link.
FlxBmFontData	Interface	Parsed AngelCode / BMFont XML payload for Pixi BitmapFont.
FlxButton	Class	Deterministic Flixel button with optional toggle and native accessibility hooks.
FlxButtonCallback	TypeAlias	Callback invoked by a button transition.
FlxButtonRenderHandle	Class	Composite Pixi view for a button background and its optional label.
FlxButtonSound	Interface	Sound-like hook accepted without coupling the button to an audio backend.
FlxNineSliceBorderInput	Interface	Partial border insets accepted by link.
FlxNineSliceBorders	Interface	Insets for one 9-slice texture region.
FlxNineSliceButton	Class	link with a renderer-owned Pixi NineSliceSprite background.
FlxNineSliceButtonRenderHandle	Class	Composite Pixi view for a 9-slice button background and optional label.
FlxNineSliceRenderHandle	Class	Pixi 9-slice projection for one link.
FlxNineSliceSprite	Class	Resizable sprite with fixed corner and edge art via Pixi 9-slice scaling. Use link or link instead of link so border insets are tracked for rendering.
FlxText	Class	Flixel-compatible text state rendered by Pixi Text or BitmapText.
FlxTextRenderHandle	Class	Pixi text leaf wrapped by a transform-owning container.
FlxTextRenderMode	TypeAlias	Pixi text implementation chosen for a FlxText render handle.
parseBmFontXml	Function	Parse AngelCode BMFont XML into the structure expected by Pixi BitmapFont.

Tilemaps

2D grid rendering, collision indexing, and map buffers.

Symbol	Kind	Description
FlxTile	Class	Reusable collision proxy for one tile type.
FlxTileCallback	TypeAlias	Callback registered for a tile type.
FlxTileFilter	TypeAlias	Runtime constructor used to filter tile callbacks.
FlxTilemap	Class	Renderer-neutral tile data, collision, ray, and pathfinding object.
FlxTilemapBuffer	Class	Compatibility metadata for the classic camera-sized bitmap tile buffer. Pixi rendering uses link chunks instead.
FlxTilemapLoadOptions	Interface	Options for loading a numeric tile array.
FlxTilemapOverlapCallback	TypeAlias	Callback used while testing a tile proxy against an object.
FlxTilemapRenderHandle	Class	Pixi sprite chunks synchronized from one authoritative tilemap.

Assets & Loading

Asset bundles, asynchronous loading sessions, and graphics cache.

Symbol	Kind	Description
FlxAssetBackend	Interface	Injectable subset of Pixi Assets used by the engine service.
FlxAssetBundle	Interface	A named group of assets with state/scene lifetime.
FlxAssetDescriptor	Interface	Browser asset descriptor accepted by FlxAssets.
FlxAssetInitOptions	Interface	Initialization options for the Pixi asset resolver.
FlxAssetLoadError	Class	Failure enriched with the alias or URL requested by the game.
FlxAssetLoadOptions	Interface	Retry, progress, and failure policy for a foreground asset load.
FlxAssetManifest	Interface	Declarative bundle manifest.
FlxAssets	Class	Typed, explicitly asynchronous facade over PixiJS v8 Assets.
FlxGraphic	Class	A loaded or generated Pixi texture plus optional CPU-side pixel data.
FlxLoadingBundleOptions	Interface	Options for loading an asset bundle through a shared loading session.
FlxLoadingError	Class	A loading failure enriched with the stage that failed.
FlxLoadingSession	Class	Renderer-independent loading state for both browser boot and in-game screens. Progress is monotonic within one run and can be reset explicitly for retry.
FlxLoadingSnapshot	Interface	Immutable loading state delivered to DOM or Pixi/Flixel loading views.
FlxLoadingStage	TypeAlias	Lifecycle stage reported by a loading operation.
FlxLoadingState	TypeAlias	High-level state shared by boot and in-game loading presentations.
FlxLoadingTaskContext	Interface	Context provided to a custom loading task.
FlxLoadingTaskOptions	Interface	Maps a task into a section of the session's overall progress.
FlxLoadingUpdate	Interface	Partial update accepted by link.
throwIfAborted	Function	Throws a browser-standard abort error when a loading signal is cancelled.

Browser DX & Viewport

Browser application bootstrap, auto-scaling viewports, and safe areas.

Symbol	Kind	Description
BrowserGameApplication	Interface	Running browser game application handle returned by link.
BrowserGameAssetOptions	Interface	Declarative asset configuration for browser startup.
BrowserGameFrame	Interface	Timing information for one completed browser render frame.
BrowserGamePreloadContext	Interface	Loading helpers supplied to a game's custom startup preparation.
BrowserGamePreloaderOptions	Interface	Configuration for the default or a custom bootstrap-preloader view.
BrowserGameRendererBackend	TypeAlias	GPU renderer backends supported by the browser game host.
BrowserGameRendererFallback	Interface	Details of an automatic renderer recovery completed during startup.
BrowserGameRendererOptions	Interface	Renderer selection and recovery policy for browser startup.
createBrowserGame	Function	Boot Pixi + FlxGame + FlxCameraRenderer for a browser game. Asset preparation, retry, cancellation, and first-frame readiness share one loading model that can also drive later in-game loading screens.
FlxBrowserSafePadding	TypeAlias	Developer-defined logical padding inside the visible viewport.
FlxBrowserScaleMode	TypeAlias	Browser presentation modes that preserve a fixed logical game size.
FlxBrowserScaleOptions	Interface	Configuration for the browser canvas presentation policy.
FlxBrowserViewport	Class	Owns CSS-space canvas sizing while the renderer keeps a stable logical size. Pointer and accessibility projection use the resulting canvas bounds.
FlxBrowserViewportInsets	Interface	Per-edge spacing used by browser-safe layout.
FlxBrowserViewportRect	Interface	Immutable rectangle expressed in logical game coordinates.
FlxBrowserViewportSnapshot	Interface	Resolved CSS-space placement of a logical game canvas.

Debugger & Diagnostics

Interactive console, variable watch, FPS meter, and object inspector.

Symbol	Kind	Description
DebugChannel	Class	Typed pub/sub channel that connects the game loop to optional debug consumers.
DebugPathDisplay	Class	Plugin that owns path-debug registration and Pixi geometry projection.
FlxConsole	Class	Headless, allow-listed debugger command registry with bounded history. It never evaluates arbitrary JavaScript; consumers decide which operations are safe by explicitly registering commands.
FlxConsoleCommand	Interface	A command explicitly exposed to the debugger console.
FlxConsoleCommandContext	Interface	Context passed to a registered debugger console command.
FlxConsoleOptions	Interface	Configuration for the headless debugger console.
FlxConsoleResult	Interface	Normalized result returned by every debugger console execution.
FlxDebugger	Class	DOM overlay debugger with Console, Log, Watch, Perf, VCR, and Vis panels. Mounts as a fixed bottom bar. Fully keyboard/screen-reader accessible.
FlxDebuggerDiagnosticSnapshot	Interface	Versioned JSON-safe debugger export.
FlxDebuggerOptions	Interface
FlxDebuggerVCRCallbacks	Interface	Callbacks the debugger needs to invoke VCR actions on the game.
FlxDiagnostics	Class	Bounded, renderer-neutral runtime diagnostics collector.
FlxDiagnosticsOptions	Interface	Bounded diagnostics collector configuration.
FlxFpsDisplay	Class	Small dependency-free DOM display for render FPS and frame pacing.
FlxFpsDisplayOptions	Interface	Options for link.
FlxFpsDisplayPosition	TypeAlias	Screen corner used by the lightweight FPS overlay.
FlxFpsDisplayTheme	Interface	Theme tokens for the lightweight FPS overlay.
FlxLog	Class	Ring-buffer log that keeps the last MAX_ENTRIES messages. Mirrors AS3 FlxG.log.
FlxPreloader	Class	Accessible, customizable HTML loading view. Dismissed automatically when a ready snapshot is received.
FlxPreloaderOptions	Interface	Options for the default DOM preloader.
FlxPreloaderTheme	Interface	Theme tokens used by the default DOM preloader.
FlxPreloaderView	Interface	Replaceable presentation driven by a shared loading session.
FlxPreloaderViewContext	Interface	Context passed to a custom bootstrap-preloader factory.
FlxPreloaderViewFactory	TypeAlias	Creates a custom DOM-first bootstrap preloader.
FlxWatch	Class	Live field watcher. Mirrors AS3 FlxG.watch.
FlxWatchDefinition	Interface	Getter-backed tracked value definition.
FlxWatchEditor	Interface	Explicit mutation contract for an editable tracked value.
FlxWatchMutationGuard	TypeAlias	Guard result: true permits mutation; false or a message rejects it.
FlxWatchMutationResult	Interface	Result of an attempted debugger watch mutation.
LogEntry	Interface	A single log entry stored in the ring buffer.
PreloaderState	TypeAlias	State of the preloader.
TimerManager	Class	Plugin that advances deterministic game-time timers.
WatchEntry	Interface	A single watched field entry.
WatchSnapshot	Interface	A resolved snapshot value.

Storage & Replay

Persistent save data, deterministic recording, and AS3 replay compatibility.

Symbol	Kind	Description
CodePair	Interface	Serializable key input state for a single replay frame.
convertAS3ReplayToFlxReplay	Function	Converts legacy AS3 Flixel text replay data into a modern FlxReplay instance.
convertFlxReplayToAS3Text	Function	Converts a modern FlxReplay instance into legacy AS3 Flixel plain-text format.
FlxReplay	Class	Manages deterministic input recording, playback, and checksum verification.
FlxSave	Class	Port of org.flixel.FlxSave. Provides namespaced, versioned save slots backed by a replaceable FlxStorageBackend. The default backend is provided by the FlxContext service map (typically LocalStorageBackend).
FlxSaveBindOptions	Interface	Options for FlxSave.bind().
FlxSaveMigration	TypeAlias	Callback for migrating save data between schema versions.
FlxSaveResult	TypeAlias	Result of a FlxSave.flush() operation. On failure, includes an error category and human-readable message.
FlxStorageBackend	Interface	Replaceable storage backend. The default implementation uses localStorage; an optional IndexedDB adapter is available for larger data. A NullStorageBackend enables headless testing.
FlxVCR	Interface	VCR control interface for recording, playback, and step controls.
FrameRecord	Class	Represents recorded inputs and state checksum for a single simulation frame.
FrameRecordData	Interface	Raw JSON representation of a FrameRecord.
IndexedDBBackend	Class	Optional IndexedDB-backed storage adapter. Reads from a cache populated while opening. Writes and erases must use the async FlxSave methods so their results represent transaction completion. Usage: ts<br>const db = await IndexedDBBackend.open('my-game-saves');<br>const save = new FlxSave();<br>save.bind('slot1', { backend: db });<br>await save.flushAsync();<br><br>
LocalStorageBackend	Class	localStorage-backed storage implementation. Keys are namespaced as flixel:{name} to avoid collisions with other web applications. Quota failures are detected via DOMException and surfaced through the FlxSaveResult type. Malformed stored JSON returns null and logs a console warning rather than throwing.
NullStorageBackend	Class	In-memory storage backend for headless unit tests. Data lives only for the lifetime of this instance.

Rendering & Filters

PixiJS render handles, post-processing filters, shaders, and camera views.

Symbol	Kind	Description
collectRenderables	Function	Collect displayables under a Flixel basic (state/group tree).
FlxBlurFilter	Class	Renderer-neutral blur effect descriptor.
FlxBlurFilterOptions	Interface	Options for link.
FlxCamera	Class	Renderer-neutral Flixel camera state. Pixi render targets and display objects are owned by FlxCameraRenderer; this class owns only deterministic simulation and coordinate transforms.
FlxCameraEffectCallback	TypeAlias	Callback invoked after a deterministic camera effect completes.
FlxCameraFollowStyle	TypeAlias	Camera follow presets retained from the AS3 API.
FlxCameraHost	Interface	Adapter hook used to mirror logical camera lifecycle into a renderer.
FlxCameraLike	Interface	Camera fields needed by headless screen-coordinate helpers.
FlxCameraObjectPick	Interface	CPU-authoritative result of debugger object picking.
FlxCameraRenderer	Class	Pixi render-texture adapter for one logical world and any number of cameras.
FlxCameraShakeDirection	TypeAlias	Camera shake direction presets retained from the AS3 API.
FlxCameraView	Interface	Pixi resources owned for one logical camera.
FlxColorMatrixFilter	Class	Renderer-neutral 4×5 color-matrix effect descriptor.
FlxDisplacementFilter	Class	Texture-backed displacement effect with revisioned runtime parameters.
FlxDisplacementFilterOptions	Interface	Options for link.
FlxFilter	TypeAlias	Built-in renderer-neutral sprite effects.
FlxRenderable	TypeAlias	Sprite, tilemap, or emitter that can be registered with link.
FlxRenderHandle	Interface	Adapter-owned Pixi view synchronized from an authoritative Flixel object.
FlxShaderFilter	Class	Renderer-neutral custom filter descriptor with typed runtime uniforms.
FlxShaderFilterOptions	Interface	Options for link.
FlxShaderUniformDefinition	Interface	Initial type and value for one shader uniform.
FlxShaderUniforms	Class	Mutable, type-checked values shared by every projection of a shader filter.
FlxShaderUniformSchema	TypeAlias	Named shader-uniform schema inferred by link.
FlxShaderUniformType	TypeAlias	Uniform data types supported by link.
FlxShaderUniformValue	TypeAlias	Type-safe JavaScript value for a shader uniform type.
makeGraphicPixels	Function	Creates a packed 0xRRGGBBAA buffer filled with one color.
PixelBuffer	Interface	A CPU-side packed RGBA pixel buffer used by generated graphics.
syncWorldToRenderer	Function	Synchronize renderer entries with the active state's renderables. Adds missing objects; removes entries for objects no longer in the tree. Does not clear and rebuild all handles. Clears link when a context is attached.

Types & Utilities

Data types, helper interfaces, and utility declarations.

Symbol	Kind	Description
CreateBrowserGameOptions	Interface	Options for link.
DebugEvents	Interface	Payload shapes for each debug event type.
DebugEventType	TypeAlias
FixedStepAdvanceResult	Interface	Result of advancing a link.
FlxActionBindingsData	Interface	Versioned binding schema returned by link.
FlxActionGamepadAxisSource	Interface	One gamepad axis exposed as a scalar analog source.
FlxActionGamepadButtonAxisSource	Interface	Pair of gamepad buttons exposed as a scalar analog source.
FlxActionGamepadButtonSource	Interface	Gamepad button used as a digital action source.
FlxActionGamepadTarget	TypeAlias	Selects one logical gamepad, the first active pad, or every connected pad.
FlxActionKeyboardAxisSource	Interface	Pair of keyboard keys exposed as a scalar analog source.
FlxActionKeyboardSource	Interface	Keyboard key used as a digital action source.
FlxActionMouseSource	Interface	Pointer button used as a digital action source.
FlxActionRebindOptions	Interface	Controls whether a newly assigned source is removed from other actions.
FlxActionSource	TypeAlias	Serializable digital or scalar-analog source for one named action.
FlxActionVirtualButtonAxisSource	Interface	Pair of virtual buttons exposed as a scalar analog source.
FlxActionVirtualButtonSource	Interface	One registered virtual control exposed as a digital action source.
FlxActionVirtualStickAxisSource	Interface	One normalized axis from a registered virtual stick.
FlxActionWheelSource	Interface	Mouse-wheel direction used as a one-step digital action source.
FlxAsyncStorageBackend	Interface	Storage backend whose durable writes must be awaited.
FlxBasicConstructor	TypeAlias	Constructor accepted by link.
FlxDiagnosticSample	Interface	One bounded runtime diagnostic sample.
FlxDiagnosticSnapshot	Interface	Versioned, serializable performance snapshot.
FlxDiagnosticSummary	Interface	Aggregate metrics included with diagnostic exports.
FlxDisplacementPoint	Interface	Point-like input used by displacement scale and texture offset.
FlxFpsMetrics	Interface	Metrics from the most recently completed FPS sampling window.
FlxG	Class	Static compatibility facade delegating to one active link.
FlxGridFramesOptions	Interface	Options for creating a uniform grid frame collection.
FlxGroup	Class	Mutation-safe collection that owns member lifecycle traversal.
FlxKeyboardEventLike	Interface	Minimal browser keyboard event shape accepted by the deterministic queue.
FlxLinearGradientOptions	Interface	Local normalized options for a linear gradient.
FlxOverlapCallback	TypeAlias	Called after an accepted overlap pair is found.
FlxPixiTextNode	TypeAlias	Pixi leaf used by a FlxTextRenderHandle.
FlxPluginConstructor	TypeAlias	Constructor used by the plugin compatibility facade.
FlxProcessCallback	TypeAlias	Decides whether an overlap pair is accepted.
FlxRadialGradientOptions	Interface	Local normalized options for a radial gradient.
FlxShaderWebGLProgram	Interface	WebGL fragment program for a custom filter.
FlxShaderWebGPUProgram	Interface	Combined WebGPU program for a custom filter.
FlxSignalListener	TypeAlias	Listener registered with link.
FlxStateConstructor	TypeAlias	Zero-argument state constructor used by reset and startup.
FlxStateRuntime	Interface	Runtime bridge installed by a FlxGame into its context.
FlxSubStateCallback	TypeAlias	Lifecycle callback invoked when a substate opens or closes.
FlxTimer	Class	Deterministic timer advanced by the context's TimerManager.
FlxTimerCallback	TypeAlias	Callback fired for each completed timer loop.
isParticlePresetValidationError	Function	Return whether an error came from particle preset parsing.
JsonObject	Interface
JsonPrimitive	TypeAlias
JsonValue	TypeAlias
parseParticlePreset	Function	Parse an unknown value or throw a link.
ParticleAppearanceDefinition	Interface
ParticleBlendMode	TypeAlias	Portable blend modes supported by particle presets.
ParticleColorStop	Interface
ParticleCurve	Interface
ParticleCurveInterpolation	TypeAlias
ParticleCurveStop	Interface
ParticleEmissionDefinition	TypeAlias
ParticleEmitterDiagnostics	Interface
ParticleEmitterState	TypeAlias
ParticleFrameSelection	TypeAlias
ParticleMotionDefinition	Interface
ParticleNumberRange	Interface
ParticlePreset	TypeAlias
ParticlePresetV1	Interface
ParticlePresetValidationError	Class	Error thrown when a particle preset cannot be parsed.
ParticlePresetValidationResult	TypeAlias
ParticleRotationDefinition	Interface
ParticleSpace	TypeAlias
ParticleSpawnDefinition	TypeAlias
ParticleState	Interface
ParticleTextureDefinition	Interface
ParticleVectorRange	Interface
ReplayFileFormat	Interface	Structure of a serialized FlxReplay JSON file.
serializeParticlePreset	Function	Serialize a validated particle preset with deterministic key ordering.
SerializeParticlePresetOptions	Interface
validateParticlePreset	Function	Validate an unknown value as a version 1 particle preset.
ValidationIssue	Interface
ValidationIssueCode	TypeAlias
ValidationResult	TypeAlias