Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

---

Checks whether the specified resource is archived. (Currently running from a ZIP file)

OOP Syntax Help! I don't understand this!

• Method: resource:isArchived(...)
• Variable: .archived

Syntax

bool isResourceArchived ( resource resourceElement )

Required Arguments

• resourceElement: The resource to check.

Returns

• bool: value

Returns true if the selected resource is archived, false if it is not archived, and nil if some kind of problem occurred.

Code Examples

Example 1 Example 2 Example 3

shared

This example stops the resource if it's archived.

addEventHandler("onResourceStart", resourceRoot,
  function(resourceElement)
    if isResourceArchived(resourceElement) then
      cancelEvent()
    end
  end
)

shared

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)

addEventHandler("onResourceStart", resourceRoot,
  function(resourceElement)
    if resourceElement:isArchived() then
      cancelEvent()
    end
  end
)

shared

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)

addEventHandler("onResourceStart", resourceRoot,
  function(resourceElement)
    if resourceElement.archived then
      cancelEvent()
    end
  end
)

See Also

Resource Functions

• abortRemoteRequest
• addResourceConfig
• addResourceMap
• call
• callRemote
• copyResource
• createResource
• deleteResource
• fetchRemote
• getRemoteRequestInfo
• getRemoteRequests
• getResourceACLRequests
• getResourceConfig
• getResourceDynamicElementRoot
• getResourceExportedFunctions
• getResourceFromName
• getResourceGUIElement
• getResourceInfo
• getResourceLastStartTime
• getResourceLoadFailureReason
• getResourceLoadTime
• getResourceMapRootElement
• getResourceName
• getResourceOrganizationalPath
• getResourceRootElement
• getResources
• getResourceState
• getThisResource
• isResourceArchived
• isResourceProtected
• refreshResources
• removeResourceFile
• renameResource
• restartResource
• setResourceInfo
• startResource
• stopResource
• updateResourceACLRequest

Resource Events

• onClientResourceFileDownload
• onClientResourceStart
• onClientResourceStop
• onPlayerResourceStart
• onResourceLoadStateChange
• onResourcePreStart
• onResourceStart
• onResourceStateChange
• onResourceStop

Resource Elements

• resource

Reference

• Scripting Functions