Difference between revisions of "SetMaxPlayers"

From Multi Theft Auto: Wiki
Line 2: Line 2:
 
{{Server function}}
 
{{Server function}}
 
This function sets the maximum number of player slots on the server.
 
This function sets the maximum number of player slots on the server.
 
+
{{Note|This function can not set more than <maxplayers> as defined in [[mtaserver.conf]]. (To find out the <maxplayers> value, use getServerConfigSetting("maxplayers"))}}
'''Note''': This function can not set more than <maxplayers> as defined in [[mtaserver.conf]]. (To find out the <maxplayers> value, use getServerConfigSetting("maxplayers"))
 
  
 
==Syntax==
 
==Syntax==

Revision as of 05:55, 11 August 2019

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

[[{{{image}}}|link=]] Note: This function can not 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