Source code for eolib.protocol.map.map_warp_row
# Generated from the eo-protocol XML specification.
#
# This file should not be modified.
# Changes will be lost when code is regenerated.
from __future__ import annotations
from collections.abc import Iterable
from .map_warp_row_tile import MapWarpRowTile
from ...serialization_error import SerializationError
from ....data.eo_writer import EoWriter
from ....data.eo_reader import EoReader
[docs]
class MapWarpRow:
"""
A row of warp entities
"""
_byte_size: int = 0
_y: int
_tiles_count: int
_tiles: tuple[MapWarpRowTile, ...]
[docs]
def __init__(self, *, y: int, tiles: Iterable[MapWarpRowTile]):
"""
Create a new instance of MapWarpRow.
Args:
y: (Value range is 0-252.)
tiles: (Length must be 252 or less.)
"""
self._y = y
self._tiles = tuple(tiles)
self._tiles_count = len(self._tiles)
@property
def byte_size(self) -> int:
"""
The size of the data that this was deserialized from.
"""
return self._byte_size
@property
def y(self) -> int:
"""
The `y` field.
"""
return self._y
@property
def tiles(self) -> tuple[MapWarpRowTile, ...]:
"""
The `tiles` field.
"""
return self._tiles
[docs]
@staticmethod
def serialize(writer: EoWriter, data: "MapWarpRow") -> None:
"""
Serializes an instance of `MapWarpRow` to the provided `EoWriter`.
Args:
writer (EoWriter): The writer that the data will be serialized to.
data (MapWarpRow): The data to serialize.
"""
old_string_sanitization_mode: bool = writer.string_sanitization_mode
try:
if data._y is None:
raise SerializationError("y must be provided.")
writer.add_char(data._y)
if data._tiles_count is None:
raise SerializationError("tiles_count must be provided.")
writer.add_char(data._tiles_count)
if data._tiles is None:
raise SerializationError("tiles must be provided.")
if len(data._tiles) > 252:
raise SerializationError(f"Expected length of tiles to be 252 or less, got {len(data._tiles)}.")
for i in range(data._tiles_count):
MapWarpRowTile.serialize(writer, data._tiles[i])
finally:
writer.string_sanitization_mode = old_string_sanitization_mode
[docs]
@staticmethod
def deserialize(reader: EoReader) -> "MapWarpRow":
"""
Deserializes an instance of `MapWarpRow` from the provided `EoReader`.
Args:
reader (EoReader): The writer that the data will be serialized to.
Returns:
The data to serialize.
"""
old_chunked_reading_mode: bool = reader.chunked_reading_mode
try:
reader_start_position: int = reader.position
y = reader.get_char()
tiles_count = reader.get_char()
tiles = []
for i in range(tiles_count):
tiles.append(MapWarpRowTile.deserialize(reader))
result = MapWarpRow(y=y, tiles=tiles)
result._byte_size = reader.position - reader_start_position
return result
finally:
reader.chunked_reading_mode = old_chunked_reading_mode
def __repr__(self):
return f"MapWarpRow(byte_size={repr(self._byte_size)}, y={repr(self._y)}, tiles={repr(self._tiles)})"