BlzGetFrameByName

Parameters

name	string
createContext	integer

comment

Returns a frame from the internal frame storage by its name and creation context. The second argument is not a child or inventory-slot index. It must match the createContext used when the frame or its named parent tree was created. Built-in frames usually use context 0.

Named children created from an FDF template use the same creation context as their root frame. Reusing the same (name, createContext) pair can overwrite the stored lookup.

Example: BlzGetFrameByName("SimpleHeroLevelBar", 0).

note

Inventory and command slots use distinct names such as "InventoryButton_0" or "CommandButton_0"; the numeric suffix is part of the name, not the createContext.

note

Refer to fdf files for frame names.

note

The first time a frame enters the map script it takes a handle ID. Never acquire this handle for the first time inside a GetLocalPlayer() block. Acquire and cache it for all players first.

patch

1.31.0.11889

Source

common.j (raise an issue to discuss on Github or submit a PR)

return type

framehandle

Source code

native BlzGetFrameByName                           takes string name, integer createContext returns framehandle