xiaokun/netease-modsdk-wiki
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
036ee39f2008ce92af589874223c89fc98667ad4
netease-modsdk-wiki/docs/mcdocs/3-PresetAPI/预设对象/通用/变换对象TransformObject.md
boybook 9a0334ee84 first commit
2025-03-17 13:24:39 +08:00

27 KiB
Raw Blame History

sidebarDepth
sidebarDepth
1

变换对象TransformObject

概述

  • 继承关系
classDiagram
GameObject <|-- TransformObject
link GameObject "/mcdocs/3-PresetAPI/%E9%A2%84%E8%AE%BE%E5%AF%B9%E8%B1%A1/%E9%80%9A%E7%94%A8/%E6%B8%B8%E6%88%8F%E5%AF%B9%E8%B1%A1GameObject.html"
TransformObject: 变换对象
GameObject: 游戏对象
GameObject: (点击跳转)

  • 描述

    TransformObject（变换对象）是拥有变换属性的GameObject（游戏对象）的基类，他们在游戏世界中有着确切的位置等信息。

  • 成员变量

    变量名
    数据类型
    		 说明
    name str 对象名称
    transform Transform 局部坐标变换
    isBroken bool 是否可用，当素材文件丢失，零件代码语法错误时处于不可用状态
    isRemoved bool 是否已销毁

索引

接口
描述
GetChildTransformObjects 客户端/服务端 获取子TransformObject列表
GetTransformObjects 客户端/服务端 获取TransformObject列表，包含自身
GetChildGameObjects 客户端/服务端 获取子GameObject列表
GetGameObjects 客户端/服务端 获取GameObject列表，包含自身
GetGameObjectById 客户端/服务端 根据ID获取GameObject
GetGameObjectByEntityId 客户端/服务端 根据实体ID获取GameObject
GetId 客户端/服务端 获取当前预设的ID
GetEntityId 客户端/服务端 获取当前预设的实体ID
GetDisplayName 客户端/服务端 获取当前预设的显示名称
GetDisplayPath 客户端/服务端 获取当前预设到根节点的显示路径
GetLocalTransform 客户端/服务端 获取当前预设的局部坐标变换
SetLocalTransform 客户端/服务端 设置当前预设的局部坐标变换
GetLocalPosition 客户端/服务端 获取当前预设的局部坐标位置
SetLocalPosition 客户端/服务端 设置当前预设的局部坐标位置
GetLocalRotation 客户端/服务端 获取当前预设的局部坐标旋转
SetLocalRotation 客户端/服务端 设置当前预设的局部坐标旋转
GetLocalScale 客户端/服务端 获取当前预设的局部坐标缩放
SetLocalScale 客户端/服务端 设置当前预设的局部坐标缩放
GetWorldTransform 客户端/服务端 获取当前预设的世界坐标变换
GetWorldMatrix 客户端/服务端 获取世界坐标变换矩阵
GetLocalMatrix 客户端/服务端 获取局部坐标变换矩阵
SetWorldTransform 客户端/服务端 设置当前预设的世界坐标变换
GetWorldPosition 客户端/服务端 获取当前预设的世界坐标位置
SetWorldPosition 客户端/服务端 设置当前预设的世界坐标位置
GetWorldRotation 客户端/服务端 获取当前预设的世界坐标旋转
SetWorldRotation 客户端/服务端 设置当前预设的世界坐标旋转
GetWorldScale 客户端/服务端 获取当前预设的世界坐标缩放
SetWorldScale 客户端/服务端 设置当前预设的世界坐标缩放
AddLocalOffset 客户端/服务端 给局部坐标变换位置增加偏移量
AddWorldOffset 客户端/服务端 给世界坐标变换位置增加偏移量
AddLocalRotation 客户端/服务端 给局部坐标变换旋转增加偏移量
AddWorldRotation 客户端/服务端 给世界坐标变换旋转增加偏移量
AddLocalScale 客户端/服务端 给局部坐标变换缩放增加偏移量
AddWorldScale 客户端/服务端 给世界坐标变换缩放增加偏移量
AddLocalTransform 客户端/服务端 给局部坐标变换增加偏移量
AddWorldTransform 客户端/服务端 给世界坐标变换增加偏移量
GetRootParent 客户端/服务端 获取当前预设所在的根预设
GetParent 客户端/服务端 获取当前预设的父预设
SetParent 客户端/服务端 设置当前预设的父预设
GetManager 客户端/服务端 获取当前预设所在的预设管理器
Unload 客户端/服务端 卸载当前预设
Destroy 客户端/服务端 销毁当前预设

