ILookupPlugin
Defined in: plugins/LookupPlugin.ts:9
Interface for the LookupPlugin providing fast container lookup functionality. Enables O(1) lookups of PIXI containers using hierarchical path strings.
Extends
Section titled “Extends”Properties
Section titled “Properties”app:
IApplication
Defined in: plugins/Plugin.ts:10
Inherited from
Section titled “Inherited from”id:
string
Defined in: plugins/Plugin.ts:8
Inherited from
Section titled “Inherited from”options
Section titled “options”
readonlyoptions:Partial<O>
Defined in: plugins/Plugin.ts:12
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”addSignalConnection()
Section titled “addSignalConnection()”addSignalConnection(…
args):void
Defined in: plugins/Plugin.ts:20
Parameters
Section titled “Parameters”…SignalConnection[]
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”clearSignalConnections()
Section titled “clearSignalConnections()”clearSignalConnections():
void
Defined in: plugins/Plugin.ts:22
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”IPlugin.clearSignalConnections
destroy()
Section titled “destroy()”destroy():
void
Defined in: plugins/Plugin.ts:18
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”getAllPaths()
Section titled “getAllPaths()”getAllPaths():
string[]
Defined in: plugins/LookupPlugin.ts:62
Gets all currently tracked hierarchical paths.
Returns
Section titled “Returns”string[]
Array of all path strings in the lookup system
Example
Section titled “Example”const allPaths = lookupPlugin.getAllPaths(); // ['UI/Menu', 'Game/Player', ...]getChildAtPath()
Section titled “getChildAtPath()”getChildAtPath(
path):undefined|Container<ContainerChild>
Defined in: plugins/LookupPlugin.ts:19
Retrieves a container at the specified hierarchical path.
Parameters
Section titled “Parameters”string
Slash-separated path like ‘Parent/Child/GrandChild’
Returns
Section titled “Returns”undefined | Container<ContainerChild>
The container at the path, or undefined if not found
Example
Section titled “Example”const button = lookupPlugin.getChildAtPath('UI/Menu/StartButton');getChildrenAtPaths()
Section titled “getChildrenAtPaths()”getChildrenAtPaths(…
paths):Container<ContainerChild>[]
Defined in: plugins/LookupPlugin.ts:41
Batch retrieval of containers at multiple paths.
Parameters
Section titled “Parameters”…string[]
Array of hierarchical paths to look up
Returns
Section titled “Returns”Container<ContainerChild>[]
Array of containers found at the specified paths (undefined entries filtered out)
Example
Section titled “Example”const [ui, player] = lookupPlugin.getChildrenAtPaths('UI/HUD', 'Game/Player');getPathForChild()
Section titled “getPathForChild()”getPathForChild(
container):string
Defined in: plugins/LookupPlugin.ts:30
Gets the hierarchical path for a given container.
Parameters
Section titled “Parameters”container
Section titled “container”Container
The PIXI container to get the path for
Returns
Section titled “Returns”string
The hierarchical path string, or empty string if not tracked
Example
Section titled “Example”const path = lookupPlugin.getPathForChild(myContainer); // 'Parent/Child'getPathsForChildren()
Section titled “getPathsForChildren()”getPathsForChildren(…
containers):string[]
Defined in: plugins/LookupPlugin.ts:52
Batch retrieval of paths for multiple containers.
Parameters
Section titled “Parameters”containers
Section titled “containers”…Container<ContainerChild>[]
Array of PIXI containers to get paths for
Returns
Section titled “Returns”string[]
Array of hierarchical paths for the containers
Example
Section titled “Example”const paths = lookupPlugin.getPathsForChildren(container1, container2);initialize()
Section titled “initialize()”initialize(
options,app):void|Promise<void>
Defined in: plugins/Plugin.ts:14
Parameters
Section titled “Parameters”options
Section titled “options”Partial<O>
Returns
Section titled “Returns”void | Promise<void>
Inherited from
Section titled “Inherited from”postInitialize()
Section titled “postInitialize()”postInitialize(
_app):void|Promise<void>
Defined in: plugins/Plugin.ts:16
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void | Promise<void>
Inherited from
Section titled “Inherited from”registerCoreFunctions()
Section titled “registerCoreFunctions()”registerCoreFunctions():
void
Defined in: plugins/Plugin.ts:24
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”registerCoreSignals()
Section titled “registerCoreSignals()”registerCoreSignals():
void
Defined in: plugins/Plugin.ts:26
Returns
Section titled “Returns”void