99
1010/**
1111 * Represents a DataValue in 1.19.3+.
12+ * Use {@link WrappedWatchableObject} before 1.19.3.
1213 */
1314public class WrappedDataValue extends AbstractWrapper {
1415
@@ -29,10 +30,28 @@ public WrappedDataValue(Object handle) {
2930 this .modifier = new StructureModifier <>(this .handleType ).withTarget (handle );
3031 }
3132
33+ /**
34+ * Creates a new WrappedDataValue from a NMS value.
35+ * ProtocolLib wrappers are not supported as arguments.
36+ * If implicit unwrapping of wrappers is required, use {@link WrappedDataValue#fromWrappedValue(int, Serializer, Object)}.
37+ * @param index the index of the metadata value
38+ * @param serializer the serializer corresponding for serializing. Can be null.
39+ * @param value The raw value for the DataValue. Can be null.
40+ */
3241 public WrappedDataValue (int index , Serializer serializer , Object value ) {
3342 this (newHandle (index , serializer , value ));
3443 }
3544
45+ /**
46+ * Creates a new WrappedDataValue from a possibly wrapped value and implicitly unwrap value if possible.
47+ * @param index the index of the metadata value
48+ * @param serializer the serializer corresponding for serializing. Can be null.
49+ * @param value The value for the DataValue. Can be null.
50+ */
51+ public static WrappedDataValue fromWrappedValue (int index , Serializer serializer , Object value ) {
52+ return new WrappedDataValue (index , serializer , value == null ? null : WrappedWatchableObject .getUnwrapped (value ));
53+ }
54+
3655 private static Object newHandle (int index , Serializer serializer , Object value ) {
3756 if (constructor == null ) {
3857 constructor = Accessors .getConstructorAccessor (HANDLE_TYPE .getConstructors ()[0 ]);
@@ -41,14 +60,26 @@ private static Object newHandle(int index, Serializer serializer, Object value)
4160 return constructor .invoke (index , serializer .getHandle (), value );
4261 }
4362
63+ /**
64+ * Returns the entity-type specific index of this DataValue
65+ * @return index of the DataValue
66+ */
4467 public int getIndex () {
4568 return this .modifier .<Integer >withType (int .class ).read (0 );
4669 }
4770
71+ /**
72+ * Sets the entity-type specific index of this DataValue
73+ * @param index New index of the DataValue
74+ */
4875 public void setIndex (int index ) {
4976 this .modifier .withType (int .class ).write (0 , index );
5077 }
5178
79+ /**
80+ * Returns the current serializer for this DataValue.
81+ * @return serializer
82+ */
5283 public Serializer getSerializer () {
5384 Object serializer = this .modifier .readSafely (1 );
5485 if (serializer != null ) {
@@ -63,22 +94,42 @@ public Serializer getSerializer() {
6394 }
6495 }
6596
97+ /**
98+ * Changes the serializer for this DataValue
99+ * @param serializer serializer
100+ */
66101 public void setSerializer (Serializer serializer ) {
67102 this .modifier .writeSafely (1 , serializer == null ? null : serializer .getHandle ());
68103 }
69104
105+ /**
106+ * Returns the current value associated and implicitly wraps it to corresponding ProtocolLib wrappers if possible.
107+ * @return Current value
108+ */
70109 public Object getValue () {
71110 return WrappedWatchableObject .getWrapped (getRawValue ());
72111 }
73112
113+ /**
114+ * Sets the current value associated and implicitly unwraps it to NMS types if a ProtocolLib wrapper is provided.
115+ * @param value New value for this DataValue
116+ */
74117 public void setValue (Object value ) {
75118 setRawValue (WrappedWatchableObject .getUnwrapped (value ));
76119 }
77120
121+ /**
122+ * Returns the current, raw value.
123+ * @return Raw value (not wrapped)
124+ */
78125 public Object getRawValue () {
79126 return this .modifier .readSafely (2 );
80127 }
81128
129+ /**
130+ * Updates the raw value for this DataValue. No unwrapping will be applied.
131+ * @param value NMS value
132+ */
82133 public void setRawValue (Object value ) {
83134 this .modifier .writeSafely (2 , value );
84135 }
0 commit comments