RefreshResources - Revision history

FileEX: /* See Also */

2024-09-06T22:48:25Z

LordHenry: Note highlights

2021-05-17T22:04:12Z

Note highlights

← Older revision		Revision as of 22:04, 17 May 2021
Line 2:		Line 2:
	__NOTOC__		__NOTOC__
	This function finds new resources and checks for changes to the current ones.		This function finds new resources and checks for changes to the current ones.
	{{Note\|The resource using this function needs access to ''function.refreshResources'' in order for this function to work. You can give it the access by including an aclrequest command in its [[meta.xml]] file or by adding it to the admin [[ACL]] group.}}		{{Note\|The resource using this function needs access to ''function.refreshResources'' in order for this function to work. You can give it the access by including an [[Server_Commands#aclrequest\|aclrequest]] command in its [[meta.xml]] file or by adding it to the admin [[ACL]] group.}}

	==Syntax==		==Syntax==

LordHenry: Note

2021-05-17T22:00:45Z

Note

← Older revision		Revision as of 22:00, 17 May 2021
Line 2:		Line 2:
	__NOTOC__		__NOTOC__
	This function finds new resources and checks for changes to the current ones.		This function finds new resources and checks for changes to the current ones.
	{{Note\|The resource using this function needs access to ''function.refreshResources'' in order to this function work. You can ~~allow~~ it by ~~using~~ aclrequest ~~on the~~ [[meta.xml]] or by ~~setting the resource on~~ the admin ACL group.}}		{{Note\|The resource using this function needs access to ''function.refreshResources'' in order for this function to work. You can give it the access by including an aclrequest command in its [[meta.xml]] file or by adding it to the admin [[ACL]] group.}}

	==Syntax==		==Syntax==

LordHenry: Note

2021-05-17T13:48:30Z

Note

← Older revision		Revision as of 13:48, 17 May 2021
Line 2:		Line 2:
	__NOTOC__		__NOTOC__
	This function finds new resources and checks for changes to the current ones.		This function finds new resources and checks for changes to the current ones.
			{{Note\|The resource using this function needs access to ''function.refreshResources'' in order to this function work. You can allow it by using aclrequest on the [[meta.xml]] or by setting the resource on the admin ACL group.}}

	==Syntax==		==Syntax==

Pawelo: typo

2017-12-01T19:06:06Z

typo

← Older revision		Revision as of 19:06, 1 December 2017
Line 17:		Line 17:

	===Returns===		===Returns===
	Returns true is refresh was successful, false otherwise.		Returns true if refresh was successful, false otherwise.

	==Example==		==Example==

Ccw at 01:09, 8 October 2017

2017-10-08T01:09:31Z

← Older revision		Revision as of 01:09, 8 October 2017
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool refreshResources ( [ bool refreshAll = false ] )		bool refreshResources ( [ bool refreshAll = false, resource targetResource = nil ] )
	</syntaxhighlight>		</syntaxhighlight>

Line 11:		Line 11:
	{{OptionalArg}}		{{OptionalArg}}
	*'''refreshAll''': If ''true'' MTA will check for changes in all resources. If ''false'', MTA will only check for new resources and try to reload resources with errors		*'''refreshAll''': If ''true'' MTA will check for changes in all resources. If ''false'', MTA will only check for new resources and try to reload resources with errors
			{{New items\|5.0155\|1.5.5-9.11718\|
			*'''targetResource''': If set, the refresh is restricted to the supplied resource only
			}}
	'''Note:''' Checking for changes in all resources can result in lag for a short period of time. It should generally be avoided to set refreshAll to ''true''.		'''Note:''' Checking for changes in all resources can result in lag for a short period of time. It should generally be avoided to set refreshAll to ''true''.

Line 26:		Line 28:
	end		end
	addCommandHandler("refreshresources", commandRefreshResources)		addCommandHandler("refreshresources", commandRefreshResources)
			</syntaxhighlight>


			This example will refresh only the named resource:
			<syntaxhighlight lang="lua">
			refreshResources(true, getResourceFromName("admin"))
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

			==Changelog==
			{{ChangelogHeader}}
			{{ChangelogItem\|1.5.5-9.11718\|Added targetResource argument}}

	==See Also==		==See Also==
	{{Resource_functions}}		{{Resource_functions}}

Snert: Added missing optional argument, for correctness' sake

2011-03-17T09:56:52Z

Added missing optional argument, for correctness' sake

← Older revision		Revision as of 09:56, 17 March 2011
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool refreshResources ( )		bool refreshResources ( [ bool refreshAll = false ] )
	</syntaxhighlight>		</syntaxhighlight>

			===Optional Arguments===
			{{OptionalArg}}
			*'''refreshAll''': If ''true'' MTA will check for changes in all resources. If ''false'', MTA will only check for new resources and try to reload resources with errors

			'''Note:''' Checking for changes in all resources can result in lag for a short period of time. It should generally be avoided to set refreshAll to ''true''.

	===Returns===		===Returns===
Line 13:		Line 19:
	==Example==		==Example==
	<section name="Server" class="server" show="true">		<section name="Server" class="server" show="true">
	This example will refresh resources when a player uses the /refreshresources command just like the hardcoded /~~refresh~~.		This example will refresh resources when a player uses the /refreshresources command just like the hardcoded /refreshall.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function commandRefreshResources(player)		function commandRefreshResources(player)
	refreshResources()		refreshResources(true)
	outputChatBox("Resources refreshed", player, 255, 255, 0)		outputChatBox("Resources refreshed", player, 255, 255, 0)
	end		end

Arran Fortuna at 17:44, 16 March 2011

2011-03-16T17:44:47Z

← Older revision		Revision as of 17:44, 16 March 2011
Line 15:		Line 15:
	This example will refresh resources when a player uses the /refreshresources command just like the hardcoded /refresh.		This example will refresh resources when a player uses the /refreshresources command just like the hardcoded /refresh.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function commandRefreshResources()		function commandRefreshResources(player)
	refreshResources()		refreshResources()
	outputChatBox("Resources refreshed", player, 255, 255, 0)		outputChatBox("Resources refreshed", player, 255, 255, 0)

Arran Fortuna: Created page with "{{Server function}} NOTOC This function finds new resources and checks for changes to the current ones. ==Syntax== bool refreshResources ( ) ===Retur..."

2011-03-16T17:44:26Z

Created page with "{{Server function}} __NOTOC__ This function finds new resources and checks for changes to the current ones. ==Syntax== <syntaxhighlight lang="lua"> bool refreshResources ( ) </syntaxhighlight> ===Retur..."

New page

{{Server function}}
__NOTOC__
This function finds new resources and checks for changes to the current ones.

==Syntax==
<syntaxhighlight lang="lua">
bool refreshResources ( )
</syntaxhighlight>

===Returns===
Returns true is refresh was successful, false otherwise.

==Example==
<section name="Server" class="server" show="true">
This example will refresh resources when a player uses the /refreshresources command just like the hardcoded /refresh.
<syntaxhighlight lang="lua">
function commandRefreshResources()
refreshResources()
outputChatBox("Resources refreshed", player, 255, 255, 0)
end
addCommandHandler("refreshresources", commandRefreshResources)
</syntaxhighlight>
</section>

==See Also==
{{Resource_functions}}

← Older revision		Revision as of 22:48, 6 September 2024
Line 43:		Line 43:

	==See Also==		==See Also==
	{{Resource_functions}}		{{Resource_functions\|server}}

RefreshResources - Revision history

FileEX: /* See Also */

LordHenry: Note highlights

LordHenry: Note

LordHenry: Note

Pawelo: typo

Ccw at 01:09, 8 October 2017

Snert: Added missing optional argument, for correctness' sake

Arran Fortuna at 17:44, 16 March 2011

Arran Fortuna: Created page with "{{Server function}} __NOTOC__ This function finds new resources and checks for changes to the current ones. ==Syntax== bool refreshResources ( ) ===Retur..."

Arran Fortuna: Created page with "{{Server function}} NOTOC This function finds new resources and checks for changes to the current ones. ==Syntax== bool refreshResources ( ) ===Retur..."