Community Resources: Difference between revisions

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


==community.mtasa.com/mta/resources.php==
Retrieves the latest version number for a resource available on MTA Community.
'''Arguments''':
<syntaxhighlight lang="lua">
string "version", string resourceName
</syntaxhighlight>
'''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===
<syntaxhighlight lang="lua">
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
</syntaxhighlight>
<!--
==community.mtasa.com/mta/verify.php==
==community.mtasa.com/mta/verify.php==


Line 12: Line 42:
'''Returns:''' an integer, 1 if user is valid, 0 otherwise
'''Returns:''' an integer, 1 if user is valid, 0 otherwise


===Example===
<syntaxhighlight lang="lua">
addEventHandler ( "onPlayerJoin", getRootElement(), function()
  local username = getPlayerUserName ( source )
  local serial = getPlayerSerial ( source )
  callRemote ( "http://community.mtasa.com/mta/verify.php", validatePlayer, source, username, serial )
end )


function validatePlayer ( player, result )
  local valid = "invalid"
  if ( result == 1 ) then valid = "valid" end
  outputChatBox ( getPlayerName ( player ).."'s username is "..valid )
end
</syntaxhighlight>
-->
==community.mtasa.com/mta/groups.php==
==community.mtasa.com/mta/groups.php==


'''Calls:'''
Retrieves group information from MTA Community.


Info:
'''Arguments''':
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
int groupID
string "info", int groupID
</syntaxhighlight>  
</syntaxhighlight>  
'''Returns 5 values:'''<br />
'''Returns 5 values:'''
1. Group name<br />
* Group name
2. Owner username<br />
* Owner username
3. Number of members<br />
* Number of members
4. Public. Integer: 1 if the group is public, 0 otherwise<br />
* Public. Integer: 1 if the group is public, 0 otherwise
5. Registration time<br />
* Registration time




Members list:
Members list:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
int groupID
string "members", int groupID
</syntaxhighlight>  
</syntaxhighlight>  
'''Returns:''' a table of usernames in the group
'''Returns:''' a table of usernames in the group


 
===Examples===
==community.mtasa.com/mta/resources.php==
<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.
'''Calls:'''
 
Latest resource version:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string resourceName
addEventHandler("onPlayerJoin",getRootElement(),function()
</syntaxhighlight>
  callRemote("http://community.mtasa.com/mta/groups.php",info,"info",1) --When the player joins, call the site for the info
'''Returns:''' an integer, resource version. 0 if an error has occured
end)


 
function info(groupName,ownerUser,members,public,registrationTime) --Define all the values
==Example==
  if(groupName)and(public)and(registrationTime)then --check if the info came through
      outputChatBox("Our group is in the MTA Community Site, it's called: "..groupName..", our groups is "..public.." and was registered in"..registrationTime..".",source,0,100,100) --output about the servers new/existing group
  end
end
</syntaxhighlight>
</section>
<section name="Members Example" class="server" show="false">
This outputs the members in the servers group, which is found on the MTA Community Site.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addEventHandler ( "onPlayerJoin", getRootElement(), function()
addCommandHandler("members",function(player)
  local username = getPlayerUserName ( source )
  callRemote("http://community.mtasa.com/mta/groups.php",members,"members",1)--Call after the command goes through
  local serial = getPlayerSerial ( source
end)
  callRemote ( "http://community.mtasa.com/mta/verify.php", validatePlayer, source, username, serial )
end )


function validatePlayer ( player, result )
function members(player,members)
  local valid = "invalid"
  if(members)then
  if ( result == 1 ) then valid = "valid" end
      outputChatBox("Members in this servers group: "..members..".",player,255,255,255) --Outputs the members to the player who typed in the command
  outputChatBox ( getClientName ( player ).."'s username is "..valid )
  end
end
end
</syntaxhighlight>
</syntaxhighlight>
</section>
[[Category:Scripting Concepts]]

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