GetResourceFromName: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (move clientside caveat to returns section) |
||
| Line 2: | Line 2: | ||
{{Server client function}} | {{Server client function}} | ||
This function is used to retrieve a resource from its name. A resource's name is the same as its folder or file archive name on the server (without the extension). | This function is used to retrieve a resource from its name. A resource's name is the same as its folder or file archive name on the server (without the extension). | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
| Line 13: | Line 13: | ||
===Returns=== | ===Returns=== | ||
Returns the [[resource]] with the specified name, or ''false'' if no resource of that name exists. | Returns the [[resource]] with the specified name, or ''false'' if no resource of that name exists. Note that clientside this will also return ''false'' for resources that are in the ''loaded'' state, since the client is unaware of resources that have not been started. | ||
==Example== | ==Example== | ||
Latest revision as of 13:04, 4 February 2020
This function is used to retrieve a resource from its name. A resource's name is the same as its folder or file archive name on the server (without the extension).
Syntax
resource getResourceFromName ( string resourceName )
OOP Syntax Help! I don't understand this!
- Note: This function is a static function underneath the Resource class. OOP function available client side
- Method: Resource.getFromName(...)
Required Arguments
- resourceName: the name of the resource you wish to get.
Returns
Returns the resource with the specified name, or false if no resource of that name exists. Note that clientside this will also return false for resources that are in the loaded state, since the client is unaware of resources that have not been started.
Example
Click to collapse [-]
ServerThis example prints out a message to the chatbox when a resource named playerblips is started.
function onStart( theResource )
local blipsResource = getResourceFromName ( "playerblips" ) -- get the resource of name "playerblips"
if ( blipsResource and theResource == blipsResource ) then -- check if the resource started was it
outputChatBox ( "Blips resource started!" )
end
end
addEventHandler ( "onResourceStart", getRootElement(), onStart )
See Also
- abortRemoteRequest
- addResourceConfig
- addResourceMap
- call
- callRemote
- copyResource
- createResource
- deleteResource
- fetchRemote
- getRemoteRequestInfo
- getRemoteRequests
- getResourceACLRequests
- getResourceConfig
- getResourceDynamicElementRoot
- getResourceExportedFunctions
- getResourceFromName
- getResourceInfo
- getResourceLastStartTime
- getResourceLoadFailureReason
- getResourceLoadTime
- getResourceMapRootElement
- getResourceName
- getResourceOrganizationalPath
- getResourceRootElement
- getResources
- getResourceState
- getThisResource
- isResourceArchived
- isResourceProtected
- refreshResources
- removeResourceFile
- renameResource
- restartResource
- setResourceInfo
- startResource
- stopResource
- updateResourceACLRequest