诊断码
每一条 DUInnnn 诊断码:它意味着什么、如何产生、如何修复。
DreamGUI 针对一个 .dui 给出的每一条消息都带有一个编码,DUInnnn,并以 File.dui(line,col): error DUI3001: … 的形式输出:文件、行和列(均从 1 开始计数)、严重级别、编码,以及一句指出问题文本的说明——例如 Settings.dui(12,5): error DUI3001: 'Title' is already the id of the node on line 4。当蓝图编译时,它们会出现在其编译器结果中。编码是稳定的那一半:一个原因对应一个编码,同一个原因从两处到达仍保留同一个编码,测试断言的是编码而非措辞,因此措辞可以自由改进;已退役的编码保持退役,绝不会分配给其他任何事物。第一位数字说明是哪个阶段拒绝了它:1 词法分析器(不是标记的字符),2 解析器(无法组成语法的标记),3 含义(语法正确,但树不成立——重复的 id、未知的类型),4 值(值与它所写入的属性不匹配),5 构建树(反射拒绝了写入,或要写入的对象不存在),6 编译进蓝图(.dui 无法附加到其蓝图),7 写回(设计器无法将编辑写入文本),8 布局(一个编译通过的屏幕,由 DreamMCP 端点的 layout 和 preview 在某个视口尺寸下布局后显示出问题:绝不是编译期的问题,只有警告和信息)。
严重级别在诊断被引发的地方决定,而不是由其范围决定。大多数编码是错误,错误会导致编译失败——一个无法解析的文件会保留 Blueprint 之前的层级结构,而不是将其清空。少数是警告——DUI3008、DUI3013、DUI3023、DUI3025、DUI5007、DUI6003——此时文件可以编译,但仍有值得一看之处。VS Code 扩展报告相同的编码和相同的措辞:单个文件能自行确定的内容(词法分析器、括号、重复名称等)会在你输入时检查,其余内容在 Unreal 编辑器编译后通过 DUI/.dui-diagnostics.json 进入其 Problems 面板;编译器始终是权威。
八个家族
| 阶段 | 含义 | 编码 | |
|---|---|---|---|
| DUI1xxx | 词法分析器 | 不是标记的字符序列。 | 7 |
| DUI2xxx | 解析器 | 无法组成语法的标记。 | 24 |
| DUI3xxx | 含义 | 语法正确,但树不成立:重复的 id、未知的类型。 | 25 |
| DUI4xxx | 值 | 值与它所写入的属性不匹配。 | 9 |
| DUI5xxx | 构建树 | 反射拒绝了写入,或目标对象不存在。 | 25 |
| DUI6xxx | 编译 | .dui 无法附加到其蓝图。 | 25 |
| DUI7xxx | 写回 | 设计器的编辑无法写入文本。 | 5 |
| DUI8xxx | 布局 | 编译通过的屏幕在某个视口尺寸下布局后显示出问题。仅来自 DreamMCP 的 layout 和 preview。 | 10 |
全部编码
| 编码 | 名称 | 严重级别 | 含义 |
|---|---|---|---|
| DUI1001 | UnexpectedCharacter | error | 不能作为任何标记开头的字符。 |
| DUI1002 | UnterminatedString | error | 到达行尾仍未遇到闭合引号的字符串。 |
| DUI1003 | UnterminatedComment | error | 始终没有到达 */ 的 /*。 |
| DUI1004 | MalformedNumber | error | 无法读取的数字:两个小数点、末尾的点、粘附的单位(24px)。 |
| DUI1005 | MalformedHexColor | error | 位数不是 3、4、6 或 8 的颜色。 |
| DUI1006 | IdentifierTooLong | error | 超出 FName 所能容纳长度的名称。 |
| DUI1007 | AssetPathTooLong | error | 超出 FName 所能容纳长度的资产路径。 |
| DUI2001 | UnexpectedToken | error | 语法期望其他内容处却出现的标记;消息会同时指出两者。 |
| DUI2002 | UnclosedBlock | error | 没有匹配 } 的 {。 |
| DUI2003 | UnclosedTuple | error | 没有匹配 ) 的 (。 |
| DUI2004 | MissingNodeId | error | 既没有 id 也没有块的节点,或带有 (was: …) 的未命名节点。 |
| DUI2005 | MissingPropertyValue | error | 没有 = 或箭头的属性,或其后面没有任何内容的属性。 |
| DUI2006 | MalformedRoot | error | 编译进类的文件中没有根节点,或有多个根节点。 |
| DUI2007 | MalformedClassDeclaration | error | class 出现两次、路径为空,或位于节点内部。 |
| DUI2008 | MalformedWasClause | error | (was: …) 包含的不是一个 id。 |
| DUI2009 | MalformedKeyOverride | error | @key(…) 包含的不是一个字符串,或位于不是字符串的值之后。 |
| DUI2010 | MalformedLoopHeader | error | 不是 <keyword> Var in Source 或 Source() 的 for / each 头部。 |
| DUI2011 | MalformedBindingExpression | error | <-、<-> 的右侧或 emit 的参数无法解析。 |
| DUI2012 | ImportFailed | error | 无法兑现的 use:文件不存在、无法读取、无法解析,或存在循环。 |
| DUI2013 | NestingTooDeep | error | 嵌套深度超过 256 的块或括号。 |
| DUI2014 | MalformedTimeline | error | 不符合语法的 timeline 块或行。 |
| DUI2015 | MalformedUseDeclaration | error | 没有名称的 use … as、以关键字作为名称,或没有 as 的类路径。 |
| DUI2016 | MalformedPropsBlock | error | 不是 Type Name 或 Type Name = value 的 props 行,或位于节点内部的 props。 |
| DUI2017 | MalformedEventsBlock | error | 不是 Name 或 Name(Type Param, …) 的 events 条目,或位于节点内部的 events。 |
| DUI2018 | MalformedConditional | error | 没有条件或块的 if、没有 if 的 else,或包含不是控件内容的分支。 |
| DUI2019 | MalformedSlotDeclaration | 错误 | 同一个 slot 中出现两次 default,或既声明又填充的块:声明可包含组件、属性、slot 行和 @tag 行,而填充只包含控件(包括与其并列的 @tag 行)。 |
| DUI2020 | MalformedRows | error | 无法读取的 rows 表:列清单不是名称、某一列出现两次、某行的值数量不对。 |
| DUI2021 | MalformedViewModelsBlock | error | 不是 Type Name、= new、= global ["Name"] 或 = parent ["Name"] 的 viewmodels 行(包括为空的 "" 名称),或位于节点内部的 viewmodels 块。 |
| DUI2022 | MalformedTextAnnotation | error | @note(…) 里不是一个字符串、@max(…) 里不是一个不小于 1 的整数、它们跟在不是字符串的值后面、同一个注解写了两次,或者 @noloc 和 @key、@note、@max 写在一起。 |
| DUI2023 | MalformedContainer | 错误 | 读不通的列表([a, b])或 Map({ key: value }):括号没有闭合、两个元素之间缺逗号,或者 Map 的一项不是 key: value。结构体的第一项可以不带键。 |
| DUI2024 | MalformedTag | 错误 | 无法解析的 @tag 行:@tag 后没有任何内容、一个数字或一个字符串、两个名称之间没有逗号、末尾逗号。还有 style 中或直接在 for / each 主体中的 @tag 行。 |
| DUI3001 | DuplicateNodeId | error | 两个节点共享同一个 id。 |
| DUI3002 | InvalidNodeId | error | 不是标识符、以数字开头或是关键字的 id。 |
| DUI3003 | UnknownNodeType | error | 不是标签、容器、别名、已注册控件或路径的类型。 |
| DUI3004 | UnknownStyle | 错误 | : Name 指定了此文件看不到的样式;子句中每个未知的名称都会被报告。 |
| DUI3005 | DuplicateStyle | 错误 | 同一个文件里的两个同名样式。 |
| DUI3006 | UnknownBehaviourClass | 错误 | 一个指向控件无法携带的东西的 + Name。 |
| DUI3007 | DuplicateSlotName_Retired | 错误 | 已退役;两个同名 slot 现在报 DUI3001。 |
| DUI3008 | ShadowedLoopVariable | 警告 | 一个遮蔽了外层循环变量的循环变量(警告)。 |
| DUI3009 | ParentRefusedChild | 错误 | 一个不肯接受这个子节点的父节点:已经满了的内容控件,或者被填了两次的命名 slot。 |
| DUI3010 | RenameOldIdStillInUse | 错误 | 一个 (was: X),而 X 仍然是这个文件里的一个 id。 |
| DUI3011 | DuplicateWasId | 错误 | 两个节点都声称 (was: X)。 |
| DUI3012 | SelfRename | 错误 | 一个写在名为 X 的节点自己身上的 (was: X)。 |
| DUI3013 | RenameGraphReferenceAmbiguous | 警告 | 这个旧 id 同时是另一个成员的名字,因此图表引用没有被迁移(警告)。 |
| DUI3014 | DuplicateResource | 错误 | 两个同名的资源条目。 |
| DUI3015 | StyleCycle | 错误 | 一个沿着基类链继承了自己的样式。 |
| DUI3016 | DuplicateTimeline | 错误 | 两个同名的时间轴。 |
| DUI3017 | DuplicateComponentAlias | 错误 | 两行 use … as 给出同一个名字。 |
| DUI3018 | AliasShadowsBuiltIn | 错误 | 一个与标签或容器同名的 use … as 名字。 |
| DUI3019 | DuplicateProp | 错误 | 两行 props 声明同一个名字。 |
| DUI3020 | DuplicateEvent | 错误 | 两个同名的 events 条目,或者一个条目里声明了两次的参数。 |
| DUI3021 | UnknownNamespace | 错误 | 一个 ns.Name,其 ns 没有被任何 use … as ns 声明过。 |
| DUI3022 | MultipleDefaultSlots | 错误 | 一个文件里不止一个 slot … default。 |
| DUI3023 | DuplicateRowKey | 警告 | 警告。一个 rows 表里有两行,其第一个值生成同一个 id;第二行的 id 随之跟着顺序走。 |
| DUI3024 | DuplicateViewModel | 错误 | 两个同名的 viewmodels 条目。 |
| DUI3025 | StyleAlreadyApplied | 警告 | 警告。子句中指定的样式已由该子句中较早的名称应用过(无论是其本身还是作为基样式):再次指定它不会带来任何变化。 |
| DUI4001 | UnknownProperty | 错误 | 没有该名称的属性;会提示最接近的属性。@slot Size <- … 就是其中之一:Size 是两个属性的简写,而绑定需要分别指定 MinDesiredSize 和 MaxDesiredSize。 |
| DUI4002 | UnknownPropertyPathSegment | 错误 | 一条开头能解析、后面解析不了的带点路径,或结构体的字段映射中指定了该结构体并不存在的字段。 |
| DUI4003 | ValueTypeMismatch | 错误 | 一个形状不可能成为该属性类型的值。 |
| DUI4004 | TupleArityMismatch | 错误 | 一个元素个数不对的元组。 |
| DUI4005 | UnknownEnumValue | 错误 | 一个属性的枚举没有声明的词。 |
| DUI4006 | PropertyNotWritable | 错误 | 一个文本写不了的属性:瞬态的、已弃用的、属于对象图的,或者是委托。 |
| DUI4007 | UnknownResource | 错误 | 一个没有指向任何资源条目的 @Name。 |
| DUI4008 | ResourceTypeMismatch | 错误 | 一个值与声明的类型不符的资源,或者一个被当作节点类型、却不是 Asset 的资源。 |
| DUI4009 | ContainerTypeMismatch | 错误 | 列表写在了不是数组或 Set 的属性上、Map 写在了不是 Map 的属性上、单个值写在了容器属性上,或者节点的 Set/Map(只有数组能存节点 id)。在真正的 Map 上,或者在没有主字段的结构体上,没有键的 Map 条目也算一种。 |
| DUI5001 | AssetNotFound | 错误 | 一个加载不出来的资产或类路径。 |
| DUI5002 | NoVisualForProperty | 错误 | 一个属于视觉对象、而节点的类型并不创建那个视觉对象的属性。 |
| DUI5003 | NoPanelSlotForProperty | 错误 | 一个父节点不布局面板、却写了 slot 行的节点。 |
| DUI5004 | BindingFunctionNotFound | 错误 | 一个类里没有的绑定函数,或者一个带参数的绑定函数。 |
| DUI5005 | BindingTargetHasNoSetter | 错误 | 一个没有 setter 的被绑定属性。 |
| DUI5006 | NotAUserWidgetClass | 错误 | 一个以不是具体 DreamUI 用户控件的类作类型的节点。 |
| DUI5007 | LoopNotExpanded | 警告 | 一个调用方没有地方记录、因而被跳过的循环(警告)。 |
| DUI5008 | BindingTargetNotSupported | 错误 | 一个落在任何绑定都无法指名的东西上的绑定:面板 slot、布局容器,或者结构体里的字段。 |
| DUI5009 | NothingToBuild | 错误 | 这棵树没有根节点;解析器说明了原因。 |
| DUI5010 | EventNotFound | 错误 | 一个 X -> …,而 X 不是目标上的事件。 |
| DUI5011 | BindingExpressionUnsupported | 错误 | 一个编译器无法转成函数的表达式。 |
| DUI5012 | EachMisplaced | 错误 | 一个放在根上的 each:嵌套在另一个循环里、宿主没有列表视图,或者不是恰好一个模板。 |
| DUI5013 | NodeReferenceNotFound | 错误 | 一个作为值写下、却没有指向文件里任何节点的节点 id。 |
| DUI5014 | LoopBodyBindingUnsupported | 错误 | 一个写在循环体里的表达式或 <->。 |
| DUI5015 | TimelineTargetNotFound | 错误 | 一条没有指向任何节点的轨道路径。 |
| DUI5016 | TimelinePropertyNotAnimatable | 错误 | 一个没有任何动画轨道能驱动的轨道属性。 |
| DUI5017 | UnknownEaseName | 错误 | 一个缓动库里没有的 ease 名字。 |
| DUI5018 | ComponentAliasUnresolved | 错误 | 一个没有指向任何类的别名:文件既没有 class 行也没有 Blueprint 用它,或者路径什么也加载不出来。 |
| DUI5019 | SlotFillOutsideComponent | 错误 | 一个 slot Name { … } 填充了非组件实例下的 slot。 |
| DUI5020 | UnknownSlotToFill | 错误 | 一个指向组件没有声明的 slot 的填充。 |
| DUI5021 | ForMisplaced | 错误 | 一个放在根上的 for:在另一个循环里、在容量固定的宿主里,或者不是恰好一个模板。 |
| DUI5022 | SecondLayoutContainer | 错误 | 一个节点上的第二个布局容器。 |
| DUI5023 | MemberPathNotFound | 错误 | 成员路径里的某一段,在它所在的类上找不到,或者 Blueprint 看不到(UnrealSharp 属性需要 BlueprintReadOnly 或 BlueprintReadWrite)。 |
| DUI5024 | MemberPathThroughNonObject | 错误 | 一条越过非对象的值继续往下走的成员路径。 |
| DUI5025 | RouteOperatorMismatch | 错误 | 单播委托上的 +=,或者多播事件上的 =。 |
| DUI6001 | SourceFileUnreadable | 错误 | Blueprint 的 Source File 指向的文件不存在或读不出来。 |
| DUI6002 | EmptyTree | 错误 | 文件解析完成却没有产生任何树,且没有其他错误说明原因。它不会与另一个错误一同报告:命名了无法解析的类型的节点会以自己的代码失败,这就是报告的全部内容。 |
| DUI6003 | ClassPathMismatch | 警告 | class 行指向的是另一个蓝图,而不是正在编译的那个(警告)。 |
| DUI6004 | EventHandlerNotFound | 错误 | -> Handler 指向一个类上没有的函数。 |
| DUI6005 | EventHandlerSignatureMismatch | 错误 | 一个参数不是事件参数的处理函数。 |
| DUI6006 | EachSourceNotFound | 错误 | 一个类里既没有同名函数、也没有同名变量的循环来源。 |
| DUI6007 | EachSourceNotObjectArray | 错误 | 一个不是对象数组的循环来源。 |
| DUI6008 | PropTypeUnknown | 错误 | 一个 props 或 events 类型没有对应的蓝图引脚。 |
| DUI6009 | PropNameTaken | 错误 | 一个 props 名字已被另一个类型不同的成员占用,或者与某个控件 id 相同。 |
| DUI6010 | EmitUnknownEvent | 错误 | emit Name 一个这个文件没有声明的事件。 |
| DUI6011 | EmitArgumentMismatch | 错误 | emit 实参不是事件的参数。 |
| DUI6012 | EmitRouteUnsupported | 错误 | 一个无法生成处理函数的 emit:在循环体里,或者事件的参数蓝图无法承载。 |
| DUI6013 | PropDefaultInvalid | 错误 | 一个 props 默认值其类型容纳不了。 |
| DUI6014 | EventNameTaken | 错误 | 一个 events 名字已被类的另一个成员占用。 |
| DUI6015 | ViewModelClassUnknown | 错误 | 一个 viewmodels 类型找不到类,或者找到不止一个。 |
| DUI6016 | ViewModelNameTaken | 错误 | 一个 viewmodels 名字已被类的另一个成员占用。 |
| DUI6017 | ViewModelSourceInvalid | 错误 | 对抽象类的 = new。 |
| DUI6018 | RouteMemberFunctionNotFound | 错误 | -> Path.Func 其函数在对象的类上没有,或者 Blueprint 不能调用。 |
| DUI6019 | RouteArgumentMismatch | 错误 | -> Path.Func 其实参与函数对不上,或者在没有括号时其函数不是什么都不接收、也不是事件发出的那些。 |
| DUI6020 | TwoWayTargetReadOnly | 错误 | <-> Path.Member 其成员写不回去:只读,且没有 Set<Member>。 |
| DUI6021 | LoopItemMemberNotFound | 错误 | Item.Member 循环来源的元素类上没有。 |
| DUI6022 | LoopItemRouteMismatch | 错误 | -> Item.Func 元素类上没有,或者其参数既不是什么都不接收、也不是事件的那些。 |
| DUI6023 | SourceFileWritePending | 错误 | 文档中存在无法写入的编辑,因此拒绝编译较旧的文件。 |
| DUI6024 | TranslationDoesNotFit | 警告 | 工程里有 DreamLoc 时:某个语言的译文放进文字控件里排版后被截断,或排出了控件的框。 |
| DUI6025 | TranslationGlyphsMissing | 警告 | 工程里有 DreamLoc 时:某个语言的译文里有字符,文字控件字体的所有字面都没有。 |
| DUI7001 | PatchTargetNotFound | 错误 | 设计器的一次编辑在文件里找不到落脚处:未知的节点、被绑定的属性、没有块的 slot。 |
| DUI7002 | SourceFileChangedUnderEdit | 错误 | 文件在一次待写入的编辑底下被改动了,于是什么都没有写入。 |
| DUI7003 | PatchValueNotRepresentable | 错误 | 一个这门语言写不出来的值(非有限的数),它所在的那一行保持原样。 |
| DUI7004 | PatchSyntaxNotWritable | 错误 | 对没有哪一行写着它的东西的一次编辑:由 if 决定的可见性、无法改写的简写、对 Tags 做出的任何行都无法接受的改动(写成两种方式,或者 @tag 行无法容纳的名字)。 |
| DUI7005 | PatchStyleComponentNotWritable | 错误 | 对样式 + 行给节点的值的一次编辑,调用方又不写覆盖行。设计器会改为在节点上写一条 + 行;脚本可以自己加这一行,或者修改样式。 |
| DUI8001 | LayoutOffScreen | 警告 | 节点可见的部分超出视口边缘 1 px 以上,或完全位于视口之外;或者放不下的文本在没有任何裁剪的地方溢出屏幕。被裁剪的部分不计入;每个分支只报告一处。 |
| DUI8002 | LayoutTextOverflow | 警告 | 文本被其溢出策略截断,或布局超出其框;消息给出它需要的尺寸和它拥有的框。 |
| DUI8003 | LayoutTooSmall | 警告 | 会绘制或可被按下的节点宽或高小于 1 px(对带有子控件的普通控件为信息级),或可按下控件小于 24 x 24 px。 |
| DUI8004 | LayoutOverlappingControls | 警告 | 同一画布中的两个可按下控件在屏幕上于两个轴上都重叠 2 px 或更多,无论它们在树中的位置如何:此处的按下只会到达上面那个控件。落在面积为其四倍或以上的控件上的小控件属于刻意分层,不予报告。 |
| DUI8005 | LayoutNearlyAligned | 信息 | 兄弟节点的左、右、上或下边缘或中心相差超过 0.5 且最多 3 px,或者三个及以上的行或列其间距相差如此。尺寸不超过 128 px 的盒子内部的纯视觉元素(由形状绘制的图标部件)不参与比较。 |
| DUI8006 | LayoutBreaksAtSize | 警告 | 在 layout 所获得的某个后续视口尺寸(sizes)下出现 DUI8001 到 DUI8004、DUI8008 或 DUI8009,而在第一个尺寸下没有。 |
| DUI8007 | LayoutLowContrast | 警告 | 在 preview 中:文本颜色与其框内紧邻像素中位数的对比度低于 3 比 1(WCAG 的对比度);对于小于 24 px 的文本,低于 4.5 比 1 的为信息级。 |
| DUI8008 | LayoutOutsideFrame | 警告 | 一个节点,其绘制超出所在的面板或卡片超过 4 px(且超过自身尺寸的 5 %):最近一个绘制盒子的祖先,或覆盖层置于其下的底板。所测量的是它绘制的内容——文本的字形、图形的轮廓、矩形块的主体。带 Bleed 标记的节点(或位于其内部)、会裁剪的框架,以及与框架同样大的底板(阴影之上的面)均不予报告。 |
| DUI8009 | LayoutCoversText | 警告 | 一个不接收指针的视觉元素,在其画布中绘制于某段文本之后,覆盖其字形 12 % 或更多——或一个大部分位于该文本行内的小装饰;或一段文本横跨绘制在其下方、并非其底板的小图形的边缘(例如滑到下一个徽标上的标签),其部分字母落在该图形上,其余部分在其外。其背板(绘制于其之前并承载它)、没有主体的轮廓、覆盖整张卡片的蒙层以及覆盖大部分屏幕的遮罩均不予报告,带 Bleed 标记的节点也不予报告。 |
| DUI8010 | LayoutUnbalanced | 信息 | 一个面板,其内容偏居一侧(有 38 % 或更多的区域为空)、在其中部留下一片宽阔的空白区域,或各行分布稀疏;属于提示性检查,且从不在栏或侧边栏上报告。 |