GetResourceInfo: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Needs_Checking|may return a string, bool or nil (?) --[[User:Jbeta|jbeta]]}}
__NOTOC__  
__NOTOC__  
{{server function}}
This function retrieves the value of any attribute in a resource info tag.
This function retrieves the value of any attribute in a resource info tag.


Line 7: Line 7:
string getResourceInfo ( resource theResource, string attribute )  
string getResourceInfo ( resource theResource, string attribute )  
</syntaxhighlight>  
</syntaxhighlight>  
 
{{OOP||[[resource]]:getInfo}}
===Required Arguments===  
===Required Arguments===  
*'''theResource:''' the resource we are getting the info from.
*'''theResource:''' the resource we are getting the info from.
Line 16: Line 16:


==Example==
==Example==
This function tells the server who's the author who made the currently running resource.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
function outputAuthor()
blabhalbalhb --abababa
    author = getResourceInfo ( getThisResource(), "author" )    --Get the authors name
--This line does this...
    if author then    --if it exists
mooo
        outputChatBox( author .. " made this script." )    --tell the world his name
    else    --if it doesn't
        outputChatBox( "I've no idea who made this script." )    --apologize.
    end
end
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Resource_functions}}
{{Resource_functions|server}}
[[Category:Incomplete]]

Latest revision as of 22:46, 6 September 2024

This function retrieves the value of any attribute in a resource info tag.

Syntax

string getResourceInfo ( resource theResource, string attribute ) 

OOP Syntax Help! I don't understand this!

Method: resource:getInfo(...)


Required Arguments

  • theResource: the resource we are getting the info from.
  • attribute: the name of the attribute we want info about.

Returns

Returns a string with the attribute value if it exists, false otherwise.

Example

This function tells the server who's the author who made the currently running resource.

function outputAuthor()
    author = getResourceInfo ( getThisResource(), "author" )    --Get the authors name
    if author then    --if it exists
        outputChatBox( author .. " made this script." )    --tell the world his name
    else    --if it doesn't
        outputChatBox( "I've no idea who made this script." )    --apologize.
    end
end

See Also