GetResourceConfig: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 18: Line 18:


==Example==
==Example==
In the example
This example opens a configuration file and prints the value of the 'attr' attribute of the first 'group' node.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function resourceStart ( resourcename )   --When the resource is started
function resourceStart ( resourcename )                         -- When a resource is started
     if ( resourcename == getThisResource () ) then   --if the resource is this one
     if ( resourcename == getThisResource () ) then             -- and the resource is this one
         node = getResourceConfig( resourcename, "file.xml" )   --get the configuration file
         node = getResourceConfig( resourcename, "config.xml" ) -- get the configuration file
         local subNode = xmlFindSubNode( node, "group", 1 )   --get a subnode in it
         local subNode = xmlFindSubNode( node, "group", 1 )     -- get a subnode in it
         outputChatBox( xmlNodeGetAttribute( node, "attr" ) )    --output its' the attributes value to chatbox.
         outputChatBox( xmlNodeGetAttribute( node, "attr" ) )    -- output its attributes value to chatbox
     end
     end
end
end

Revision as of 13:34, 19 August 2007

This function is used to return the root node of a configuration file. Config files must be predefined in a resource's meta file.

Syntax

xmlnode getResourceConfig ( [resource theResource = getThisResource()], string filename )

Required Arguments

  • filename: The exact file name of the configuration file. (e.g. "file.xml" )

Optional Arguments

  • theResource: The resource from which the function calls the configuration file

Returns

Returns the root node of the specified configuration file. If the file is corrupted, not defined in the meta file or doesn't exist, returns false.

Example

This example opens a configuration file and prints the value of the 'attr' attribute of the first 'group' node.

function resourceStart ( resourcename )                         -- When a resource is started
    if ( resourcename == getThisResource () ) then              -- and the resource is this one
        node = getResourceConfig( resourcename, "config.xml" )  -- get the configuration file
        local subNode = xmlFindSubNode( node, "group", 1 )      -- get a subnode in it
        outputChatBox( xmlNodeGetAttribute( node, "attr" ) )    -- output its attributes value to chatbox
    end
end
addEventHandler ( "onResourceStart", getRootElement(), resourceStart )

See Also