ClientItemTexture - DauntlessStudio/Bedrock-Developments GitHub Wiki
Remarks
The parent class for all Minecraft data types, i.e. MinecraftServerClient.
-
↳
ClientItemTexture
- addTexture
- replacer
- serialize
- toFile
- createFilePath
- createFromTemplate
- deserialize
- fileWithAddedTextures
- fromFile
- fromPathOrTemplate
• new ClientItemTexture(filepath, template): ClientItemTexture
| Name | Type |
|---|---|
filepath |
string |
template |
IClientItemTexture |
ts/app/types/client/item_texture.ts:28
• filePath: string
• resource_pack_name: "vanilla"
IClientItemTexture.resource_pack_name
ts/app/types/client/item_texture.ts:16
• texture_data: Object
▪ [key: string]: { textures: string }
IClientItemTexture.texture_data
ts/app/types/client/item_texture.ts:18
• texture_name: "atlas.items"
IClientItemTexture.texture_name
ts/app/types/client/item_texture.ts:17
• get DirectoryPath(): string
string
Remarks
The directory where this type of file is kept.
MinecraftDataType.DirectoryPath
ts/app/types/client/item_texture.ts:24
▸ addTexture(name, textures): void
| Name | Type |
|---|---|
name |
string |
textures |
string |
void
ts/app/types/client/item_texture.ts:57
▸ replacer(key, value): any
| Name | Type |
|---|---|
key |
string |
value |
any |
any
▸ serialize(): string
string
A string representation of this object.
Remarks
Serializes this object to a string.
▸ toFile(): 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.
ts/app/types/client/item_texture.ts:53
▸ createFilePath(): string
string
The filepath as a string.
Remarks
Creates a filepath for this object type from a NameData.
MinecraftDataType.createFilePath
ts/app/types/client/item_texture.ts:35
▸ createFromTemplate(): ClientItemTexture
An instance of this data type.
Remarks
Creates a new instance of the data type using reasonable defaults from a NameData.
MinecraftDataType.createFromTemplate
ts/app/types/client/item_texture.ts:39
▸ deserialize<T>(create, filepath, json): T
| Name |
|---|
T |
| 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. |
T
An instance of the MinecraftDataType child provided.
Remarks
Creates an instace of a MinecraftDataType child from a source string, used in fromFile.
▸ fileWithAddedTextures(...data): File
| Name | Type |
|---|---|
...data |
{ name: string ; texture: string }[] |
ts/app/types/client/item_texture.ts:47
▸ fromFile<T>(create, file): T
| Name |
|---|
T |
| 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. |
T
An instance of the MinecraftDataType child provided.
Remarks
Crates an instance of a MinecraftDataTypeChild from a File.
▸ fromPathOrTemplate<T>(create, path): T
| Name |
|---|
T |
| Name | Type | Description |
|---|---|---|
create |
(filePath: string, template: any) => T
|
The child of MinecraftDataType to create. |
path |
string |
The filepath to create the object from. |
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.