我的世界中国版 Wiki

主题

预设基类PresetBase ​

概述 ​

  • 继承关系

  • 描述

    PresetBase（预设基类）是所有预设的基类。预设是一类可以被直接放置在场景中的TransformObject（变换对象），并且预设下可以挂接其他TransformObject，可以通过这种方式对游戏逻辑进行简单的封装。在编辑器中放置预设时，会生成预设的虚拟实例，在游戏中生成预设，会生成实例。

  • 成员变量

    变量名
    数据类型
    		说明
    presetIdstr预设文件ID
    preLoadbool是否预加载
    forceLoadbool是否常加载
    childPresetInstanceslist(PresetBase)子预设列表
    childPartInstanceslist(PartBase)子零件列表
    dimensionint预设所在维度
    isAlivebool预设是否存活

索引 ​

接口
描述
GetIsAlive客户端/服务端获取预设的存活状态
GetGameObjectById客户端/服务端获取当前预设节点底下指定ID的游戏对象
GetGameObjectByEntityId客户端/服务端获取当前预设节点底下指定实体ID的游戏对象
GetChildPresets客户端/服务端获取当前预设的所有子预设
GetChildPresetsByName客户端/服务端获取指定名称的所有子预设
GetChildPresetsByType客户端/服务端获取指定类型的所有子预设
GetChildObjectByTypeName客户端/服务端获取指定实体ID的游戏对象
GetChildObjectsByTypeName客户端/服务端获取指定实体ID的游戏对象
SetBlockProtect服务端设置预设内的所有素材区域的方块保护状态
Replicate客户端/服务端在指定位置坐标下复制当前预设
RemoveChild客户端/服务端移除指定的子节点对象
AddBoxData客户端/服务端添加指定的素材数据
RemoveBoxData客户端/服务端移除指定的素材数据
AddPreset客户端/服务端添加指定预设作为子预设
RemovePreset客户端/服务端移除指定的子预设
AddPart客户端/服务端添加指定零件作为子零件
RemovePart客户端/服务端移除指定的子零件
GetPartsByName客户端/服务端获取指定名称的所有子零件
GetPartByName客户端/服务端获取指定名称的第一个子零件
GetPartsByType客户端/服务端获取指定类型的所有子零件
GetPartByType客户端/服务端获取指定类型的第一个子零件
RemovePartsByType客户端/服务端移除指定类型的所有子零件

GetIsAlive ​

客户端/服务端

method in Preset.Model.PresetBase.PresetBase

  • 描述

    获取预设的存活状态

  • 参数

    无

  • 返回值

    数据类型
    		说明
    bool是否存活

GetGameObjectById ​

客户端/服务端

method in Preset.Model.PresetBase.PresetBase

  • 描述

    获取当前预设节点底下指定ID的游戏对象

  • 参数

    参数名
    数据类型
    		说明
    idint对象ID

  • 返回值

    数据类型
    		说明
    GameObject成功返回游戏对象，失败返回None

GetGameObjectByEntityId ​

客户端/服务端

method in Preset.Model.PresetBase.PresetBase

  • 描述

    获取当前预设节点底下指定实体ID的游戏对象

  • 参数

    参数名
    数据类型
    		说明
    entityIdstr实体ID

  • 返回值

    数据类型
    		说明
    GameObject成功返回游戏对象，失败返回None

GetChildPresets ​

客户端/服务端

method in Preset.Model.PresetBase.PresetBase

  • 描述

    获取当前预设的所有子预设

  • 参数

    无

  • 返回值

    数据类型
    		说明
    list(PresetBase)子预设列表

GetChildPresetsByName ​

客户端/服务端

method in Preset.Model.PresetBase.PresetBase

  • 描述

    获取指定名称的所有子预设

  • 参数

    参数名
    数据类型
    		说明
    namestr名称
    recursivebool是否递归查找，默认为是

  • 返回值

    数据类型
    		说明
    list(PresetBase)子预设列表

GetChildPresetsByType ​

客户端/服务端

method in Preset.Model.PresetBase.PresetBase

  • 描述

    获取指定类型的所有子预设

  • 参数

    参数名
    数据类型
    		说明
    classTypestr类型
    recursivebool是否递归查找，默认为是

  • 返回值

    数据类型
    		说明
    list(PresetBase)子预设列表

GetChildObjectByTypeName ​

客户端/服务端

method in Preset.Model.PresetBase.PresetBase

  • 描述

    获取指定实体ID的游戏对象

  • 参数

    参数名
    数据类型
    		说明
    classTypestr指定类型
    namestr指定名称，可缺省

  • 返回值

    数据类型
    		说明
    TransformObject成功返回游戏对象，失败返回None

  • 示例

