Resource:Settingsmanager - Revision history

AleksCore at 18:04, 6 January 2018

2018-01-06T18:04:51Z

← Older revision		Revision as of 18:04, 6 January 2018
Line 27:		Line 27:
	function onStart ()		function onStart ()
	local playerLanguage = exports.settingsmanager:loadSetting ( "language" )		local playerLanguage = exports.settingsmanager:loadSetting ( "language" )
	if playerLanguage == nil then		if playerLanguage == nil then --if no language set
	exports.settingsmanager:saveSetting("language", ~~"english"~~) --~~here we~~ set default language		playerLanguage = "english"
			exports.settingsmanager:saveSetting("language", playerLanguage ) --set default language
	end		end
	outputChatBox ( "Current language is " ..playerLanguage.. ". Type /language to change")		outputChatBox ( "Current language is " ..playerLanguage.. ". Type /language to change")

AleksCore at 18:00, 6 January 2018

2018-01-06T18:00:10Z

← Older revision		Revision as of 18:00, 6 January 2018
Line 27:		Line 27:
	function onStart ()		function onStart ()
	local playerLanguage = exports.settingsmanager:loadSetting ( "language" )		local playerLanguage = exports.settingsmanager:loadSetting ( "language" )
	if no playerLanguage then		if playerLanguage == nil then
	exports.settingsmanager:saveSetting("language", "english") --here we set default language		exports.settingsmanager:saveSetting("language", "english") --here we set default language
	end		end

AleksCore at 17:51, 6 January 2018

2018-01-06T17:51:39Z

← Older revision		Revision as of 17:51, 6 January 2018
Line 1:		Line 1:
	[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'' )		[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:==		==Exported functions:==
Line 5:		Line 5:
	saveSetting ( string settingName, var value [, string resourceName ] )		saveSetting ( string settingName, var value [, string resourceName ] )
	</syntaxhighlight>		</syntaxhighlight>
	Returns true if value was successfully saved, false otherwise.		Returns ''true'' if value was successfully saved, ''false'' otherwise.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	loadSetting ( string settingName [, string resourceName ] )		loadSetting ( string settingName [, string resourceName ] )
	</syntaxhighlight>		</syntaxhighlight>
	Returns the value if it was received successfully, '''nil''' otherwise. Strings "true" and "false" will be returned as booleans.		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.		* 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: ==		== Example: ==

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..."

2018-01-06T17:47:01Z

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..."

New page

[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".