prismarine schematic

prismarine-schéma

Lire, écrire et manipuler des schémas Minecraft.

Formats pris en charge :

• Éponge (lecture/écriture)
• MCEdit (lecture seule)

Usage

 const fs = require ( 'fs' ) . promises
const { Schematic } = require ( 'prismarine-schematic' )

async function main ( ) {
  // Read a schematic (sponge or mcedit format)
  const schematic = await Schematic . read ( await fs . readFile ( 'test/schematics/smallhouse1.schem' ) )

  // Write a schematic (sponge format)
  await fs . writeFile ( 'test.schem' , await schematic . write ( ) )
}

main ( ) 

API

Schématique

Une instance schématique.

• version : la version mc de ce schéma
• size : vec3, la taille en blocs
• offset : vec3, décalage de 0
• palette : liste des stateIds pour la palette de ce schéma
• blocs : indices dans la palette pour chaque bloc dans l'ordre y, z, x

Schéma.start()

Renvoie la coordonnée de départ de ce schéma.

Schéma.end()

Renvoie la coordonnée de fin de ce schéma.

Schéma.forEach(cb)

appelle le rappel sur chaque bloc du schéma. le rappel est appelé avec args (block, pos) .

Schéma.map(cb)

renvoie un tableau des résultats de l'appel du rappel sur chaque bloc du schéma. le rappel est appelé avec args (block, pos) .

Schematic.makeWithCommands(offset, platform = 'pc')

• platform est un paramètre facultatif. Il peut s'agir pc (par défaut) ou pe pour tenir compte d'un style de commande différent entre Java et Pocket Edition.

renvoie un tableau de commandes à exécuter pour créer le schéma sur un serveur Vanilla. le décalage est une instance vec3 qui est appliquée par .offset sur chaque bloc du schéma.

• Dans la version 1.13+, il y a des états de bloc sous forme de tableau dans les commandes

• Dans la version 1.11+, il y a des états de bloc sous forme de métadonnées sous forme de nombre dans les commandes

• Dans <1.11, il n'y a pas d'état de bloc, juste le bloc dans les commandes

Schéma.getBlockStateId(pos)

Obtenez le stateId du bloc à pos . pos doit être compris entre start() et end() .

Schéma.getBlock(pos)

Obtenez le bloc à pos . pos doit être compris entre start() et end() .

Schematic.setBlock(pos, bloc)

Définissez un bloc en pos sur un bloc d'instance de bloc (voir prismarine-block). Si le bloc n'est pas donné ou est nul, setBlock supprime le bloc en pos .

Schematic.copy (monde, début, fin, décalage, version)

Statique, asynchrone. Créez une instance schématique à partir world (prismarine-world) entre start et end (vec3), offset sera le décalage du schéma, version doit correspondre à la version du world .

Schéma.paste(monde, à)

Asynchrone. Collez le schéma dans world (prismarine-world) à at emplacement (vec3).

Schematic.read (tampon, version = null)

Statique, asynchrone. Renvoie une instance Schematic, lue à partir du tampon. Si la version n'est pas définie, le chargeur essaie de détecter automatiquement la version du fichier.

Schéma.write()

Asynchrone. Renvoie un tampon codant pour ce schéma

Schéma.toJSON (espace ?)

Renvoie une représentation string à partir du schéma. space représente l'option space pour JSON.stringify() .

Schéma.fromJSON()

Renvoie une nouvelle instance Schematic en analysant un schéma stringifié. Renvoie null en cas d'erreur.