DynamicOps - Revision history

ChampionAsh5357: Update to 1.17

2021-08-02T19:32:39Z

Update to 1.17

Tslat: /* Format Conversion */

2021-01-19T08:21:23Z

Format Conversion

Commoble: Expand and rewrite; emphasize relationship between dynamicops and codecs

2021-01-04T17:56:04Z

Expand and rewrite; emphasize relationship between dynamicops and codecs

Unbekannt: Corret Link

2020-12-19T09:07:48Z

Corret Link

Unbekannt: Inital Import dokuwiki

2020-10-25T11:14:31Z

Inital Import dokuwiki

New page

<code>DynamicOps</code> is a helper interface that's used to convert files into data types and vice versa. Their usages will probably never be explored by most modders. They are overshadowed by [[latest:advanced:handle:codecs|codecs]].

== <code>NBTDynamicOps</code> ==

<code>NBTDynamicOps</code> is a handler that converts an NBT file to an <code>INBT</code> tag. They are also used to parse information from codecs to send them across networks.

There is only one public instance of <code>NBTDynamicOps</code>: <code>INSTANCE</code>.

== <code>JsonOps</code> ==

<code>JsonOps</code> are similar in which they convert a JSON file into a <code>JsonElement</code>. These are usually used in conjunction with codecs as well to serialize/deserialize instances.

There are two public instances of <code>JsonOps</code>: <code>INSTANCE</code> and <code>COMPRESSED</code>. Compressed data is represented as a single string to read/write. However, this is never used within vanilla itself.

@@ Line 11: / Line 11: @@
 There are two public instances of JsonOps: <code>JsonOps.INSTANCE</code> and <code>JsonOps.COMPRESSED</code>. Compressed data is represented as a single string to read/write. However, this is never used within vanilla itself.
-== NBTDynamicOps ==
+== NbtOps ==
-The <code>NBTDynamicOps.INSTANCE</code> is an instance of <code>DynamicOps<INBT></code>, meaning it is used to convert java objects to and from <code>INBT</code> instances. This can be used for serializing data into packets to send across networks, as well as serializing persistant data for entities and similar objects.
+The <code>NbtOps.INSTANCE</code> is an instance of <code>DynamicOps<Tag></code>, meaning it is used to convert java objects to and from <code>Tag</code> instances. This can be used for serializing data into packets to send across networks, as well as serializing persistent data for entities and similar objects.
-There is only one public instance of NBTDynamicOps: <code>NBTDynamicOps.INSTANCE</code>.
+There is only one public instance of NbtOps: <code>NbtOps.INSTANCE</code>.
 = Using DynamicOps =
@@ Line 25: / Line 25: @@
 == Format Conversion ==
-By using the <code>DynamicOps#convertTo</code> instance method with a second DynamicOps instance, data can be converted between two different serialized formats, such as JsonElement to INBT and back.
+By using the <code>DynamicOps#convertTo</code> instance method with a second DynamicOps instance, data can be converted between two different serialized formats, such as JsonElement to Tag and back.
 <syntaxhighlight lang=java>
-// converting INBT to JsonElement
+// converting Tag to JsonElement
-JsonElement someJsonElement = NBTDynamicOps.INSTANCE.convertTo(JsonOps.INSTANCE, someNBT);
+JsonElement someJsonElement = NbtOps.INSTANCE.convertTo(JsonOps.INSTANCE, someTag);
-// converting JsonElement to INBT
+// converting JsonElement to Tag
-INBT someNBT = JsonOps.INSTANCE.convertTo(NBTDynamicOps.INSTANCE, someJsonElement);
+Tag someTag = JsonOps.INSTANCE.convertTo(NbtOps.INSTANCE, someJsonElement);
 </syntaxhighlight>
 Depending on the implementation of the DynamicOps used, this may throw an exception or return an empty object if the two formats are incompatible.
-In particular, it is '''not''' safe to convert lists of numbers to NBT in this manner, due to the NBT format's strong typing and the way the NBTDynamicOps attempts to create lists of numbers.
+In particular, it is '''not''' safe to convert lists of numbers to NBT in this manner, due to the NBT format's strong typing and the way the NbtOps attempts to create lists of numbers.
 = External Links =
 * [https://kvverti.github.io/Documented-DataFixerUpper/snapshot/com/mojang/serialization/DynamicOps.html DynamicOps unofficial javadocs]

@@ Line 37: / Line 37: @@
 Depending on the implementation of the DynamicOps used, this may throw an exception or return an empty object if the two formats are incompatible.
-In particular, it is *not* safe to convert lists of numbers to NBT in this manner, due to the NBT format's strong typing and the way the NBTDynamicOps attempts to create lists of numbers.
+In particular, it is '''not''' safe to convert lists of numbers to NBT in this manner, due to the NBT format's strong typing and the way the NBTDynamicOps attempts to create lists of numbers.
 = External Links =
 * [https://kvverti.github.io/Documented-DataFixerUpper/snapshot/com/mojang/serialization/DynamicOps.html DynamicOps unofficial javadocs]

@@ Line 1: / Line 1: @@
-<code>DynamicOps</code> is a helper interface that's used to convert files into data types and vice versa. Their usages will probably never be explored by most modders. They are overshadowed by [[codecs]].
+The <code>DynamicOps</code> class is part of mojang's DataFixerUpper serialization library; DynamicOps are used alongside [[codecs]] to convert java objects to a serialized format and back. While Codecs describe how a java object is to be serialized, DynamicOps describe the format the object is to be serialized to.
-== <code>NBTDynamicOps</code> ==
+The DataFixerUpper library includes several DynamicOps for serializing to json; vanilla minecraft also includes a DynamicOps for serializing to minecraft's [[Using_NBT|NBT]] format.
-<code>NBTDynamicOps</code> is a handler that converts an NBT file to an <code>INBT</code> tag. They are also used to parse information from codecs to send them across networks.
+= Builtin DynamicOps =
-There is only one public instance of <code>NBTDynamicOps</code>: <code>INSTANCE</code>.
+== JsonOps ==
-== <code>JsonOps</code> ==
+The <code>JsonOps</code> DynamicOps are used to serialize and deserialize json data. These are instances of <code>DynamicOps<JsonElement></code>, meaning that they are used to convert java objects to and from <code>JsonElement</code> instances. These can used in conjunction with codecs to serialize/deserialize objects from assets and datapacks.
-<code>JsonOps</code> are similar in which they convert a JSON file into a <code>JsonElement</code>. These are usually used in conjunction with codecs as well to serialize/deserialize instances.
+There are two public instances of JsonOps: <code>JsonOps.INSTANCE</code> and <code>JsonOps.COMPRESSED</code>. Compressed data is represented as a single string to read/write. However, this is never used within vanilla itself.
-There are two public instances of <code>JsonOps</code>: <code>INSTANCE</code> and <code>COMPRESSED</code>. Compressed data is represented as a single string to read/write. However, this is never used within vanilla itself.
+== NBTDynamicOps ==

← Older revision		Revision as of 09:07, 19 December 2020
Line 1:		Line 1:
−	<code>DynamicOps</code> is a helper interface that's used to convert files into data types and vice versa. Their usages will probably never be explored by most modders. They are overshadowed by [[~~latest:advanced:handle:codecs\|~~codecs]].	+	<code>DynamicOps</code> is a helper interface that's used to convert files into data types and vice versa. Their usages will probably never be explored by most modders. They are overshadowed by [[codecs]].

	== <code>NBTDynamicOps</code> ==		== <code>NBTDynamicOps</code> ==