通用设置

GetSettingInst

客户端

method in mod.client.component.neteaseWindowCompClient.NeteaseWindowCompClient

• 描述

  获取当前模组的通用设置实例

• 参数

  参数名	数据类型	说明
  modNamespace	str	组件命名空间，需唯一性，仅在开发环境预览使用

• 返回值

  数据类型	说明
  SettingInst	返回实例对象，未注册则返回None

• 备注

  • 请先使用RegisterSettingInst注册，再使用GetSettingInst获取。
  • 开发环境中，将会获取modNamespace对应的通用设置实例；正式环境中则仅能获取当前模组注册的实例。
  • 建议不要在__init__的时候就获取实例，过早获取会返回None。

• 示例

import mod.client.extraClientApi as clientApi
levelId = clientApi.GetLevelId()
comp = clientApi.GetEngineCompFactory().CreateNeteaseWindow(levelId)
settingInst = comp.GetSettingInst()
if settingInst:
    settingInst.AddText("text_uid_01", "这是一段文字").AddToggle("toggle_uid_01", "开关按钮", False, callbackFunction)

RegisterSettingInst

客户端

method in mod.client.component.neteaseWindowCompClient.NeteaseWindowCompClient

• 描述

  注册通用设置实例

• 参数

  参数名	数据类型	说明
  modNamespace	str	组件命名空间，需唯一性，仅在开发环境预览使用
  modName	str	组件名字，默认为None，仅在开发环境预览使用
  iconPath	str	组件icon图路径，默认为None，仅在开发环境预览使用

• 返回值

  数据类型	说明
  SettingInst	返回实例对象，系统未初始化则返回None

• 备注

  • 每个模组仅能注册一个通用设置实例，重复注册会返回同样的实例。
  • 建议在UiInitFinished触发时再注册，注册过早会导致注册失败而返回None。
  • 设置界面的注册是通过Scripts文件夹名称来判断是由哪个模组注册的实例，开发者的Scripts名称需要确保不与其他模组作者的Scripts名称冲突。

• 示例

import mod.client.extraClientApi as clientApi
levelId = clientApi.GetLevelId()
comp = clientApi.GetEngineCompFactory().CreateNeteaseWindow(levelId)
settingInst = comp.RegisterSettingInst("123456789", "模组1", "textures/ui/abc")
if settingInst:
    settingInst.AddText("text_uid_01", "这是一段文字").AddToggle("toggle_uid_01", "开关按钮", False, callbackFunction)