Community Resources - Revision history

AlexTMjugador: Prettified

2016-06-23T09:25:21Z

Prettified

← Older revision		Revision as of 09:25, 23 June 2016
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.

Ccw at 17:13, 14 December 2014

2014-12-14T17:13:38Z

← Older revision		Revision as of 17:13, 14 December 2014
Line 1:		Line 1:
	==Community calls documentation==		==Community calls documentation==
	~~only use~~:
			==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">		<syntaxhighlight lang="lua">
	callRemote()		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>		</syntaxhighlight>

			<!--
	==community.mtasa.com/mta/verify.php==		==community.mtasa.com/mta/verify.php==

Line 29:		Line 56:
	end		end
	</syntaxhighlight>		</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">
	string "info", 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


Line 82:		Line 109:
	</section>		</section>

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

	~~'''Calls:'''~~

	~~'''PLEASE NOTE:''' The resource that uses this, needs to be added to the ACL.xml in the Admin Group.~~
	~~Latest resource version:~~
	~~<syntaxhighlight lang="lua">~~
	~~string "version", string resourceName~~
	~~</syntaxhighlight>~~
	~~'''Returns:''' a string, resource version in format of "x.x.x". Integer 0 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>~~

	[[Category:Scripting Concepts]]		[[Category:Scripting Concepts]]

Ccw: /* Example */

2014-12-14T17:01:18Z

Example

← Older revision		Revision as of 17:01, 14 December 2014
Line 95:		Line 95:
	==Example==		==Example==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	addEventHandler("onResourceStart",getResourceRootElement(~~getThisResource()~~),~~function(startedRes)~~		addEventHandler( "onResourceStart", getResourceRootElement(),
	~~ver = getResourceInfo~~(~~startedRes,"version"~~) ~~--Get the resource version~~		function()
	~~name = getResourceName(startedRes) -- Get the name of the resource~~		callRemote( "http://community.mtasa.com/mta/resources.php", handleVersionCheck, "version", getResourceName(getThisResource()) )
	callRemote("http://community.mtasa.com/mta/resources.php",~~resource~~,~~ver~~,~~name~~) ~~--Call the site to see if the resource if the latest~~		end
	end)		)

	function ~~resource~~(~~version~~)		function handleVersionCheck( resName, commVer, commId )
	~~if(version=~~=getResourceInfo(getThisResource(),"version"))then ~~--Check if the resource is the latest~~		local thisVer = getResourceInfo(getThisResource(), "version")
	outputChatBox("~~This resource~~ is ~~the latest resource available~~."~~,root,0,100,0~~) ~~--if it is, then output this~~		if commId and thisVer ~= commVer then
	~~else~~		outputChatBox( getResourceName(getThisResource()) .. " is outdated. Your version: " .. thisVer .. " \| Current: " .. commVer )
	outputChatBox("~~This resource is old, get~~ the ~~latest resource at~~ community.~~mtasa~~.com"~~,root,100,0,0~~) ~~--if it's not, then output this~~		outputChatBox( "Please download the update @ http://community.multitheftauto.com/index.php?p=resources&s=details&id=" .. commId )
	end		end
	end		end
	</syntaxhighlight>		</syntaxhighlight>

	[[Category:Scripting Concepts]]		[[Category:Scripting Concepts]]

Jaysds: /* Exmaple */

2012-04-06T00:29:35Z

Exmaple

