mdkjs

Index

Namespaces

Interfaces

Variables

Text

Type aliases

Callback

Callback<D>: (context: File<{}>) => D

Type parameters

D: DataObject

Type declaration

- (context: File<{}>): D
- Parameters
  - context: File<{}>
  Returns D

CommandType

Criteria

Criteria: SingleCriteria | TeamKillCriteria | KilledByTeamCriteria | CustomCriteria

DataObject

DataObject: Record<string, unknown>

FileType

FileType: "functions" | "predicates" | "loottables" | "tags"

FilenameType

FilenameType: `${TagFileType}/${string}`

LiteralFuncType

LiteralFuncType: string | ((context: { filename: string; namespace: string }) => string)

LiteralType

LiteralType<T>: string | T

Type parameters

LiteralUnion

LiteralUnion<T, U>: T | (U & {})

Type parameters

T: U
U

ObjectMap

ObjectMap<T>: {}

Type parameters

Type declaration

[prop: string]: T

ObjectiveProps

ObjectiveProps: { criterion: Criteria; displayName?: string; name: string }

Type declaration

criterion: Criteria
Optional displayName?: string
name: string

OperationType

OperationType: "+=" | "-=" | "*=" | "/=" | "%=" | ">" | "<" | "><" | "="

RecipeItem

RecipeItem: { item: ItemId } | { tag: string } | { item: ItemId }[]

RecipeItemArray

RecipeItemArray: { item: ItemId }[]

RecipeResult

RecipeResult: { count?: number; item: ItemId }

Type declaration

Optional count?: number
item: ItemId

RecipeType

SingleArrayResult

SingleArrayResult<T>: T | T[]

Type parameters

SmeltingType

SmeltingType: "smelting" | "blasting" | "smoking" | "campfire_cooking"

TagFileType

TagFileType: "blocks" | "entity_types" | "items" | "fluids" | "functions"

Text

Text: TextTokenType & TextFunction & { create: any }

Variables

Text

Text: Text

Functions

ArgumentExpection

ArgumentExpection(...message: string[]): Error

- Defined in mdk-core/src/tools/expection/NormalExpection.ts:2
参数错误

Parameters
- Rest ...message: string[]
Returns Error

ContainerExpection

ContainerExpection(...message: string[]): Error

- Defined in mdk-core/src/tools/expection/NormalExpection.ts:10
容器错误

Parameters
- Rest ...message: string[]
Returns Error

FieldExpection

FieldExpection(...message: string[]): Error

- Defined in mdk-core/src/tools/expection/NormalExpection.ts:6
字段错误

Parameters
- Rest ...message: string[]
Returns Error

GsonStringify

GsonStringify(object: any, key?: string): any

- Defined in mdk-core/src/utils/format/GsonStringify/index.ts:22
Parameters
- object: any
- Optional key: string
Returns any

SceneExpection

SceneExpection(...message: string[]): Error

- Defined in mdk-core/src/tools/expection/NormalExpection.ts:14
使用场景错误

Parameters
- Rest ...message: string[]
Returns Error

addAffix

addAffix(raw: string, char?: string): string

- Defined in mdk-core/src/utils/format/string.ts:17
Parameters
- raw: string
- char: string = ','
Returns string

area

area(from: Location, to: Location): Area

- Defined in mdk-core/src/lib/Area.ts:4
Parameters
- from: Location
- to: Location
Returns Area

composition

composition(value: ComplexNbt, key?: string): string

- Defined in mdk-core/src/utils/format/NbtStringify/index.ts:40
Parameters
- value: ComplexNbt
- Optional key: string
Returns string

createEntity

createEntity(nbt: Entity): NbtEntity<Entity>

- Defined in mdk-core/src/core/nbt/entity.ts:32
Parameters
- nbt: Entity
Returns NbtEntity<Entity>

createEntityBlock

createEntityBlock(nbt: BlockEntity): NbtEntityBlock<BlockEntity>

- Defined in mdk-core/src/core/nbt/block.ts:10
Parameters
- nbt: BlockEntity
Returns NbtEntityBlock<BlockEntity>

createItem

createItem(nbt: Item): NbtItem<Item>

- Defined in mdk-core/src/core/nbt/item.ts:10
Parameters
- nbt: Item
Returns NbtItem<Item>

eatChar

