RemoveResourceDefaultSetting: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(New page: __NOTOC__ {{Server function}} This function is used to remove a default setting from specified resource. <!-- What are default settings? --> Category:Incomplete <!-- Do not remove...)
 
(Remove issue from deprecated function)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Server function}}
{{Server function}}
{{Disabled|This function doesn't work actually. See [[#Issues|issues]] for more information.}}
This function is used to remove a default setting from specified [[resource]].
This function is used to remove a default setting from specified [[resource]].
<!-- What are default settings? -->
<!-- What are default settings? -->
[[Category:Incomplete]] <!-- Do not remove unless you finish the documentation. -->


==Syntax==  
==Syntax==  
Line 18: Line 18:


==Example==
==Example==
<syntaxhighlight lang="lua">
This example would check if the server has the freeroam resource and removes the default settings called "spawnmaponstart".
--TODO
<syntaxhighlight lang="lua">addEventHandler("onResourceStart",resourceRoot,function()
local freeroamRes = getResourceFromName("Freeroam")
if(freeroamRes)then
removeResourceDefaultSetting(freeroamRes,"spawnmaponstart")
end
end)
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Resource_functions}}
{{Resource_functions}}
[[Category:Needs_Example]]

Latest revision as of 10:41, 30 January 2022

Dialog-warning.png Function has been disabled.

Reason/Note: This function doesn't work actually. See issues for more information.

This function is used to remove a default setting from specified resource.

Syntax

bool removeResourceDefaultSetting ( resource theResource, string settingName ) 

Required Arguments

  • theResource: the resource which setting is to be removed
  • settingName: name of the default setting which is to be removed

Returns

Returns true if the default setting was successfully removed, false otherwise.

Example

This example would check if the server has the freeroam resource and removes the default settings called "spawnmaponstart".

addEventHandler("onResourceStart",resourceRoot,function()
	local freeroamRes = getResourceFromName("Freeroam")
	if(freeroamRes)then
		removeResourceDefaultSetting(freeroamRes,"spawnmaponstart")
	end
end)

See Also

Shared