← Older revision		Revision as of 00:29, 6 April 2012
Line 93:		Line 93:
	'''Returns:''' a string, resource version in format of "x.x.x". Integer 0 if an error has occurred		'''Returns:''' a string, resource version in format of "x.x.x". Integer 0 if an error has occurred

	==~~Exmaple~~==		==Example==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	addEventHandler("onResourceStart",getResourceRootElement(getThisResource()),function(startedRes)		addEventHandler("onResourceStart",getResourceRootElement(getThisResource()),function(startedRes)

Jaysds: /* Examples */

2012-04-06T00:21:11Z

Examples

← Older revision		Revision as of 00:21, 6 April 2012
Line 53:		Line 53:

	==Examples==		==Examples==
	<section name="Group Example" class="server" show="~~true~~">		<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.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 67:		Line 67:
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>
	<section name="Members Example" class="server" show="~~true~~">		<section name="Members Example" class="server" show="false">
	This outputs the members in the servers group, which is found on the MTA Community Site.		This outputs the members in the servers group, which is found on the MTA Community Site.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Jaysds: /* community.mtasa.com/mta/resources.php */

2012-04-06T00:20:19Z

community.mtasa.com/mta/resources.php

← Older revision		Revision as of 00:20, 6 April 2012
Line 86:		Line 86:
	'''Calls:'''		'''Calls:'''

			'''PLEASE NOTE:''' The resource that uses this, needs to be added to the ACL.xml in the Admin Group.
	Latest resource version:		Latest resource version:
	~~'''PLEASE NOTE:'''The resource that uses this, needs to be added to the ACL.xml in the Admin Group.~~
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	string "version", string resourceName		string "version", string resourceName

Jaysds: /* community.mtasa.com/mta/resources.php */

2012-04-06T00:18:15Z

community.mtasa.com/mta/resources.php

← Older revision		Revision as of 00:18, 6 April 2012
Line 87:		Line 87:

	Latest resource version:		Latest resource version:
			'''PLEASE NOTE:'''The resource that uses this, needs to be added to the ACL.xml in the Admin Group.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	string "version", string resourceName		string "version", string resourceName
	</syntaxhighlight>		</syntaxhighlight>
	'''Returns:''' a string, resource version in format of "x.x.x". Integer 0 if an error has ~~occured~~		'''Returns:''' a string, resource version in format of "x.x.x". Integer 0 if an error has occurred

			==Exmaple==
			<syntaxhighlight lang="lua">
			addEventHandler("onResourceStart",getResourceRootElement(getThisResource()),function(startedRes)
			ver = getResourceInfo(startedRes,"version") --Get the resource version
			name = getResourceName(startedRes) -- Get the name of the resource
			callRemote("http://community.mtasa.com/mta/resources.php",resource,ver,name) --Call the site to see if the resource if the latest
			end)

			function resource(version)
			if(version==getResourceInfo(getThisResource(),"version"))then --Check if the resource is the latest
			outputChatBox("This resource is the latest resource available.",root,0,100,0) --if it is, then output this
			else
			outputChatBox("This resource is old, get the latest resource at community.mtasa.com",root,100,0,0) --if it's not, then output this
			end
			end
			</syntaxhighlight>

	[[Category:Scripting Concepts]]		[[Category:Scripting Concepts]]

Jaysds: /* Examples */

2012-04-05T23:52:28Z

Examples

← Older revision		Revision as of 23:52, 5 April 2012
Line 71:		Line 71:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	addCommandHandler("members",function(player)		addCommandHandler("members",function(player)
	callRemote("http://community.mtasa.com/mta/groups.php",~~function(~~members,~~player~~)--Call after the command goes through		callRemote("http://community.mtasa.com/mta/groups.php",members,"members",1)--Call after the command goes through
			end)

			function members(player,members)
	if(members)then		if(members)then
	outputChatBox("Members in this servers group: "..members..".",player,255,255,255) --Outputs the members to the player who typed in the command		outputChatBox("Members in this servers group: "..members..".",player,255,255,255) --Outputs the members to the player who typed in the command
	end		end
	end~~,"members",1)~~		end
	~~end)~~
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

Jaysds: /* community.mtasa.com/mta/groups.php */

2012-04-05T23:49:10Z

community.mtasa.com/mta/groups.php

← Older revision		Revision as of 23:49, 5 April 2012
Line 52:		Line 52:
	'''Returns:''' a table of usernames in the group		'''Returns:''' a table of usernames in the group

			==Examples==
			<section name="Group Example" class="server" show="true">
			This outputs the servers group name, if the group is public or private, and the registration time.
			<syntaxhighlight lang="lua">
			addEventHandler("onPlayerJoin",getRootElement(),function()
			callRemote("http://community.mtasa.com/mta/groups.php",info,"info",1) --When the player joins, call the site for the info
			end)

			function info(groupName,ownerUser,members,public,registrationTime) --Define all the values
			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="true">
			This outputs the members in the servers group, which is found on the MTA Community Site.
			<syntaxhighlight lang="lua">
			addCommandHandler("members",function(player)
			callRemote("http://community.mtasa.com/mta/groups.php",function(members,player)--Call after the command goes through
			if(members)then
			outputChatBox("Members in this servers group: "..members..".",player,255,255,255) --Outputs the members to the player who typed in the command
			end
			end,"members",1)
			end)
			</syntaxhighlight>
			</section>

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

Jaysds: /* Community calls documentation */

2012-04-05T22:50:50Z

Community calls documentation

← Older revision		Revision as of 22:50, 5 April 2012
Line 1:		Line 1:
	==Community calls documentation==		==Community calls documentation==
	~~using~~ callRemote		only use:
			<syntaxhighlight lang="lua">
			callRemote()
			</syntaxhighlight>

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