Multi Theft Auto: Wiki - User contributions [en]

Resource:Settingsmanager

2018-01-06T18:04:51Z

AleksCore:

[https://community.multitheftauto.com/index.php?p=resources&s=details&id=15127 Settings manager] is a simple resource to save/load player settings (any data). All settings stored client-side in a XML file placed using private [[filepath]] ( ''\MTA San Andreas\mods\deathmatch\priv\<server-id>\settingsmanager'' )

==Exported functions:==
<syntaxhighlight lang="lua">
saveSetting ( string settingName, var value [, string resourceName ] )
</syntaxhighlight>
Returns ''true'' if value was successfully saved, ''false'' otherwise.
<syntaxhighlight lang="lua">
loadSetting ( string settingName [, string resourceName ] )
</syntaxhighlight>
Returns the value if it was received successfully, ''nil'' otherwise. Strings "true" and "false" will be returned as booleans.

* Last argument is optional for both functions. It used to store settings in XML file under resourceName node. Default argument is the resource name of the resource which called the exported function. See example below for more information.

== Example: ==
For example we have a "language-manager" resource with script like this:
<syntaxhighlight lang="lua">
function changeLanguage ( _, newLang )
if no newLang then
outputChatBox('Error. Command syntax: /lang <language name>. Available languages: "english", "russian"')
return
end
exports.settingsmanager:saveSetting("language", newLang)
end
addCommandHandler( "lang", changeLaguage )

function onStart ()
local playerLanguage = exports.settingsmanager:loadSetting ( "language" )
if playerLanguage == nil then --if no language set
playerLanguage = "english"
exports.settingsmanager:saveSetting("language", playerLanguage ) --set default language
end
outputChatBox ( "Current language is " ..playerLanguage.. ". Type /language to change")
end
addEventHandler( "onClientResourceStart", resourceRoot, onStart )
</syntaxhighlight>
Then XML file will look like this:
<syntaxhighlight lang="xml">
<settings>
<language-manager>
<language>english</language>
</language-manager>
</settings>
</syntaxhighlight>
XML node called "language-manager" because resource name of the resource which called exported function is "language-manager".

Resource:Settingsmanager

2018-01-06T18:00:10Z

AleksCore:

[https://community.multitheftauto.com/index.php?p=resources&s=details&id=15127 Settings manager] is a simple resource to save/load player settings (any data). All settings stored client-side in a XML file placed using private [[filepath]] ( ''\MTA San Andreas\mods\deathmatch\priv\<server-id>\settingsmanager'' )

==Exported functions:==
<syntaxhighlight lang="lua">
saveSetting ( string settingName, var value [, string resourceName ] )
</syntaxhighlight>
Returns ''true'' if value was successfully saved, ''false'' otherwise.
<syntaxhighlight lang="lua">
loadSetting ( string settingName [, string resourceName ] )
</syntaxhighlight>
Returns the value if it was received successfully, ''nil'' otherwise. Strings "true" and "false" will be returned as booleans.

* Last argument is optional for both functions. It used to store settings in XML file under resourceName node. Default argument is the resource name of the resource which called the exported function. See example below for more information.

== Example: ==
For example we have a "language-manager" resource with script like this:
<syntaxhighlight lang="lua">
function changeLanguage ( _, newLang )
if no newLang then
outputChatBox('Error. Command syntax: /lang <language name>. Available languages: "english", "russian"')
return
end
exports.settingsmanager:saveSetting("language", newLang)
end
addCommandHandler( "lang", changeLaguage )

function onStart ()
local playerLanguage = exports.settingsmanager:loadSetting ( "language" )
if playerLanguage == nil then
exports.settingsmanager:saveSetting("language", "english") --here we set default language
end
outputChatBox ( "Current language is " ..playerLanguage.. ". Type /language to change")
end
addEventHandler( "onClientResourceStart", resourceRoot, onStart )
</syntaxhighlight>
Then XML file will look like this:
<syntaxhighlight lang="xml">
<settings>
<language-manager>
<language>english</language>
</language-manager>
</settings>
</syntaxhighlight>
XML node called "language-manager" because resource name of the resource which called exported function is "language-manager".

Resource:Settingsmanager

2018-01-06T17:51:39Z

AleksCore:

[https://community.multitheftauto.com/index.php?p=resources&s=details&id=15127 Settings manager] is a simple resource to save/load player settings (any data). All settings stored client-side in a XML file placed using private [[filepath]] ( ''\MTA San Andreas\mods\deathmatch\priv\<server-id>\settingsmanager'' )

==Exported functions:==
<syntaxhighlight lang="lua">
saveSetting ( string settingName, var value [, string resourceName ] )
</syntaxhighlight>
Returns ''true'' if value was successfully saved, ''false'' otherwise.
<syntaxhighlight lang="lua">
loadSetting ( string settingName [, string resourceName ] )
</syntaxhighlight>
Returns the value if it was received successfully, ''nil'' otherwise. Strings "true" and "false" will be returned as booleans.

* Last argument is optional for both functions. It used to store settings in XML file under resourceName node. Default argument is the resource name of the resource which called the exported function. See example below for more information.

== Example: ==
For example we have a "language-manager" resource with script like this:
<syntaxhighlight lang="lua">
function changeLanguage ( _, newLang )
if no newLang then
outputChatBox('Error. Command syntax: /lang <language name>. Available languages: "english", "russian"')
return
end
exports.settingsmanager:saveSetting("language", newLang)
end
addCommandHandler( "lang", changeLaguage )

function onStart ()
local playerLanguage = exports.settingsmanager:loadSetting ( "language" )
if no playerLanguage then
exports.settingsmanager:saveSetting("language", "english") --here we set default language
end
outputChatBox ( "Current language is " ..playerLanguage.. ". Type /language to change")
end
addEventHandler( "onClientResourceStart", resourceRoot, onStart )
</syntaxhighlight>
Then XML file will look like this:
<syntaxhighlight lang="xml">
<settings>
<language-manager>
<language>english</language>
</language-manager>
</settings>
</syntaxhighlight>
XML node called "language-manager" because resource name of the resource which called exported function is "language-manager".

Resource:Settingsmanager

2018-01-06T17:47:01Z

AleksCore: Created page with "[https://community.multitheftauto.com/index.php?p=resources&s=details&id=15127 Settings manager] is a simple resource to save/load player settings. '''All settings stored clie..."

[https://community.multitheftauto.com/index.php?p=resources&s=details&id=15127 Settings manager] is a simple resource to save/load player settings. '''All settings stored client-side in a XML file placed using private [[filepath]]''' ( ''\MTA San Andreas\mods\deathmatch\priv\<'''server-id'''>\settingsmanager'' )

==Exported functions:==
<syntaxhighlight lang="lua">
saveSetting ( string settingName, var value [, string resourceName ] )
</syntaxhighlight>
Returns true if value was successfully saved, false otherwise.
<syntaxhighlight lang="lua">
loadSetting ( string settingName [, string resourceName ] )
</syntaxhighlight>
Returns the value if it was received successfully, '''nil''' otherwise. Strings "true" and "false" will be returned as booleans.

* '''Last argument is optional for both functions. It used to store settings in XML file under resourceName node.''' Default argument is the resource name of the resource which called the exported function. See example below for more information.

== Example: ==
For example we have a "language-manager" resource with script like this:
<syntaxhighlight lang="lua">
function changeLanguage ( _, newLang )
if no newLang then
outputChatBox('Error. Command syntax: /lang <language name>. Available languages: "english", "russian"')
return
end
exports.settingsmanager:saveSetting("language", newLang)
end
addCommandHandler( "lang", changeLaguage )

function onStart ()
local playerLanguage = exports.settingsmanager:loadSetting ( "language" )
if no playerLanguage then
exports.settingsmanager:saveSetting("language", "english") --here we set default language
end
outputChatBox ( "Current language is " ..playerLanguage.. ". Type /language to change")
end
addEventHandler( "onClientResourceStart", resourceRoot, onStart )
</syntaxhighlight>
Then XML file will look like this:
<syntaxhighlight lang="xml">
<settings>
<language-manager>
<language>english</language>
</language-manager>
</settings>
</syntaxhighlight>
XML node called "language-manager" because resource name of the resource which called exported function is "language-manager".

Template:Server functions

2016-10-09T17:03:44Z

AleksCore:

*[[addCommandHandler]]
*[[executeCommandHandler]]
*[[fromJSON]]
*[[getFPSLimit]]
*[[getMaxPlayers]]
*[[getServerHttpPort]]
*[[getServerName]]
*[[getServerPassword]]
*[[getServerPort]]
*[[getVersion]]
{{New items|3.0153|1.5.3|
*[[getCommandHandlers]]
}}
*[[isGlitchEnabled]]
*[[outputChatBox]]
*[[outputConsole]]
*[[outputDebugString]]
*[[outputServerLog]]
*[[removeCommandHandler]]
*[[setFPSLimit]]
*[[setGlitchEnabled]]
*[[setMaxPlayers]]
*[[setServerPassword]]
*[[showChat]]
*[[shutdown]]
*[[toJSON]]

GetCommandHandlers

2016-10-09T16:56:55Z

AleksCore:

{{Server function}}
__NOTOC__
{{New items|3.0153|1.5.3|
This function is used to retrieve a list of all the registered command handlers of a given resource (or of all resources).
}}

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
table getCommandHandlers ( [ resource theResource ] )
</syntaxhighlight>

==Optional Arguments==
*'''theResource:''' The resource from which you wish to retrieve all command handlers. Or leave it empty to retrieve command handlers of all resources.
</section>

===Returns===
Returns a ''table'' containing all the commands of the given resource or a table with subtables containing the command and theResource pointer ( { "command", theResource } ). See examples below if you don't understand it.

==Example==
<section class="server" name="Server" show="true">
This example add a command to output list of all commands in the chat.
<syntaxhighlight lang="lua">
addCommandHandler( "commands",
function(player)
local commandsList = {} --table to store commands

--store/sort commands in the table where key is resource and value is table with commands
for _, subtable in pairs( getCommandHandlers() ) do
local commandName = subtable[1]
local theResource = subtable[2]

if not commandsList[theResource] then
commandsList[theResource] = {}
end

table.insert( commandsList[theResource], commandName )
end

--output sorted information in the chat
for theResource, commands in pairs( commandsList ) do
local resourceName = getResourceInfo( theResource, "name" ) or getResourceName( theResource ) --try to get full name, if no full name - use short name
outputChatBox( "== "..resourceName.. " ==", player, 0, 255, 0 )

--output list of commands
for _, command in pairs( commands ) do
outputChatBox( "/"..command, player, 255, 255, 255 )
end
end
end
)
</syntaxhighlight>
</section>

<section class="server" name="Server" show="true">
This example add a command to output list of all commands for the resource in the chat. Syntax: /commands [resource-name]
<syntaxhighlight lang="lua">
addCommandHandler( "commands",
function( player, _, resourceName )
if not resourceName then
resourceName = ""
end

local theResource = getResourceFromName( resourceName )

if not theResource then
outputChatBox( "Can't find resource with name \"" .. resourceName .. "\".", player, 255, 0, 0 )
return false
end

outputChatBox( "== Commands from \""..resourceName.. "\" resource ==", player, 0, 255, 0 )

local commands = getCommandHandlers( theResource )
for _, command in pairs( commands ) do
outputChatBox( "/"..command, player, 255, 255, 255 )
end
end
)
</syntaxhighlight>
</section>

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

GetCommandHandlers

2016-10-09T14:16:47Z

AleksCore: /* Returns */

{{Server function}}
__NOTOC__
This function is used to retrieve a list of all the registered command handlers of a given resource (or of all resources).

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
table getElementsByType ( [ resource theResource ] )
</syntaxhighlight>

==Optional Arguments==
*'''theResource:''' The resource from which you wish to retrieve all command handlers. Or leave it empty to retrieve command handlers of all resources.
</section>

===Returns===
Returns a ''table'' containing all the commands of the given resource or a table with subtables containing the command and theResource pointer ( { "command", theResource } ). See examples below if you don't understand it.

==Example==
<section class="server" name="Server" show="true">
This example add a command to output list of all commands in the chat.
<syntaxhighlight lang="lua">
addCommandHandler( "commands",
function(player)
local commandsList = {} --table to store commands

--store/sort commands in the table where key is resource and value is table with commands
for _, subtable in pairs( getCommandHandlers() ) do
local commandName = subtable[1]
local theResource = subtable[2]

if not commandsList[theResource] then
commandsList[theResource] = {}
end

table.insert( commandsList[theResource], commandName )
end

--output sorted information in the chat
for theResource, commands in pairs( commandsList ) do
local resourceName = getResourceInfo( theResource, "name" ) or getResourceName( theResource ) --try to get full name, if no full name - use short name
outputChatBox( "== "..resourceName.. " ==", player, 0, 255, 0 )

--output list of commands
for _, command in pairs( commands ) do
outputChatBox( "/"..command, player, 255, 255, 255 )
end
end
end
)
</syntaxhighlight>
</section>

<section class="server" name="Server" show="true">
This example add a command to output list of all commands for the resource in the chat. Syntax: /commands [resource-name]
<syntaxhighlight lang="lua">
addCommandHandler( "commands",
function( player, _, resourceName )
if not resourceName then
resourceName = ""
end

local theResource = getResourceFromName( resourceName )

if not theResource then
outputChatBox( "Can't find resource with name \"" .. resourceName .. "\".", player, 255, 0, 0 )
return false
end

outputChatBox( "== Commands from \""..resourceName.. "\" resource ==", player, 0, 255, 0 )

local commands = getCommandHandlers( theResource )
for _, command in pairs( commands ) do
outputChatBox( "/"..command, player, 255, 255, 255 )
end
end
)
</syntaxhighlight>
</section>

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

GetCommandHandlers

2016-10-09T14:12:56Z

AleksCore: /* Example */

{{Server function}}
__NOTOC__
This function is used to retrieve a list of all the registered command handlers of a given resource (or of all resources).

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
table getElementsByType ( [ resource theResource ] )
</syntaxhighlight>

==Optional Arguments==
*'''theResource:''' The resource from which you wish to retrieve all command handlers. Or leave it empty to retrieve command handlers of all resources.
</section>

===Returns===
Returns a ''table'' containing all the commands of the given resource or a table with subtables containing the command and theResource pointer ( { "command", theResource } )

==Example==
<section class="server" name="Server" show="true">
This example add a command to output list of all commands in the chat.
<syntaxhighlight lang="lua">
addCommandHandler( "commands",
function(player)
local commandsList = {} --table to store commands

--store/sort commands in the table where key is resource and value is table with commands
for _, subtable in pairs( getCommandHandlers() ) do
local commandName = subtable[1]
local theResource = subtable[2]

if not commandsList[theResource] then
commandsList[theResource] = {}
end

table.insert( commandsList[theResource], commandName )
end

--output sorted information in the chat
for theResource, commands in pairs( commandsList ) do
local resourceName = getResourceInfo( theResource, "name" ) or getResourceName( theResource ) --try to get full name, if no full name - use short name
outputChatBox( "== "..resourceName.. " ==", player, 0, 255, 0 )

--output list of commands
for _, command in pairs( commands ) do
outputChatBox( "/"..command, player, 255, 255, 255 )
end
end
end
)
</syntaxhighlight>
</section>

<section class="server" name="Server" show="true">
This example add a command to output list of all commands for the resource in the chat. Syntax: /commands [resource-name]
<syntaxhighlight lang="lua">
addCommandHandler( "commands",
function( player, _, resourceName )
if not resourceName then
resourceName = ""
end

local theResource = getResourceFromName( resourceName )

if not theResource then
outputChatBox( "Can't find resource with name \"" .. resourceName .. "\".", player, 255, 0, 0 )
return false
end

outputChatBox( "== Commands from \""..resourceName.. "\" resource ==", player, 0, 255, 0 )

local commands = getCommandHandlers( theResource )
for _, command in pairs( commands ) do
outputChatBox( "/"..command, player, 255, 255, 255 )
end
end
)
</syntaxhighlight>
</section>

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

GetCommandHandlers

2016-10-09T13:57:32Z

AleksCore: /* Example */

GetCommandHandlers

2016-10-09T13:33:38Z

AleksCore: /* Example */

GetCommandHandlers

2016-10-09T13:32:33Z

AleksCore: /* Example */

GetCommandHandlers

2016-10-09T13:28:22Z

AleksCore: /* Example */

GetCommandHandlers

2016-10-09T13:26:09Z

AleksCore:

GetCommandHandlers

2016-10-09T13:14:21Z

AleksCore:

GetCommandHandlers

2016-10-09T12:57:42Z

AleksCore: /* Returns */

GetCommandHandlers

2016-10-09T12:53:37Z

AleksCore: Created page with "{{Server function}} __NOTOC__ This function is used to retrieve a list of all the registered command handlers of a given resource (or of all resources). ==Syntax== <section..."

GetOriginalHandling

2015-10-10T20:55:20Z

AleksCore: fixed wrong example

{{Server client function}}
__NOTOC__
This function returns a table of the original vehicle handling. Use [[getVehicleHandling]] if you wish to get the current handling of a vehicle, or [[getModelHandling]] for a specific vehicle model.

==Syntax==
<syntaxhighlight lang="lua">
table getOriginalHandling ( int modelID )
</syntaxhighlight>

===Required Arguments===
*'''modelID:''' The vehicle ID you wish to get the original handling from.

===Returns===
Returns a ''table'' containing all the handling data, ''false'' otherwise. Here a list of valid table properties and what they return:
{{Handling Properties}}

==Example==
<section name="Server & Client" class="both" show="true">
This example creates a new function called getVehicleOriginalProperty, which simulates the previous syntax of this function.
<syntaxhighlight lang="lua">
function getVehicleOriginalProperty( element, property )
if isElement ( element ) and getElementType ( element ) == "vehicle" and type ( property ) == "string" then -- Make sure there's a valid vehicle and a property string
local modelID = getElementModel ( element )
local handlingTable = getOriginalHandling ( modelID ) -- Get the handling as table and save as handlingTable
local value = handlingTable[property] -- Get the value from the table

if value then -- If there's a value (valid property)
return value -- Return it
end
end

return false -- Not an element, not a vehicle or no valid property string. Return failure
end
</syntaxhighlight>
</section>

==See other vehicle functions==
{{Vehicle functions}}

User:AleksCore

2013-04-24T20:14:26Z

AleksCore:

I Love MTA :)

А милитари лалка

User:AleksCore

2013-04-24T20:13:44Z

AleksCore:

I Love MTA :)

lukum :P

User:AleksCore

2012-03-01T18:03:28Z

AleksCore: Created page with "I Love MTA :)"

I Love MTA :)