跳转到内容

34. UI、提示和反馈

约 45 分钟 内容:基础 动手章

世界中的文字承担不同用途:入口说明、物体操作提示、状态显示和详细规则。先确定信息的用途、阅读位置和交互方式,再配置组件。

可由 VRChat 指针交互的 Unity UI 使用 World Space Canvas,并按 SDK 要求配置 VRC_UIShape。纯文字牌不需要为了显示文字额外添加交互逻辑。

  1. 创建 UI → Canvas,将 Render Mode 改成 World Space。
  2. 将 Rect Transform 的 Width / Height 设为 400 / 200,Scale 设为 0.005, 0.005, 0.005。
  3. 将 Canvas 放到预定阅读位置,并朝向观察者。
  4. 添加 UI → Text - TextMeshPro。首次使用时导入 TMP Essentials。
  5. 如果含有按钮或滑块,按 UI Events 配置 VRC_UIShape、Graphic Raycaster 和事件接收行为,再检查 Collider 是否挡住指针。

Width × Scale 决定世界中的实际宽度。本例是 400 × 0.005 = 2 米。父物体缩放也会影响最终尺寸;Rect Transform 数值不是固定的屏幕像素。

示例宽度Width × Scale
0.5 米200 × 0.0025
1.0 米400 × 0.0025
2.0 米400 × 0.005

移动端的 screen-space UI 是另一种布局需求,不能把 World Space 指针配置直接套过去,也不能据此声称 VRChat 完全禁用所有 Screen Space UI。

TMP 使用字体资产与图集绘制文字。默认 LiberationSans SDF 不包含所有中文字符。固定文本有两种可选配置。

  1. 从字体发布者获取允许用于此项目的字体,并保留许可证。思源黑体、思源宋体使用 SIL Open Font License;具体以下载包为准。
  2. 把字体文件放进 Assets/Fonts/。
  3. 打开 Window → TextMeshPro → Font Asset Creator。
  4. Source Font File 指向字体;Character Set 选择 Custom Characters。
  5. 将世界实际使用的文字、数字和标点整理成字符集。
  6. 从合适的 Atlas Resolution 开始,例如 2048 × 2048;生成后检查遗漏字符和清晰度。
  7. 保存 Font Asset,并拖到 TMP 文本的 Font Asset 字段。

一份固定文字牌可先用 Sampling Point Size = Auto Sizing、Padding = 5、Render Mode = SDFAA 生成。这里的 Padding 是试排起点;描边或字形被裁切时需要调整并重生成,不能只放大场景中的 Font Size。Auto Sizing 是生成图集时的采样字号,与文本组件运行时的 Auto Size 是两个设置。

例如,牌子实际内容为「月光小屋 / Moonlight Room」「展开规则 / Rules」「返回 / Back」时,把这些完整文字连同空格、斜线和实际使用的数字、标点贴入 Custom Character List。点 Generate Font Atlas,检查生成报告中的缺字,再用 Save 保存到 Assets/Fonts/Resources/ 下。将字体资产拖入 TMP 后,先逐行检查这三段文字,再在客户端从规定阅读距离复测。新增规则文字时,更新字符集并重新生成,不能只检查原来的标题。

字体包大小由图集分辨率、数量、格式和源字体等因素决定,不由「中文字符数」直接确定一个固定 MB 数。不要为了未使用的字符无条件生成大图集。

官方 TextMesh Pro 文档 提供客户端 fallback 配置:在 Project Settings → TextMeshPro Settings 中移除全局 Fallback Font Assets 条目,让 VRChat 提供其内置后备字体。

这种配置下,编辑器里的缺字方框可能在客户端正常显示。仍需测试目标语言和特殊字符;不能把「几乎全部 Unicode」理解成所有字体样式、组合字符都保证显示一致。玩家姓名等不可预先穷举的文本尤其需要 fallback 测试。

字体覆盖与翻译是两个问题:能显示中文,不代表不懂中文的玩家理解它。

在固定 Canvas 缩放下,提高 Font Size 会增大文字。实际可读性还受字体、行距、对比度、观看角度和头显分辨率影响。

