widgets.create
Creates a UUserWidget from a generated Widget Blueprint class.
Syntax
ue.widgets.create(class_or_path: UObjectProxy | string, options?: table) -> UObjectProxy?, string?Parameters
| Parameter | Type | Description |
|---|---|---|
class_or_path | `UObjectProxy | string` |
options.player | integer? | Zero-based local-player index. Default: 0. |
options.owning_player | UObjectProxy? | PlayerController proxy; overrides player. |
options.add_to_viewport | boolean? | Add immediately. Default: true. |
options.z_order | integer? | Viewport Z-order. Default: 0. |
Returns
| Type | Description |
|---|---|
UObjectProxy | Created UUserWidget. |
nil, string | Class, player, creation, or viewport operation failed. |
Example
local screen = assert(ue.widgets.create(
"/Game/UI/WBP_LuaCamera.WBP_LuaCamera_C",
{ player = 0, z_order = 100 }
))