RemoveResourceFile: Difference between revisions
Jump to navigation
Jump to search
m (Needs example) |
m (→See Also) |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 7: | Line 7: | ||
bool removeResourceFile ( resource theResource, string fileName ) | bool removeResourceFile ( resource theResource, string fileName ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[resource]]:removeFile}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type --> | <!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type --> | ||
| Line 14: | Line 14: | ||
===Returns=== | ===Returns=== | ||
Returns ''true'' if file was deleted, otherwise ''false''. | Returns ''true'' if file was deleted, otherwise ''false'' if the resource is in use or the file doesn't exist. | ||
==Example== | ==Example== | ||
< | This example removes a .txt file from the resource sx_remanager (in-game script editor) when started. | ||
<syntaxhighlight lang="lua">addEventHandler("onResourceStart",resourceRoot,function() | |||
resource = getResourceFromName("sx_resmanager") | |||
removeResourceFile(resource,"description.txt") | |||
end) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Resource_functions}} | {{Resource_functions|server}} | ||
Latest revision as of 22:48, 6 September 2024
This function removes a file from the resource.
Syntax
bool removeResourceFile ( resource theResource, string fileName )
OOP Syntax Help! I don't understand this!
- Method: resource:removeFile(...)
Required Arguments
- theResource: The resource element.
- fileName: The filename what you wan't to delete.
Returns
Returns true if file was deleted, otherwise false if the resource is in use or the file doesn't exist.
Example
This example removes a .txt file from the resource sx_remanager (in-game script editor) when started.
addEventHandler("onResourceStart",resourceRoot,function()
resource = getResourceFromName("sx_resmanager")
removeResourceFile(resource,"description.txt")
end)
See Also
- addResourceConfig
- addResourceMap
- callRemote
- copyResource
- createResource
- deleteResource
- getResourceACLRequests
- getResourceInfo
- getResourceLastStartTime
- getResourceLoadFailureReason
- getResourceLoadTime
- getResourceMapRootElement
- getResourceOrganizationalPath
- getResources
- isResourceArchived
- isResourceProtected
- refreshResources
- removeResourceFile
- renameResource
- restartResource
- setResourceInfo
- startResource
- stopResource
- updateResourceACLRequest
- Shared
- abortRemoteRequest
- call
- fetchRemote
- getResourceConfig
- getResourceDynamicElementRoot
- getResourceExportedFunctions
- getResourceFromName
- getResourceName
- getResourceRootElement
- getResourceState
- getThisResource
- getRemoteRequests
- getRemoteRequestInfo