<spanid="engines-server-module"></span><h1>engines.server module<aclass="headerlink" href="#module-engines.server" title="Link to this heading">¶</a></h1>
<p>Provides access to the base Server interfaces.</p>
<emclass="property"><spanclass="k"><spanclass="pre">class</span></span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">engines.server.</span></span><spanclass="sig-name descname"><spanclass="pre">ConnectionlessPacketHandler</span></span><aclass="headerlink" href="#engines.server.ConnectionlessPacketHandler" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">__init__</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#engines.server.ConnectionlessPacketHandler.__init__" title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">class</span></span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">engines.server.</span></span><spanclass="sig-name descname"><spanclass="pre">MapLoadType</span></span><aclass="headerlink" href="#engines.server.MapLoadType" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">Background</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">_globals.MapLoadType.Background</span></em><aclass="headerlink" href="#engines.server.MapLoadType.Background" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">LoadGame</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">_globals.MapLoadType.LoadGame</span></em><aclass="headerlink" href="#engines.server.MapLoadType.LoadGame" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">NewGame</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">_globals.MapLoadType.NewGame</span></em><aclass="headerlink" href="#engines.server.MapLoadType.NewGame" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">Transition</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">_globals.MapLoadType.Transition</span></em><aclass="headerlink" href="#engines.server.MapLoadType.Transition" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">names</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">{'Background':</span><spanclass="pre">_globals.MapLoadType.Background,</span><spanclass="pre">'LoadGame':</span><spanclass="pre">_globals.MapLoadType.LoadGame,</span><spanclass="pre">'NewGame':</span><spanclass="pre">_globals.MapLoadType.NewGame,</span><spanclass="pre">'Transition':</span><spanclass="pre">_globals.MapLoadType.Transition}</span></em><aclass="headerlink" href="#engines.server.MapLoadType.names" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">values</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">{0:</span><spanclass="pre">_globals.MapLoadType.NewGame,</span><spanclass="pre">1:</span><spanclass="pre">_globals.MapLoadType.LoadGame,</span><spanclass="pre">2:</span><spanclass="pre">_globals.MapLoadType.Transition,</span><spanclass="pre">3:</span><spanclass="pre">_globals.MapLoadType.Background}</span></em><aclass="headerlink" href="#engines.server.MapLoadType.values" title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">class</span></span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">engines.server.</span></span><spanclass="sig-name descname"><spanclass="pre">QueryCvarStatus</span></span><aclass="headerlink" href="#engines.server.QueryCvarStatus" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">INVALID</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">_engines._server.QueryCvarStatus.INVALID</span></em><aclass="headerlink" href="#engines.server.QueryCvarStatus.INVALID" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">NOT_FOUND</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">_engines._server.QueryCvarStatus.NOT_FOUND</span></em><aclass="headerlink" href="#engines.server.QueryCvarStatus.NOT_FOUND" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">PROTECTED</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">_engines._server.QueryCvarStatus.PROTECTED</span></em><aclass="headerlink" href="#engines.server.QueryCvarStatus.PROTECTED" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">SUCCESS</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">_engines._server.QueryCvarStatus.SUCCESS</span></em><aclass="headerlink" href="#engines.server.QueryCvarStatus.SUCCESS" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">names</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">{'INVALID':</span><spanclass="pre">_engines._server.QueryCvarStatus.INVALID,</span><spanclass="pre">'NOT_FOUND':</span><spanclass="pre">_engines._server.QueryCvarStatus.NOT_FOUND,</span><spanclass="pre">'PROTECTED':</span><spanclass="pre">_engines._server.QueryCvarStatus.PROTECTED,</span><spanclass="pre">'SUCCESS':</span><spanclass="pre">_engines._server.QueryCvarStatus.SUCCESS}</span></em><aclass="headerlink" href="#engines.server.QueryCvarStatus.names" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">values</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">{0:</span><spanclass="pre">_engines._server.QueryCvarStatus.SUCCESS,</span><spanclass="pre">1:</span><spanclass="pre">_engines._server.QueryCvarStatus.NOT_FOUND,</span><spanclass="pre">2:</span><spanclass="pre">_engines._server.QueryCvarStatus.INVALID,</span><spanclass="pre">3:</span><spanclass="pre">_engines._server.QueryCvarStatus.PROTECTED}</span></em><aclass="headerlink" href="#engines.server.QueryCvarStatus.values" title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">class</span></span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">engines.server.</span></span><spanclass="sig-name descname"><spanclass="pre">Server</span></span><aclass="headerlink" href="#engines.server.Server" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">__init__</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#engines.server.Server.__init__" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">get_client</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">(Server)arg1</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">(_engines._sound.Channel)arg2</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">_players.Client</span><spanclass="pre">:</span></span></span><aclass="headerlink" href="#engines.server.Server.get_client" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">get_player_info</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">(Server)arg1</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">(_engines._sound.Channel)arg2</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">(object)arg3</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">bool</span><spanclass="pre">:</span></span></span><aclass="headerlink" href="#engines.server.Server.get_player_info" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">is_active</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">(Server)arg1</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">bool</span><spanclass="pre">:</span></span></span><aclass="headerlink" href="#engines.server.Server.is_active" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">is_dedicated</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">(Server)arg1</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">bool</span><spanclass="pre">:</span></span></span><aclass="headerlink" href="#engines.server.Server.is_dedicated" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">is_hltv</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">(Server)arg1</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">bool</span><spanclass="pre">:</span></span></span><aclass="headerlink" href="#engines.server.Server.is_hltv" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">is_loading</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">(Server)arg1</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">bool</span><spanclass="pre">:</span></span></span><aclass="headerlink" href="#engines.server.Server.is_loading" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">is_multiplayer</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">(Server)arg1</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">bool</span><spanclass="pre">:</span></span></span><aclass="headerlink" href="#engines.server.Server.is_multiplayer" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">is_pausable</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">(Server)arg1</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">bool</span><spanclass="pre">:</span></span></span><aclass="headerlink" href="#engines.server.Server.is_pausable" title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">property</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">class_bits</span></span><aclass="headerlink" href="#engines.server.Server.class_bits" title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">property</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">client_count</span></span><aclass="headerlink" href="#engines.server.Server.client_count" title="Link to this definition">¶</a></dt>
<dd><p>Return the number of client slots (used and unused).</p>
<emclass="property"><spanclass="k"><spanclass="pre">property</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">map_name</span></span><aclass="headerlink" href="#engines.server.Server.map_name" title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">property</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">max_clients</span></span><aclass="headerlink" href="#engines.server.Server.max_clients" title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">property</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">name</span></span><aclass="headerlink" href="#engines.server.Server.name" title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">property</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">net_stats</span></span><aclass="headerlink" href="#engines.server.Server.net_stats" title="Link to this definition">¶</a></dt>
<dd><p>Return a tuple containing the total net in/out in bytes/sec.</p>
<emclass="property"><spanclass="k"><spanclass="pre">property</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">num_classes</span></span><aclass="headerlink" href="#engines.server.Server.num_classes" title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">property</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">num_clients</span></span><aclass="headerlink" href="#engines.server.Server.num_clients" title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">property</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">num_fake_clients</span></span><aclass="headerlink" href="#engines.server.Server.num_fake_clients" title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">property</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">num_players</span></span><aclass="headerlink" href="#engines.server.Server.num_players" title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">property</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">num_proxies</span></span><aclass="headerlink" href="#engines.server.Server.num_proxies" title="Link to this definition">¶</a></dt>
<dd><p>Return the number of attached HLTV proxies.</p>
<emclass="property"><spanclass="k"><spanclass="pre">property</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">password</span></span><aclass="headerlink" href="#engines.server.Server.password" title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">property</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">paused</span></span><aclass="headerlink" href="#engines.server.Server.paused" title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">property</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">spawn_count</span></span><aclass="headerlink" href="#engines.server.Server.spawn_count" title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">property</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">tick</span></span><aclass="headerlink" href="#engines.server.Server.tick" title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">property</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">tick_interval</span></span><aclass="headerlink" href="#engines.server.Server.tick_interval" title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">property</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">time</span></span><aclass="headerlink" href="#engines.server.Server.time" title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">property</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">udp_port</span></span><aclass="headerlink" href="#engines.server.Server.udp_port" title="Link to this definition">¶</a></dt>
<spanclass="sig-prename descclassname"><spanclass="pre">engines.server.</span></span><spanclass="sig-name descname"><spanclass="pre">execute_server_command</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#engines.server.execute_server_command" title="Link to this definition">¶</a></dt>
<li><p><aclass="reference external" href="https://docs.python.org/3.13/library/exceptions.html#TypeError" title="(in Python v3.13)"><strong>TypeError</strong></a> – Raised if keyword arguments have been passed.</p></li>
<li><p><aclass="reference external" href="https://docs.python.org/3.13/library/exceptions.html#ValueError" title="(in Python v3.13)"><strong>ValueError</strong></a> – Raised if the server command was not found or if the command couldn’t be tokenized.</p></li>
<spanclass="sig-prename descclassname"><spanclass="pre">engines.server.</span></span><spanclass="sig-name descname"><spanclass="pre">insert_command_string</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">(str)arg1</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">None</span><spanclass="pre">:</span></span></span><aclass="headerlink" href="#engines.server.insert_command_string" title="Link to this definition">¶</a></dt>
<dd><p>Same like <aclass="reference internal" href="#engines.server.queue_command_string" title="engines.server.queue_command_string"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">queue_command_string()</span></code></a>, but inserts the command at the beginning of the server command queue.</p>
<spanclass="sig-prename descclassname"><spanclass="pre">engines.server.</span></span><spanclass="sig-name descname"><spanclass="pre">insert_server_command</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#engines.server.insert_server_command" title="Link to this definition">¶</a></dt>
<dd><p>Same as <aclass="reference internal" href="#engines.server.queue_server_command" title="engines.server.queue_server_command"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">queue_server_command()</span></code></a>, but inserts the command at the beginning of the server command queue.</p>
<ddclass="field-odd"><p><aclass="reference external" href="https://docs.python.org/3.13/library/exceptions.html#ValueError" title="(in Python v3.13)"><strong>ValueError</strong></a> – Raised if the server command was not found.</p>
<spanclass="sig-prename descclassname"><spanclass="pre">engines.server.</span></span><spanclass="sig-name descname"><spanclass="pre">queue_command_string</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">(str)arg1</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">None</span><spanclass="pre">:</span></span></span><aclass="headerlink" href="#engines.server.queue_command_string" title="Link to this definition">¶</a></dt>
<dd><p>Adds a string to the end of the server command queue. It’s the same like typing something into the server console.</p>
<spanclass="sig-prename descclassname"><spanclass="pre">engines.server.</span></span><spanclass="sig-name descname"><spanclass="pre">queue_server_command</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#engines.server.queue_server_command" title="Link to this definition">¶</a></dt>
<dd><p>Same as <aclass="reference internal" href="#engines.server.execute_server_command" title="engines.server.execute_server_command"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">execute_server_command()</span></code></a>, but does not execute the server command immediately. Instead it is added to the server command queue. Thus, it can be executed with a little delay.</p>
<ddclass="field-odd"><p><aclass="reference external" href="https://docs.python.org/3.13/library/exceptions.html#ValueError" title="(in Python v3.13)"><strong>ValueError</strong></a> – Raised if the server command was not found.</p>