ParamDefinition.md

sapi-pro

---

sapi-pro / ParamDefinition

Interface: ParamDefinition

Extends

• ParamObject

Properties

branches?

optional branches?: paramBranches[]

参数分支

Inherited from

ParamObject.branches

---

default?

optional default?: parsedTypes

默认值

Inherited from

ParamObject.default

---

enums?

optional enums?: string[]

枚举值

Inherited from

ParamObject.enums

---

explain?

optional explain?: string

参数解释

Inherited from

ParamObject.explain

---

name

name: string

参数名

Inherited from

ParamObject.name

---

optional?

optional optional?: boolean

是否可选，默认否

Inherited from

ParamObject.optional

---

subParams?

optional subParams?: ParamDefinition[]

---

type

type: "string" | "boolean" | "float" | "position" | "target" | "flag" | "enum" | "int" | "itemType" | "blockType" | "player" | "entity" | "entityType"

参数类型

Inherited from

ParamObject.type

---

validator?

optional validator?: ParamValidator

参数验证器

Inherited from

ParamObject.validator