对 Scale = 0.005 的测试牌,可比较 Font Size = 40 / 60 / 80,分别站在 1 / 2 / 4 米处阅读。选择能满足目标阅读距离的尺寸,不把某个字号称为所有设备的舒适下限。

可在地面用小 Cube 标记距牌面 1 / 2 / 4 米的位置,再从这些点以相同视高测试。测量标记移除 Collider,避免妨碍行走;正式构建前删除或标为 EditorOnly。

  • 文字与底板保持足够对比,避免贴在明暗不断变化的背景上
  • Auto Size 的最小值不能低到无法阅读;超长文本可分页或折叠
  • 牌子应同时适配不同视高和坐姿
  • 双语版本需要重新检查行数和布局

Udon Behaviour 的 Interaction Text 是交互目标的提示文本,Proximity 控制交互可用距离。实际提示位置和操作方式由客户端处理,不必固定描述为「浮在物体头顶」。

物体简短双语示例
灯开关开关灯 / Toggle light
镜子打开镜子 / Show mirror
信息板查看 / Read
录音机播放 / Play

SDK 不会把作者填写的中文自动翻译成玩家的界面语言。可行方案包括简短双语、图标配文字,或由世界提供语言选择按钮,切换作者预先写好的文本。语言选择应在本地保存或应用,不应改变其他玩家的显示。

以下镜子开关根据本地状态更新双语提示:

它是独立镜子按钮中 MirrorSwitch.cs 的更新版。已经创建过该脚本时,在原文件中用下面的完整类替换旧实现,保留原 Udon Program Asset 和 Mirror Object 引用,不新建第二个同名类或重复挂载。尚未制作镜子时,先按链接完成镜子与独立按钮的接线,再使用这个版本。

MirrorSwitch.cs
using UdonSharp;
using UnityEngine;
public class MirrorSwitch : UdonSharpBehaviour
{
public GameObject mirrorObject;
private void Start()
{
UpdatePrompt();
}
public override void Interact()
{
if (mirrorObject == null) return;
mirrorObject.SetActive(!mirrorObject.activeSelf);
UpdatePrompt();
}
private void UpdatePrompt()
{
if (mirrorObject == null) return;
InteractionText = mirrorObject.activeSelf
? "关闭镜子 / Hide mirror"
: "打开镜子 / Show mirror";
}
}

InteractionText 是 UdonSharp 提供的属性接口。这里修改的是本机提示和镜子状态;没有声明同步变量。按钮物体保持启用,镜子对象通过引用控制。

Proximity 可从 2 米开始测试。距离太大可能选到不想操作的目标,太小可能难以触及。桌面端与 VR 的交互操作可能不同,提示文字应描述动作,不硬写未经当前设备验证的键位。

反馈可以是状态文字、颜色、动画或声音,按功能选择即可。无需每个按钮都同时使用全部反馈形式。

使用支持 _EmissionColor 的材质,并预先在材质 Inspector 启用 Emission。脚本只改变表面自亮,不能据此承诺周围照明会变化。

ButtonHighlight.cs
using UdonSharp;
using UnityEngine;
public class ButtonHighlight : UdonSharpBehaviour
{
public Renderer buttonRenderer;
public Color idleEmission = Color.black;
public Color pressedEmission = Color.white;
private Material buttonMaterial;
private void Start()
{
if (buttonRenderer != null)
buttonMaterial = buttonRenderer.material;
}
public override void Interact()
{
if (buttonMaterial == null) return;
buttonMaterial.SetColor("_EmissionColor", pressedEmission);
SendCustomEventDelayedSeconds(nameof(_RestoreEmission), 0.2f);
}
public void _RestoreEmission()
{
if (buttonMaterial == null) return;
buttonMaterial.SetColor("_EmissionColor", idleEmission);
}
}

这是按下反馈,不包含「瞄准时高亮」。Renderer.material 会创建此 Renderer 的材质实例,脚本在 Start 缓存引用。多个按钮需要评估材质实例开销。连续点击会安排多个还原事件;若需要每次点击后完整保持 0.2 秒,应改为记录截止时间。

