Skip to content

server_settings

ServerSettings

Settings sent with WELCOME_REPLY packet

Source code in src/eolib/protocol/_generated/net/server/server_settings.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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
class ServerSettings:
    """
    Settings sent with WELCOME_REPLY packet
    """
    _byte_size: int = 0
    _jail_map: int
    _rescue_map: int
    _rescue_coords: Coords
    _spy_and_light_guide_flood_rate: int
    _guardian_flood_rate: int
    _game_master_flood_rate: int
    _high_game_master_flood_rate: int

    def __init__(self, *, jail_map: int, rescue_map: int, rescue_coords: Coords, spy_and_light_guide_flood_rate: int, guardian_flood_rate: int, game_master_flood_rate: int, high_game_master_flood_rate: int):
        """
        Create a new instance of ServerSettings.

        Args:
            jail_map (int): (Value range is 0-64008.)
            rescue_map (int): (Value range is 0-64008.)
            rescue_coords (Coords): 
            spy_and_light_guide_flood_rate (int): (Value range is 0-64008.)
            guardian_flood_rate (int): (Value range is 0-64008.)
            game_master_flood_rate (int): (Value range is 0-64008.)
            high_game_master_flood_rate (int): (Value range is 0-64008.)
        """
        self._jail_map = jail_map
        self._rescue_map = rescue_map
        self._rescue_coords = rescue_coords
        self._spy_and_light_guide_flood_rate = spy_and_light_guide_flood_rate
        self._guardian_flood_rate = guardian_flood_rate
        self._game_master_flood_rate = game_master_flood_rate
        self._high_game_master_flood_rate = high_game_master_flood_rate

    @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 jail_map(self) -> int:
        return self._jail_map

    @property
    def rescue_map(self) -> int:
        return self._rescue_map

    @property
    def rescue_coords(self) -> Coords:
        return self._rescue_coords

    @property
    def spy_and_light_guide_flood_rate(self) -> int:
        return self._spy_and_light_guide_flood_rate

    @property
    def guardian_flood_rate(self) -> int:
        return self._guardian_flood_rate

    @property
    def game_master_flood_rate(self) -> int:
        return self._game_master_flood_rate

    @property
    def high_game_master_flood_rate(self) -> int:
        return self._high_game_master_flood_rate

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

        Args:
            writer (EoWriter): The writer that the data will be serialized to.
            data (ServerSettings): The data to serialize.
        """
        old_string_sanitization_mode: bool = writer.string_sanitization_mode
        try:
            if data._jail_map is None:
                raise SerializationError("jail_map must be provided.")
            writer.add_short(data._jail_map)
            if data._rescue_map is None:
                raise SerializationError("rescue_map must be provided.")
            writer.add_short(data._rescue_map)
            if data._rescue_coords is None:
                raise SerializationError("rescue_coords must be provided.")
            Coords.serialize(writer, data._rescue_coords)
            if data._spy_and_light_guide_flood_rate is None:
                raise SerializationError("spy_and_light_guide_flood_rate must be provided.")
            writer.add_short(data._spy_and_light_guide_flood_rate)
            if data._guardian_flood_rate is None:
                raise SerializationError("guardian_flood_rate must be provided.")
            writer.add_short(data._guardian_flood_rate)
            if data._game_master_flood_rate is None:
                raise SerializationError("game_master_flood_rate must be provided.")
            writer.add_short(data._game_master_flood_rate)
            if data._high_game_master_flood_rate is None:
                raise SerializationError("high_game_master_flood_rate must be provided.")
            writer.add_short(data._high_game_master_flood_rate)
        finally:
            writer.string_sanitization_mode = old_string_sanitization_mode

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

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

        Returns:
            ServerSettings: The data to serialize.
        """
        old_chunked_reading_mode: bool = reader.chunked_reading_mode
        try:
            reader_start_position: int = reader.position
            jail_map = reader.get_short()
            rescue_map = reader.get_short()
            rescue_coords = Coords.deserialize(reader)
            spy_and_light_guide_flood_rate = reader.get_short()
            guardian_flood_rate = reader.get_short()
            game_master_flood_rate = reader.get_short()
            high_game_master_flood_rate = reader.get_short()
            result = ServerSettings(jail_map=jail_map, rescue_map=rescue_map, rescue_coords=rescue_coords, spy_and_light_guide_flood_rate=spy_and_light_guide_flood_rate, guardian_flood_rate=guardian_flood_rate, game_master_flood_rate=game_master_flood_rate, high_game_master_flood_rate=high_game_master_flood_rate)
            result._byte_size = reader.position - reader_start_position
            return result
        finally:
            reader.chunked_reading_mode = old_chunked_reading_mode

    def __repr__(self):
        return f"ServerSettings(byte_size={repr(self._byte_size)}, jail_map={repr(self._jail_map)}, rescue_map={repr(self._rescue_map)}, rescue_coords={repr(self._rescue_coords)}, spy_and_light_guide_flood_rate={repr(self._spy_and_light_guide_flood_rate)}, guardian_flood_rate={repr(self._guardian_flood_rate)}, game_master_flood_rate={repr(self._game_master_flood_rate)}, high_game_master_flood_rate={repr(self._high_game_master_flood_rate)})"

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.

