cve-connector/types/controllers/polymesh.d.ts

UE Web 开发套件

import type { PolymeshData, PolymeshStyle } from '../features/polymesh'
import type { Selector } from '../features/query'
import type { UIDescriptor } from '../utils/matchmaker'

export type PolymeshCommand =
  | 'AddPolymeshTag'
  | 'CreatePolymesh'
  | 'DeletePolymesh'
  | 'HidePolymesh'
  | 'RemovePolymeshTag'
  | 'RemovePolymeshAllTags'
  | 'SelectPolymesh'
  | 'ShowPolymesh'
  | 'UpdatePolymesh'
  | 'UnselectPolymesh'

/** Polymesh 控制 */
export interface PolymeshController {
  /** 为 Polymesh 添加Tag */
  addTag: (params: Selector, key: string, val: string) => Promise<UIDescriptor>

  /** 生成 Polymesh */
  create: (polymeshes: PolymeshData<PolymeshStyle>[]) => Promise<UIDescriptor>

  /** 删除指定的 Polymesh */
  delete: (params: Selector) => Promise<UIDescriptor>

  /** 隐藏指定的 Polymesh */
  hide: (params: Selector) => Promise<UIDescriptor>

  /** 移除 Polymesh 的Tag */
  removeTag: (params: Selector, key: string) => Promise<UIDescriptor>

  /** 移除 Polymesh 的所有Tag */
  removeAllTags: (params: Selector) => Promise<UIDescriptor>

  /** 选择指定的 Polymesh */
  select: (params: Selector) => Promise<UIDescriptor>

  /** 显示指定的 Polymesh */
  show: (params: Selector) => Promise<UIDescriptor>

  /** 取消选择的 Polymesh */
  unselect: () => Promise<UIDescriptor>
  
  /** 更新 Polymesh 的补充参数 */
  update: (polymeshes: PolymeshData<PolymeshStyle>[]) => Promise<UIDescriptor>
}

export declare const PolymeshController: PolymeshController