Skip to content

map_sign

MapSign

Sign EMF entity

Source code in src/eolib/protocol/_generated/map/map_sign.py 
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
class MapSign:
    """
    Sign EMF entity
    """
    _byte_size: int = 0
    _coords: Coords = None # type: ignore [assignment]
    _string_data_length: int = None # type: ignore [assignment]
    _string_data: str = None # type: ignore [assignment]
    _title_length: int = None # type: ignore [assignment]

    @property
    def byte_size(self) -> int:
        """
        Returns the size of the data that this was deserialized from.

        Returns:
            int: The size of the data that this was deserialized from.
        """
        return self._byte_size

    @property
    def coords(self) -> Coords:
        return self._coords

    @coords.setter
    def coords(self, coords: Coords) -> None:
        self._coords = coords

    @property
    def string_data(self) -> str:
        """
        Note:
          - Length must be 64007 or less.
        """
        return self._string_data

    @string_data.setter
    def string_data(self, string_data: str) -> None:
        """
        Note:
          - Length must be 64007 or less.
        """
        self._string_data = string_data
        self._string_data_length = len(self._string_data)

    @property
    def title_length(self) -> int:
        """
        Note:
          - Value range is 0-252.
        """
        return self._title_length

    @title_length.setter
    def title_length(self, title_length: int) -> None:
        """
        Note:
          - Value range is 0-252.
        """
        self._title_length = title_length

    @staticmethod
    def serialize(writer: EoWriter, data: "MapSign") -> None:
        """
        Serializes an instance of `MapSign` to the provided `EoWriter`.

        Args:
            writer (EoWriter): The writer that the data will be serialized to.
            data (MapSign): The data to serialize.
        """
        if data._coords is None:
            raise SerializationError("coords must be provided.")
        Coords.serialize(writer, data._coords)
        if data._string_data_length is None:
            raise SerializationError("string_data_length must be provided.")
        writer.add_short(data._string_data_length + 1)
        if data._string_data is None:
            raise SerializationError("string_data must be provided.")
        if len(data._string_data) > 64007:
            raise SerializationError(f"Expected length of string_data to be 64007 or less, got {len(data._string_data)}.")
        writer.add_fixed_encoded_string(data._string_data, data._string_data_length, False)
        if data._title_length is None:
            raise SerializationError("title_length must be provided.")
        writer.add_char(data._title_length)

    @staticmethod
    def deserialize(reader: EoReader) -> "MapSign":
        """
        Deserializes an instance of `MapSign` from the provided `EoReader`.

        Args:
            reader (EoReader): The writer that the data will be serialized to.

        Returns:
            MapSign: The data to serialize.
        """
        data: MapSign = MapSign()
        old_chunked_reading_mode: bool = reader.chunked_reading_mode
        try:
            reader_start_position: int = reader.position
            data._coords = Coords.deserialize(reader)
            data._string_data_length = reader.get_short() - 1
            data._string_data = reader.get_fixed_encoded_string(data._string_data_length, False)
            data._title_length = reader.get_char()
            data._byte_size = reader.position - reader_start_position
            return data
        finally:
            reader.chunked_reading_mode = old_chunked_reading_mode

    def __repr__(self):
        return f"MapSign(byte_size={repr(self._byte_size)}, coords={repr(self._coords)}, string_data={repr(self._string_data)}, title_length={repr(self._title_length)})"

byte_size: int property

Returns the size of the data that this was deserialized from.

Returns:

Name Type Description
int int

The size of the data that this was deserialized from.

coords: Coords property writable

string_data: str property writable

Note
  • Length must be 64007 or less.

title_length: int property writable

Note
  • Value range is 0-252.

serialize(writer, data) staticmethod

Serializes an instance of MapSign to the provided EoWriter.

Parameters:

Name Type Description Default
writer EoWriter

The writer that the data will be serialized to.

 required
data MapSign

The data to serialize.

 required
Source code in src/eolib/protocol/_generated/map/map_sign.py 
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
@staticmethod
def serialize(writer: EoWriter, data: "MapSign") -> None:
    """
    Serializes an instance of `MapSign` to the provided `EoWriter`.

    Args:
        writer (EoWriter): The writer that the data will be serialized to.
        data (MapSign): The data to serialize.
    """
    if data._coords is None:
        raise SerializationError("coords must be provided.")
    Coords.serialize(writer, data._coords)
    if data._string_data_length is None:
        raise SerializationError("string_data_length must be provided.")
    writer.add_short(data._string_data_length + 1)
    if data._string_data is None:
        raise SerializationError("string_data must be provided.")
    if len(data._string_data) > 64007:
        raise SerializationError(f"Expected length of string_data to be 64007 or less, got {len(data._string_data)}.")
    writer.add_fixed_encoded_string(data._string_data, data._string_data_length, False)
    if data._title_length is None:
        raise SerializationError("title_length must be provided.")
    writer.add_char(data._title_length)

deserialize(reader) staticmethod

Deserializes an instance of MapSign from the provided EoReader.

Parameters:

Name Type Description Default
reader EoReader

The writer that the data will be serialized to.

 required

Returns:

Name Type Description
MapSign MapSign

The data to serialize.
Source code in src/eolib/protocol/_generated/map/map_sign.py 
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
@staticmethod
def deserialize(reader: EoReader) -> "MapSign":
    """
    Deserializes an instance of `MapSign` from the provided `EoReader`.

    Args:
        reader (EoReader): The writer that the data will be serialized to.

    Returns:
        MapSign: The data to serialize.
    """
    data: MapSign = MapSign()
    old_chunked_reading_mode: bool = reader.chunked_reading_mode
    try:
        reader_start_position: int = reader.position
        data._coords = Coords.deserialize(reader)
        data._string_data_length = reader.get_short() - 1
        data._string_data = reader.get_fixed_encoded_string(data._string_data_length, False)
        data._title_length = reader.get_char()
        data._byte_size = reader.position - reader_start_position
        return data
    finally:
        reader.chunked_reading_mode = old_chunked_reading_mode