创建带 Box Collider 的测试 Cube,赋予启用了 Emission 的独立材质,将该脚本挂到 Cube,并把它的 Mesh Renderer 拖入 Button Renderer。设置 Idle / Pressed Emission 后先点一次,检查变亮与还原;再快速点两次,记录第二次反馈是否被前一次延迟事件提前还原。不要把这个已说明的计时边界误报成指针悬停效果。

HintPopup.cs
using UdonSharp;
using UnityEngine;
using VRC.SDKBase;
public class HintPopup : UdonSharpBehaviour
{
public GameObject hintCanvas;
public float showSeconds = 3f;
private float hideAt;
public override void OnPlayerTriggerEnter(VRCPlayerApi player)
{
if (!Utilities.IsValid(player) || !player.isLocal) return;
if (hintCanvas == null) return;
hintCanvas.SetActive(true);
hideAt = Time.time + showSeconds;
}
private void Update()
{
if (hintCanvas != null && hintCanvas.activeSelf && Time.time >= hideAt)
hintCanvas.SetActive(false);
}
}

脚本挂在保持启用的 Trigger 区域上,提示 Canvas 单独作为目标。重复进入会更新隐藏时间,避免旧的延迟回调提前关闭新提示。

为区域添加 Box Collider 并勾选 Is Trigger;将默认禁用的提示 Canvas 拖入 Hint Canvas,Show Seconds 设为 3。从区外进入,约三秒后应隐藏;在隐藏前退出并重新进入,应从最近一次进入起重新计时。再让第二位玩家进入,确认不改变本机提示。先检查编译和挂载,再执行 Build & Test。

按一次性音效的完整脚本与接线创建 LocalClickSound、Audio Source 与短音轨,再挂到测试按钮。Audio Source 的 2D / 3D 配置决定音效有无空间方向,PlayOneShot 决定播放一次。音量需与背景音、人声一起测试。

在同一 World Space Canvas 下创建 TitlePanel 和 RulesPanel,分别放简短标题与完整规则。另创建一个始终启用、带 Collider 的 Cube 按钮,挂以下脚本;它不能成为两个面板的子物体。

RulesPanelToggle.cs
using UdonSharp;
using UnityEngine;
public class RulesPanelToggle : UdonSharpBehaviour
{
public GameObject titlePanel;
public GameObject rulesPanel;
private bool expanded;
private void Start()
{
ApplyPanels();
}
public override void Interact()
{
expanded = !expanded;
ApplyPanels();
}
private void ApplyPanels()
{
if (titlePanel == null || rulesPanel == null) return;
titlePanel.SetActive(!expanded);
rulesPanel.SetActive(expanded);
InteractionText = expanded ? "收起 / Collapse" : "展开规则 / Rules";
}
}

将两个不同的面板分别拖入 Title Panel / Rules Panel。保存、检查 Console 编译结果,Build & Test 后依次验证首次只显示标题、点击显示规则、再次点击返回标题。两位玩家各自操作,面板只改变本地显示。这使用 Cube 的 Interact;如果改用 Canvas 内的 UI Button,需要另按本章链接的 UI Events 接线。

入口放世界名与必要路线,物体旁放功能说明,较长规则和 Credits 放在可主动展开的面板。保留制作来源和授权记录,不需要把所有信息放在同一块大牌子上。

反馈对照可先给一个按钮组合高亮、短音效和状态文字,再在三个场景副本中每次只关闭一种反馈。保持按钮的主操作、位置、距离和其他反馈不变,记录还能否判断「已收到点击」和「目标状态已改变」。无声或无颜色的版本也需要能读懂结果;这项实验不要求所有按钮固定具备三种反馈。

  • 可交互 Canvas 使用 World Space,并按 SDK 配好 VRC_UIShape
  • 固定文字与玩家姓名等动态文字均测试了字体覆盖
  • 中外文含义由作者提供,未假定自动翻译
  • 字号、对比度和布局在实际距离与目标设备上可读
  • 提示与真实状态一致,禁用目标不会一并禁用开关
  • 重复点击和重复进入区域的反馈经过测试