-
Notifications
You must be signed in to change notification settings - Fork 1
ClientEntity
Remarks
The parent class for all Minecraft data types, i.e. MinecraftServerClient.
-
↳
ClientEntity
- addAnimateScript
- addAnimation
- addGeometry
- addInitializeVariable
- addMaterials
- addPreAnimationVariable
- addPublicVariable
- addRenderController
- replacer
- serialize
- toFile
- upgradeFormatVersion
- createFilePath
- createFromTemplate
- deserialize
- fromFile
- fromPathOrTemplate
• new ClientEntity(filepath, template): ClientEntity
| Name | Type |
|---|---|
filepath |
string |
template |
IClientEntity |
ts/app/types/client/entity.ts:66
• filePath: string
• format_version: `${number}.${number}.${number}`
ts/app/types/client/entity.ts:57
• minecraft:client_entity: Object
| Name | Type |
|---|---|
description |
IClientEntityDescription |
IClientEntity.minecraft:client_entity
ts/app/types/client/entity.ts:58
• get DirectoryPath(): string
string
Remarks
The directory where this type of file is kept.
MinecraftDataType.DirectoryPath
ts/app/types/client/entity.ts:62
▸ addAnimateScript(...animations): void
| Name | Type |
|---|---|
...animations |
(string | { [key: string]: string; })[] |
void
ts/app/types/client/entity.ts:171
▸ addAnimation(...animations): void
| Name | Type |
|---|---|
...animations |
{ name: string ; reference: string }[] |
void
ts/app/types/client/entity.ts:163
▸ addGeometry(...geometry): void
| Name | Type |
|---|---|
...geometry |
{ name: string ; reference: `geometry.${string}` }[] |
void
ts/app/types/client/entity.ts:146
▸ addInitializeVariable(...variables): void
| Name | Type |
|---|---|
...variables |
string[] |
void
ts/app/types/client/entity.ts:117
▸ addMaterials(...materials): void
| Name | Type |
|---|---|
...materials |
{ name: string ; reference: string }[] |
void
ts/app/types/client/entity.ts:139
▸ addPreAnimationVariable(...variables): void
| Name | Type |
|---|---|
...variables |
string[] |
void
ts/app/types/client/entity.ts:128
▸ addPublicVariable(...variables): void
| Name | Type |
|---|---|
...variables |
string[] |
void
ts/app/types/client/entity.ts:182
▸ addRenderController(...render_controllers): void
| Name | Type |
|---|---|
...render_controllers |
MolangOption[] |
void
ts/app/types/client/entity.ts:153
▸ 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(handleExisting?): File
| 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. |
A File object with this MinecraftDataType's filepath, and this object serialized as the file contents.
Remarks
Creates a File object from this MinecraftDataType.
▸ upgradeFormatVersion(): void
void
ts/app/types/client/entity.ts:100
▸ createFilePath(nameData): string
| Name | Type | Description |
|---|---|---|
nameData |
NameData |
The namedata to use when creating the filepath. |
string
The filepath as a string.
Remarks
Creates a filepath for this object type from a NameData.
MinecraftDataType.createFilePath
ts/app/types/client/entity.ts:96
▸ createFromTemplate(nameData): ClientEntity
| Name | Type | Description |
|---|---|---|
nameData |
NameData |
The namedata to use for identifiers and the filepath. |
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/entity.ts:72
▸ 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.
▸ 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.