GetServerConfigSetting: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Server function}} This function retreives server settings which are usually stored in the '''mtaserver.conf''' file. {{New feature|3.0110|1.1| Available in 1.1 and o...")
 
m (If the setting name is 'serverip', may(...))
(6 intermediate revisions by 4 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server function}}
{{Server function}}
This function retreives server settings which are usually stored in the '''mtaserver.conf''' file.
This function retrieves server settings which are usually stored in the '''mtaserver.conf''' file.


{{New feature|3.0110|1.1|
{{New feature|3.0110|1.1|
Line 11: Line 11:
string getServerConfigSetting ( string name )
string getServerConfigSetting ( string name )
</syntaxhighlight>
</syntaxhighlight>
===Required Arguments===
*'''name :''' The name of the setting (setting names can be found [[Server_mtaserver.conf|here]])


===Returns===
===Returns===
Returns a string containing the current value for the named setting, or ''false'' if the setting does not exist.
Returns a string containing the current value for the named setting, or ''false'' if the setting does not exist.<br>
If the setting name is ''serverip'', may return the string ''"auto"'' on local servers.


==Example==
==Example==
Line 19: Line 23:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
outputChatBox( getServerConfigSetting ("minclientversion") )
outputChatBox( getServerConfigSetting ("minclientversion") )
</syntaxhighlight>
This example creates a <code>getServerIP</code> helper function:
<syntaxhighlight lang="lua">
function getServerIP()
    return getServerConfigSetting("serverip")
end
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Utility functions}}
{{Utility functions}}

Revision as of 20:28, 16 May 2020

This function retrieves server settings which are usually stored in the mtaserver.conf file.

Available in 1.1 and onwards

Syntax

string getServerConfigSetting ( string name )

Required Arguments

  • name : The name of the setting (setting names can be found here)

Returns

Returns a string containing the current value for the named setting, or false if the setting does not exist.
If the setting name is serverip, may return the string "auto" on local servers.

Example

This example prints the server minimum allowed client version to the chatbox

outputChatBox( getServerConfigSetting ("minclientversion") )

This example creates a getServerIP helper function:

function getServerIP()
    return getServerConfigSetting("serverip")
end

See Also