虚幻引擎 pythonAPI 讲解:_ObjectBase

本文详细介绍了UnrealEngine中_ObjectBase类在Python中的功能,包括获取对象属性、信息、编辑器属性操作,以及处理对象关联、状态改变和类型转换等,为开发者提供了强大的工具和灵活性。
摘要由CSDN通过智能技术生成

在 Unreal Engine 中,_ObjectBase 类是所有暴露给 Unreal 的对象实例的类型。它提供了一系列方法和属性,使得在 Python 中对 Unreal 对象进行操作和管理更加便捷和灵活。

首先,_ObjectBase 类提供了一系列方法来获取对象的属性和信息。通过 get_class() 方法可以获取对象所属的 Unreal 类;通过 get_name() 方法可以获取对象的名称;而 get_path_name() 方法则可以获取对象的完整路径名,包括类名和对象所在路径。这些方法为开发者提供了访问对象信息的途径,方便进行对象的管理和操作。

此外,_ObjectBase 类还提供了一些方法来操作对象的属性。通过 get_editor_property() 方法和 set_editor_property() 方法,开发者可以获取和设置对象在编辑器中可见的属性值。这为在编辑器中编辑对象属性提供了便利,同时还能确保属性的修改触发相应的前后变更通知。

除了属性操作外,_ObjectBase 类还提供了一些方法来处理对象的外部关联和修改状态。例如,通过 get_outer() 方法可以获取对象的外部对象,即该对象所属的容器对象;而 modify() 方法则可以标记对象即将被修改,以便追踪修改并进行撤销/重做操作。这些方法为管理对象的层级关系和状态变化提供了支持。

另外,_ObjectBase 类还提供了一些静态方法和类方法。例如,cast() 方法可以将给定的对象转换为指定的 Unreal 对象类型;而 get_default_object() 方法可以获取指定类型的 Unreal 类的默认对象(CDO)。这些方法为开发者在处理对象类型和实例时提供了更多的灵活性和便利性。

让我们逐个方法进行细化讲解。

  1. call_method(self, name: str, args: Any, kwargs: Mapping[str, object]) -> Any:
  • 这个方法允许你通过 Unreal 的反射机制调用对象上的方法。你可以传递位置参数(args)或关键字参数(kwargs),然后该方法会在对象上调用对应的方法并返回结果。
  1. classmethod cast(cls: Type[_T], object: object) -> _T:

    • 这个类方法允许你将给定的对象转换为指定的 Unreal 对象类型。如果转换不可行,会引发异常。
  2. get_class(self) -> Class:

    • 返回当前对象所属的 Unreal 类。
  3. classmethod get_default_object(cls: Type[_T]) -> _T:

    • 返回指定类型的 Unreal 类的默认对象(CDO)。
  4. get_editor_property(self, name: str) -> object:

    • 返回对象在编辑器中可见的指定属性的值。
  5. get_fname(self) -> Name:

    • 返回对象的名称(Name 对象)。
  6. get_full_name(self) -> str:

    • 返回对象的完整名称,包括类名和对象所在路径。
  7. get_name(self) -> str:

    • 返回对象的名称。
  8. get_outer(self) -> Any:

    • 返回对象的外部对象(如果有),即该对象所属的容器对象。
  9. get_outermost(self) -> Package:

    • 返回对象的最外部对象(即所在的包)。
  10. get_package(self) -> Package:

    • 返回与该对象直接关联的包。
  11. get_path_name(self) -> str:

    • 返回对象的路径名。
  12. get_typed_outer(self, type: Union[Class, type]) -> Any:

    • 返回该对象的第一个外部对象,其类型为指定的类型。
  13. get_world(self) -> Optional[World]:

    • 返回与该对象关联的世界(如果有)。
  14. is_package_external(self) -> bool:

    • 如果该对象与其外部对象的包不同,则返回 True。
  15. modify(self, always_mark_dirty: bool = True) -> bool:

    • 通知系统该对象即将被修改,以便跟踪更改以进行撤销/重做操作。
  16. rename(self, name: Name | str = ‘None’, outer: Object | None = None) -> bool:

    • 重命名对象并/或更改其外部对象。
  17. set_editor_properties(self, properties: Mapping[str, object]) -> None:

    • 设置对象在编辑器中可见的多个属性的值。
  18. set_editor_property(self, name: str, value: object, notify_mode: PropertyAccessChangeNotifyMode = PropertyAccessChangeNotifyMode.DEFAULT) -> None:

    • 设置对象在编辑器中可见的单个属性的值。
  19. classmethod static_class(cls) -> Class:

    • 返回该类型的 Unreal 类。

这些方法提供了访问对象信息、属性操作、状态管理等功能,为开发者提供了丰富的工具和支持,使得在 Python 中与 Unreal 对象进行交互变得更加灵活和高效。

  • 14
    点赞
  • 32
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值