API reference / @jsprismarine/protocol / CameraAimAssistCategoryPriorities
Class: CameraAimAssistCategoryPriorities
Defined in: protocol/src/structure/CameraAimAssistCategoryPriorities.ts:33
The CameraAimAssistCategoryPriorities of one CameraAimAssistCategoryDefinition: which blocks and entities aim assist prefers while the category is active.
Protocol 2193 wire order: 0. entities: varuint32 count, then one CameraAimAssistPriority per entity identifier.
blocks: varuint32 count, then one entry per block identifier.block_tags: varuint32 count, then one entry per block tag.entity_type_families: varuint32 count, then one entry per entity type family.entity_default: optional. A presence byte, then a little-endian int32 when present.block_default: optional. A presence byte, then a little-endian int32 when present.
Each entry is its identifier string (varuint32 byte length then UTF-8) followed by the priority as a little-endian int32. https://mojang.github.io/bedrock-protocol-docs/1.26.51/types/camera-aim-assist-category-priorities/
Extends
Constructors
Constructor
new CameraAimAssistCategoryPriorities(
entities?,blocks?,blockTags?,entityTypeFamilies?,entityDefault?,blockDefault?):CameraAimAssistCategoryPriorities
Defined in: protocol/src/structure/CameraAimAssistCategoryPriorities.ts:44
Creates a priority set. Every parameter has a default so the static deserialize can construct an empty instance before reading the stream.
Parameters
entities?
CameraAimAssistPriority[] = []
entities, priorities keyed by entity identifier.
blocks?
CameraAimAssistPriority[] = []
blocks, priorities keyed by block identifier.
blockTags?
CameraAimAssistPriority[] = []
block_tags, priorities keyed by block tag.
entityTypeFamilies?
CameraAimAssistPriority[] = []
entity_type_families, priorities keyed by entity type family.
entityDefault?
number
entity_default, the priority for entities missing from entities. Omitted when undefined.
blockDefault?
number
block_default, the priority for blocks missing from blocks. Omitted when undefined.
Returns
CameraAimAssistCategoryPriorities
Overrides
Properties
blockDefault?
optionalblockDefault?:number
Defined in: protocol/src/structure/CameraAimAssistCategoryPriorities.ts:50
block_default, the priority for blocks missing from blocks. Omitted when undefined.
blocks
blocks:
CameraAimAssistPriority[] =[]
Defined in: protocol/src/structure/CameraAimAssistCategoryPriorities.ts:46
blocks, priorities keyed by block identifier.
blockTags
blockTags:
CameraAimAssistPriority[] =[]
Defined in: protocol/src/structure/CameraAimAssistCategoryPriorities.ts:47
block_tags, priorities keyed by block tag.
entities
entities:
CameraAimAssistPriority[] =[]
Defined in: protocol/src/structure/CameraAimAssistCategoryPriorities.ts:45
entities, priorities keyed by entity identifier.
entityDefault?
optionalentityDefault?:number
Defined in: protocol/src/structure/CameraAimAssistCategoryPriorities.ts:49
entity_default, the priority for entities missing from entities. Omitted when undefined.
entityTypeFamilies
entityTypeFamilies:
CameraAimAssistPriority[] =[]
Defined in: protocol/src/structure/CameraAimAssistCategoryPriorities.ts:48
entity_type_families, priorities keyed by entity type family.
Methods
deserialize()
deserialize(
stream):void
Defined in: protocol/src/structure/CameraAimAssistCategoryPriorities.ts:94
Reads the four maps and the two optional defaults in wire order.
Parameters
stream
Returns
void
Overrides
serialize()
serialize(
stream):void
Defined in: protocol/src/structure/CameraAimAssistCategoryPriorities.ts:84
Writes the four maps and the two optional defaults in wire order.
Parameters
stream
Returns
void
Overrides
deserialize()
staticdeserialize<T>(this,stream):T
Defined in: protocol/src/NetworkStructure.ts:28
Deserializes the network structure from a binary stream. The constructor runs with no arguments before the stream is read, so the class must tolerate that.
Type Parameters
T
T extends NetworkStructure
Parameters
this
Constructor<T>
stream
The binary stream to deserialize from.
Returns
T
An instance of the class T.