主题
PlayerGui
概览
| 字段 | 值 |
|---|---|
| Kind | Data · 数据 Data |
| Realm | common |
PlayerGui 是当前玩家的客户端 UI 入口,提供 EUIManager 和 ScreenGui 两个常用 UI 控制对象。
适用场景
在客户端脚本中,通过 Players.LocalPlayer.PlayerGui 获取当前玩家的 UI 入口,再访问 EuiManager 查找或管理 EUI 节点,或通过 ScreenGui 显示飘字、结算面板等界面效果。
使用要点
PlayerGui 不可直接构造,应从 Players.LocalPlayer.PlayerGui 获取实例;再通过公开的 EuiManager 和 ScreenGui 属性进入对应 UI API。
注意事项
PlayerGui 不可自行构造,禁止使用 PlayerGui.New 或直接调用 PlayerGui 创建实例,只能借助玩家对象上的公开属性获取。EuiManager 与 ScreenGui 属于界面容器引用,需在玩家界面加载完成后再访问,未就绪时读取可能得到无效结果。两个属性的界面职责不同,EUI 节点相关操作与屏幕面板控制不要混用同一个对象。
代码示例
获取当前玩家 UI 入口
lua
-- @runtime client
local Players = game:GetService('Players')
local localPlayer = Players.LocalPlayer
if localPlayer == nil then return end
local playerGui = localPlayer.PlayerGui
local euiManager = playerGui.EuiManager
local screenGui = playerGui.ScreenGui
print('UI 管理器:', euiManager)
screenGui:ShowTips('欢迎回来', 1.0)属性 (2)
| Name | 类型 | 默认值 | 说明 |
|---|---|---|---|
EuiManager | EUIManager | - | PlayerGui 上的只读属性,返回当前玩家的 EUI 管理器实例,类型为 EUIManager。该实例是客户端访问 EUI 体系(根节点、设备分辨率、按类型查询节点、创建 UI 模块节点与场景节点等)的入口。PlayerGui 本身不可直接构造,只能在获取到玩家对象后读取其 PlayerGui 属性,再从中取用本属性。 |
ScreenGui | ScreenGui | - | PlayerGui 上的只读属性,返回当前玩家的屏幕 UI 实例,类型为 ScreenGui。该实例集中提供面向玩家的界面控制能力,包括飘字提示、游戏结果与游戏结束面板、观战控件显隐、个人积分面板与团队积分面板的显示/更新/隐藏,以及截图与模拟点击、滑动等操作。 |