python
self.GetChildObjectByTypeName("PresetDebugPart")

GetChildObjectsByTypeName ​

客户端/服务端

method in Preset.Model.PresetBase.PresetBase

  • 描述

    获取指定实体ID的游戏对象

  • 参数

    参数名
    数据类型
    		说明
    classTypestr指定类型
    namestr指定名称，可缺省

  • 返回值

    数据类型
    		说明
    TransformObject成功返回游戏对象，失败返回None

  • 示例

python
self.GetChildObjectsByTypeName("PresetDebugPart")

SetBlockProtect ​

服务端

method in Preset.Model.PresetBase.PresetBase

  • 描述

    设置预设内的所有素材区域的方块保护状态

  • 参数

    参数名
    数据类型
    		说明
    protectbool保护/取消保护

  • 返回值

    无

Replicate ​

客户端/服务端

method in Preset.Model.PresetBase.PresetBase

  • 描述

    在指定位置坐标下复制当前预设

  • 参数

    参数名
    数据类型
    		说明
    postuple(float,float,float)位置坐标

  • 返回值

    数据类型
    		说明
    PresetBase返回复制的预设，失败返回None

RemoveChild ​

客户端/服务端

method in Preset.Model.PresetBase.PresetBase

  • 描述

    移除指定的子节点对象

  • 参数

    参数名
    数据类型
    		说明
    childTransformObject待移除的子对象

  • 返回值

    无

AddBoxData ​

客户端/服务端

method in Preset.Model.PresetBase.PresetBase

  • 描述

    添加指定的素材数据

  • 参数

    参数名
    数据类型
    		说明
    boxDataBoxData待添加的素材数据

  • 返回值

    无

RemoveBoxData ​

客户端/服务端

method in Preset.Model.PresetBase.PresetBase

  • 描述

    移除指定的素材数据

  • 参数

    参数名
    数据类型
    		说明
    boxDataBoxData待移除的素材数据

  • 返回值

    无

AddPreset ​

客户端/服务端

method in Preset.Model.PresetBase.PresetBase

  • 描述

    添加指定预设作为子预设

  • 参数

    参数名
    数据类型
    		说明
    presetPresetBase待添加的预设

  • 返回值

    无

RemovePreset ​

客户端/服务端

method in Preset.Model.PresetBase.PresetBase

  • 描述

    移除指定的子预设

  • 参数

    参数名
    数据类型
    		说明
    presetPresetBase待移除的子预设

  • 返回值

    无

AddPart ​

客户端/服务端

method in Preset.Model.PresetBase.PresetBase

  • 描述

    添加指定零件作为子零件

  • 参数

    参数名
    数据类型
    		说明
    partPartBase待添加的零件

  • 返回值

    无

RemovePart ​

客户端/服务端

method in Preset.Model.PresetBase.PresetBase

  • 描述

    移除指定的子零件

  • 参数

    参数名
    数据类型
    		说明
    partPartBase待移除的零件

  • 返回值

    无

GetPartsByName ​

客户端/服务端

method in Preset.Model.PresetBase.PresetBase

  • 描述

    获取指定名称的所有子零件

  • 参数

    参数名
    数据类型
    		说明
    namestr零件名称

  • 返回值

    数据类型
    		说明
    list(PartBase)零件列表

GetPartByName ​

客户端/服务端

method in Preset.Model.PresetBase.PresetBase

  • 描述

    获取指定名称的第一个子零件

  • 参数

    参数名
    数据类型
    		说明
    namestr零件名称

  • 返回值

    数据类型
    		说明
    PartBase零件/None

GetPartsByType ​

客户端/服务端

method in Preset.Model.PresetBase.PresetBase

  • 描述

    获取指定类型的所有子零件

  • 参数

    参数名
    数据类型
    		说明
    typestr零件类名

  • 返回值

    数据类型
    		说明
    list(PartBase)零件列表

GetPartByType ​

客户端/服务端

method in Preset.Model.PresetBase.PresetBase

  • 描述

    获取指定类型的第一个子零件

  • 参数

    参数名
    数据类型
    		说明
    typestr零件类名

  • 返回值

    数据类型
    		说明
    PartBase零件/None

RemovePartsByType ​

客户端/服务端

method in Preset.Model.PresetBase.PresetBase

  • 描述

    移除指定类型的所有子零件

  • 参数

    参数名
    数据类型
    		说明
    typestr零件类名

  • 返回值

    无