GetChildTransformObjects

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    获取子TransformObject列表

  • 参数

    参数名
    数据类型
    		 说明
    recursive bool 是否递归查找所有子节点

  • 返回值

    数据类型
    		 说明
    list(TransformObject) TransformObject列表

GetTransformObjects

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    获取TransformObject列表，包含自身

  • 参数

    参数名
    数据类型
    		 说明
    recursive bool 是否递归查找所有子节点

  • 返回值

    数据类型
    		 说明
    list(TransformObject) TransformObject列表

GetChildGameObjects

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    获取子GameObject列表

  • 参数

    参数名
    数据类型
    		 说明
    recursive bool 是否递归查找所有子节点

  • 返回值

    数据类型
    		 说明
    list(GameObject) 游戏对象列表

GetGameObjects

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    获取GameObject列表，包含自身

  • 参数

    参数名
    数据类型
    		 说明
    recursive bool 是否递归查找所有子节点

  • 返回值

    数据类型
    		 说明
    list(GameObject) 游戏对象列表

GetGameObjectById

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    根据ID获取GameObject

  • 参数

    无

  • 返回值

    数据类型
    		 说明
    GameObject 游戏对象

GetGameObjectByEntityId

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    根据实体ID获取GameObject

  • 参数

    无

  • 返回值

    数据类型
    		 说明
    GameObject 游戏对象

GetId

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    获取当前预设的ID

  • 参数

    无

  • 返回值

    数据类型
    		 说明
    str ID

GetEntityId

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    获取当前预设的实体ID

  • 参数

    无

  • 返回值

    数据类型
    		 说明
    str 实体ID

GetDisplayName

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    获取当前预设的显示名称

  • 参数

    无

  • 返回值

    数据类型
    		 说明
    str 名称

GetDisplayPath

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    获取当前预设到根节点的显示路径

  • 参数

    无

  • 返回值

    数据类型
    		 说明
    str 节点路径

GetLocalTransform

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    获取当前预设的局部坐标变换

  • 参数

    无

  • 返回值

    数据类型
    		 说明
    Transform 坐标变换

SetLocalTransform

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    设置当前预设的局部坐标变换

  • 参数

    参数名
    数据类型
    		 说明
    transform Transform 坐标变换

  • 返回值

    无

GetLocalPosition

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    获取当前预设的局部坐标位置

  • 参数

    无

  • 返回值

    数据类型
    		 说明
    tuple(float,float,float) （X轴位置，Y轴位置，Z轴位置）

SetLocalPosition

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    设置当前预设的局部坐标位置

  • 参数

    参数名
    数据类型
    		 说明
    pos tuple(float,float,float) （X轴位置，Y轴位置，Z轴位置）

  • 返回值

    无

GetLocalRotation

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    获取当前预设的局部坐标旋转

  • 参数

    无

  • 返回值

    数据类型
    		 说明
    tuple(float,float,float) （X轴角度，Y轴角度，Z轴角度）

SetLocalRotation

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    设置当前预设的局部坐标旋转

  • 参数

    参数名
    数据类型
    		 说明
    rotation tuple(float,float,float) （X轴角度，Y轴角度，Z轴角度）

  • 返回值

    无

GetLocalScale

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    获取当前预设的局部坐标缩放

  • 参数

    无

  • 返回值

    数据类型
    		 说明
    tuple(float,float,float) （X轴缩放，Y轴缩放，Z轴缩放）

SetLocalScale

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    设置当前预设的局部坐标缩放

  • 参数

    参数名
    数据类型
    		 说明
    scale tuple(float,float,float) （X轴缩放，Y轴缩放，Z轴缩放）

  • 返回值

    无

GetWorldTransform

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    获取当前预设的世界坐标变换

  • 参数

    无

  • 返回值

    数据类型
    		 说明
    Transform 坐标变换

GetWorldMatrix

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    获取世界坐标变换矩阵

  • 参数

    无

  • 返回值

    数据类型
    		 说明
    Matrix 世界坐标变换矩阵

