IsResourceArchived - Revision history

FileEX: /* See Also */

2024-09-06T22:48:06Z

Nico834: Correcting incorrect phrases, replacing the existing example and adding more examples.

2023-08-12T03:13:51Z

Correcting incorrect phrases, replacing the existing example and adding more examples.

← Older revision		Revision as of 03:13, 12 August 2023
Line 2:		Line 2:
	{{Server function}}		{{Server function}}
	{{New feature/item\|3.0155\|1.5.5\|11550\|		{{New feature/item\|3.0155\|1.5.5\|11550\|
	Checks whether a resource is ~~currently~~ archived (running from ~~within~~ a ZIP file).		Checks whether the specified resource is archived. (Currently running from a ZIP file)
	}}		}}

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">bool isResourceArchived ( resource resourceElement )</syntaxhighlight>		<syntaxhighlight lang="lua">bool isResourceArchived(resource resourceElement)</syntaxhighlight>
	{{OOP\|\|[[resource]]:isArchived\|archived\|}}		{{OOP\|\|[[resource]]:isArchived\|archived\|}}

	===Required Arguments===		===Required Arguments===
	*'''~~resource~~:''' ~~the~~ resource to check		*'''resourceElement:''' The resource to check.

	===Returns===		===Returns===
	Returns ''true'' if a resource is archived, ''false'' if it is not archived, or ''nil'' if ~~there is~~ problem ~~with resource~~.		Returns '''true''' if the selected resource is archived, '''false''' if it is not archived, and '''nil''' if some kind of problem occurred.

	==Example==		==Example==
			<section name="Example 1" class="server" show="true">
			This example stops the resource if it's archived.
			<syntaxhighlight lang="lua">
			addEventHandler("onResourceStart", resourceRoot,
			function(resourceElement)
			if isResourceArchived(resourceElement) then
			cancelEvent()
			end
			end
			)
			</syntaxhighlight>
			</section>

	This example stops the resource ~~from loading~~ if it's archived		<section name="Example 2 (OOP)" class="server" show="true">
			This example stops the resource if it's archived by using the object oriented method. '''(It's important to note that you need to enable OOP in meta.xml to use this)'''
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function ~~resourceLoading~~( ~~res~~ )		addEventHandler("onResourceStart", resourceRoot,
	if ~~res.archived~~ then		function(resourceElement)
	cancelEvent()		if resourceElement:isArchived() then
	end		cancelEvent()
			end
			end
			)
			</syntaxhighlight>
			</section>

	~~end~~		<section name="Example 3 (OOP)" class="server" show="true">
	~~addEventHandler~~('~~onResourcePreStart~~',~~root~~,~~resourceLoading,true,'high+10'~~)		This example stops the resource if it's archived by using the object oriented variable. '''(It's important to note that you need to enable OOP in meta.xml to use this)'''
			<syntaxhighlight lang="lua">
			addEventHandler("onResourceStart", resourceRoot,
			function(resourceElement)
			if resourceElement.archived then
			cancelEvent()
			end
			end
			)
	</syntaxhighlight>		</syntaxhighlight>
			</section>

	==See Also==		==See Also==
	{{Resource functions}}		{{Resource functions}}

Gothemsh: Fixed build number and added example.

2017-07-05T19:12:49Z

Fixed build number and added example.

← Older revision		Revision as of 19:12, 5 July 2017
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server function}}		{{Server function}}
	{{New feature/item\|3.0155\|1.5.5\|~~11533~~\|		{{New feature/item\|3.0155\|1.5.5\|11550\|
	Checks whether a resource is currently archived (running from within a ZIP file).		Checks whether a resource is currently archived (running from within a ZIP file).
	}}		}}
Line 16:		Line 16:
	==Example==		==Example==

	~~{{Example}}~~		This example stops the resource from loading if it's archived
			<syntaxhighlight lang="lua">
			function resourceLoading( res )
			if res.archived then
			cancelEvent()
			end

			end
			addEventHandler('onResourcePreStart',root,resourceLoading,true,'high+10')
			</syntaxhighlight>
	==See Also==		==See Also==
	{{Resource functions}}		{{Resource functions}}

Qaisjp: return nil if error

2017-07-04T00:37:12Z

return nil if error

← Older revision		Revision as of 00:37, 4 July 2017
Line 12:		Line 12:

	===Returns===		===Returns===
	Returns ''true'' if a resource is archived, ''false'' if it is not archived, or ''~~false~~'' if there is problem with resource.		Returns ''true'' if a resource is archived, ''false'' if it is not archived, or ''nil'' if there is problem with resource.

	==Example==		==Example==

Qaisjp: isResourceArchived is server only, not shared

2017-07-04T00:07:46Z

isResourceArchived is server only, not shared

← Older revision		Revision as of 00:07, 4 July 2017
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{~~Shared~~ function}}		{{Server function}}
	{{New feature/item\|3.0155\|1.5.5\|11533\|		{{New feature/item\|3.0155\|1.5.5\|11533\|
	Checks whether a resource is currently archived (running from within a ZIP file).		Checks whether a resource is currently archived (running from within a ZIP file).

Qaisjp: Created page with "NOTOC {{Shared function}} {{New feature/item|3.0155|1.5.5|11533| Checks whether a resource is currently archived (running from within a ZIP file). }} ==Syntax==
2017-07-04T00:07:28Z

Created page with "NOTOC {{Shared function}} {{New feature/item|3.0155|1.5.5|11533| Checks whether a resource is currently archived (running from within a ZIP file). }} ==Syntax== <syntaxhi..."

New page
NOTOC
{{Shared function}}
{{New feature/item|3.0155|1.5.5|11533|
Checks whether a resource is currently archived (running from within a ZIP file).
}}

==Syntax==
<syntaxhighlight lang="lua">bool isResourceArchived ( resource resourceElement )</syntaxhighlight>
{{OOP||[[resource]]:isArchived|archived|}}
===Required Arguments===
*'''resource:''' the resource to check

===Returns===
Returns ''true'' if a resource is archived, ''false'' if it is not archived, or ''false'' if there is problem with resource.

==Example==

{{Example}}

==See Also==
{{Resource functions}}

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

	==See Also==		==See Also==
	{{~~Resource functions~~}}		{{Resource_functions\|server}}