GetResourceFromName: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{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). | ||
| Line 13: | Line 14: | ||
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. | ||
==Example== | ==Example== | ||
<section name="Server" class="server" show="true"> | |||
This example prints out a message to the chatbox when a resource named ''playerblips'' is started. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function onStart( theResource ) | |||
function onStart( | local blipsResource = getResourceFromName ( "playerblips" ) -- get the resource of name "playerblips" | ||
local blipsResource = getResourceFromName("playerblips") -- get the resource of name "playerblips" | if ( blipsResource and theResource == blipsResource ) then -- check if the resource started was it | ||
if (blipsResource and | outputChatBox ( "Blips resource started!" ) | ||
outputChatBox("Blips resource started!") | |||
end | end | ||
end | end | ||
addEventHandler ( "onResourceStart", getRootElement(), onStart ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | |||
==See Also== | ==See Also== | ||
{{Resource_functions}} | {{Resource_functions}} | ||
Revision as of 07:40, 19 June 2009
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 )
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.
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
- call
- fetchRemote
- getResourceConfig
- getResourceDynamicElementRoot
- getResourceExportedFunctions
- getResourceFromName
- getResourceName
- getResourceRootElement
- getResourceState
- getThisResource
- getRemoteRequests
- getRemoteRequestInfo