eatChar(raw: string): string
eatChar(raw: string, char: string): string
eatChar(raw: string, reg: RegExp): string

- Defined in mdk-core/src/utils/format/string.ts:25
删除尾部字符

Parameters
- raw: string
  
  元字符串
Returns string
- Defined in mdk-core/src/utils/format/string.ts:31
删除尾部字符

Parameters
- raw: string
  
  元字符串
- char: string
  
  处理的字符
Returns string
- Defined in mdk-core/src/utils/format/string.ts:37
删除尾部字符

Parameters
- raw: string
  
  元字符串
- reg: RegExp
  
  处理字符的正则
Returns string

emit

emit(event: "init", ctx: any): void

- Defined in mdk-core/src/core/plugin.ts:14
Parameters
- event: "init"
- ctx: any
Returns void

escape

escape(raw: string): string

- Defined in mdk-core/src/utils/format/string.ts:5
转义

Parameters
- raw: string
  
  原始字符串
Returns string

formatMCParams

formatMCParams(params: IMCParams): string

- Defined in mdk-core/src/utils/format/object.ts:21
格式化mc参数

Parameters
- params: IMCParams
  
  mc参数
Returns string

formatScoreRange

formatScoreRange(range: ScoreRange): string

- Defined in mdk-core/src/utils/format/object.ts:46
格式化分数区间，例如 ..10

Parameters
- range: ScoreRange
  
  分数区间
Returns string

getPlatform

getPlatform(): "web" | "worker" | "node" | "unknown"

- Defined in mdk-core/src/utils/getPlatform.ts:1
Returns "web" | "worker" | "node" | "unknown"

getRandomStr

getRandomStr(): string

- Defined in mdk-core/src/utils/random.ts:4
获取随机字符串

Returns string

isValidDeclareName

isValidDeclareName(filename: string): boolean

- Defined in mdk-core/src/utils/rules.ts:26
命名时名称只识别小写英文字母、数字、- _ / . 如：sys:foo/bar

Parameters
- filename: string
  
  文件名
Returns boolean

isValidPathName

isValidPathName(filename: string): boolean

- Defined in mdk-core/src/utils/rules.ts:19
命名时名称只识别小写英文字母、数字、-和_ /

Parameters
- filename: string
  
  文件名
Returns boolean

isValidSpacename

isValidSpacename(filename: string): boolean

- Defined in mdk-core/src/utils/rules.ts:5
命名空间只识别小写英文字母、数字、-、_和.

Parameters
- filename: string
  
  文件名
Returns boolean

isValidSystemFileChar

isValidSystemFileChar(filename: string): boolean

- Defined in mdk-core/src/utils/rules.ts:12
不能包含 < > ? : * | / \

Parameters
- filename: string
  
  文件名
Returns boolean

location

location(): Location
location(text: string): Location
location(xyz: number): Location
location(x: number, y: number, z: number): Location

- Defined in mdk-core/src/lib/Location.ts:18
Returns Location
- Defined in mdk-core/src/lib/Location.ts:19
Parameters
- text: string
Returns Location
- Defined in mdk-core/src/lib/Location.ts:20
Parameters
- xyz: number
Returns Location
- Defined in mdk-core/src/lib/Location.ts:21
Parameters
- x: number
- y: number
- z: number
Returns Location

on

on(event: "init", handle: PluginHandle): void

- Defined in mdk-core/src/core/plugin.ts:21
Parameters
- event: "init"
- handle: PluginHandle
Returns void

popFile

popFile(): void

- Defined in mdk-core/src/hooks/useFile.ts:13
Returns void

pushFile

pushFile(file: FileAbstract<any>): void

- Defined in mdk-core/src/hooks/useFile.ts:9
缓存file对象

Parameters
- file: FileAbstract<any>
Returns void

revise

revise(str: string): string

- Defined in mdk-core/src/utils/format/string.ts:73
修正指令字符串

Parameters
- str: string
Returns string

rotation

rotation(): Rotation
rotation(text: string): Rotation
rotation(x: number, y: number): Rotation

- Defined in mdk-core/src/lib/Rotation.ts:11
Returns Rotation
- Defined in mdk-core/src/lib/Rotation.ts:12
Parameters
- text: string
Returns Rotation
- Defined in mdk-core/src/lib/Rotation.ts:13
Parameters
- x: number
- y: number
Returns Rotation

