跳转至

BinderInfo

  • 种类: class
  • 命名空间: Runestone.AesirModules
  • 程序集: Runestone.AesirModules.OdinInspector

继承链: System.Object → BinderInfo

声明

[Serializable]
public class BinderInfo

绑定单元数据。描述一条要绑定到生成脚本字段的组件引用信息。 在 BinderAssistant 的「绑定单元列表」中以表格形式配置, 由「构建绑定单元」按子物体上的 BinderTag 标记增量维护; 每条记录对应生成脚本「绑定字段(自动生成)」region 中的一个 [SerializeField] 字段和 BindComponents() 中的一行赋值代码。

构造方法

名称 描述
BinderInfo() 供序列化创建实例使用的无参构造。
BinderInfo(BinderAssistant, BinderTag) 由 BinderAssistant 扫描 BinderTag 时构造,自动计算路径并生成默认字段名。

BinderInfo()

供序列化创建实例使用的无参构造。

public BinderInfo()

BinderInfo(BinderAssistant, BinderTag)

由 BinderAssistant 扫描 BinderTag 时构造,自动计算路径并生成默认字段名。

public BinderInfo(BinderAssistant assistant, BinderTag tagObj)

参数

名称 类型 说明
assistant BinderAssistant —
tagObj BinderTag —

字段

名称 描述
LabelObj 被绑定组件所在的 GameObject 引用。
ComponentFullName 组件类型的完整名称(含命名空间),作为代码生成时 GetComponent() 的泛型参数; 选择 GameObject 表示绑定物体本身。
FieldName 生成脚本中的字段名(camelCase)。默认值为「物体名_类型简称」,可手动修改; 重复字段名会在校验时报错。
HierarchyPath 相对于 BinderAssistant 的 transform.Find() 路径, 由 UpdatePath 自动计算;空字符串表示绑定 Assistant 自身所在物体。

LabelObj

被绑定组件所在的 GameObject 引用。

[TableColumnWidth]
[LabelText]
public GameObject LabelObj;

ComponentFullName

组件类型的完整名称(含命名空间),作为代码生成时 GetComponent() 的泛型参数; 选择 GameObject 表示绑定物体本身。

[TableColumnWidth]
[LabelText]
[ValueDropdown]
public string ComponentFullName;

FieldName

生成脚本中的字段名(camelCase)。默认值为「物体名_类型简称」,可手动修改; 重复字段名会在校验时报错。

[TableColumnWidth]
[LabelText]
[InlineButton]
public string FieldName;

HierarchyPath

相对于 BinderAssistant 的 transform.Find() 路径, 由 UpdatePath 自动计算;空字符串表示绑定 Assistant 自身所在物体。

[LabelText]
[DisplayAsString]
public string HierarchyPath;

方法

声明的方法

名称 描述
DefaultFieldName() 将字段名重置为默认值: 「物体名_类型简称」的 camelCase 形式(如 playButton_Button)。 可能与其他单元重名,重名会在校验时报错。 仅编辑器可用:依赖运行时可见程序集 Runestone.AesirModules.OdinInspector 内、 由 #if UNITY_EDITOR 收拢的代码生成器。
UpdatePath(BinderAssistant) 更新相对于 BinderAssistant 的层级路径。 物体丢失或缺少 BinderTag 标记时置空,交由校验报错。

继承的方法

名称 描述 声明类型
GetType() — object
Equals(object) — object
GetHashCode() — object
ToString() — object
MemberwiseClone() — object
Finalize() — object

DefaultFieldName()

将字段名重置为默认值: 「物体名_类型简称」的 camelCase 形式(如 playButton_Button)。 可能与其他单元重名,重名会在校验时报错。 仅编辑器可用:依赖运行时可见程序集 Runestone.AesirModules.OdinInspector 内、 由 #if UNITY_EDITOR 收拢的代码生成器。

public void DefaultFieldName()

UpdatePath(BinderAssistant)

更新相对于 BinderAssistant 的层级路径。 物体丢失或缺少 BinderTag 标记时置空,交由校验报错。

public void UpdatePath(BinderAssistant assistant)

参数

名称 类型 说明
assistant BinderAssistant —

Additional Notes

首个 ## Additional Notes 是增量生成文档标识符,请勿修改标题级别和内容!本文档由 Script Doc Generator 辅助生成。