org.cloudburstmc.protocol.bedrock.transformer

Class FlagTransformer

java.lang.Object

org.cloudburstmc.protocol.bedrock.transformer.FlagTransformer

All Implemented Interfaces:

EntityDataTransformer<java.lang.Long,java.util.EnumMap<EntityFlag,java.lang.Boolean>>

public final class FlagTransformer
extends java.lang.Object
implements EntityDataTransformer<java.lang.Long,java.util.EnumMap<EntityFlag,java.lang.Boolean>>

Transforms entity flags between their EnumMap representation and a packed long value.

Entity flags are split into multiple groups of 64 flags each (FLAGS, FLAGS_2). Each transformer instance handles one group, identified by its index: - index 0 = FLAGS (flags 0-63) - index 1 = FLAGS_2 (flags 64-127)

Field Summary

Fields inherited from interface org.cloudburstmc.protocol.bedrock.transformer.EntityDataTransformer

IDENTITY

Constructor Summary

Constructors

Constructor and Description
FlagTransformer(org.cloudburstmc.protocol.common.util.TypeMap<EntityFlag> typeMap, int index)

Method Summary

Modifier and Type	Method and Description
java.util.EnumMap<EntityFlag,java.lang.Boolean>	deserialize(BedrockCodecHelper helper, EntityDataMap map, java.lang.Long value) Deserializes a packed long value into individual entity flags.
java.lang.Long	serialize(BedrockCodecHelper helper, EntityDataMap map, java.util.EnumMap<EntityFlag,java.lang.Boolean> flags) Serializes entity flags into a packed long value for network transmission.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.cloudburstmc.protocol.bedrock.transformer.EntityDataTransformer

identity

Constructor Detail

FlagTransformer

public FlagTransformer(org.cloudburstmc.protocol.common.util.TypeMap<EntityFlag> typeMap,
                       int index)

Method Detail

serialize

public java.lang.Long serialize(BedrockCodecHelper helper,
                                EntityDataMap map,
                                java.util.EnumMap<EntityFlag,java.lang.Boolean> flags)

Serializes entity flags into a packed long value for network transmission.

Only flags within this transformer's range (determined by index) are processed. For example, if index=0, only flags 0-63 are handled; flags 64+ are ignored.

Returns null if no flags in this group are present, preventing unnecessary serialization of empty flag groups. This fixes the issue where missing flag groups would be written as zero, causing clients to incorrectly clear flags.

Specified by:

serialize in interface EntityDataTransformer<java.lang.Long,java.util.EnumMap<EntityFlag,java.lang.Boolean>>

Parameters:

helper - the codec helper

map - the entity data map

flags - the complete flag map

Returns:

the packed long value containing flags for this group, or null if no flags exist

deserialize

public java.util.EnumMap<EntityFlag,java.lang.Boolean> deserialize(BedrockCodecHelper helper,
                                                                   EntityDataMap map,
                                                                   java.lang.Long value)

Deserializes a packed long value into individual entity flags.

Reads all 64 possible flag positions for this group, setting each flag to true or false based on the corresponding bit in the value.

Specified by:

deserialize in interface EntityDataTransformer<java.lang.Long,java.util.EnumMap<EntityFlag,java.lang.Boolean>>

Parameters:

helper - the codec helper

map - the entity data map to populate

value - the packed long value containing flag states

Returns:

the updated flag map