Skip to content

players_list

PlayersList

Information about online players

Source code in src/eolib/protocol/_generated/net/server/players_list.py 
 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
class PlayersList:
    """
    Information about online players
    """
    _byte_size: int = 0
    _players_count: int
    _players: tuple[OnlinePlayer, ...]

    def __init__(self, *, players: Iterable[OnlinePlayer]):
        """
        Create a new instance of PlayersList.

        Args:
            players (Iterable[OnlinePlayer]): (Length must be 64008 or less.)
        """
        self._players = tuple(players)
        self._players_count = len(self._players)

    @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 players(self) -> tuple[OnlinePlayer, ...]:
        return self._players

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

        Args:
            writer (EoWriter): The writer that the data will be serialized to.
            data (PlayersList): The data to serialize.
        """
        old_string_sanitization_mode: bool = writer.string_sanitization_mode
        try:
            writer.string_sanitization_mode = True
            if data._players_count is None:
                raise SerializationError("players_count must be provided.")
            writer.add_short(data._players_count)
            writer.add_byte(0xFF)
            if data._players is None:
                raise SerializationError("players must be provided.")
            if len(data._players) > 64008:
                raise SerializationError(f"Expected length of players to be 64008 or less, got {len(data._players)}.")
            for i in range(data._players_count):
                OnlinePlayer.serialize(writer, data._players[i])
                writer.add_byte(0xFF)
            writer.string_sanitization_mode = False
        finally:
            writer.string_sanitization_mode = old_string_sanitization_mode

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

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

        Returns:
            PlayersList: The data to serialize.
        """
        old_chunked_reading_mode: bool = reader.chunked_reading_mode
        try:
            reader_start_position: int = reader.position
            reader.chunked_reading_mode = True
            players_count = reader.get_short()
            reader.next_chunk()
            players = []
            for i in range(players_count):
                players.append(OnlinePlayer.deserialize(reader))
                reader.next_chunk()
            reader.chunked_reading_mode = False
            result = PlayersList(players=players)
            result._byte_size = reader.position - reader_start_position
            return result
        finally:
            reader.chunked_reading_mode = old_chunked_reading_mode

    def __repr__(self):
        return f"PlayersList(byte_size={repr(self._byte_size)}, players={repr(self._players)})"

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.

players: tuple[OnlinePlayer, ...] property

__init__(*, players)

Create a new instance of PlayersList.

Parameters:

Name Type Description Default
players Iterable[OnlinePlayer]

(Length must be 64008 or less.)

 required
Source code in src/eolib/protocol/_generated/net/server/players_list.py 
21
22
23
24
25
26
27
28
29
def __init__(self, *, players: Iterable[OnlinePlayer]):
    """
    Create a new instance of PlayersList.

    Args:
        players (Iterable[OnlinePlayer]): (Length must be 64008 or less.)
    """
    self._players = tuple(players)
    self._players_count = len(self._players)

serialize(writer, data) staticmethod

Serializes an instance of PlayersList to the provided EoWriter.

Parameters:

Name Type Description Default
writer EoWriter

The writer that the data will be serialized to.

 required
data PlayersList

The data to serialize.

 required
Source code in src/eolib/protocol/_generated/net/server/players_list.py 
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
@staticmethod
def serialize(writer: EoWriter, data: "PlayersList") -> None:
    """
    Serializes an instance of `PlayersList` to the provided `EoWriter`.

    Args:
        writer (EoWriter): The writer that the data will be serialized to.
        data (PlayersList): The data to serialize.
    """
    old_string_sanitization_mode: bool = writer.string_sanitization_mode
    try:
        writer.string_sanitization_mode = True
        if data._players_count is None:
            raise SerializationError("players_count must be provided.")
        writer.add_short(data._players_count)
        writer.add_byte(0xFF)
        if data._players is None:
            raise SerializationError("players must be provided.")
        if len(data._players) > 64008:
            raise SerializationError(f"Expected length of players to be 64008 or less, got {len(data._players)}.")
        for i in range(data._players_count):
            OnlinePlayer.serialize(writer, data._players[i])
            writer.add_byte(0xFF)
        writer.string_sanitization_mode = False
    finally:
        writer.string_sanitization_mode = old_string_sanitization_mode

deserialize(reader) staticmethod

Deserializes an instance of PlayersList 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
PlayersList 'PlayersList'

The data to serialize.
Source code in src/eolib/protocol/_generated/net/server/players_list.py 
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
@staticmethod
def deserialize(reader: EoReader) -> "PlayersList":
    """
    Deserializes an instance of `PlayersList` from the provided `EoReader`.

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

    Returns:
        PlayersList: The data to serialize.
    """
    old_chunked_reading_mode: bool = reader.chunked_reading_mode
    try:
        reader_start_position: int = reader.position
        reader.chunked_reading_mode = True
        players_count = reader.get_short()
        reader.next_chunk()
        players = []
        for i in range(players_count):
            players.append(OnlinePlayer.deserialize(reader))
            reader.next_chunk()
        reader.chunked_reading_mode = False
        result = PlayersList(players=players)
        result._byte_size = reader.position - reader_start_position
        return result
    finally:
        reader.chunked_reading_mode = old_chunked_reading_mode