LookupPlugin

High-performance container lookup plugin for PIXI.js applications.

Provides O(1) lookup of containers using hierarchical path strings by maintaining bidirectional maps between paths and containers. Automatically tracks container hierarchy changes through global Container events.

Example

// Access containers by path
const player = app.lookup.getChildAtPath('Game/Entities/Player');
const menuButton = app.lookup.getChildAtPath('UI/MainMenu/StartButton');

// Get paths for containers
const playerPath = app.lookup.getPathForChild(playerSprite); // 'Game/Entities/Player'

Remarks

Paths are built using container labels in hierarchical order
Only containers with labels are included in paths
Automatically handles container addition/removal through event listeners
Uses Map data structures for optimal performance

Extends

Plugin

Implements

ILookupPlugin

Constructors

Constructor

new LookupPlugin(id): LookupPlugin

Defined in: plugins/Plugin.ts:48

Parameters

id

string = 'Plugin'

Returns

LookupPlugin

Inherited from

Plugin.constructor

Properties

__dill_pixel_method_binding_root

__dill_pixel_method_binding_root: boolean

Defined in: plugins/Plugin.ts:39

Inherited from

Plugin.__dill_pixel_method_binding_root

id

id: string = 'Plugin'

Defined in: plugins/Plugin.ts:48

Implementation of

ILookupPlugin.id

Inherited from

Plugin.id

name

name: string = 'lookup'

Defined in: plugins/LookupPlugin.ts:89

Accessors

app

Get Signature

get app(): A

Defined in: plugins/Plugin.ts:53

Returns

A

Implementation of

ILookupPlugin.app

Inherited from

Plugin.app

coreFunctions

Get Signature

get coreFunctions(): string[]

Defined in: plugins/LookupPlugin.ts:100

Core function names exposed by this plugin for framework integration.

Returns

string[]

options

Get Signature

get options(): O

Defined in: plugins/Plugin.ts:44

Returns

O

Implementation of

ILookupPlugin.options

Inherited from

Plugin.options

Methods

addSignalConnection()

addSignalConnection(…args): void

Defined in: plugins/Plugin.ts:79

Add signal connections to the container.

Parameters

args

…SignalConnection[]

The signal connections to add.

Returns

void

Implementation of

ILookupPlugin.addSignalConnection

Inherited from

Plugin.addSignalConnection

clearSignalConnections()

clearSignalConnections(): void

Defined in: plugins/Plugin.ts:85

Returns

void

Implementation of

ILookupPlugin.clearSignalConnections

Inherited from

Plugin.clearSignalConnections

destroy()

destroy(): void

Defined in: plugins/Plugin.ts:57

Returns

void

Implementation of

ILookupPlugin.destroy

Inherited from

Plugin.destroy

getAllChildren()

getAllChildren(): Container<ContainerChild>[]

Defined in: plugins/LookupPlugin.ts:211

Gets all currently tracked containers. Useful for bulk operations or debugging.

Returns

Container<ContainerChild>[]

Array of all container references in the lookup system

getAllPaths()

getAllPaths(): string[]

Defined in: plugins/LookupPlugin.ts:201

Gets all currently tracked hierarchical paths. Useful for debugging, serialization, or introspection.

Returns

string[]

Array of all path strings in the lookup system

Example

// Debug all tracked containers
const allPaths = lookup.getAllPaths();
console.log('All tracked containers:', allPaths);

Implementation of

ILookupPlugin.getAllPaths

getChildAtPath()

getChildAtPath(path): undefined | Container<ContainerChild>

Defined in: plugins/LookupPlugin.ts:129

Fast O(1) lookup of container by hierarchical path.

Parameters

path

string

Slash-separated path like ‘Parent/Child/GrandChild’

Returns

undefined | Container<ContainerChild>

The container at the specified path, or undefined if not found

Example

// Get a specific UI element
const healthBar = lookup.getChildAtPath('UI/HUD/HealthBar');
if (healthBar) {
  // Update health display
  healthBar.visible = true;
}

Implementation of

ILookupPlugin.getChildAtPath

getChildrenAtPaths()

getChildrenAtPaths(…paths): Container<ContainerChild>[]

Defined in: plugins/LookupPlugin.ts:150

Batch retrieval of containers at multiple paths. Filters out undefined results for convenience.

Parameters

paths

…string[]

Variable number of hierarchical paths to look up

Returns

Container<ContainerChild>[]

Array of found containers (undefined entries filtered out)

Example

// Get multiple UI elements at once
const [menu, hud, inventory] = lookup.getChildrenAtPaths(
  'UI/MainMenu',
  'UI/HUD',
  'UI/Inventory'
);

Implementation of

ILookupPlugin.getChildrenAtPaths

getPathForChild()

getPathForChild(container): string

Defined in: plugins/LookupPlugin.ts:167

Get the hierarchical path for a given container.

Parameters

container

Container

The container to get the path for

Returns

string

The hierarchical path or empty string if not tracked

Example

// Get path for debugging or logging
const containerPath = lookup.getPathForChild(someSprite);
console.log(`Container is at: ${containerPath}`);

Implementation of

ILookupPlugin.getPathForChild

getPathsForChildren()

getPathsForChildren(…containers): string[]

Defined in: plugins/LookupPlugin.ts:184

Batch retrieval of paths for multiple containers.

Parameters

containers

…Container<ContainerChild>[]

Variable number of PIXI containers to get paths for

Returns

string[]

Array of hierarchical paths for the containers

Example

// Get paths for multiple containers for debugging
const paths = lookup.getPathsForChildren(sprite1, sprite2, sprite3);
console.log('Container paths:', paths);