Community Resources: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (Prettified)
 
Line 1: Line 1:
==Community calls documentation==
This page lists PHP calls that MTA Community allows you to use in your scripts, via [[callRemote]].


==community.mtasa.com/mta/resources.php==
==community.mtasa.com/mta/resources.php==


Retrieves the latest version number for a resource available on MTA Community
Retrieves the latest version number for a resource available on MTA Community.


'''Arguments''':
'''Arguments''':
Line 14: Line 14:
*a number which is the community id for the resource, or nil if an error has occurred
*a number which is the community id for the resource, or nil if an error has occurred


==Example==
===Example===
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addEventHandler( "onResourceStart", getResourceRootElement(),  
addEventHandler( "onResourceStart", getResourceRootElement(),  
Line 42: Line 42:
'''Returns:''' an integer, 1 if user is valid, 0 otherwise
'''Returns:''' an integer, 1 if user is valid, 0 otherwise


==Example==
===Example===
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addEventHandler ( "onPlayerJoin", getRootElement(), function()
addEventHandler ( "onPlayerJoin", getRootElement(), function()
Line 59: Line 59:
==community.mtasa.com/mta/groups.php==
==community.mtasa.com/mta/groups.php==


Retrieves group information from MTA Community
Retrieves group information from MTA Community.


'''Arguments''':
'''Arguments''':
Line 79: Line 79:
'''Returns:''' a table of usernames in the group
'''Returns:''' a table of usernames in the group


==Examples==
===Examples===
<section name="Group Example" class="server" show="false">
<section name="Group Example" class="server" show="false">
This outputs the servers group name, if the group is public or private, and the registration time.
This outputs the servers group name, if the group is public or private, and the registration time.

Latest revision as of 09:25, 23 June 2016

This page lists PHP calls that MTA Community allows you to use in your scripts, via callRemote.

community.mtasa.com/mta/resources.php

Retrieves the latest version number for a resource available on MTA Community.

Arguments:

string "version", string resourceName

Returns:

  • a string with the resource name
  • a string of the resource version in format of "x.x.x", or integer 0 if an error has occurred
  • a number which is the community id for the resource, or nil if an error has occurred

Example

addEventHandler( "onResourceStart", getResourceRootElement(), 
   function()
      callRemote( "http://community.mtasa.com/mta/resources.php", handleVersionCheck, "version", getResourceName(getThisResource()) )
   end
)

function handleVersionCheck( resName, commVer, commId )
    local thisVer = getResourceInfo(getThisResource(), "version")
    if commId and thisVer ~= commVer then
        outputChatBox( getResourceName(getThisResource()) .. " is outdated. Your version: " .. thisVer .. " | Current: " .. commVer )
        outputChatBox( "Please download the update @ http://community.multitheftauto.com/index.php?p=resources&s=details&id=" .. commId )
    end
end

community.mtasa.com/mta/groups.php

Retrieves group information from MTA Community.

Arguments:

string "info", int groupID

Returns 5 values:

  • Group name
  • Owner username
  • Number of members
  • Public. Integer: 1 if the group is public, 0 otherwise
  • Registration time


Members list:

string "members", int groupID

Returns: a table of usernames in the group

Examples

Click to expand [+]
Group Example
Click to expand [+]
Members Example