Class File<D>

File类用于生成.mcfunction文件

Type parameters

D: DataObject = {}

Hierarchy

FileAbstract<D>
- File

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new File<D>(options: FileOptions<D>): File<D>

Overrides FileAbstract.constructor
- Defined in mdk-core/src/core/file/function/File.ts:30
Type parameters
- D: DataObject = {}
Parameters
- options: FileOptions<D>
Returns File<D>

Properties

Private #data

#data: D = null

Private Readonly #list

#list: LineInfo<unknown>[] = []

Private Readonly #options

#options: FileAbstractOptions<D>

Private #tag

#tag: string = ''

Private #tagNamespace

#tagNamespace: string = ''

context

context: Pack = null

Accessors

Protected data

get data(): D

- Defined in mdk-core/src/core/file/FileAbstract.ts:84
获取自定义数据

Returns D

description

get description(): string

- Defined in mdk-core/src/core/file/FileAbstract.ts:87
获取描述信息

Returns string

filename

get filename(): string

- Defined in mdk-core/src/core/file/FileAbstract.ts:62
获取文件名

Returns string

fullname

get fullname(): string

- Defined in mdk-core/src/core/file/FileAbstract.ts:127
获取全路径

Returns string

list

get list(): LineInfo<unknown>[]

- Defined in mdk-core/src/core/file/function/File.ts:43
file对象中的内容

Returns LineInfo<unknown>[]

namespace

get namespace(): string

- Defined in mdk-core/src/core/file/FileAbstract.ts:65
获取命名空间

Returns string

tag

get tag(): string

- Defined in mdk-core/src/core/file/function/File.ts:46
tag路径

Returns string

tagNamespace

get tagNamespace(): string

- Defined in mdk-core/src/core/file/function/File.ts:49
tag的命名空间

Returns string

type

get type(): FileType | "recipes"

- Defined in mdk-core/src/core/file/FileAbstract.ts:81
获取类型

Returns FileType | "recipes"

Methods

add

add(value: string | FileAbstract<D> | LineInfo<unknown>): void

Overrides FileAbstract.add
- Defined in mdk-core/src/core/file/function/File.ts:73
添加内容

Parameters
- value: string | FileAbstract<D> | LineInfo<unknown>
  
  内容
Returns void

addComment

addComment(value: string | string[]): void

- Defined in mdk-core/src/core/file/function/File.ts:54
添加注释

Parameters
- value: string | string[]
Returns void

create

create(dir: string): FileInfo

Overrides FileAbstract.create
- Defined in mdk-core/src/core/file/function/File.ts:117
生成文件信息

Parameters
- dir: string
Returns FileInfo

getData

getData(cached?: boolean): D

Overrides FileAbstract.getData
- Defined in mdk-core/src/core/file/function/File.ts:112
获取接口数据

Parameters
- cached: boolean = true
Returns D

load

load(cached?: boolean): boolean

Overrides FileAbstract.load
- Defined in mdk-core/src/core/file/function/File.ts:87
加载数据

Parameters
- cached: boolean = true
Returns boolean
返回true表示首次加载

toJson

toJson(): LineInfo<unknown>

Overrides FileAbstract.toJson
- Defined in mdk-core/src/core/file/function/File.ts:126
Returns LineInfo<unknown>

toString

toString(): string

- Defined in mdk-core/src/core/file/function/File.ts:135
Returns string

Generated using TypeDoc