jail_map: int property

rescue_map: int property

rescue_coords: Coords property

spy_and_light_guide_flood_rate: int property

guardian_flood_rate: int property

game_master_flood_rate: int property

high_game_master_flood_rate: int property

__init__(*, jail_map, rescue_map, rescue_coords, spy_and_light_guide_flood_rate, guardian_flood_rate, game_master_flood_rate, high_game_master_flood_rate)

Create a new instance of ServerSettings.

Parameters:

Name Type Description Default
jail_map int

(Value range is 0-64008.)

 required
rescue_map int

(Value range is 0-64008.)

 required
rescue_coords Coords
required
spy_and_light_guide_flood_rate int

(Value range is 0-64008.)

 required
guardian_flood_rate int

(Value range is 0-64008.)

 required
game_master_flood_rate int

(Value range is 0-64008.)

 required
high_game_master_flood_rate int

(Value range is 0-64008.)

 required
Source code in src/eolib/protocol/_generated/net/server/server_settings.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
def __init__(self, *, jail_map: int, rescue_map: int, rescue_coords: Coords, spy_and_light_guide_flood_rate: int, guardian_flood_rate: int, game_master_flood_rate: int, high_game_master_flood_rate: int):
    """
    Create a new instance of ServerSettings.

    Args:
        jail_map (int): (Value range is 0-64008.)
        rescue_map (int): (Value range is 0-64008.)
        rescue_coords (Coords): 
        spy_and_light_guide_flood_rate (int): (Value range is 0-64008.)
        guardian_flood_rate (int): (Value range is 0-64008.)
        game_master_flood_rate (int): (Value range is 0-64008.)
        high_game_master_flood_rate (int): (Value range is 0-64008.)
    """
    self._jail_map = jail_map
    self._rescue_map = rescue_map
    self._rescue_coords = rescue_coords
    self._spy_and_light_guide_flood_rate = spy_and_light_guide_flood_rate
    self._guardian_flood_rate = guardian_flood_rate
    self._game_master_flood_rate = game_master_flood_rate
    self._high_game_master_flood_rate = high_game_master_flood_rate

serialize(writer, data) staticmethod

Serializes an instance of ServerSettings to the provided EoWriter.

Parameters:

Name Type Description Default
writer EoWriter

The writer that the data will be serialized to.

 required
data ServerSettings

The data to serialize.

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

    Args:
        writer (EoWriter): The writer that the data will be serialized to.
        data (ServerSettings): The data to serialize.
    """
    old_string_sanitization_mode: bool = writer.string_sanitization_mode
    try:
        if data._jail_map is None:
            raise SerializationError("jail_map must be provided.")
        writer.add_short(data._jail_map)
        if data._rescue_map is None:
            raise SerializationError("rescue_map must be provided.")
        writer.add_short(data._rescue_map)
        if data._rescue_coords is None:
            raise SerializationError("rescue_coords must be provided.")
        Coords.serialize(writer, data._rescue_coords)
        if data._spy_and_light_guide_flood_rate is None:
            raise SerializationError("spy_and_light_guide_flood_rate must be provided.")
        writer.add_short(data._spy_and_light_guide_flood_rate)
        if data._guardian_flood_rate is None:
            raise SerializationError("guardian_flood_rate must be provided.")
        writer.add_short(data._guardian_flood_rate)
        if data._game_master_flood_rate is None:
            raise SerializationError("game_master_flood_rate must be provided.")
        writer.add_short(data._game_master_flood_rate)
        if data._high_game_master_flood_rate is None:
            raise SerializationError("high_game_master_flood_rate must be provided.")
        writer.add_short(data._high_game_master_flood_rate)
    finally:
        writer.string_sanitization_mode = old_string_sanitization_mode

deserialize(reader) staticmethod

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

The data to serialize.
Source code in src/eolib/protocol/_generated/net/server/server_settings.py 
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
@staticmethod
def deserialize(reader: EoReader) -> "ServerSettings":
    """
    Deserializes an instance of `ServerSettings` from the provided `EoReader`.

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

    Returns:
        ServerSettings: The data to serialize.
    """
    old_chunked_reading_mode: bool = reader.chunked_reading_mode
    try:
        reader_start_position: int = reader.position
        jail_map = reader.get_short()
        rescue_map = reader.get_short()
        rescue_coords = Coords.deserialize(reader)
        spy_and_light_guide_flood_rate = reader.get_short()
        guardian_flood_rate = reader.get_short()
        game_master_flood_rate = reader.get_short()
        high_game_master_flood_rate = reader.get_short()
        result = ServerSettings(jail_map=jail_map, rescue_map=rescue_map, rescue_coords=rescue_coords, spy_and_light_guide_flood_rate=spy_and_light_guide_flood_rate, guardian_flood_rate=guardian_flood_rate, game_master_flood_rate=game_master_flood_rate, high_game_master_flood_rate=high_game_master_flood_rate)
        result._byte_size = reader.position - reader_start_position
        return result
    finally:
        reader.chunked_reading_mode = old_chunked_reading_mode