ClientGeometryAttachable - DauntlessStudio/Bedrock-Developments GitHub Wiki

Class: ClientGeometryAttachable

Remarks

The parent class for all Minecraft data types, i.e. MinecraftServerClient.

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new ClientGeometryAttachable(filepath, template): ClientGeometryAttachable

Parameters

Name Type
filepath string
template IClientGeometry

Returns

ClientGeometryAttachable

Inherited from

ClientGeometry.constructor

Defined in

ts/app/types/client/geometry.ts:86

Properties

filePath

filePath: string

Inherited from

ClientGeometry.filePath

Defined in

ts/app/types/minecraft.ts:23


format_version

format_version: `${number}.${number}.${number}`

Inherited from

ClientGeometry.format_version

Defined in

ts/app/types/client/geometry.ts:78


minecraft:geometry

Optional minecraft:geometry: IClientGeometryNew[]

Inherited from

ClientGeometry.minecraft:geometry

Defined in

ts/app/types/client/geometry.ts:79

Accessors

DirectoryPath

get DirectoryPath(): string

Returns

string

Remarks

The directory where this type of file is kept.

Overrides

ClientGeometry.DirectoryPath

Defined in

ts/app/types/client/geometry.ts:137

Methods

replacer

replacer(key, value): any

Parameters

Name Type
key string
value any

Returns

any

Inherited from

ClientGeometry.replacer

Defined in

ts/app/types/minecraft.ts:72


serialize

serialize(): string

Returns

string

A string representation of this object.

Remarks

Serializes this object to a string.

Inherited from

ClientGeometry.serialize

Defined in

ts/app/types/minecraft.ts:63


toFile

toFile(handleExisting?): File

Parameters

Name Type Description
handleExisting? "overwrite" | "overwrite_silent" How to handle existing files. Undefined will not overwrite, 'overwite' replaces the file with this object, 'overwrite_silent' does the same with no terminal log.

Returns

File

A File object with this MinecraftDataType's filepath, and this object serialized as the file contents.

Remarks

Creates a File object from this MinecraftDataType.

Inherited from

ClientGeometry.toFile

Defined in

ts/app/types/minecraft.ts:98


createFilePath

createFilePath(nameData): string

Parameters

Name Type Description
nameData NameData The namedata to use when creating the filepath.

Returns

string

The filepath as a string.

Remarks

Creates a filepath for this object type from a NameData.

Overrides

ClientGeometry.createFilePath

Defined in

ts/app/types/client/geometry.ts:261


createFromTemplate

createFromTemplate(nameData): ClientGeometry

Parameters

Name Type Description
nameData NameData The namedata to use for identifiers and the filepath.

Returns

ClientGeometry

An instance of this data type.

Remarks

Creates a new instance of the data type using reasonable defaults from a NameData.

Overrides

ClientGeometry.createFromTemplate

Defined in

ts/app/types/client/geometry.ts:141


deserialize

deserialize<T>(create, filepath, json): T

Type parameters

Name
T

Parameters

Name Type Description
create (filePath: string, template: any) => T The child of MinecraftDataType to create.
filepath string The filepath the MinecraftDataType can be written to with toFile.
json string The source string this should be deserialized from.

Returns

T

An instance of the MinecraftDataType child provided.

Remarks

Creates an instace of a MinecraftDataType child from a source string, used in fromFile.

Inherited from

ClientGeometry.deserialize

Defined in

ts/app/types/minecraft.ts:83


fromFile

fromFile<T>(create, file): T

Type parameters

Name
T

Parameters

Name Type Description
create (filePath: string, template: any) => T The child of MinecraftDataType to create.
file File The File object used to deserialize into this object.

Returns

T

An instance of the MinecraftDataType child provided.

Remarks

Crates an instance of a MinecraftDataTypeChild from a File.

Inherited from

ClientGeometry.fromFile

Defined in

ts/app/types/minecraft.ts:108


fromPathOrTemplate

fromPathOrTemplate<T>(create, path): T

Type parameters

Name
T

Parameters

Name Type Description
create (filePath: string, template: any) => T The child of MinecraftDataType to create.
path string The filepath to create the object from.

Returns

T

The deserialized file as a child of MinecraftDataType, or this object's createFromTemplate default if the file doesn't exist.

Remarks

Creates a MinecraftDataType object from a filepath, or a template if that filepath doesn't exist.

Inherited from

ClientGeometry.fromPathOrTemplate

Defined in

ts/app/types/minecraft.ts:118

⚠️ **GitHub.com Fallback** ⚠️