GetServerConfigSetting: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (If the setting name is 'serverip', may(...))
 
(One intermediate revision by one other user not shown)
Line 9: Line 9:
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string getServerConfigSetting ( string name )
mixed getServerConfigSetting ( string name )
</syntaxhighlight>
</syntaxhighlight>


Line 16: Line 16:


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


Line 34: Line 34:


==See Also==
==See Also==
{{Utility functions}}
{{Utility functions|server}}

Latest revision as of 22:37, 6 September 2024

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

Available in 1.1 and onwards

Syntax

mixed 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, table if name is module 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


Retrieved from "https://wiki.multitheftauto.com/wiki/GetServerConfigSetting?oldid=80381"