SetMaxPlayers: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
 
(11 intermediate revisions by 6 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server function}}
{{Server function}}
This function set the maximum number of player slots on the server. Note: the maximum this function can set is what is defined in mtaserver.conf
This function sets the maximum number of player slots on the server.
{{Note|This function cannot set more than <maxplayers> as defined in [[mtaserver.conf]]. (To find out the <maxplayers> value, use getServerConfigSetting("maxplayers"))}}


==Syntax==
==Syntax==
Line 15: Line 16:


==Example==
==Example==
This example increases server slots count if server is full.
This example set server slots count to half value from current value.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addEventHandler( "onPlayerJoin", root,
local curMaxPlayers = getMaxPlayers()
    function()
local newMaxPlayers = math.ceil( curMaxPlayers / 2 )
        local nowPlayers = getPlayerCount()
        local maxPlayers = getMaxPlayers()


        if nowPlayers and maxPlayers and nowPlayers >= maxPlayers then
setMaxPlayers( newMaxPlayers )
            setMaxPlayers( maxPlayers + 1 )
</syntaxhighlight>
        end
 
    end
 
)</syntaxhighlight>
This example resets the server slots count to the value from mtaserver.conf
<syntaxhighlight lang="lua">
setMaxPlayers( tonumber( getServerConfigSetting("maxplayers") ) )
</syntaxhighlight>


==See Also==
==See Also==
{{Server functions}}
{{Server functions}}

Latest revision as of 05:56, 11 August 2019

This function sets the maximum number of player slots on the server.

[[{{{image}}}|link=|]] Note: This function cannot set more than <maxplayers> as defined in mtaserver.conf. (To find out the <maxplayers> value, use getServerConfigSetting("maxplayers"))

Syntax

bool setMaxPlayers ( int slots )

Required Arguments

  • slots: Maximum number of player slots on the server.

Returns

Returns true if number of player slots was successfully changed, false or nil otherwise.

Example

This example set server slots count to half value from current value. 

local curMaxPlayers = getMaxPlayers()
local newMaxPlayers = math.ceil( curMaxPlayers / 2 )

setMaxPlayers( newMaxPlayers )


This example resets the server slots count to the value from mtaserver.conf 

setMaxPlayers( tonumber( getServerConfigSetting("maxplayers") ) )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetMaxPlayers?oldid=63704"