selector

selector(): Selector
selector(name: string): Selector
selector(selector: SelectorProps): Selector

- Defined in mdk-core/src/core/Selector.ts:10
Returns Selector
- Defined in mdk-core/src/core/Selector.ts:11
Parameters
- name: string
Returns Selector
- Defined in mdk-core/src/core/Selector.ts:12
Parameters
- selector: SelectorProps
Returns Selector

setPack

setPack(pack: Pack): void

- Defined in mdk-core/src/hooks/usePack.ts:9
设置当前pack对象

Parameters
- pack: Pack
Returns void

toHump

toHump(str: string): string

- Defined in mdk-core/src/utils/format/string.ts:48
下划线转换驼峰

Parameters
- str: string
Returns string

toJson

toJson(object: any): any

- Defined in mdk-core/src/utils/format/object.ts:3
Parameters
- object: any
Returns any

toLine

toLine(name: string): string

- Defined in mdk-core/src/utils/format/string.ts:61
驼峰转换下划线

Parameters
- name: string
Returns string

toLink

toLink(name: string): string

- Defined in mdk-core/src/utils/format/string.ts:67
驼峰转换连接符

Parameters
- name: string
Returns string

toPascal

toPascal(str: string): string

- Defined in mdk-core/src/utils/format/string.ts:54
下划线转换大驼峰

Parameters
- str: string
Returns string

unescape

unescape(raw: string): string

- Defined in mdk-core/src/utils/format/string.ts:12
反转义

Parameters
- raw: string
  
  原始字符串
Returns string

use

use(pluginFunc: PluginFunc, ...args: any[]): void

- Defined in mdk-core/src/core/plugin.ts:8
Parameters
- pluginFunc: PluginFunc
- Rest ...args: any[]
Returns void

useCommand

useCommand(target?: Selector): Command

- Defined in mdk-core/src/hooks/useCommand.ts:4
Parameters
- target: Selector = ...
Returns Command

useFile

useFile(): FileAbstract<any>

- Defined in mdk-core/src/hooks/useFile.ts:20
获取当前file对象

Returns FileAbstract<any>

usePack

usePack(): Pack

- Defined in mdk-core/src/hooks/usePack.ts:16
获取当前pack对象

Returns Pack

useScope

useScope(name: string): string

- Defined in mdk-core/src/hooks/useScope.ts:4
Parameters
- name: string
Returns string

validPathName

validPathName(filename: string): void

- Defined in mdk-core/src/tools/valid.ts:4
Parameters
- filename: string
Returns void

versionCompare

versionCompare(v1: string, v2: string): 0 | 1 | -1

- Defined in mdk-core/src/utils/version.ts:7
Parameters
- v1: string
- v2: string
Returns 0 | 1 | -1

warn

warn(...msg: string[]): void

- Defined in mdk-core/src/tools/expection/warning.ts:1
Parameters
- Rest ...msg: string[]
Returns void

wrapScope

wrapScope(tagname: string, scope: string | boolean): string

- Defined in mdk-core/src/tools/wrapScope.ts:1
Parameters
- tagname: string
- scope: string | boolean
Returns string

Index

Namespaces

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

Callback

Type parameters

D: DataObject

Type declaration

Parameters

context: File<{}>

Returns D

CommandType

Criteria

DataObject

FileType

FilenameType

LiteralFuncType

LiteralType

Type parameters

T

LiteralUnion

Type parameters

T: U

U

ObjectMap

Type parameters

T

Type declaration

[prop: string]: T

ObjectiveProps

Type declaration

criterion: Criteria

Optional displayName?: string

name: string

OperationType

PredicateItemMap

PredicateMap

Type parameters

D: DataObject

RecipeItem

RecipeItemArray

RecipeResult

Type declaration

Optional count?: number

item: ItemId

RecipeType

SingleArrayResult

Type parameters

T

SmeltingType

TagFileType

Text

Variables

Text

Functions

ArgumentExpection

Parameters

Rest ...message: string[]

Returns Error

ContainerExpection

Parameters

Rest ...message: string[]

Returns Error

FieldExpection

Parameters

Rest ...message: string[]

Returns Error

GsonStringify

Parameters

object: any

Optional key: string

Returns any

SceneExpection

Parameters

Rest ...message: string[]

Returns Error