GetLocalMatrix

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    获取局部坐标变换矩阵

  • 参数

    无

  • 返回值

    数据类型
    		 说明
    Matrix 局部坐标变换矩阵

SetWorldTransform

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    设置当前预设的世界坐标变换

  • 参数

    参数名
    数据类型
    		 说明
    transform Transform 坐标变换

  • 返回值

    无

GetWorldPosition

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    获取当前预设的世界坐标位置

  • 参数

    无

  • 返回值

    数据类型
    		 说明
    tuple(float,float,float) （X轴位置，Y轴位置，Z轴位置）

SetWorldPosition

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    设置当前预设的世界坐标位置

  • 参数

    参数名
    数据类型
    		 说明
    pos tuple(float,float,float) （X轴位置，Y轴位置，Z轴位置）

  • 返回值

    无

GetWorldRotation

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    获取当前预设的世界坐标旋转

  • 参数

    无

  • 返回值

    数据类型
    		 说明
    tuple(float,float,float) （X轴角度，Y轴角度，Z轴角度）

SetWorldRotation

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    设置当前预设的世界坐标旋转

  • 参数

    参数名
    数据类型
    		 说明
    rotation tuple(float,float,float) （X轴角度，Y轴角度，Z轴角度）

  • 返回值

    无

GetWorldScale

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    获取当前预设的世界坐标缩放

  • 参数

    无

  • 返回值

    数据类型
    		 说明
    tuple(float,float,float) （X轴缩放，Y轴缩放，Z轴缩放）

SetWorldScale

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    设置当前预设的世界坐标缩放

  • 参数

    参数名
    数据类型
    		 说明
    scale tuple(float,float,float) （X轴缩放，Y轴缩放，Z轴缩放）

  • 返回值

    无

AddLocalOffset

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    给局部坐标变换位置增加偏移量

  • 参数

    参数名
    数据类型
    		 说明
    offset tuple(float,float,float) 变换位置

  • 返回值

    无

AddWorldOffset

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    给世界坐标变换位置增加偏移量

  • 参数

    参数名
    数据类型
    		 说明
    offset tuple(float,float,float) 变换位置

  • 返回值

    无

AddLocalRotation

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    给局部坐标变换旋转增加偏移量

  • 参数

    参数名
    数据类型
    		 说明
    rotation tuple(float,float,float) 变换旋转

  • 返回值

    无

AddWorldRotation

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    给世界坐标变换旋转增加偏移量

  • 参数

    参数名
    数据类型
    		 说明
    rotation tuple(float,float,float) 变换旋转

  • 返回值

    无

AddLocalScale

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    给局部坐标变换缩放增加偏移量

  • 参数

    参数名
    数据类型
    		 说明
    scale tuple(float,float,float) 变换缩放

  • 返回值

    无

AddWorldScale

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    给世界坐标变换缩放增加偏移量

  • 参数

    参数名
    数据类型
    		 说明
    scale tuple(float,float,float) 变换缩放

  • 返回值

    无

AddLocalTransform

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    给局部坐标变换增加偏移量

  • 参数

    参数名
    数据类型
    		 说明
    transform Transform 坐标变换

  • 返回值

    无

AddWorldTransform

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    给世界坐标变换增加偏移量

  • 参数

    参数名
    数据类型
    		 说明
    transform Transform 坐标变换

  • 返回值

    无

GetRootParent

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    获取当前预设所在的根预设

  • 参数

    无

  • 返回值

    数据类型
    		 说明
    PresetBase 预设

GetParent

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    获取当前预设的父预设

  • 参数

    无

  • 返回值

    数据类型
    		 说明
    PresetBase 预设

SetParent

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    设置当前预设的父预设

  • 参数

    参数名
    数据类型
    		 说明
    parent PresetBase 预设

  • 返回值

    无

GetManager

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    获取当前预设所在的预设管理器

  • 参数

    无

  • 返回值

    数据类型
    		 说明
    PresetManager 预设管理

Unload

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    卸载当前预设

  • 参数

    无

  • 返回值

    无

Destroy

客户端/服务端

method in Preset.Model.TransformObject.TransformObject

  • 描述

    销毁当前预设

  • 参数

    无

  • 返回值

    无