https://wiki.multitheftauto.com/api.php?action=feedcontributions&feedformat=atom&user=RansomMulti Theft Auto: Wiki - User contributions [en]2026-05-03T18:36:36ZUser contributionsMediaWiki 1.39.3https://wiki.multitheftauto.com/index.php?title=IsTimer&diff=38533IsTimer2014-01-18T23:57:12Z<p>Ransom: /* Example */</p>
<hr />
<div>__NOTOC__<br />
{{Server client function}}<br />
This function checks if a variable is a [[timer]].<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua">bool isTimer ( timer theTimer )</syntaxhighlight><br />
<br />
===Required Arguments===<br />
* '''theTimer''': The variable that we want to check.<br />
<br />
===Returns===<br />
Returns ''true'' if the passed value is a timer, ''false'' otherwise.<br />
<br />
==Example==<br />
<section name="Server" class="server" show="true"><br />
This example uses isTimer to prevent players from using chat/teamchat/me more than once a second, to prevent spammers.<br />
<syntaxhighlight lang="lua"><br />
-- This anti spam is just an example and won't work if you have other scripts and game modes which manipulate chat,<br />
-- If you do then this script would need to be put with the other script/gamemode that handles chat else cancelEvent() won't work.<br />
<br />
antiSpam = {} -- This makes a table called antiSpam<br />
function antiChatSpam() -- The function that the event has called. Will stop all mainchat/teamchat/me spam.<br />
if isTimer(antiSpam[source]) then -- Check if timer is running using isTimer (this is an example of its use and all)<br />
cancelEvent() -- If timer is running then cancel the event<br />
outputChatBox("Sorry bro, you may only send 1 message a second to prevent spam.", source, 255, 255, 0) -- Message to player<br />
else<br />
antiSpam[source] = setTimer(function(source) antiSpam[source] = nil end, 1000, 1, source) -- Timer lasting 1 second.<br />
-- The "function(source) antiSpam[source] = nil end" should clear the player from table after 1 second so he can chat again. <br />
-- antiSpam[source] = setTimer(... is using the table to bind that player to the timer.<br />
end<br />
end<br />
addEventHandler("onPlayerChat", root, antiChatSpam) -- Event we're using, don't waste your time with getRootElement() (root is the same)<br />
-- You now have an antispam to prevent people super spamming your chatbox!<br />
</syntaxhighlight><br />
</section><br />
<br />
==See Also==<br />
{{Utility functions}}</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=Main_Page&diff=34468Main Page2013-01-12T19:08:36Z<p>Ransom: added forum resources</p>
<hr />
<div>{| width="100%" cellspacing="0" cellpadding="0"<br />
| colspan="2" |<br />
<div style="/*border: 1px solid #D8D8D8;*/ padding-left: 15px; padding-right: 15px; height: 100%;"><br />
[[File:Mtalogo.png|left|100px|link=http://wiki.multitheftauto.com/]]'''Welcome to the [[Multi Theft Auto]] wiki.''' On this wiki you'll find a wealth of information on using Multi Theft Auto.<br />
<br />
There are many [[How you can help|things you can do to help us]] improve MTA - create a map, a gamemode, help document scripting functions, write example code, write tutorials or just play MTA and report the bugs you find.<br />
<br />
If you have any questions or problems related to scripting, feel free to get in touch with us on our [[IRC Channel]].<br />
<br/><br/>[ Stop playing with yourself ]<br />
</div><br />
|}<br />
{| width="100%" cellspacing="0" cellpadding="0"<br />
| colspan="2" |<br />
|-<br />
|width="50%" style="vertical-align:top;" |<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px; background: #FFFCF2;"><br />
<div style="float:right; width: 32px;">[[File:Input-gaming.png|link=]]</div><br />
<h3>Play</h3><br />
<div style="background: #FFEEAA; border: 1px solid #FFCD19;"><br />
[[File:Go-down.png|link=http://mtasa.com/]] ''' [http://mtasa.com/ Download Multi Theft Auto: San Andreas {{Current Version|full}}]'''</div><br />
* [[Client Manual]]<br />
<!-- * [[Changes_in_{{padleft:|3|{{Current Version|full}}}}| Changes in {{padleft:|3|{{Current Version|full}}}}]] --><br />
* [[Changes_in_{{padleft:|5|{{Current Version|full}}}}| Changes in {{padleft:|5|{{Current Version|full}}}}]]<br />
* [[Known_Issues_-_FAQ|Known Issues]]<br />
* [[Upgrading_from_MTA:Race|Migrating from MTA:Race to MTA:SA {{padleft:|3|{{Current Version|full}}}}]]<br />
* [[Server Manual]]<br />
* [[Map manager|Map Manager]]<br />
<br />
<h3>Map Editor</h3><br />
*[[Resource:Editor|Manual]]<br />
*[[Resource:Editor/EDF|Editor Definition Format]]<br />
*[[Resource:Editor/Plugins|Plugins]]<br />
*[[Resource:Editor#FAQ|Frequently Asked Questions]]<br />
</div><br />
<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px;"><br />
<div style="float:right; width: 32px;">[[File:Package-x-generic.png|link=]]</div><br />
<h3>Databases</h3><br />
This section outlines all the Lua capabilites MTA or resources provide.<br />
* [[:Category:Resource|Resource Catalogue]] - You must learn these to make proper scripts<br />
* [[Client side scripts]]<br />
* [[Modules]]<br />
</div><br />
<br />
<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px;"><br />
<div style="float:right; width: 32px;">[[File:Applications-development.png|link=]]</div><br />
<h3>Developing Multi Theft Auto</h3><br />
[[File:Go-down.png|link=http://nightly.mtasa.com/]] [http://nightly.mtasa.com/ Nightly builds]<br />
* [[Compiling_MTASA|Compiling MTASA on Windows]]<br />
* [[Building_MTASA_Server_on_Mac_OS_X|Compiling MTASA on Mac OS X]]<br />
* [[Building_MTASA_Server_on_GNU_Linux|Compiling MTASA on GNU/Linux]]<br />
* [[Coding guidelines]]<br />
* [http://code.google.com/p/mtasa-blue Google Code SVN]<br />
* [[Roadmap]]<br />
* [http://bugs.mtasa.com/ Bugtracker]<br />
* [[Branches]]<br />
</div><br />
<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px;"><br />
<div style="float:right; width: 32px;">[[File:Applications-office.png|link=]]</div><br />
<h3>Wiki - How can you help</h3><br />
* Finish documentation for [[:Category:Incomplete|Incomplete functions]].<br />
* [[:Category:Needs_Example |Add examples to functions and events]].<br />
* Review and verify [[:Category:Needs Checking|pages that need checking]].<br />
* Write tutorials to help new people.<br />
* Translate wiki pages.<br />
</div><br />
<br />
<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px;"><br />
<div style="float:right; width: 32px;">[[File:Internet-group-chat.png|link=]]</div><br />
<h3>Community</h3><br />
* [http://forum.multitheftauto.com/ Forum]<br />
* IRC: [irc://irc.multitheftauto.com/mta irc.multitheftauto.com #mta]<br />
* [http://community.mtasa.com/ MTA Community] - Share and download resources.<br />
* [http://twitter.com/#!/MTAQA/ Twitter] - [http://www.youtube.com/user/MTAQA Youtube] - [http://plus.google.com/102014133442331779727/ Google+] - [http://www.moddb.com/mods/multi-theft-auto-san-andreas ModDB]<br />
</div><br />
<br />
| width="50%" style="vertical-align:top;" |<br />
<br />
<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px;"><br />
<div style="float:right; width: 32px;">[[File:Accessories-text-editor.png|link=]]</div><br />
<h3>Scripting</h3><br />
* [[Scripting Introduction|Introduction to Scripting]]<br />
* [[Introduction to Scripting the GUI]]<br />
* [[Debugging|Debugging Tutorial]] - How to find errors in your scripts<br />
* [[Resources|Introduction to Resources]]<br />
** [[Resource Web Access]] - How you can write websites with resources<br />
** [[:Category:Resource|Resource Catalogue]]<br />
** [[Meta.xml]] - Behind every resource is a meta file that defines it<br />
** [[ACL]] - Access Control List, this is vital for complex scripts to work<br />
* [[Writing_Gamemodes|Writing Gamemodes]]<br />
* [[Useful_Functions|Useful functions]]<br />
Forum Links<br />
* [http://forum.mtasa.com/viewforum.php?f=91 Scripting Forum]<br />
* [http://forum.mtasa.com/viewforum.php?f=148 Scripting Tutorials Sub-Forum]<br />
* [http://forum.mtasa.com/viewtopic.php?f=13&t=29363 Offline Wiki Copies]<br />
<div style="float:right; width: 32px;">[[File:start-here.png|link=]]</div><br />
<h3>General Lua Help</h3><br />
Pages designed to aid your understanding of Lua<br />
*[http://www.lua.org/pil/index.html "Programming in Lua" Manual]<br />
**[http://www.lua.org/manual/5.1/#index Internal Lua functions reference]<br />
*[http://lua-users.org/wiki/TutorialDirectory Lua Wiki]<br />
*[http://nixstaller.berlios.de/manual/0.2/nixstaller_9.html A general guide to Lua from Nixstaller]<br />
</div><br />
<br />
<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px; background:#F2F2FF;"><br />
<div style="float:right; width: 32px;">[[File:Preferences-system.png|link=]]</div><br />
<h3>Reference</h3><br />
* [[Client Scripting Functions|Client-side Functions]]<br />
* [[Client Scripting Events|Client-side Events]]<br />
* [[Server Scripting Functions|Server-side Functions]]<br />
* [[Server Scripting Events|Server-side Events]]<br />
<!-- Incomplete * [[Module functions|Server-side external module scripting functions list]] --><br />
* [[MTA Classes]] - Detailed descriptions of all MTA custom types<br />
** [[Element|MTA Elements]] / [[Element tree]]<br />
</div><br />
<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px;"><br />
<div style="float:right; width: 32px;">[[File:System-file-manager.png|link=]]</div><br />
<h3>[[Id|ID Lists]]</h3><br />
*[[Animations|Animations]]<br />
*[[Character Skins]]<br />
*[[CJ_Clothes|Clothing styles]]<br />
*[[Garage|Garage IDs]]<br />
*[[Interior IDs]]<br />
*[[Material IDs]]<br />
*[[Projectiles]]<br />
*[[Radar Blips]]<br />
*[[Sounds]]<br />
*[[Vehicle IDs]]<br />
*[[Vehicle Colors]]<br />
*[[Vehicle Upgrades]]<br />
*[[Vehicle variants|Vehicle Variants]]<br />
*[[Vehicle component manipulation]]<br />
*[[Weapons|Weapons]]<br />
*[[Weather]]<br />
</div><br />
<div style="padding:4px 8px 8px 8px; margin:10px;"><br />
[[File:Osi symbol.png|75px|link=http://opensource.org/|left]]<br />
'''Multi Theft Auto''' is '''Open Source'''. <br />
<br/>This means anyone can contribute to making Multi Theft Auto even better!<br />
</div><br />
|-<br />
| colspan="2" |<br />
|}<br />
{| width="100%" cellspacing="0" cellpadding="0"<br />
| colspan="2" |<br />
<div style="padding-left: 15px; padding-right: 15px;" class="plainlinks"><br />
[[File:MTALogo_8ball.png|left|85px|link=Archive]]<br />
<ul style="list-style: none; width: 200px; float: left;"><br />
<li>'''About [[Multi Theft Auto]]'''</li><br />
<li>[[Archive]]</li><br />
<li>[[Press Coverage]]</li><br />
<li>[http://code.google.com/p/mtasa-blue/people/list Developers]</li><br />
</ul><br />
<ul style="list-style: none; width: 200px; float: left;"><br />
<li>'''Multi Theft Auto 0.5'''</li><br />
<li>[[Archive#Multi_Theft_Auto_0.5|Download]]</li><br />
<li>[[MTA 0.5r2 Known Issues|Known Issues]]</li><br />
</ul><br />
<ul style="list-style: none; width: 200px; float: left;"><br />
<li>'''Wiki Stats'''</li><br />
<li>{{NUMBEROFARTICLES}} Articles</li><br />
<li>{{NUMBEROFPAGES}} Pages</li><br />
<li>{{NUMBEROFUSERS}} Registered Users</li><br />
</ul><br />
</div><br />
|}<br />
<br />
__NOTOC__<br />
__NOEDITSECTION__<br />
{{Languages list|en}}</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=Access_Control_List&diff=34294Access Control List2012-12-19T12:16:49Z<p>Ransom: was still a mistake!</p>
<hr />
<div>MTA includes a complete Access Control List (ACL) that allows you to secure and limit access to the server, its functions and resources in any number of ways.<br />
<br />
The key concept of MTA's ACL (and ACLs in general) is that you're giving a specific object a set of rights. In MTA's case objects are one of two things - resources or users. There are numerous ''rights'' available in MTA - these mainly focus on server-side scripting functions. <br />
<br />
What this essentially means is that the ACL allows you to choose exactly what functions a resource or user can perform. This can obviously be invaluable - for example preventing all your server's players from being able to ban each other, or preventing your new untested resources from doing the same. <br />
<br />
Of course, ''with great power comes great responsibility'' and it is very easily possible to completely break resources - for example, disabling [[spawnPlayer]] for all resources would be a Bad Thing. Of course, there are situations when you might want to do this - if you want to force all your resources to use a spawn manager resource for example, but even this is somewhat draconian.<br />
<br />
==Understanding the ACL==<br />
There are two major components to the ACL: groups and ACL lists. They appear as '''<group name="">''' nodes and '''<acl name="" />''' nodes. Their purpose is to:<br \><br />
'''1.''' Grant users permission to control the server and use resource commands. Examples:''<br \><br />
*Allowing only admins to use the giveweapon function of freeroam<br />
*Allowing all users to start a resource<br />
'''2.''' Grant resources permission to use script functions and functions of other resources. Examples:<br \><br />
*Allowing a resource to use the restartResource function<br />
*Allowing a resource to use the call function to use exported functions from another script<br />
<br />
===Default Groups===<br />
MTA has provided some default groups with increasing permissions. These groups are:<br />
*'''Everyone'''<br />
*'''Moderator'''<br />
*'''SuperModerator'''<br />
*'''Admin'''<br />
*'''Console''' - This controls permissions of people who are using the console through '''<object name="user.Console" />'''<br />
*'''RPC''' - Remote Procedure Call. Specifically grants access to [[callRemote]] only and disables commands of default resources. Check the function for details.<br />
<br \><br />
<br />
To explain further, I will use the Everyone group as an example. By default it looks like this:<br />
<syntaxhighlight lang="lua"> <group name="Everyone"><br />
<acl name="Default" /><br />
<object name="user.*" /><br />
<object name="resource.*" /><br />
</group><br />
</syntaxhighlight><br />
<br \><br />
You will first notice the acl name inside the group. It defines what permissions the group has. Users and resources in this group will have the permissions specified on the "Default" acl name list. ''Note: You will notice this group is special, in that it includes every user and resource by using a '''wildcard (*)''' where the user or resource name would be.''<br />
<br />
Now, scroll further down the ACL and you will see the '''<acl name="Default" />''' listing. Note I have trimmed this list dramatically due to its length.<br />
<br />
<syntaxhighlight lang="lua"> <acl name="Default"><br />
<right name="command.start" access="false" /><br />
<right name="command.stop" access="false" /><br />
<right name="command.stopall" access="false" /><br />
...etc etc...<br />
<right name="function.executeCommandHandler" access="false" /><br />
<right name="function.setPlayerMuted" access="false" /><br />
<right name="function.restartResource" access="false" /><br />
...etc etc...<br />
<right name="general.adminpanel" access="false" /><br />
<right name="general.tab_players" access="false" /><br />
<right name="general.tab_resources" access="false" /><br />
...etc etc...<br />
<right name="command.freeze" access="false" /><br />
<right name="command.shout" access="false" /><br />
<right name="command.spectate" access="false" /><br />
...etc etc...<br />
</acl><br />
</syntaxhighlight><br />
<br \><br />
*'''Function''' entries are MTA scripting functions. For example, if a resource needed to use restartResource and was only in the 'Everyone' group (with the 'Default' list), it would be denied access to restartResource and fail to work correctly.<br />
*'''Commands''' are created when a resource uses [[addCommandHandler]]. An example would be typing '''/createvehicle [vehicle]''' in the chatbox for the freeroam resource. This controls whether users in the group using this ACL can use the command. ''Note: commands have no effect on resources within the group. Commands are only related to users.''<br />
**''General is a custom right name group created by the admin resource but it works on the same principles. The script works with them by using [[hasObjectPermissionTo]]''<br />
<br />
<br />
You will notice some groups such as admin have multiple '''<acl name="" />''' nodes. An example is the admin group:<br />
<syntaxhighlight lang="lua"><br />
<group name="Admin"><br />
<acl name="Moderator" /><br />
<acl name="SuperModerator" /><br />
<acl name="Admin" /><br />
<acl name="RPC" /><br />
<object name="resource.admin" /><br />
<object name="resource.webadmin" /><br />
<object name="user.Ransom" /><br />
</group><br />
</syntaxhighlight><br />
<br />
This gives all the permissions defined in each '''<acl name="" />''' node in order of listing. So for example, the admin group makes sure all the permissions are given to admins by using all the lists. If there are any conflicts, the lowest entry wins. For example, pretend these 2 acls were in a group in the following order:<br />
<br />
'''1.''' '''<acl name="Default">''' sets <right name="general.ModifyOtherObjects" access="false" /> <br\><br />
'''2.''' '''<acl name="Admin">''' sets <right name="general.ModifyOtherObjects" access="true" /> <br\><br />
'''3.''' For all users and resources in group admin: <right name="general.ModifyOtherObjects" access="true" /><br\><br />
<br\><br />
<br />
=== Resource Groups and ACLs ===<br />
You will notice there are some other groups that came with MTA. These were defined by resources that came with MTA. If a resource wants to designate specific ACL rights not provided by the default MTA groups, it can create its own ACL name and a group to use it. I will show AMX's entry as an example. AMX is designed to emulate SA-MP scripts and it needs a certain set of permissions that doesn't fit the default groups well. It is shown below:<br />
<br />
<syntaxhighlight lang="lua"><br />
<group name="AMX"><br />
<acl name="AMX" /><br />
<object name="resource.amx" /><br />
</group><br />
<br />
<acl name="AMX"><br />
<right name="general.ModifyOtherObjects" access="true" /><br />
<right name="function.startResource" access="true" /><br />
<right name="function.stopResource" access="true" /><br />
<right name="general.adminpanel" access="false" /><br />
...etc etc...<br />
<right name="command.kick" access="false" /><br />
<right name="command.freeze" access="false" /><br />
<right name="command.mute" access="false" /><br />
...etc etc...<br />
</acl><br />
</syntaxhighlight><br />
<br />
==Modifying the ACL==<br />
There are three ways you can modify the ACL - how you do it depends who you are.<br />
<br />
===HTTP Interface===<br />
You can use the [[Resource/webadmin|webadmin]] http interface to modify the ACL in your web browser. This is by far the easiest way to do so. Just make sure the ''webadmin'' resource is started on your server and visit ''<nowiki>http://ServerIP:HttpPort/</nowiki>''. You can then use the two sections - ACLs and Groups. ACLs allows you to create your Access Control Lists - lists of rights. Groups allow you to group together collections of users and assign ACLs to them. For example, the ACLs section allows you to specify that the Admin ACL has access to the ''start'' console command. You can the go to the Groups section and create an Admin ''group'' that has access to your Admin ''acl''. You can then add users to your Admin ''group''.<br />
<br />
===XML file===<br />
You can modify the ACL.xml file manually. This has a fairly straightforward syntax, but it can get a bit confusing at times. If you do it while the server is running, don't forget to call the scripting function [[aclReload]] ("start runcode", "run aclReload()") so the new ACL is loaded, or otherwise stop your server before modifying. This also prevents your changes from being accidentally overwritten by the server.<br />
<br />
===Scripting functions===<br />
You can use a large number of ACL scripting functions to modify the ACL on the fly. Of course, you can (and really should!) limit access to the ACL functions with the ACL. Note that the '''admin resource''' that comes with MTA can be used to manage the ACL from the resources tab. You must be setup as admin to use the admin panel. [http://wiki.multitheftauto.com/wiki/Admin Click here for admin setup instructions].<br />
<br />
==See Also==<br />
{{ACL functions}}<br />
[[Category:Scripting Concepts]]<br />
[[ru:Access Control List]]</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=Access_Control_List&diff=34293Access Control List2012-12-19T12:14:26Z<p>Ransom: mistake</p>
<hr />
<div>MTA includes a complete Access Control List (ACL) that allows you to secure and limit access to the server, its functions and resources in any number of ways.<br />
<br />
The key concept of MTA's ACL (and ACLs in general) is that you're giving a specific object a set of rights. In MTA's case objects are one of two things - resources or users. There are numerous ''rights'' available in MTA - these mainly focus on server-side scripting functions. <br />
<br />
What this essentially means is that the ACL allows you to choose exactly what functions a resource or user can perform. This can obviously be invaluable - for example preventing all your server's players from being able to ban each other, or preventing your new untested resources from doing the same. <br />
<br />
Of course, ''with great power comes great responsibility'' and it is very easily possible to completely break resources - for example, disabling [[spawnPlayer]] for all resources would be a Bad Thing. Of course, there are situations when you might want to do this - if you want to force all your resources to use a spawn manager resource for example, but even this is somewhat draconian.<br />
<br />
==Understanding the ACL==<br />
There are two major components to the ACL: groups and ACL lists. They appear as '''<group name="">''' nodes and '''<acl name="" />''' nodes. Their purpose is to:<br \><br />
'''1.''' Grant users permission to control the server and use resource commands. Examples:''<br \><br />
*Allowing only admins to use the giveweapon function of freeroam<br />
*Allowing all users to start a resource<br />
'''2.''' Grant resources permission to use script functions and functions of other resources. Examples:<br \><br />
*Allowing a resource to use the restartResource function<br />
*Allowing a resource to use the call function to use exported functions from another script<br />
<br />
===Default Groups===<br />
MTA has provided some default groups with increasing permissions. These groups are:<br />
*'''Everyone'''<br />
*'''Moderator'''<br />
*'''SuperModerator'''<br />
*'''Admin'''<br />
*'''Console''' - This controls permissions of people who are using the console through '''<object name="user.Console" />'''<br />
*'''RPC''' - Remote Procedure Call. Specifically grants access to [[callRemote]] only and disables commands of default resources. Check the function for details.<br />
<br \><br />
<br />
To explain further, I will use the Everyone group as an example. By default it looks like this:<br />
<syntaxhighlight lang="lua"> <group name="Everyone"><br />
<acl name="Default" /><br />
<object name="user.*" /><br />
<object name="resource.*" /><br />
</group><br />
</syntaxhighlight><br />
<br \><br />
You will first notice the acl name inside the group. It defines what permissions the group has. Users and resources in this group will have the permissions specified on the "Default" acl name list. ''Note: You will notice this group is special, in that it includes every user and resource by using a '''wildcard (*)''' where the user or resource name would be.''<br />
<br />
Now, scroll further down the ACL and you will see the '''<acl name="Default" />''' listing. Note I have trimmed this list dramatically due to its length.<br />
<br />
<syntaxhighlight lang="lua"> <acl name="Default"><br />
<right name="command.start" access="false" /><br />
<right name="command.stop" access="false" /><br />
<right name="command.stopall" access="false" /><br />
...etc etc...<br />
<right name="function.executeCommandHandler" access="false" /><br />
<right name="function.setPlayerMuted" access="false" /><br />
<right name="function.restartResource" access="false" /><br />
...etc etc...<br />
<right name="general.adminpanel" access="false" /><br />
<right name="general.tab_players" access="false" /><br />
<right name="general.tab_resources" access="false" /><br />
...etc etc...<br />
<right name="command.freeze" access="false" /><br />
<right name="command.shout" access="false" /><br />
<right name="command.spectate" access="false" /><br />
...etc etc...<br />
</acl><br />
</syntaxhighlight><br />
<br \><br />
*'''Function''' entries are MTA scripting functions. For example, if a resource needed to use restartResource and was only in the 'Everyone' group (with the 'Default' list), it would be denied access to restartResource and fail to work correctly.<br />
*'''Commands''' are created when a resource uses [[addCommandHandler]]. An example would be typing '''/createvehicle [vehicle]''' in the chatbox for the freeroam resource. This controls whether users in the group using this ACL can use the command. ''Note: commands have no effect on resources within the group. Commands are only related to users.''<br />
**''General is a custom right name group created by the admin resource but it works on the same principles. The script works with them by using [[hasObjectPermissionTo]]''<br />
<br />
<br />
You will notice some groups such as admin have multiple '''<acl name="" />''' nodes. An example is the admin group:<br />
<syntaxhighlight lang="lua"><br />
<group name="Admin"><br />
<acl name="Moderator" /><br />
<acl name="SuperModerator" /><br />
<acl name="Admin" /><br />
<acl name="RPC" /><br />
<object name="resource.admin" /><br />
<object name="resource.webadmin" /><br />
<object name="user.Ransom" /><br />
</group><br />
</syntaxhighlight><br />
<br />
This gives all the permissions defined in each '''<acl name="" />''' node in order of listing. So for example, the admin group makes sure all the permissions are given to admins by using all the lists. If there are any conflicts, the lowest entry wins. For example, pretend these 2 acls were in a group in the following order:<br />
<br />
'''1.''' '''<acl name="Default">''' sets <right name="general.http" access="false" /> <br\><br />
'''2.''' '''<acl name="Admin">''' sets <right name="general.ModifyOtherObjects" access="true" /> <br\><br />
'''3.''' For all users and resources in group admin: <right name="general.ModifyOtherObjects" access="true" /><br\><br />
<br\><br />
<br />
=== Resource Groups and ACLs ===<br />
You will notice there are some other groups that came with MTA. These were defined by resources that came with MTA. If a resource wants to designate specific ACL rights not provided by the default MTA groups, it can create its own ACL name and a group to use it. I will show AMX's entry as an example. AMX is designed to emulate SA-MP scripts and it needs a certain set of permissions that doesn't fit the default groups well. It is shown below:<br />
<br />
<syntaxhighlight lang="lua"><br />
<group name="AMX"><br />
<acl name="AMX" /><br />
<object name="resource.amx" /><br />
</group><br />
<br />
<acl name="AMX"><br />
<right name="general.ModifyOtherObjects" access="true" /><br />
<right name="function.startResource" access="true" /><br />
<right name="function.stopResource" access="true" /><br />
<right name="general.adminpanel" access="false" /><br />
...etc etc...<br />
<right name="command.kick" access="false" /><br />
<right name="command.freeze" access="false" /><br />
<right name="command.mute" access="false" /><br />
...etc etc...<br />
</acl><br />
</syntaxhighlight><br />
<br />
==Modifying the ACL==<br />
There are three ways you can modify the ACL - how you do it depends who you are.<br />
<br />
===HTTP Interface===<br />
You can use the [[Resource/webadmin|webadmin]] http interface to modify the ACL in your web browser. This is by far the easiest way to do so. Just make sure the ''webadmin'' resource is started on your server and visit ''<nowiki>http://ServerIP:HttpPort/</nowiki>''. You can then use the two sections - ACLs and Groups. ACLs allows you to create your Access Control Lists - lists of rights. Groups allow you to group together collections of users and assign ACLs to them. For example, the ACLs section allows you to specify that the Admin ACL has access to the ''start'' console command. You can the go to the Groups section and create an Admin ''group'' that has access to your Admin ''acl''. You can then add users to your Admin ''group''.<br />
<br />
===XML file===<br />
You can modify the ACL.xml file manually. This has a fairly straightforward syntax, but it can get a bit confusing at times. If you do it while the server is running, don't forget to call the scripting function [[aclReload]] ("start runcode", "run aclReload()") so the new ACL is loaded, or otherwise stop your server before modifying. This also prevents your changes from being accidentally overwritten by the server.<br />
<br />
===Scripting functions===<br />
You can use a large number of ACL scripting functions to modify the ACL on the fly. Of course, you can (and really should!) limit access to the ACL functions with the ACL. Note that the '''admin resource''' that comes with MTA can be used to manage the ACL from the resources tab. You must be setup as admin to use the admin panel. [http://wiki.multitheftauto.com/wiki/Admin Click here for admin setup instructions].<br />
<br />
==See Also==<br />
{{ACL functions}}<br />
[[Category:Scripting Concepts]]<br />
[[ru:Access Control List]]</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=Talk:Access_Control_List&diff=34292Talk:Access Control List2012-12-19T12:12:45Z<p>Ransom: Created page with "general. whatever needs explaining. I think it comes from resources own functions but I am not sure."</p>
<hr />
<div>general. whatever needs explaining. I think it comes from resources own functions but I am not sure.</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=SetWeaponFlags&diff=33751SetWeaponFlags2012-10-15T13:53:50Z<p>Ransom: usage note</p>
<hr />
<div>__NOTOC__<br />
{{Client function}}<br />
Set a custom weapons flags.<br />
<br />
'''Note:''' This is not the same as [[setWeaponProperty]]. These flags are different and can only be set for custom weapon types. You cannot set these flags for 'normal' weapons. This is true despite the ability in setWeaponProperty to set any number of supported [[Weapon Flags]].<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua">bool setWeaponFlags ( theWeapon, string theFlag, value TheValue )</syntaxhighlight><br />
<br />
===Required Arguments===<br />
* '''theWeapon:''' the weapon to set the flag of<br />
* '''theFlag:''' the weapon flag to set:<br />
** bool disable_model disable the weapon model of the weapon<br />
** flags edit the processLineOfSight flags used to find the hit position<br />
** bool checkBuildings<br />
** bool checkCarTires<br />
** bool checkDummies<br />
** bool checkObjects<br />
** bool checkPeds<br />
** bool checkVehicles<br />
** bool checkSeeThroughStuff<br />
** bool checkShootThroughStuff<br />
** bool instant_reload reload the weapon instantly rather than doing a reload<br />
** bool shoot_if_out_of_range shoot the target position if out of weapon range<br />
** bool shoot_if_blocked shoot the target position if blocked<br />
* '''theValue:''' the value to set<br />
<br />
===Returns===<br />
Returns ''true'' on success (flags have 8 values), ''false'' otherwise.<br />
<br />
==Requirements==<br />
{{Requirements|n/a|1.3.0-9.04555|}}<br />
<br />
==See Also==<br />
{{Client weapon creation functions}}<br />
<br />
sets the flags of the weapon ( used to determine what to hit )</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=CreateWeapon&diff=33750CreateWeapon2012-10-15T13:37:52Z<p>Ransom: needs checking</p>
<hr />
<div>{{Needs_Checking|"Some weapon types do not work."... needs investigating. Shotguns do not work because the pellet code was complex and its actually 8 very clustered pellets. All other bullet weapons should work and be synced. Exact weapons this works with needs documenting still.}}<br />
__NOTOC__<br />
{{Client function}}<br />
Creates a custom weapon that can fire bullets not related to player held weapons.<br />
'''Note:''' Some weapon types do not work.<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua">weapon createWeapon ( string theType, float x, float y, float z )</syntaxhighlight><br />
<br />
===Required Arguments===<br />
* '''theType:''' The weapon type which can be:<br />
{{Custom Weapon Types}}<br />
<br />
* '''x:''' The x position to create the weapon.<br />
* '''y:''' The y position to create the weapon.<br />
* '''z:''' The z position to create the weapon.<br />
<br />
===Returns===<br />
Returns a custom weapon element type and creates a simulated weapon at that position.<br />
<br />
==Requirements==<br />
{{Requirements|n/a|1.3.0-9.04555|}}<br />
<br />
==See Also==<br />
{{Client weapon creation functions}}<br />
[[ru:createWeapon]]</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=CreateWeapon&diff=33749CreateWeapon2012-10-14T13:39:25Z<p>Ransom: </p>
<hr />
<div>{{Needs_Checking|Figure out what types will not work and get rid of the stupid note.}}<br />
__NOTOC__<br />
{{Client function}}<br />
Creates a custom weapon that can fire bullets not related to player held weapons.<br />
'''Note:''' Some weapon types do not work.<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua">weapon createWeapon ( string theType, float x, float y, float z )</syntaxhighlight><br />
<br />
===Required Arguments===<br />
* '''theType:''' The weapon type which can be:<br />
{{Custom Weapon Types}}<br />
<br />
* '''x:''' The x position to create the weapon.<br />
* '''y:''' The y position to create the weapon.<br />
* '''z:''' The z position to create the weapon.<br />
<br />
===Returns===<br />
Returns a custom weapon element type and creates a simulated weapon at that position.<br />
<br />
==Requirements==<br />
{{Requirements|n/a|1.3.0-9.04555|}}<br />
<br />
==See Also==<br />
{{Client weapon creation functions}}<br />
[[ru:createWeapon]]</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=CreateWeapon&diff=33748CreateWeapon2012-10-14T13:38:42Z<p>Ransom: engrish</p>
<hr />
<div>__NOTOC__<br />
{{Client function}}<br />
Creates a custom weapon that can fire bullets not related to player held weapons.<br />
'''Note:''' Some weapon types do not work.<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua">weapon createWeapon ( string theType, float x, float y, float z )</syntaxhighlight><br />
<br />
===Required Arguments===<br />
* '''theType:''' The weapon type which can be:<br />
{{Custom Weapon Types}}<br />
<br />
* '''x:''' The x position to create the weapon.<br />
* '''y:''' The y position to create the weapon.<br />
* '''z:''' The z position to create the weapon.<br />
<br />
===Returns===<br />
Returns a custom weapon element type and creates a simulated weapon at that position.<br />
<br />
==Requirements==<br />
{{Requirements|n/a|1.3.0-9.04555|}}<br />
<br />
==See Also==<br />
{{Client weapon creation functions}}<br />
[[ru:createWeapon]]</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=CreateWeapon&diff=33747CreateWeapon2012-10-14T13:38:03Z<p>Ransom: </p>
<hr />
<div>__NOTOC__<br />
{{Client function}}<br />
Creates a custom weapon that can fire bullets not related to player held weapons.<br />
'''Note:''' Some weapon types does not work.<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua">weapon createWeapon ( string theType, float x, float y, float z )</syntaxhighlight><br />
<br />
===Required Arguments===<br />
* '''theType:''' The weapon type which can be:<br />
{{Custom Weapon Types}}<br />
<br />
* '''x:''' The x position to create the weapon.<br />
* '''y:''' The y position to create the weapon.<br />
* '''z:''' The z position to create the weapon.<br />
<br />
===Returns===<br />
Returns a custom weapon element type and creates a simulated weapon at that position.<br />
<br />
==Requirements==<br />
{{Requirements|n/a|1.3.0-9.04555|}}<br />
<br />
==See Also==<br />
{{Client weapon creation functions}}<br />
[[ru:createWeapon]]</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=GetTickCount&diff=33656GetTickCount2012-09-29T21:23:10Z<p>Ransom: /* Example */ new example</p>
<hr />
<div>__NOTOC__<br />
{{Server client function}}<br />
This function returns amount of time that your system has been running in milliseconds. By comparing two values of [[getTickCount]], you can determine how much time has passed (in milliseconds) between two events. This could be used to determine how efficient your code is, or to time how long a player takes to complete a task.<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua">int getTickCount ()</syntaxhighlight><br />
<br />
===Returns===<br />
Returns an integer containing the number of milliseconds since the system the server is running on started. This has the potential to wrap-around.<br />
<br />
==Example==<br />
This will start a timer displayed at the top of the screen displayed every frame. You can log any specific moment in time by outputting the currentCount variable.<br />
<br />
<syntaxhighlight lang="lua">screenX,screenY = guiGetScreenSize()<br />
function startTheClock ()<br />
<br />
if not systemUpTime then<br />
systemUpTime = getTickCount () --Store the system tick count, this will be 0 for us<br />
end<br />
<br />
currentCount = getTickCount ()<br />
<br />
dxDrawRectangle (screenX *.40, screenY * .09, 250, 50, tocolor(0,0,0,150))<br />
dxDrawText ( currentCount - systemUpTime, screenX * .48, screenY * .1, screenX, screenY, tocolor(255,255,255), 2)<br />
end<br />
addEventHandler ( "onClientRender", root, startTheClock )<br />
<br />
startTheClock()</syntaxhighlight><br />
<br />
==See Also==<br />
{{Utility functions}}</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=CreateWater&diff=33615CreateWater2012-09-27T07:11:23Z<p>Ransom: Poor page construction JAYSDS1...</p>
<hr />
<div>__NOTOC__<br />
{{Server client function}}<br />
<br />
{{Needs_Checking|Use of bShallow is unknown. There was a stupid note pointing to arc_ and assuming it meant if the water is visible which is not true.}}<br />
<br />
Creates an area of [[water]].<br />
<br />
The largest possible size of a water area is 5996&#0215;5996. Also be aware that the function will change all x and y coordinates you specify into even integer numbers if necessary: this is because of a limitation of San Andreas.<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua">water createWater ( float x1, float y1, float z1, float x2, float y2, float z2, float x3, float y3, float z3 [, float x4, float y4, float z4 ] [, bool bShallow = false ] )</syntaxhighlight><br />
[[Image:WaterAreas.jpg|thumb|Example of water quadrant.|284x230px]]<br />
<br />
===Required Arguments===<br />
*'''x1, y1, z1:''' position of bottom left (south-west) corner.<br />
*'''x2, y2, z2:''' position of bottom right (south-east) corner.<br />
*'''x3, y3, z3:''' position of top left (north-west) corner.<br />
''Note: Only 3 coords creates a triangle''<br />
<br />
===Optional Arguments===<br />
*'''x4, y4, z4:''' position of top right (north-east) corner.<br />
*'''bShallow:''' Need documentation...<br />
<br />
===Returns===<br />
Returns a water element if successful, ''false'' otherwise. The water element can be repositioned with [[setElementPosition]] and destroyed with [[destroyElement]].<br />
<br />
==Example== <br />
<section name="Client" class="client" show="true"><br />
Example code for creating a water area to cover the entire San Andreas Map (flood the cities). Also, [[setWaterLevel]] is used to raise the existing rivers and lakes.<br />
<syntaxhighlight lang="lua"><br />
-- Setting water properties.<br />
height = 40<br />
SizeVal = 2998<br />
-- Defining variables.<br />
southWest_X = -SizeVal<br />
southWest_Y = -SizeVal<br />
southEast_X = SizeVal<br />
southEast_Y = -SizeVal<br />
northWest_X = -SizeVal<br />
northWest_Y = SizeVal<br />
northEast_X = SizeVal<br />
northEast_Y = SizeVal<br />
<br />
-- OnClientResourceStart function that creates the water.<br />
function thaResourceStarting( )<br />
water = createWater ( southWest_X, southWest_Y, height, southEast_X, southEast_Y, height, northWest_X, northWest_Y, height, northEast_X, northEast_Y, height )<br />
setWaterLevel ( height )<br />
end<br />
addEventHandler("onClientResourceStart", getResourceRootElement(getThisResource()), thaResourceStarting)<br />
</syntaxhighlight><br />
</section><br />
<br />
==See Also==<br />
{{Client water functions}}</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=Talk:SetObjectBreakable&diff=33424Talk:SetObjectBreakable2012-09-16T20:20:42Z<p>Ransom: </p>
<hr />
<div>How is the example helpful when:<br />
<br />
1. The 1337 object (a bin) to my knowledge does not break, I've never seen it break.<br />
<br />
2. There is no comparison between breakable and not, 2 identical breakable objects should be placed side by side so that they can see what the function does when one of those objects won't break.<br />
<br />
--[[User:Arran Fortuna|Arran Fortuna]] 10:44, 16 September 2012 (UTC)<br />
<br />
The function itself needs to elaborate more on what it does. I assume it does what [[setObjectStatic]] used to do.<br />
<br />
--[[User:Ransom|Ransom]] 20:20, 16 September 2012 (UTC)</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=Talk:SetObjectBreakable&diff=33423Talk:SetObjectBreakable2012-09-16T20:20:16Z<p>Ransom: </p>
<hr />
<div>How is the example helpful when:<br />
<br />
1. The 1337 object (a bin) to my knowledge does not break, I've never seen it break.<br />
<br />
2. There is no comparison between breakable and not, 2 identical breakable objects should be placed side by side so that they can see what the function does when one of those objects won't break.<br />
<br />
--[[User:Arran Fortuna|Arran Fortuna]] 10:44, 16 September 2012 (UTC)<br />
<br />
The function itself needs to elaborate more on what it does. I assume it does what [[setObjectStatic]] used to do. --[[User:Ransom|Ransom]] 20:20, 16 September 2012 (UTC)</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=Talk:SetObjectBreakable&diff=33422Talk:SetObjectBreakable2012-09-16T20:20:06Z<p>Ransom: </p>
<hr />
<div>How is the example helpful when:<br />
<br />
1. The 1337 object (a bin) to my knowledge does not break, I've never seen it break.<br />
<br />
2. There is no comparison between breakable and not, 2 identical breakable objects should be placed side by side so that they can see what the function does when one of those objects won't break.<br />
<br />
--[[User:Arran Fortuna|Arran Fortuna]] 10:44, 16 September 2012 (UTC)<br />
<br />
The function itself needs to elaborate more on what it does. I assume it does what [[setObjectStatic]] used to do.</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=SetPedAnimation&diff=33421SetPedAnimation2012-09-16T20:16:29Z<p>Ransom: /* Optional Arguments */</p>
<hr />
<div>__NOTOC__<br />
{{Server client function}}<br />
<br />
Sets the current animation of a player or ped. Not specifying the type of animation will automatically cancel the current one.<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool setPedAnimation ( ped thePed [, string block=nil, string anim=nil, int time=-1, bool loop=true, bool updatePosition=true, bool interruptable=true, bool freezeLastFrame = true] )<br />
</syntaxhighlight><br />
<br />
===Required Arguments===<br />
*'''thePed:''' the player or ped you want to apply an animation to.<br />
<br />
===Optional Arguments===<br />
{{OptionalArg}}<br />
*'''block:''' the [[Animations|animation]] block's name.<br />
*'''anim:''' the name of the [[Animations|animation]] within the block.<br />
*'''time:''' how long the animation will run for in milliseconds.<br />
*'''loop:''' indicates whether or not the animation will loop.<br />
*'''updatePosition:''' will change the actual coordinates of the ped according to the animation. Use this for e.g. walking animations.<br />
*'''interruptable:''' if set to 'false' other tasks wont be able to interupt the animation. Setting this to 'false' also gives this function more power to override other animations that are running. For example, squatting after a jump can be terminated.<br />
*'''freezeLastFrame:''' ... (From 1.1 onwards).<br />
<br />
===Returns===<br />
Returns ''true'' if succesful, ''false'' otherwise.<br />
<br />
==Example1== <br />
<br />
<section name="Server" class="server" show="true"><br />
This example creates a ped, rotates him, and makes him walk:<br />
<syntaxhighlight lang="lua"><br />
function makePed()<br />
ped1 = createPed(56, 1, 1, 4)<br />
setPedRotation(ped1, 315)<br />
setPedAnimation( ped1, "ped", "WOMAN_walknorm")<br />
end<br />
addCommandHandler("makemyped", makePed)<br />
</syntaxhighlight><br />
</section><br />
<br />
<br />
==Example2==<br />
This example makes the player dance when he uses command /dance and stop when he uses the same command:<br />
<br />
<section name="Client" class="client" show="true"><br />
<syntaxhighlight lang="lua"><br />
<br />
addEventHandler("onClientPreRender",root,<br />
function ()<br />
daBlock, daAnim = getPedAnimation(getLocalPlayer())<br />
setElementData(root,"blockz",daBlock)<br />
setElementData(root,"animz",daAnim)<br />
end )<br />
<br />
<br />
</syntaxhighlight><br />
</section><br />
<br />
<br />
<section name="Server" class="server" show="true"><br />
<syntaxhighlight lang="lua"><br />
function dance (source)<br />
daBlockz = getElementData(root,"blockz")<br />
daAnimz = getElementData(root,"animz")<br />
if daBlockz == "dancing" and daAnimz == "dnce_m_b" then<br />
setPedAnimation(source,false)<br />
else<br />
setPedAnimation ( source, "DANCING", "dnce_m_b")<br />
end<br />
end<br />
addCommandHandler("dance",dance)<br />
<br />
</syntaxhighlight><br />
</section><br />
<br />
==See Also==<br />
{{Ped_functions}}<br />
[[ru:setPedAnimation]]</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=Help:Adding_Pages_to_Categories_and_Templates&diff=33372Help:Adding Pages to Categories and Templates2012-09-14T08:03:19Z<p>Ransom: MTA_Wiki:Editing_Guidelines link</p>
<hr />
<div>==Introduction==<br />
Did you create a new page, such as a function, and it isn't showing up in a list? Did you try and edit it in only to see <nowiki>{{weird_tags_like_this}}</nowiki> instead of text relating to the page you viewed? Welcome to the world of templates. We have noticed in [[Special:RecentChanges|RecentChanges]] that people are making pages and not linking to them properly. '''These pages are being lost in the bowels of the Wiki!'''<br />
<br />
We also use categories in this wiki, but they are not as crucial as templates. Please read on to learn about both and to understand how to contribute to our wiki properly.<br />
<br />
=Template=<br />
===What is a Template===<br />
It is like a big copy paste on a clipboard. You write a template tag on another page and it writes everything that was on the template page.<br />
<br />
*'''Why Use Templates?'''<br />
It allows the same information to be represented in multiple places, without duplicating texts and updating them manually numerous times.<br />
<br />
*'''Example?''' <br />
Look at the page source (edit button) on our functions or event pages. You can see that the functions aren't actually listed there, each function group has its own template. The main use for this is to fill out the "See Also" section of individual functions with their related functions.<br />
<br />
===How Do You Make/Edit/Use a Template?===<br />
<br />
The best way to teach is by example. I will need a template to direct people to this guide from multiple pages in the wiki. Let's just create this template together! FUN!<br />
<br />
====1. Choosing a Template Name====<br />
The best template name explains what it is. Typically the best thing is to make the template URL identical to the actual page. Therefore I am going to use:<br />
<br />
<pre>http://wiki.multitheftauto.com/index.php?title=Template:Adding_Pages_to_Categories_and_Templates</pre><br />
<br />
'''IMPORTANT:''' Remember that all wiki pages are case sensitive. The same page can exist in uppercase and lowercase! Capitalize appropriately.<br />
<br />
If I tried to link to a template that doesn't exist this happens:<br />
{{link_to_nonexistant_template_click_here_to_create_lazypants}}<br />
<br />
So as you can see, it is better we create the template before attempting to link to it!<br />
<br />
====2. Filling out the Template====<br />
<br />
At the template page, hit create page, and you'll see the edit field box. Type in whatever you need to be said in other pages and save the page. It could be simple text, links to a set of functions, or even as advanced as a bit of code that determines something, such as our future functions template. If you were trying to add to our functions/events then you would just edit a link to your function into the template. Don't screw it up or I will be disappointed in you!<br />
<br />
From this point, you use the template page name as a tag inside the pages where you want to use it. My template tag is:<br />
<br />
<pre>{{Adding_Pages_to_Categories_and_Templates}}</pre><br />
<br />
====3. Demonstration====<br />
So here I will actually link to the template. If you check the template page source, you will see exactly what is printed below:<br />
<br />
{{Adding_Pages_to_Categories_and_Templates}}<br />
<br />
'''Note:''' The easiest way to reach a template that was used on a page is to edit the page and scroll to the bottom. A list of all templates used will appear with links to the template pages. For something like the main function pages you have to edit the ENTIRE page to see templates used at the bottom, they do not appear if you only edit a section.<br />
<br />
=Category=<br />
===What is a Category===<br />
Categories group pages together. The categories have their own special page where all the grouped pages are alphabetized. Think of them like sorting the Wiki into folders for common pages. For example here is a link to the server functions category page: [[:Category:Server_functions]]<br />
<br />
===How do I Make/Edit/Use Categories===<br />
A page is put into a category by editing the following syntax into a page:<br />
<pre>[[:Category:pagename]]</pre><br />
<br />
You do need to create the category page just as you would a template. Again, you simply go to the URL of the category page you want to make. The format is:<br />
<pre>http://wiki.multitheftauto.com/index.php?title=Category:Page_Name_Here</pre><br />
<br />
For the category page itself, you simply write a small explanation what the category (folder) is about.<br />
<br />
If you look at the source of the pages listed in [[:Category:Server_functions]], you may notice that the category tag is not in them! It actually is there, but it is being applied through the clever combination of a template with the category embedded.<br />
<br />
Those nice colored stripes you see at the tops of pages are all templates that have a category tag embedded. This was designed to make it hard for people to mess-up categories. For example, look at the page source for the blue stripe that says "Client and Server Function" http://wiki.multitheftauto.com/index.php?title=Template:Server_client_function&action=edit<br />
<br />
===Demonstration===<br />
I have put a category tag in this page. This is reflected at the very bottom of the page you are reading right now. The category page just happens to be the exact same name. Unlike templates, it is not typical to name the category after a page. They are more like folder names. This is just for demonstration however.<br />
<br />
The category page is here: [[:Category:Adding_Pages_to_Categories_and_Templates]]<br />
<br />
[[Category:Adding_Pages_to_Categories_and_Templates]]<br />
<br />
=More Info=<br />
===Lists of Templates and Categories===<br />
Looking for template and category listings? This is one thing [[Special:SpecialPages|SpecialPages]] is for.<br />
<br />
'''Templates:'''<br />
*[[Special:UncategorizedTemplates]]<br />
:Templates not organized into templates (ie think of categories as folders).<br />
*[[Special:UnusedTemplates]]<br />
:Unused templates<br />
*[[Special:WantedTemplates]]<br />
:Tags are linked to this template, but the page itself doesn't exist. It still works de facto. You need to hit create on the template page.<br />
*[[Special:MostLinkedTemplates]]<br />
:Templates that were tagged in the most pages<br />
<br />
'''Categories:'''<br />
*[[Special:Categories]]<br />
:All categories overview.<br />
*[[Special:UncategorizedCategories]]<br />
:Categories not within another category (ie not used as subfolders of folders).<br />
*[[Special:UnusedCategories]]<br />
:Unused categories<br />
*[[Special:WantedCategories]]<br />
:Tags are linked to this category, but the page itself doesn't exist. It still works de facto. You need to hit create on the category page.<br />
*[[Special:MostLinkedCategories]]<br />
:Categories that were tagegd in the most places<br />
<br />
===Further Reference===<br />
http://en.wikipedia.org/wiki/Help:Template<br><br />
http://en.wikipedia.org/wiki/Help:Category<br />
<br />
===See Also===<br />
[[MTA_Wiki:Editing_Guidelines]] - This is a complete overview of how we use Wiki for MTA, this was only part of it. Please read this!<br />
<br />
===Questions?===<br />
Best way to discuss wiki is live on IRC. See the community box on the [[Main Page]] for more info.<br />
<br />
[[Category:MTA Wiki:Editing]]</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=Help:Adding_Pages_to_Categories_and_Templates&diff=33371Help:Adding Pages to Categories and Templates2012-09-14T08:01:23Z<p>Ransom: /* 3. Demonstration */</p>
<hr />
<div>==Introduction==<br />
Did you create a new page, such as a function, and it isn't showing up in a list? Did you try and edit it in only to see <nowiki>{{weird_tags_like_this}}</nowiki> instead of text relating to the page you viewed? Welcome to the world of templates. We have noticed in [[Special:RecentChanges|RecentChanges]] that people are making pages and not linking to them properly. '''These pages are being lost in the bowels of the Wiki!'''<br />
<br />
We also use categories in this wiki, but they are not as crucial as templates. Please read on to learn about both and to understand how to contribute to our wiki properly.<br />
<br />
=Template=<br />
===What is a Template===<br />
It is like a big copy paste on a clipboard. You write a template tag on another page and it writes everything that was on the template page.<br />
<br />
*'''Why Use Templates?'''<br />
It allows the same information to be represented in multiple places, without duplicating texts and updating them manually numerous times.<br />
<br />
*'''Example?''' <br />
Look at the page source (edit button) on our functions or event pages. You can see that the functions aren't actually listed there, each function group has its own template. The main use for this is to fill out the "See Also" section of individual functions with their related functions.<br />
<br />
===How Do You Make/Edit/Use a Template?===<br />
<br />
The best way to teach is by example. I will need a template to direct people to this guide from multiple pages in the wiki. Let's just create this template together! FUN!<br />
<br />
====1. Choosing a Template Name====<br />
The best template name explains what it is. Typically the best thing is to make the template URL identical to the actual page. Therefore I am going to use:<br />
<br />
<pre>http://wiki.multitheftauto.com/index.php?title=Template:Adding_Pages_to_Categories_and_Templates</pre><br />
<br />
'''IMPORTANT:''' Remember that all wiki pages are case sensitive. The same page can exist in uppercase and lowercase! Capitalize appropriately.<br />
<br />
If I tried to link to a template that doesn't exist this happens:<br />
{{link_to_nonexistant_template_click_here_to_create_lazypants}}<br />
<br />
So as you can see, it is better we create the template before attempting to link to it!<br />
<br />
====2. Filling out the Template====<br />
<br />
At the template page, hit create page, and you'll see the edit field box. Type in whatever you need to be said in other pages and save the page. It could be simple text, links to a set of functions, or even as advanced as a bit of code that determines something, such as our future functions template. If you were trying to add to our functions/events then you would just edit a link to your function into the template. Don't screw it up or I will be disappointed in you!<br />
<br />
From this point, you use the template page name as a tag inside the pages where you want to use it. My template tag is:<br />
<br />
<pre>{{Adding_Pages_to_Categories_and_Templates}}</pre><br />
<br />
====3. Demonstration====<br />
So here I will actually link to the template. If you check the template page source, you will see exactly what is printed below:<br />
<br />
{{Adding_Pages_to_Categories_and_Templates}}<br />
<br />
'''Note:''' The easiest way to reach a template that was used on a page is to edit the page and scroll to the bottom. A list of all templates used will appear with links to the template pages. For something like the main function pages you have to edit the ENTIRE page to see templates used at the bottom, they do not appear if you only edit a section.<br />
<br />
=Category=<br />
===What is a Category===<br />
Categories group pages together. The categories have their own special page where all the grouped pages are alphabetized. Think of them like sorting the Wiki into folders for common pages. For example here is a link to the server functions category page: [[:Category:Server_functions]]<br />
<br />
===How do I Make/Edit/Use Categories===<br />
A page is put into a category by editing the following syntax into a page:<br />
<pre>[[:Category:pagename]]</pre><br />
<br />
You do need to create the category page just as you would a template. Again, you simply go to the URL of the category page you want to make. The format is:<br />
<pre>http://wiki.multitheftauto.com/index.php?title=Category:Page_Name_Here</pre><br />
<br />
For the category page itself, you simply write a small explanation what the category (folder) is about.<br />
<br />
If you look at the source of the pages listed in [[:Category:Server_functions]], you may notice that the category tag is not in them! It actually is there, but it is being applied through the clever combination of a template with the category embedded.<br />
<br />
Those nice colored stripes you see at the tops of pages are all templates that have a category tag embedded. This was designed to make it hard for people to mess-up categories. For example, look at the page source for the blue stripe that says "Client and Server Function" http://wiki.multitheftauto.com/index.php?title=Template:Server_client_function&action=edit<br />
<br />
===Demonstration===<br />
I have put a category tag in this page. This is reflected at the very bottom of the page you are reading right now. The category page just happens to be the exact same name. Unlike templates, it is not typical to name the category after a page. They are more like folder names. This is just for demonstration however.<br />
<br />
The category page is here: [[:Category:Adding_Pages_to_Categories_and_Templates]]<br />
<br />
[[Category:Adding_Pages_to_Categories_and_Templates]]<br />
<br />
=More Info=<br />
===Lists of Templates and Categories===<br />
Looking for template and category listings? This is one thing [[Special:SpecialPages|SpecialPages]] is for.<br />
<br />
'''Templates:'''<br />
*[[Special:UncategorizedTemplates]]<br />
:Templates not organized into templates (ie think of categories as folders).<br />
*[[Special:UnusedTemplates]]<br />
:Unused templates<br />
*[[Special:WantedTemplates]]<br />
:Tags are linked to this template, but the page itself doesn't exist. It still works de facto. You need to hit create on the template page.<br />
*[[Special:MostLinkedTemplates]]<br />
:Templates that were tagged in the most pages<br />
<br />
'''Categories:'''<br />
*[[Special:Categories]]<br />
:All categories overview.<br />
*[[Special:UncategorizedCategories]]<br />
:Categories not within another category (ie not used as subfolders of folders).<br />
*[[Special:UnusedCategories]]<br />
:Unused categories<br />
*[[Special:WantedCategories]]<br />
:Tags are linked to this category, but the page itself doesn't exist. It still works de facto. You need to hit create on the category page.<br />
*[[Special:MostLinkedCategories]]<br />
:Categories that were tagegd in the most places<br />
<br />
===Further Reference===<br />
http://en.wikipedia.org/wiki/Help:Template<br><br />
http://en.wikipedia.org/wiki/Help:Category<br />
<br />
===Questions?===<br />
Best way to discuss wiki is live on IRC. See the community box on the [[Main Page]] for more info.<br />
<br />
[[Category:MTA Wiki:Editing]]</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=Template:Client_ped_functions&diff=33370Template:Client ped functions2012-09-14T07:57:20Z<p>Ransom: getPedSimplestTask moved above getPedTask some better re-organization of the function lists under the templates might be needed</p>
<hr />
<div>{{New items|3|1.0|<br />
*[[canPedBeKnockedOffBike]]<br />
*[[createPed]]<br />
*[[doesPedHaveJetPack]]<br />
*[[getPedAmmoInClip]]<br />
*[[getPedAnimation]]<br />
*[[getPedAnimationData]]<br />
*[[getPedArmor]]<br />
*[[getPedBonePosition]]<br />
*[[getPedClothes]]<br />
*[[getPedContactElement]]<br />
*[[getPedControlState]]<br />
{{New items|3.0110|1.1|<br />
*[[getPedMoveState]]<br />
}}<br />
*[[getPedOccupiedVehicle]]<br />
*[[getPedSkin]]<br />
*[[getPedStat]]<br />
*[[getPedTarget]]<br />
*[[getPedTargetCollision]]<br />
*[[getPedTargetEnd]]<br />
*[[getPedTargetStart]]<br />
*[[getPedSimplestTask]]<br />
*[[getPedTask]]<br />
*[[getPedTotalAmmo]]<br />
*[[getPedVoice]]<br />
*[[getPedWeapon]]<br />
*[[getPedWeaponMuzzlePosition]]<br />
*[[getPedWeaponSlot]]<br />
*[[isPedChoking]]<br />
*[[isPedDoingGangDriveby]]<br />
*[[isPedDoingTask]]<br />
*[[isPedDucked]]<br />
*[[isPedFrozen]]<br />
*[[isPedHeadless]]<br />
*[[isPedInVehicle]]<br />
*[[isPedInWater]]<br />
*[[isPedOnFire]]<br />
*[[isPedOnGround]]<br />
*[[setPedAimTarget]]<br />
*[[setPedAnalogControlState]]<br />
*[[setPedAnimation]]<br />
*[[setPedCameraRotation]]<br />
*[[setPedCanBeKnockedOffBike]]<br />
*[[setPedControlState]]<br />
*[[setPedDoingGangDriveby]]<br />
*[[setPedFrozen]]<br />
*[[setPedHeadless]]<br />
*[[setPedLookAt]]<br />
*[[setPedOnFire]]<br />
*[[setPedSkin]]<br />
*[[setPedVoice]]<br />
*[[setPedWeaponSlot]]<br />
*[[setPedFootBloodEnabled]]<br />
}}<br />
<noinclude>[[Category:Functions templates]]</noinclude></div>Ransomhttps://wiki.multitheftauto.com/index.php?title=SetWorldSoundEnabled&diff=33246SetWorldSoundEnabled2012-09-09T21:08:24Z<p>Ransom: /* Example */ Removed wind example, this function will not turn off wind. See http://bugs.mtasa.com/view.php?id=7304</p>
<hr />
<div>__NOTOC__<br />
{{Client function}}<br />
{{New items|3.0131|1.3.1|<br />
This function allows you to disable world sounds. A world sound is a sound effect which has '''''not''''' been caused by [[playSound]] or [[playSound3D]].<br />
<br />
Note: The values for ''group'' and ''index'' can be determined by using the client command [[Client_Commands#showsound|showsound]] in conjunction with [[setDevelopmentMode]]<br />
}}<br />
<br />
{{Note box|See Also: [[setAmbientSoundEnabled]]}}<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool setWorldSoundEnabled( int group, [ int index = -1, ] bool enable )<br />
</syntaxhighlight> <br />
<br />
===Required Arguments=== <br />
*'''group :''' An integer representing the world sound group<br />
*'''enable :''' Set ''false'' to disable, ''true'' to enable<br />
<br />
===OptionalArguments=== <br />
*'''index :''' An integer representing an individual sound within the group<br />
<br />
===Returns===<br />
Returns ''true'' if the world sound was correctly enabled/disabled, ''false'' if invalid values were passed.<br />
<br />
==Example== <br />
This example turns off car engine sounds<br />
<syntaxhighlight lang="lua"><br />
setWorldSoundEnabled( 40, false )<br />
</syntaxhighlight><br />
<br />
==Requirements==<br />
{{Requirements|n/a|1.3.0-9.04134|}}<br />
<br />
==See Also==<br />
{{Client world functions}}</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=SetAmbientSoundEnabled&diff=33164SetAmbientSoundEnabled2012-09-06T17:25:31Z<p>Ransom: </p>
<hr />
<div>__NOTOC__<br />
{{Client function}}<br />
{{Note box|See Also: [[setWorldSoundEnabled]]}}<br />
<br />
This function allows you to disable some background sound effects.<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool setAmbientSoundEnabled( string theType, bool enable )<br />
</syntaxhighlight> <br />
<br />
===Required Arguments=== <br />
*'''theType:''' The type of ambient sound to toggle. Can be either "gunfire" or "general".<br />
*'''enable :''' Set ''false'' to turn off, ''true'' to turn on<br />
<br />
===Returns===<br />
Returns ''true'' if the ambient sound was set correctly, ''false'' if invalid values were passed.<br />
<br />
==Example== <br />
This example turns off the ambient water and gunfire sounds:<br />
<syntaxhighlight lang="lua"><br />
setAmbientSoundEnabled( "general", false )<br />
setAmbientSoundEnabled( "gunfire", false )<br />
</syntaxhighlight><br />
<br />
==See Also==<br />
{{Client world functions}}</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=SetAmbientSoundEnabled&diff=33163SetAmbientSoundEnabled2012-09-06T17:25:07Z<p>Ransom: Linked two similar named functions in the notebox until (if?) one is deprecated</p>
<hr />
<div>__NOTOC__<br />
{{Client function}}<br />
This function allows you to disable some background sound effects.<br />
<br />
{{Note box|See Also: [[setWorldSoundEnabled]]}}<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool setAmbientSoundEnabled( string theType, bool enable )<br />
</syntaxhighlight> <br />
<br />
===Required Arguments=== <br />
*'''theType:''' The type of ambient sound to toggle. Can be either "gunfire" or "general".<br />
*'''enable :''' Set ''false'' to turn off, ''true'' to turn on<br />
<br />
===Returns===<br />
Returns ''true'' if the ambient sound was set correctly, ''false'' if invalid values were passed.<br />
<br />
==Example== <br />
This example turns off the ambient water and gunfire sounds:<br />
<syntaxhighlight lang="lua"><br />
setAmbientSoundEnabled( "general", false )<br />
setAmbientSoundEnabled( "gunfire", false )<br />
</syntaxhighlight><br />
<br />
==See Also==<br />
{{Client world functions}}</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=SetWorldSoundEnabled&diff=33162SetWorldSoundEnabled2012-09-06T17:24:15Z<p>Ransom: Linked two similar named functions in the notebox until (if?) one is deprecated</p>
<hr />
<div>__NOTOC__<br />
{{Client function}}<br />
{{New items|3.0140|1.3.1|<br />
This function allows you to disable world sounds. A world sound is a sound effect which has '''''not''''' been caused by [[playSound]] or [[playSound3D]].<br />
<br />
Note: The values for ''group'' and ''index'' can be determined by using the client command [[Client_Commands#showsound|showsound]] in conjunction with [[setDevelopmentMode]]<br />
}}<br />
<br />
{{Note box|See Also: [[setAmbientSoundEnabled]]}}<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
bool setWorldSoundEnabled( int group, [ int index = -1, ] bool enable )<br />
</syntaxhighlight> <br />
<br />
===Required Arguments=== <br />
*'''group :''' An integer representing the world sound group<br />
*'''enable :''' Set ''false'' to disable, ''true'' to enable<br />
<br />
===OptionalArguments=== <br />
*'''index :''' An integer representing an individual sound within the group<br />
<br />
===Returns===<br />
Returns ''true'' if the world sound was correctly enabled/disabled, ''false'' if invalid values were passed.<br />
<br />
==Example== <br />
This example turns off car engine sounds, maybe<br />
<syntaxhighlight lang="lua"><br />
setWorldSoundEnabled( 40, false )<br />
</syntaxhighlight><br />
<br />
This example turns off the annoying wind sound that is always heard<br />
<syntaxhighlight lang="lua"><br />
setWorldSoundEnabled( 0, false, 0 )<br />
</syntaxhighlight><br />
<br />
==Requirements==<br />
{{Requirements|n/a|1.3.0-9.04134|}}<br />
<br />
==See Also==<br />
{{Client world functions}}</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=SetPlayerNametagColor&diff=33090SetPlayerNametagColor2012-09-03T01:42:43Z<p>Ransom: Note about hexcodes in player tags overriding this function</p>
<hr />
<div>__NOTOC__<br />
{{Server client function}}<br />
{{Note box|If the player is using a hexcode in front of their name, it will override this function. You must first strip the name of the hexcode using [[setPlayerNametagText]]}}<br />
<br />
{{Needs_Checking|See the note. There should probably be a useful function to do this instead of everyone trying to re-invent the wheel when they need to force nick colors ie TDM/gangwars. If someone makes a useful function, link it in the note.}}<br />
<br />
<!-- Describe in plain english what this function does. Don't go into details, just give an overview --><br />
This allows you to change the RGB color mixture in the name tags of players.<br />
<br />
==Syntax== <br />
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd --><br />
<syntaxhighlight lang="lua"><br />
bool setPlayerNametagColor ( player thePlayer, int r, int g, int b )<br />
</syntaxhighlight> <br />
<br />
{{New feature|2|DP2|<br />
'''OR'''<br />
<br />
<syntaxhighlight lang="lua"><br />
bool setPlayerNametagColor ( player thePlayer, false )<br />
</syntaxhighlight> <br />
}}<br />
<br />
===Required Arguments=== <br />
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type --><br />
*'''thePlayer:''' The player whose name tag text you wish to change the color of<br />
*'''r:''' The amount of red you want in the mixture of RGB (0-255 is valid)<br />
*'''g:''' The amount of green you want in the mixture of RGB (0-255 is valid)<br />
*'''b:''' The amount of blue you want in the mixture of RGB (0-255 is valid)<br />
{{New feature|2|DP2|<br />
*'''false:''' If false is specified instead of the colors, the nametag color will reset to defaulting to your team color.<br />
}}<br />
<br />
===Returns===<br />
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check --><br />
Returns ''true'' if the function was successful, ''false'' otherwise.<br />
<br />
==Example== <br />
<!-- Explain what the example is in a single sentance --><br />
This will allow a player to change the RGB color mixture of their nickname. Valid RGB is between 0-255.<br />
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized --><br />
<syntaxhighlight lang="lua"><br />
-- The handler function for the console command<br />
function nametagColorChange ( thePlayer, commandName, r, g, b )<br />
-- Apply the new color mix of RGB to the command handler activator<br />
setPlayerNametagColor ( thePlayer, r, g, b )<br />
end<br />
-- This is a command handler that activates on text "nametagcolor" in the console. It also asks <br />
-- the player to provide values for the extra parameters r, g, b after the command name. These will <br />
-- be the new color mix of RGB to apply to the player's name tag.<br />
addCommandHandler ( "nametagcolor", nametagColorChange )<br />
</syntaxhighlight><br />
<br />
==See Also==<br />
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc --><br />
{{Player_functions}}</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=User:Ransom&diff=33041User:Ransom2012-09-01T03:38:51Z<p>Ransom: </p>
<hr />
<div>== ''Notice to whoever stumbles upon this page: I am at best an amateur Lua scripter. These are just some notes I have saved for myself of things I have learned along the way for quick reference if I forget something.'' ==<br />
<br />
'''Nesting functions:'''<br />
Remember that functions are variables. ie if you nest a function on a render event, each loop that function is re-created again. The code in the function may not run, but the function variable is re-created every time. This has nothing to do with being local. Functions are only local if you specify, otherwise they are global. You can still nest them, just do an "if not" check to see if they have been created yet. This can help you keep the code in order instead of jumping all over the place.<br />
<br />
'''Timed set of instructions:'''<br />
<pre><br />
setTimer (function()<br />
outputChatBox ("test")<br />
end, 250, 1)<br />
</pre><br />
<br />
'''Secret Variables'''<br\><br />
getRootElement()= root<br\><br />
getResourceRootElement() = resourceRoot<br\><br />
<br\><br />
screwed myself over with a very old problem... do NOT use root most times. ie onResourceStop under root for example would trigger when ANY script stops. You only need root when you have something that handles all vehicles for some purpose or something like that. Note that onClientRender or onClientPreRender require root. They don't make sense and do not work otherwise. There is only 1 render.<br />
<br />
'''Use of type()'''<br\><br />
Returns the type of its only argument, coded as a string. The possible results of this function are "nil" (a string, not the value nil), "number", "string", "boolean", "table", "function", "thread", and "userdata".<br />
<br />
'''Nested function for nicely structured timer that will have the source arg preserved when triggered:'''<br />
<syntaxhighlight lang="lua"><br />
function PlayerDamage ( attacker, weapon, bodypart )...<br />
...<br />
...<br />
...<br />
...<br />
function wheeeeeeee (source)<br />
setPedAnimation (source, "ped", "getup", 1, false, true, false, false )<br />
end<br />
<br />
setTimer ( wheeeeeeee, 2500, 1, source )<br />
<br />
end<br />
</syntaxhighlight><br />
<br />
<br />
'''Use of ... and the hidden 'arg' table for variable amount of arguments'''<br />
<syntaxhighlight lang="lua">function test(...)<br />
for k,v in ipairs(arg) do<br />
outputChatBox ( v )<br />
end<br />
end<br />
test("hi", "ho", "the", "deere", "o" )</syntaxhighlight><br />
<br />
*Meta order is important! Remember everything is one big code list when compiled. Utilities should go first!<br />
<br />
Finite loops:<br />
<syntaxhighlight lang="lua">use for variable,nth do ... end or for i=1,nth do ... end --USE THIS WHEN POSSIBLE<br />
while blah <= nth do when possible. --ONLY WHEN NEEDED. Minimize infinite loop capability.</syntaxhighlight><br />
<br />
something can serve as false, 0, etc. to help with pulling option stuff from users or general error compensation<br />
<syntaxhighlight lang="lua">blah = getSomething(...) or something<br />
--or say prevent the need of if statement when declaring variables...<br />
someTable = someTable or {}<br />
</syntaxhighlight><br />
<br />
Lua's secret global table... this is how you would refer to a variable, knowing its name through the use of other variables, such as a for k,v statement that makes a number attached to a static string<br />
<br />
<syntaxhighlight lang="lua">_G["blah"..tonumber(x)]</syntaxhighlight><br />
<br />
Using 1 line of code for 2 lines (bad practice!):<br />
<syntaxhighlight lang="lua">outputChatBox("hi") outputChatBox("there") outputChatBox("sir")<br />
hi = "hi"; there = "there"; sir = "sir"--for assignment stuff</syntaxhighlight><br />
<br />
bindKey Lesson:<br />
<syntaxhighlight lang="lua"> <br />
bindageB = function() outputChatBox ( "bindageB" ) end<br />
bindKey ( "F1", "down", function (bindageA) outputChatBox("bindageA") end )<br />
bindKey ( "F1", "down", bindageB )<br />
unbindKey ( "F1", "down", bindageA )--This would unbind everything from F1! bindageA is nil. You must use 2 lines as shown with bindageB.<br />
unbindKey ( "F1", "down", bindageB )--This only removes bindageB. Proper.</syntaxhighlight><br />
<br />
A short piece about addEventHandler:<br />
addEventHandler is like a filter mostly... its to trigger on specific things. You could create fake parent elements (tree branches) and move elements out of their trees into the dummy tree, so only they call a function. They could also be got by getElementsByType. root is defined by default in MTA as the root of the resource's element tree. That means all peds, vehicles, objects, everything will trigger an event handler. The one place where it is very significant is GUI elements. Since their use is mainly a bunch of clicking, you can see the need to isolate GUI elements with their own event handlers, vs. a massive onClientGUIClick if statement.<br />
<br />
When using bindkey, just make it all filter into 1 function and do some checks. Don't be ignant.<br />
<br />
---------------------------------------------------------------------------------------------------<br />
'''My old LUA Information, Tips, and Tricks from the main page!<br />
Deleted revision of LUA Information, Tips, and Tricks (as of 21 September 2007, at 07:14) by Ransom''' <br />
---------------------------------------------------------------------------------------------------<br />
<br />
This may possibly be a brief tut in the future trying to get people familiar with things like tables, xml, and other 'scary' stuff :P<br />
<br />
*'''Statements:''' http://www.lua.org/pil/4.html<br />
<br />
*'''Operators:''' http://www.lua.org/pil/3.2.html<br />
<br />
*'''Nil:''' http://www.lua.org/pil/2.1.html<br />
<br />
*'''[[Local]] Varibles'''<br />
<br />
*'''Appending two Strings:''' .. Will append a string to another string or varible. This could for example show who has joined a server by appending joining text and joining it to another string which reads a varible (for this example, called playerstring) that sees what player has joined: playerstring.."has joined the server"<br />
<br />
*'''Script Commentation (--):''' -- Denotes script commentation. This is for taking notes on your script and will not be read by the script. Everything after -- on the same line will be ignored unless you surround the comment like so: <nowiki>--[[like this]],</nowiki> which allows you to comment somewhere besides the end of script lines.<br />
<br />
*'''Using strings (""):''' Is used to specify a string of text, rather than a varible. Quotes must surround your text on functions that have a text argument.<br />
<br />
*'''Usage of == and =:''' Two equal signs ('''==''') are used to compare and see if two varibles are equal. One equal sign ('''=''') sign is used to set a varible after the sign.<br />
<br />
*'''Optional Arguments:''' You do not have to specify all arguments for some functions. Optional functions are enclosed with [ ] in the syntax display. They are also explained under the "Optional Arguments" heading rather than the "Required Arguments" heading. All the required arguments will always come before optional arguments. You may specify any amount of the optional varibles, but required arguments must always be assigned. You may also choose to skip assigning a value to an optional argument by using "nil" to leave it unassigned and move to the next argument. I will use the following function in the examples (which is a more rare type of function with no required varibles):<br />
<syntaxhighlight lang="lua"><br />
textitem textCreateTextItem ( [string text, float x, float y, string priority, int red, int green, int blue, int alpha, float scale] )<br />
</syntaxhighlight><br />
Using only the required arguments:<br />
<syntaxhighlight lang="lua">scoregrove = textCreateTextItem ( "Display this as text", 0.075, 0.215 ) --I only wanted to display that text at x,y position on the screen</syntaxhighlight><br />
Using optional arguments after an optional argument you do not want to specify:<br />
<syntaxhighlight lang="lua"><br />
scoregrove = textCreateTextItem ( "Display this as text", 0.075, 0.215, nil, 70, 145, 0, 255, 1.8 ) --I wanted to display that text at x, y and in certain color without specifying its text priority argument</syntaxhighlight><br />
<br />
*'''Source:''' Can be used to point to a player if player is not a predefined varible specified in the function. For example playerquit does not have the "player" varible in it. Source is used to point to the player who quit to perform actions on him/her: <br />
<syntaxhighlight lang="lua">on function on PlayerQuit ()<br />
destroyBlipAttachedTo ( source )</syntaxhighlight><br />
<br />
*'''Converting numbers to strings:''' A number can be changed to be read as a string by LUA when using it in a string argument of a function. One use for this is with the function '''textItem = textCreateTextItem ( ''string'' text, ''float'' x, ''float'' y )''' - if you wanted to display a score varible (groveteamscore = a number), you would need to convert it to be read as a string by LUA so satisfies the requirement of the function for the text to be a string. You can use the following methods to convert the number varible to a string varible:<br />
'''1.''' Use a string (can be empty: "" to not display anything ) and append the number varible to the string using .. so it satisfies the function: <br />
<syntaxhighlight lang="lua">textItem = textCreateTextItem ( "Score: " .. groveteamscore, 0.5, 0.5 )</syntaxhighlight><br />
'''2.''' Use the '''tostring()''' function which will convert your number to be read as a string of text by LUA<br />
<syntaxhighlight lang="lua">textItem = textCreateTextItem ( "Score: " .. tostring(groveteamscore), 0.5, 0.5 )</syntaxhighlight><br />
<br />
*'''Converting strings to numbers:''': id = tonumber ( gettok ( text, 3, 32 ) )<br />
<br />
*'''RandInt & RandFloat''': + skipping numbers inbetween lower_limit+randint()*upper_limiter<br />
randFloat () * 0.94 + 0.01<br />
<br />
*'''Doing Math Right - Using Parenthesis''':<br />
<br />
*'''Time Measurement of MS''': 1000 = 1 minute<br />
<br />
*'''Check type''' -bit here about checking argument type with type()-<br />
<br />
*'''Tables as strings and [#] and nested tables''' -bit here-<br />
Refer to string tables as Table.string<br />
<br />
Creating a table of varibles.. ex:<br />
buyWeaponText = {} --Must declare an empty table to use for filling in values<br />
<br />
for k, v in ipairs(buyWeapon) do<br />
buyWeaponText[k] = textCreateTextItem ( "Purchase Price: $"..tostring(buyWeapon[k].buyWeaponPrice), 0.2, 0.3, nil, 0, 170, 0, nil, 3 ) <br />
textDisplayAddText ( buyWeaponDisplay, buyWeaponText[k] )<br />
end<br />
<br />
*'''k,v in i(pairs) <br />
(in order pair checking, possible with continuous table (array) vs.(pairs) table with numbering that has holes and pairs must be checked in random out of order)<br />
<br />
Triggering a custom function: in another function type "Explosion()" for example to activate function "function Explosion ()". This would activate it once. You could use a timer to trigger how many times it was activated.<br />
<br />
*'''Using double quotes in a string''' A backslash before a double quote will stop it from being recognized as the beginning or end of a string. For example: outputChatBox ( " Ransom called Fedor a \"disgrace\" for not being patient enough to learn Lua. " )<br />
<br />
----<br />
<br />
==Other LUA Tips & Tricks==<br />
[[id]] - This page is a collection of various IDs (weapons, cars, clothes, sounds, upgrades, weather, skins, etc)<br />
'''Bold text'''</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=User:Ransom&diff=33040User:Ransom2012-09-01T03:33:55Z<p>Ransom: </p>
<hr />
<div>== ''Notice to whoever stumbles upon this page: I am at best an amateur Lua scripter. These are just some notes I have saved for myself of things I have learned along the way for quick reference if I forget something.'' ==<br />
<br />
'''Nesting functions:'''<br />
Remember that functions are variables. ie if you nest a function on a render event, each loop that entire function is re-created again. This has nothing to do with being local. Functions are only local if you specify, otherwise they are global. You can still nest them, just do an "if not" check to see if they have been created yet. This can help you keep the code in order instead of jumping all over the place.<br />
<br />
'''Timed set of instructions:'''<br />
<pre><br />
setTimer (function()<br />
outputChatBox ("test")<br />
end, 250, 1)<br />
</pre><br />
<br />
'''Secret Variables'''<br\><br />
getRootElement()= root<br\><br />
getResourceRootElement() = resourceRoot<br\><br />
<br\><br />
screwed myself over with a very old problem... do NOT use root most times. ie onResourceStop under root for example would trigger when ANY script stops. You only need root when you have something that handles all vehicles for some purpose or something like that. Note that onClientRender or onClientPreRender require root. They don't make sense and do not work otherwise. There is only 1 render.<br />
<br />
'''Use of type()'''<br\><br />
Returns the type of its only argument, coded as a string. The possible results of this function are "nil" (a string, not the value nil), "number", "string", "boolean", "table", "function", "thread", and "userdata".<br />
<br />
'''Nested function for nicely structured timer that will have the source arg preserved when triggered:'''<br />
<syntaxhighlight lang="lua"><br />
function PlayerDamage ( attacker, weapon, bodypart )...<br />
...<br />
...<br />
...<br />
...<br />
function wheeeeeeee (source)<br />
setPedAnimation (source, "ped", "getup", 1, false, true, false, false )<br />
end<br />
<br />
setTimer ( wheeeeeeee, 2500, 1, source )<br />
<br />
end<br />
</syntaxhighlight><br />
<br />
<br />
'''Use of ... and the hidden 'arg' table for variable amount of arguments'''<br />
<syntaxhighlight lang="lua">function test(...)<br />
for k,v in ipairs(arg) do<br />
outputChatBox ( v )<br />
end<br />
end<br />
test("hi", "ho", "the", "deere", "o" )</syntaxhighlight><br />
<br />
*Meta order is important! Remember everything is one big code list when compiled. Utilities should go first!<br />
<br />
Finite loops:<br />
<syntaxhighlight lang="lua">use for variable,nth do ... end or for i=1,nth do ... end --USE THIS WHEN POSSIBLE<br />
while blah <= nth do when possible. --ONLY WHEN NEEDED. Minimize infinite loop capability.</syntaxhighlight><br />
<br />
something can serve as false, 0, etc. to help with pulling option stuff from users or general error compensation<br />
<syntaxhighlight lang="lua">blah = getSomething(...) or something<br />
--or say prevent the need of if statement when declaring variables...<br />
someTable = someTable or {}<br />
</syntaxhighlight><br />
<br />
Lua's secret global table... this is how you would refer to a variable, knowing its name through the use of other variables, such as a for k,v statement that makes a number attached to a static string<br />
<br />
<syntaxhighlight lang="lua">_G["blah"..tonumber(x)]</syntaxhighlight><br />
<br />
Using 1 line of code for 2 lines (bad practice!):<br />
<syntaxhighlight lang="lua">outputChatBox("hi") outputChatBox("there") outputChatBox("sir")<br />
hi = "hi"; there = "there"; sir = "sir"--for assignment stuff</syntaxhighlight><br />
<br />
bindKey Lesson:<br />
<syntaxhighlight lang="lua"> <br />
bindageB = function() outputChatBox ( "bindageB" ) end<br />
bindKey ( "F1", "down", function (bindageA) outputChatBox("bindageA") end )<br />
bindKey ( "F1", "down", bindageB )<br />
unbindKey ( "F1", "down", bindageA )--This would unbind everything from F1! bindageA is nil. You must use 2 lines as shown with bindageB.<br />
unbindKey ( "F1", "down", bindageB )--This only removes bindageB. Proper.</syntaxhighlight><br />
<br />
A short piece about addEventHandler:<br />
addEventHandler is like a filter mostly... its to trigger on specific things. You could create fake parent elements (tree branches) and move elements out of their trees into the dummy tree, so only they call a function. They could also be got by getElementsByType. root is defined by default in MTA as the root of the resource's element tree. That means all peds, vehicles, objects, everything will trigger an event handler. The one place where it is very significant is GUI elements. Since their use is mainly a bunch of clicking, you can see the need to isolate GUI elements with their own event handlers, vs. a massive onClientGUIClick if statement.<br />
<br />
When using bindkey, just make it all filter into 1 function and do some checks. Don't be ignant.<br />
<br />
---------------------------------------------------------------------------------------------------<br />
'''My old LUA Information, Tips, and Tricks from the main page!<br />
Deleted revision of LUA Information, Tips, and Tricks (as of 21 September 2007, at 07:14) by Ransom''' <br />
---------------------------------------------------------------------------------------------------<br />
<br />
This may possibly be a brief tut in the future trying to get people familiar with things like tables, xml, and other 'scary' stuff :P<br />
<br />
*'''Statements:''' http://www.lua.org/pil/4.html<br />
<br />
*'''Operators:''' http://www.lua.org/pil/3.2.html<br />
<br />
*'''Nil:''' http://www.lua.org/pil/2.1.html<br />
<br />
*'''[[Local]] Varibles'''<br />
<br />
*'''Appending two Strings:''' .. Will append a string to another string or varible. This could for example show who has joined a server by appending joining text and joining it to another string which reads a varible (for this example, called playerstring) that sees what player has joined: playerstring.."has joined the server"<br />
<br />
*'''Script Commentation (--):''' -- Denotes script commentation. This is for taking notes on your script and will not be read by the script. Everything after -- on the same line will be ignored unless you surround the comment like so: <nowiki>--[[like this]],</nowiki> which allows you to comment somewhere besides the end of script lines.<br />
<br />
*'''Using strings (""):''' Is used to specify a string of text, rather than a varible. Quotes must surround your text on functions that have a text argument.<br />
<br />
*'''Usage of == and =:''' Two equal signs ('''==''') are used to compare and see if two varibles are equal. One equal sign ('''=''') sign is used to set a varible after the sign.<br />
<br />
*'''Optional Arguments:''' You do not have to specify all arguments for some functions. Optional functions are enclosed with [ ] in the syntax display. They are also explained under the "Optional Arguments" heading rather than the "Required Arguments" heading. All the required arguments will always come before optional arguments. You may specify any amount of the optional varibles, but required arguments must always be assigned. You may also choose to skip assigning a value to an optional argument by using "nil" to leave it unassigned and move to the next argument. I will use the following function in the examples (which is a more rare type of function with no required varibles):<br />
<syntaxhighlight lang="lua"><br />
textitem textCreateTextItem ( [string text, float x, float y, string priority, int red, int green, int blue, int alpha, float scale] )<br />
</syntaxhighlight><br />
Using only the required arguments:<br />
<syntaxhighlight lang="lua">scoregrove = textCreateTextItem ( "Display this as text", 0.075, 0.215 ) --I only wanted to display that text at x,y position on the screen</syntaxhighlight><br />
Using optional arguments after an optional argument you do not want to specify:<br />
<syntaxhighlight lang="lua"><br />
scoregrove = textCreateTextItem ( "Display this as text", 0.075, 0.215, nil, 70, 145, 0, 255, 1.8 ) --I wanted to display that text at x, y and in certain color without specifying its text priority argument</syntaxhighlight><br />
<br />
*'''Source:''' Can be used to point to a player if player is not a predefined varible specified in the function. For example playerquit does not have the "player" varible in it. Source is used to point to the player who quit to perform actions on him/her: <br />
<syntaxhighlight lang="lua">on function on PlayerQuit ()<br />
destroyBlipAttachedTo ( source )</syntaxhighlight><br />
<br />
*'''Converting numbers to strings:''' A number can be changed to be read as a string by LUA when using it in a string argument of a function. One use for this is with the function '''textItem = textCreateTextItem ( ''string'' text, ''float'' x, ''float'' y )''' - if you wanted to display a score varible (groveteamscore = a number), you would need to convert it to be read as a string by LUA so satisfies the requirement of the function for the text to be a string. You can use the following methods to convert the number varible to a string varible:<br />
'''1.''' Use a string (can be empty: "" to not display anything ) and append the number varible to the string using .. so it satisfies the function: <br />
<syntaxhighlight lang="lua">textItem = textCreateTextItem ( "Score: " .. groveteamscore, 0.5, 0.5 )</syntaxhighlight><br />
'''2.''' Use the '''tostring()''' function which will convert your number to be read as a string of text by LUA<br />
<syntaxhighlight lang="lua">textItem = textCreateTextItem ( "Score: " .. tostring(groveteamscore), 0.5, 0.5 )</syntaxhighlight><br />
<br />
*'''Converting strings to numbers:''': id = tonumber ( gettok ( text, 3, 32 ) )<br />
<br />
*'''RandInt & RandFloat''': + skipping numbers inbetween lower_limit+randint()*upper_limiter<br />
randFloat () * 0.94 + 0.01<br />
<br />
*'''Doing Math Right - Using Parenthesis''':<br />
<br />
*'''Time Measurement of MS''': 1000 = 1 minute<br />
<br />
*'''Check type''' -bit here about checking argument type with type()-<br />
<br />
*'''Tables as strings and [#] and nested tables''' -bit here-<br />
Refer to string tables as Table.string<br />
<br />
Creating a table of varibles.. ex:<br />
buyWeaponText = {} --Must declare an empty table to use for filling in values<br />
<br />
for k, v in ipairs(buyWeapon) do<br />
buyWeaponText[k] = textCreateTextItem ( "Purchase Price: $"..tostring(buyWeapon[k].buyWeaponPrice), 0.2, 0.3, nil, 0, 170, 0, nil, 3 ) <br />
textDisplayAddText ( buyWeaponDisplay, buyWeaponText[k] )<br />
end<br />
<br />
*'''k,v in i(pairs) <br />
(in order pair checking, possible with continuous table (array) vs.(pairs) table with numbering that has holes and pairs must be checked in random out of order)<br />
<br />
Triggering a custom function: in another function type "Explosion()" for example to activate function "function Explosion ()". This would activate it once. You could use a timer to trigger how many times it was activated.<br />
<br />
*'''Using double quotes in a string''' A backslash before a double quote will stop it from being recognized as the beginning or end of a string. For example: outputChatBox ( " Ransom called Fedor a \"disgrace\" for not being patient enough to learn Lua. " )<br />
<br />
----<br />
<br />
==Other LUA Tips & Tricks==<br />
[[id]] - This page is a collection of various IDs (weapons, cars, clothes, sounds, upgrades, weather, skins, etc)<br />
'''Bold text'''</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=GetPedAnimationData&diff=33039GetPedAnimationData2012-09-01T03:22:26Z<p>Ransom: </p>
<hr />
<div>__NOTOC__<br />
{{Client function}}<br />
{{Needs_Checking|This function doesn't exist in 1.0.1 --[[User:50p|50p]] 22:06, 9 October 2009 (UTC)<br />
Still missing in 1.3, [[getPedTask]] monitors the player, but you can't get animation table --[[User:Ransom|Ransom]] 03:14, 1 September 2012 (UTC)}}<br />
{{Needs Example}}<br />
This function is used to return the animation data of a [[player]] or [[ped]] that was set using [[setPedAnimation]].<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
table getPedAnimationData ( ped thePed )<br />
</syntaxhighlight><br />
<br />
===Required Arguments===<br />
*'''thePed:''' the player or ped you want to get the animation data of.<br />
<br />
===Returns===<br />
Returns a [[table]] containing information about animation. These keys are present in the table:<br />
*'''name:''' string - name of the animation<br />
*'''block_name:''' string - name of animation block<br />
*'''loop:''' boolean - is animation looping?<br />
*'''update_position:''' boolean - updating position<br />
*'''interruptible:''' boolean - is animation interruptible?<br />
*'''time:''' float - duration of the animation<br />
*'''start_time:''' float - starting point<br />
*'''finished:''' boolean - has animation finished playing?<br />
*'''speed:''' float - speed<br />
*'''blend_speed:''' float - blending speed<br />
<br />
==See Also==<br />
{{Client ped functions}}</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=GetPedAnimationData&diff=33038GetPedAnimationData2012-09-01T03:14:00Z<p>Ransom: </p>
<hr />
<div>__NOTOC__<br />
{{Client function}}<br />
{{Needs_Checking|This function doesn't exist in 1.0.1 --[[User:50p|50p]] 22:06, 9 October 2009 (UTC)<br />
It does not exist as of 1.3 --[[User:Ransom|Ransom]] 03:14, 1 September 2012 (UTC)}}<br />
{{Needs Example}}<br />
This function is used to return the animation data of a [[player]] or [[ped]] that was set using [[setPedAnimation]].<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
table getPedAnimationData ( ped thePed )<br />
</syntaxhighlight><br />
<br />
===Required Arguments===<br />
*'''thePed:''' the player or ped you want to get the animation data of.<br />
<br />
===Returns===<br />
Returns a [[table]] containing information about animation. These keys are present in the table:<br />
*'''name:''' string - name of the animation<br />
*'''block_name:''' string - name of animation block<br />
*'''loop:''' boolean - is animation looping?<br />
*'''update_position:''' boolean - updating position<br />
*'''interruptible:''' boolean - is animation interruptible?<br />
*'''time:''' float - duration of the animation<br />
*'''start_time:''' float - starting point<br />
*'''finished:''' boolean - has animation finished playing?<br />
*'''speed:''' float - speed<br />
*'''blend_speed:''' float - blending speed<br />
<br />
==See Also==<br />
{{Client ped functions}}</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=User:Ransom&diff=32990User:Ransom2012-08-30T22:40:10Z<p>Ransom: </p>
<hr />
<div>== ''Notice to whoever stumbles upon this page: I am at best an amateur Lua scripter. These are just some notes I have saved for myself of things I have learned along the way for quick reference if I forget something.'' ==<br />
<br />
Timed set of instructions:<br />
<pre><br />
setTimer (function()<br />
outputChatBox ("test")<br />
end, 250, 1)<br />
</pre><br />
<br />
'''Secret Variables'''<br\><br />
getRootElement()= root<br\><br />
getResourceRootElement() = resourceRoot<br\><br />
<br\><br />
screwed myself over with a very old problem... do NOT use root most times. ie onResourceStop under root for example would trigger when ANY script stops. You only need root when you have something that handles all vehicles for some purpose or something like that. Note that onClientRender or onClientPreRender require root. They don't make sense and do not work otherwise. There is only 1 render.<br />
<br />
'''Use of type()'''<br\><br />
Returns the type of its only argument, coded as a string. The possible results of this function are "nil" (a string, not the value nil), "number", "string", "boolean", "table", "function", "thread", and "userdata".<br />
<br />
'''Nested function for nicely structured timer that will have the source arg preserved when triggered:'''<br />
<syntaxhighlight lang="lua"><br />
function PlayerDamage ( attacker, weapon, bodypart )...<br />
...<br />
...<br />
...<br />
...<br />
function wheeeeeeee (source)<br />
setPedAnimation (source, "ped", "getup", 1, false, true, false, false )<br />
end<br />
<br />
setTimer ( wheeeeeeee, 2500, 1, source )<br />
<br />
end<br />
</syntaxhighlight><br />
<br />
<br />
'''Use of ... and the hidden 'arg' table for variable amount of arguments'''<br />
<syntaxhighlight lang="lua">function test(...)<br />
for k,v in ipairs(arg) do<br />
outputChatBox ( v )<br />
end<br />
end<br />
test("hi", "ho", "the", "deere", "o" )</syntaxhighlight><br />
<br />
*Meta order is important! Remember everything is one big code list when compiled. Utilities should go first!<br />
<br />
Finite loops:<br />
<syntaxhighlight lang="lua">use for variable,nth do ... end or for i=1,nth do ... end --USE THIS WHEN POSSIBLE<br />
while blah <= nth do when possible. --ONLY WHEN NEEDED. Minimize infinite loop capability.</syntaxhighlight><br />
<br />
something can serve as false, 0, etc. to help with pulling option stuff from users or general error compensation<br />
<syntaxhighlight lang="lua">blah = getSomething(...) or something<br />
--or say prevent the need of if statement when declaring variables...<br />
someTable = someTable or {}<br />
</syntaxhighlight><br />
<br />
Lua's secret global table... this is how you would refer to a variable, knowing its name through the use of other variables, such as a for k,v statement that makes a number attached to a static string<br />
<br />
<syntaxhighlight lang="lua">_G["blah"..tonumber(x)]</syntaxhighlight><br />
<br />
Using 1 line of code for 2 lines (bad practice!):<br />
<syntaxhighlight lang="lua">outputChatBox("hi") outputChatBox("there") outputChatBox("sir")<br />
hi = "hi"; there = "there"; sir = "sir"--for assignment stuff</syntaxhighlight><br />
<br />
bindKey Lesson:<br />
<syntaxhighlight lang="lua"> <br />
bindageB = function() outputChatBox ( "bindageB" ) end<br />
bindKey ( "F1", "down", function (bindageA) outputChatBox("bindageA") end )<br />
bindKey ( "F1", "down", bindageB )<br />
unbindKey ( "F1", "down", bindageA )--This would unbind everything from F1! bindageA is nil. You must use 2 lines as shown with bindageB.<br />
unbindKey ( "F1", "down", bindageB )--This only removes bindageB. Proper.</syntaxhighlight><br />
<br />
A short piece about addEventHandler:<br />
addEventHandler is like a filter mostly... its to trigger on specific things. You could create fake parent elements (tree branches) and move elements out of their trees into the dummy tree, so only they call a function. They could also be got by getElementsByType. root is defined by default in MTA as the root of the resource's element tree. That means all peds, vehicles, objects, everything will trigger an event handler. The one place where it is very significant is GUI elements. Since their use is mainly a bunch of clicking, you can see the need to isolate GUI elements with their own event handlers, vs. a massive onClientGUIClick if statement.<br />
<br />
When using bindkey, just make it all filter into 1 function and do some checks. Don't be ignant.<br />
<br />
---------------------------------------------------------------------------------------------------<br />
'''My old LUA Information, Tips, and Tricks from the main page!<br />
Deleted revision of LUA Information, Tips, and Tricks (as of 21 September 2007, at 07:14) by Ransom''' <br />
---------------------------------------------------------------------------------------------------<br />
<br />
This may possibly be a brief tut in the future trying to get people familiar with things like tables, xml, and other 'scary' stuff :P<br />
<br />
*'''Statements:''' http://www.lua.org/pil/4.html<br />
<br />
*'''Operators:''' http://www.lua.org/pil/3.2.html<br />
<br />
*'''Nil:''' http://www.lua.org/pil/2.1.html<br />
<br />
*'''[[Local]] Varibles'''<br />
<br />
*'''Appending two Strings:''' .. Will append a string to another string or varible. This could for example show who has joined a server by appending joining text and joining it to another string which reads a varible (for this example, called playerstring) that sees what player has joined: playerstring.."has joined the server"<br />
<br />
*'''Script Commentation (--):''' -- Denotes script commentation. This is for taking notes on your script and will not be read by the script. Everything after -- on the same line will be ignored unless you surround the comment like so: <nowiki>--[[like this]],</nowiki> which allows you to comment somewhere besides the end of script lines.<br />
<br />
*'''Using strings (""):''' Is used to specify a string of text, rather than a varible. Quotes must surround your text on functions that have a text argument.<br />
<br />
*'''Usage of == and =:''' Two equal signs ('''==''') are used to compare and see if two varibles are equal. One equal sign ('''=''') sign is used to set a varible after the sign.<br />
<br />
*'''Optional Arguments:''' You do not have to specify all arguments for some functions. Optional functions are enclosed with [ ] in the syntax display. They are also explained under the "Optional Arguments" heading rather than the "Required Arguments" heading. All the required arguments will always come before optional arguments. You may specify any amount of the optional varibles, but required arguments must always be assigned. You may also choose to skip assigning a value to an optional argument by using "nil" to leave it unassigned and move to the next argument. I will use the following function in the examples (which is a more rare type of function with no required varibles):<br />
<syntaxhighlight lang="lua"><br />
textitem textCreateTextItem ( [string text, float x, float y, string priority, int red, int green, int blue, int alpha, float scale] )<br />
</syntaxhighlight><br />
Using only the required arguments:<br />
<syntaxhighlight lang="lua">scoregrove = textCreateTextItem ( "Display this as text", 0.075, 0.215 ) --I only wanted to display that text at x,y position on the screen</syntaxhighlight><br />
Using optional arguments after an optional argument you do not want to specify:<br />
<syntaxhighlight lang="lua"><br />
scoregrove = textCreateTextItem ( "Display this as text", 0.075, 0.215, nil, 70, 145, 0, 255, 1.8 ) --I wanted to display that text at x, y and in certain color without specifying its text priority argument</syntaxhighlight><br />
<br />
*'''Source:''' Can be used to point to a player if player is not a predefined varible specified in the function. For example playerquit does not have the "player" varible in it. Source is used to point to the player who quit to perform actions on him/her: <br />
<syntaxhighlight lang="lua">on function on PlayerQuit ()<br />
destroyBlipAttachedTo ( source )</syntaxhighlight><br />
<br />
*'''Converting numbers to strings:''' A number can be changed to be read as a string by LUA when using it in a string argument of a function. One use for this is with the function '''textItem = textCreateTextItem ( ''string'' text, ''float'' x, ''float'' y )''' - if you wanted to display a score varible (groveteamscore = a number), you would need to convert it to be read as a string by LUA so satisfies the requirement of the function for the text to be a string. You can use the following methods to convert the number varible to a string varible:<br />
'''1.''' Use a string (can be empty: "" to not display anything ) and append the number varible to the string using .. so it satisfies the function: <br />
<syntaxhighlight lang="lua">textItem = textCreateTextItem ( "Score: " .. groveteamscore, 0.5, 0.5 )</syntaxhighlight><br />
'''2.''' Use the '''tostring()''' function which will convert your number to be read as a string of text by LUA<br />
<syntaxhighlight lang="lua">textItem = textCreateTextItem ( "Score: " .. tostring(groveteamscore), 0.5, 0.5 )</syntaxhighlight><br />
<br />
*'''Converting strings to numbers:''': id = tonumber ( gettok ( text, 3, 32 ) )<br />
<br />
*'''RandInt & RandFloat''': + skipping numbers inbetween lower_limit+randint()*upper_limiter<br />
randFloat () * 0.94 + 0.01<br />
<br />
*'''Doing Math Right - Using Parenthesis''':<br />
<br />
*'''Time Measurement of MS''': 1000 = 1 minute<br />
<br />
*'''Check type''' -bit here about checking argument type with type()-<br />
<br />
*'''Tables as strings and [#] and nested tables''' -bit here-<br />
Refer to string tables as Table.string<br />
<br />
Creating a table of varibles.. ex:<br />
buyWeaponText = {} --Must declare an empty table to use for filling in values<br />
<br />
for k, v in ipairs(buyWeapon) do<br />
buyWeaponText[k] = textCreateTextItem ( "Purchase Price: $"..tostring(buyWeapon[k].buyWeaponPrice), 0.2, 0.3, nil, 0, 170, 0, nil, 3 ) <br />
textDisplayAddText ( buyWeaponDisplay, buyWeaponText[k] )<br />
end<br />
<br />
*'''k,v in i(pairs) <br />
(in order pair checking, possible with continuous table (array) vs.(pairs) table with numbering that has holes and pairs must be checked in random out of order)<br />
<br />
Triggering a custom function: in another function type "Explosion()" for example to activate function "function Explosion ()". This would activate it once. You could use a timer to trigger how many times it was activated.<br />
<br />
*'''Using double quotes in a string''' A backslash before a double quote will stop it from being recognized as the beginning or end of a string. For example: outputChatBox ( " Ransom called Fedor a \"disgrace\" for not being patient enough to learn Lua. " )<br />
<br />
----<br />
<br />
==Other LUA Tips & Tricks==<br />
[[id]] - This page is a collection of various IDs (weapons, cars, clothes, sounds, upgrades, weather, skins, etc)<br />
'''Bold text'''</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=CreatePickup&diff=32850CreatePickup2012-08-26T04:44:20Z<p>Ransom: </p>
<hr />
<div>{{Needs_Checking|Explain custom pickup type usage cases and examples}}<br />
<br />
__NOTOC__ <br />
{{Server client function}}<br />
This function creates a pickup element, which is placed in the GTA world and can be picked up to retrieve a health, armour or a weapon. <br />
<br />
==Syntax== <br />
<syntaxhighlight lang="lua"><br />
pickup createPickup ( float x, float y, float z, int theType, int amount/weapon/model, [ int respawnTime = 30000, int ammo = 50 ] ) <br />
</syntaxhighlight> <br />
<br />
===Required Arguments=== <br />
* '''x''': A floating point number representing the X coordinate on the map.<br />
* '''y''': A floating point number representing the Y coordinate on the map.<br />
* '''z''': A floating point number representing the Z coordinate on the map.<br />
* '''theType''': This is an integer representing the type of pickup, representing the following types:<br />
** '''0''': Health Pickup<br />
** '''1''': Armour Pickup<br />
** '''2''': Weapon Pickup<br />
** '''3''': Custom Pickup<br />
* '''amount''': This is an integer representing the amount of Health points or Armour points a pickup has.<br />
'''OR'''<br />
* '''weapon''': If the type is a Weapon pickup, then it represents the [[Weapon|weapon ID]] of the weapon pickup. When used with the weapon pickup type set, the ammo parameter can be used.<br />
'''OR'''<br />
* '''model''': If the pickup is a custom model, this is the model id to use. Many non-pickup models can be used, though some may cause crashes. The following is a list of models designed to be used as pickups.<br />
** '''370:''' Jetpack<br />
** '''1212:''' Money (Wad of Cash)<br />
** '''1240:''' Health (heart)<br />
** '''1242:''' Armour<br />
** '''1272:''' House (blue)<br />
** '''1273:''' House (green)<br />
** '''1274:''' Money (dollar symbol)<br />
** '''1277:''' Save (floppy disk)<br />
<br />
===Optional Arguments=== <br />
{{OptionalArg}} <br />
* '''respawnTime''': How long before the pickup respawns in milliseconds<br />
* '''ammo''': An integer representing the amount of ammo a pickup contains. This is only valid when the pickup type is a weapon pickup.<br />
<br />
===Returns===<br />
Returns [[pickup]] [[element]] if the pickup was created succesfully, otherwise returns ''false''.<br />
<br />
==Example== <br />
<section name="Server" class="server" show="true"><br />
This example creates a pickup after a player dies so that he drops his weapon.<br />
<syntaxhighlight lang="lua"><br />
function createDeathPickup ( totalammo, killer, killerweapon, bodypart ) --when a player dies<br />
x, y, z = getElementPosition ( source ) --get the position of the person who died and define it as x, y and z<br />
currentweapon = getPlayerWeapon ( source ) --get the current weapon of the dead person<br />
createPickup ( x, y, z, 2, currentweapon, 10000, totalammo )<br />
end<br />
addEventHandler ( "onPlayerWasted", getRootElement(), createDeathPickup ) --add an event handler for onPlayerWasted<br />
</syntaxhighlight><br />
</section><br />
<br />
==See Also==<br />
<br />
{{Pickup functions}}</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=Main_Page&diff=32811Main Page2012-08-25T14:42:00Z<p>Ransom: </p>
<hr />
<div>{| width="100%" cellspacing="0" cellpadding="0"<br />
| colspan="2" |<br />
<div style="/*border: 1px solid #D8D8D8;*/ padding-left: 15px; padding-right: 15px; height: 100%;"><br />
[[File:Mtalogo.png|left|100px|link=http://wiki.multitheftauto.com/]]'''Welcome to the [[Multi Theft Auto]] wiki.''' On this wiki you'll find a wealth of information on using Multi Theft Auto.<br />
<br />
There are many [[How you can help|things you can do to help us]] improve MTA - create a map, a gamemode, help document scripting functions, write example code, write tutorials or just play MTA and report the bugs you find.<br />
<br />
If you have any questions or problems related to scripting, feel free to get in touch with us on our [[IRC Channel]].<br />
<br/><br/>[ Stop playing with yourself ]<br />
</div><br />
|}<br />
{| width="100%" cellspacing="0" cellpadding="0"<br />
| colspan="2" |<br />
|-<br />
|width="50%" style="vertical-align:top;" |<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px; background: #FFFCF2;"><br />
<div style="float:right; width: 32px;">[[File:Input-gaming.png|link=]]</div><br />
<h3>Play</h3><br />
<div style="background: #FFEEAA; border: 1px solid #FFCD19;"><br />
[[File:Go-down.png|link=http://mtasa.com/]] ''' [http://mtasa.com/ Download Multi Theft Auto: San Andreas {{Current Version|full}}]'''</div><br />
* [[Client Manual]]<br />
* [[Changes_in_{{padleft:|3|{{Current Version|full}}}}| Changes in {{padleft:|3|{{Current Version|full}}}}]]<br />
* [[Known_Issues_-_FAQ|Known Issues]]<br />
* [[Upgrading_from_MTA:Race|Migrating from MTA:Race to MTA:SA {{padleft:|3|{{Current Version|full}}}}]]<br />
* [[Server Manual]]<br />
* [[Map manager|Map Manager]]<br />
<br />
<h3>Map Editor</h3><br />
*[[Resource:Editor|Manual]]<br />
*[[Resource:Editor/EDF|Editor Definition Format]]<br />
*[[Resource:Editor/Plugins|Plugins]]<br />
*[[Resource:Editor#FAQ|Frequently Asked Questions]]<br />
</div><br />
<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px;"><br />
<div style="float:right; width: 32px;">[[File:Package-x-generic.png|link=]]</div><br />
<h3>Databases</h3><br />
This section outlines all the Lua capabilites MTA or resources provide.<br />
* [[:Category:Resource|Resource Catalogue]] - You must learn these to make proper scripts<br />
* [[Client side scripts]]<br />
* [[Modules]]<br />
</div><br />
<br />
<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px;"><br />
<div style="float:right; width: 32px;">[[File:Applications-development.png|link=]]</div><br />
<h3>Developing Multi Theft Auto</h3><br />
[[File:Go-down.png|link=http://nightly.mtasa.com/]] [http://nightly.mtasa.com/ Nightly builds]<br />
* [[Compiling_MTASA|Compiling MTASA on Windows]]<br />
* [[Building_MTASA_Server_on_Mac_OS_X|Compiling MTASA on Mac OS X]]<br />
* [[Building_MTASA_Server_on_GNU_Linux|Compiling MTASA on GNU/Linux]]<br />
* [[Coding guidelines]]<br />
* [http://code.google.com/p/mtasa-blue Google Code SVN]<br />
* [[Roadmap]]<br />
* [http://bugs.mtasa.com/ Bugtracker]<br />
* [[Branches]]<br />
</div><br />
<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px;"><br />
<div style="float:right; width: 32px;">[[File:Applications-office.png|link=]]</div><br />
<h3>Wiki - How can you help</h3><br />
* Finish documentation for [[:Category:Incomplete|Incomplete functions]].<br />
* [[:Category:Needs_Example |Add examples to functions and events]].<br />
* Review and verify [[:Category:Needs Checking|pages that need checking]].<br />
* Write tutorials to help new people.<br />
* Translate wiki pages.<br />
</div><br />
<br />
<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px;"><br />
<div style="float:right; width: 32px;">[[File:Internet-group-chat.png|link=]]</div><br />
<h3>Community</h3><br />
* [http://forum.multitheftauto.com/ Forum]<br />
* IRC: [irc://irc.multitheftauto.com/mta irc.multitheftauto.com #mta]<br />
* [http://community.mtasa.com/ MTA Community] - Share and download resources.<br />
* [http://twitter.com/#!/MTAQA/ Twitter] - [http://www.youtube.com/user/MTAQA Youtube] - [http://plus.google.com/102014133442331779727/ Google+] - [http://www.moddb.com/mods/multi-theft-auto-san-andreas ModDB]<br />
</div><br />
<br />
| width="50%" style="vertical-align:top;" |<br />
<br />
<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px;"><br />
<div style="float:right; width: 32px;">[[File:Accessories-text-editor.png|link=]]</div><br />
<h3>Scripting</h3><br />
* [[Scripting Introduction|Introduction to Scripting]]<br />
* [[Introduction to Scripting the GUI]]<br />
* [[Debugging|Debugging Tutorial]] - How to find errors in your scripts<br />
* [[Resources|Introduction to Resources]]<br />
** [[Resource Web Access]] - How you can write websites with resources<br />
** [[:Category:Resource|Resource Catalogue]]<br />
** [[Meta.xml]] - Behind every resource is a meta file that defines it<br />
** [[ACL]] - Access Control List, this is vital for complex scripts to work<br />
* [[Writing_Gamemodes|Writing Gamemodes]]<br />
* [[Useful_Functions|Useful functions]]<br />
* [http://forum.mtasa.com/viewtopic.php?f=13&t=29363 Offline Wiki Copies]<br />
<div style="float:right; width: 32px;">[[File:start-here.png|link=]]</div><br />
<h3>General Lua Help</h3><br />
Pages designed to aid your understanding of Lua<br />
*[http://www.lua.org/pil/index.html "Programming in Lua" Manual]<br />
**[http://www.lua.org/manual/5.1/#index Internal Lua functions reference]<br />
*[http://lua-users.org/wiki/TutorialDirectory Lua Wiki]<br />
*[http://nixstaller.berlios.de/manual/0.2/nixstaller_9.html A general guide to Lua from Nixstaller]<br />
</div><br />
<br />
<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px; background:#F2F2FF;"><br />
<div style="float:right; width: 32px;">[[File:Preferences-system.png|link=]]</div><br />
<h3>Reference</h3><br />
* [[Client Scripting Functions|Client-side Functions]]<br />
* [[Client Scripting Events|Client-side Events]]<br />
* [[Server Scripting Functions|Server-side Functions]]<br />
* [[Server Scripting Events|Server-side Events]]<br />
<!-- Incomplete * [[Module functions|Server-side external module scripting functions list]] --><br />
* [[MTA Classes]] - Detailed descriptions of all MTA custom types<br />
** [[Element|MTA Elements]] / [[Element tree]]<br />
</div><br />
<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px;"><br />
<div style="float:right; width: 32px;">[[File:System-file-manager.png|link=]]</div><br />
<h3>[[Id|ID Lists]]</h3><br />
*[[Animations|Animations]]<br />
*[[Character Skins]]<br />
*[[CJ_Clothes|Clothing styles]]<br />
*[[Garage|Garage IDs]]<br />
*[[Interior IDs]]<br />
*[[Material IDs]]<br />
*[[Projectiles]]<br />
*[[Radar Blips]]<br />
*[[Sounds]]<br />
*[[Vehicle IDs]]<br />
*[[Vehicle Colors]]<br />
*[[Vehicle Upgrades]]<br />
*[[Vehicle variants|Vehicle Variants]]<br />
*[[Weapons|Weapons]]<br />
*[[Weather]]<br />
</div><br />
<div style="padding:4px 8px 8px 8px; margin:10px;"><br />
[[File:Osi symbol.png|75px|link=http://opensource.org/|left]]<br />
'''Multi Theft Auto''' is '''Open Source'''. <br />
<br/>This means anyone can contribute to making Multi Theft Auto even better!<br />
</div><br />
|-<br />
| colspan="2" |<br />
|}<br />
{| width="100%" cellspacing="0" cellpadding="0"<br />
| colspan="2" |<br />
<div style="padding-left: 15px; padding-right: 15px;" class="plainlinks"><br />
[[File:MTALogo_8ball.png|left|85px|link=Archive]]<br />
<ul style="list-style: none; width: 200px; float: left;"><br />
<li>'''About [[Multi Theft Auto]]'''</li><br />
<li>[[Archive]]</li><br />
<li>[[Press Coverage]]</li><br />
<li>[http://code.google.com/p/mtasa-blue/people/list Developers]</li><br />
</ul><br />
<ul style="list-style: none; width: 200px; float: left;"><br />
<li>'''Multi Theft Auto 0.5'''</li><br />
<li>[[Archive#Multi_Theft_Auto_0.5|Download]]</li><br />
<li>[[MTA 0.5r2 Known Issues|Known Issues]]</li><br />
</ul><br />
<ul style="list-style: none; width: 200px; float: left;"><br />
<li>'''Wiki Stats'''</li><br />
<li>{{NUMBEROFARTICLES}} Articles</li><br />
<li>{{NUMBEROFPAGES}} Pages</li><br />
<li>{{NUMBEROFUSERS}} Registered Users</li><br />
</ul><br />
</div><br />
|}<br />
<br />
__NOTOC__<br />
__NOEDITSECTION__<br />
{{Languages list|en}}</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=GetPedAnimation&diff=32405GetPedAnimation2012-08-20T03:50:53Z<p>Ransom: /* Example 2 */</p>
<hr />
<div>__NOTOC__<br />
{{Client function}}<br />
<br />
Gets the animation of a player or ped that was set using [[setPedAnimation]].<br />
<br />
''Note: Use [[getPedTask]] to monitor what movements the player is currently doing.''<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
string string getPedAnimation ( ped thePed )<br />
</syntaxhighlight><br />
<br />
===Required Arguments===<br />
*'''thePed:''' the player or ped you want to get the animation of.<br />
<br />
===Returns===<br />
Returns two ''strings'': the first is the name of the block, the second is the name of the animation. Returns ''false'' if there was an error or if the ped is not doing an animation.<br />
<br />
==Example==<br />
This example adds a command that allows you to copy the animation being used by another player using /copyanim theirName<br />
<syntaxhighlight lang="lua"><br />
function CopyAnimation(theCommand, thePlayer) -- The Command Function<br />
if thePlayer then -- If a player name entered then<br />
thePlayerToCopyFrom = getPlayerFromName(thePlayer) -- get player from his name<br />
Block, Anim = getPedAnimation(thePlayerToCopyFrom) -- get the player animation<br />
if Block then -- if got the animation successfully then<br />
setPedAnimation(localPlayer, Block, Anim) -- set my animation the same<br />
outputChatBox("* Copied Successfully !") -- output chat message<br />
end<br />
else <br />
outputChatBox("* Please Enter a Player Name To Copy From !") -- if you didnt entered a player name , then output a chat box message<br />
end<br />
end<br />
addCommandHandler("copyanim", CopyAnimation) -- adding the Command Handler<br />
</syntaxhighlight><br />
<br />
==Example 2==<br />
<br />
This example shows what block and animation your player is currently performing. Note this will return "N/A" if you did not set an animation with [[setPedAnimation]]. If you want to see what the player ped is doing as you control them that is [[getPedTask]].<br />
<syntaxhighlight lang="lua"><br />
addEventHandler("onClientPreRender",root,<br />
function ()<br />
local block, animation = getPedAnimation(localPlayer)<br />
dxDrawText ( "CURRENT ANIMATION INFO...", 100, 300 )<br />
if not block then block = "N/A" end<br />
if not animation then animation = "N/A" end<br />
dxDrawText ( "Block = "..block.." Animation = "..animation, 100, 315 )<br />
end )<br />
</syntaxhighlight><br />
<br />
==See Also==<br />
{{Ped_functions}}</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=GetPedAnimation&diff=32404GetPedAnimation2012-08-20T03:50:10Z<p>Ransom: /* Example 2 */</p>
<hr />
<div>__NOTOC__<br />
{{Client function}}<br />
<br />
Gets the animation of a player or ped that was set using [[setPedAnimation]].<br />
<br />
''Note: Use [[getPedTask]] to monitor what movements the player is currently doing.''<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
string string getPedAnimation ( ped thePed )<br />
</syntaxhighlight><br />
<br />
===Required Arguments===<br />
*'''thePed:''' the player or ped you want to get the animation of.<br />
<br />
===Returns===<br />
Returns two ''strings'': the first is the name of the block, the second is the name of the animation. Returns ''false'' if there was an error or if the ped is not doing an animation.<br />
<br />
==Example==<br />
This example adds a command that allows you to copy the animation being used by another player using /copyanim theirName<br />
<syntaxhighlight lang="lua"><br />
function CopyAnimation(theCommand, thePlayer) -- The Command Function<br />
if thePlayer then -- If a player name entered then<br />
thePlayerToCopyFrom = getPlayerFromName(thePlayer) -- get player from his name<br />
Block, Anim = getPedAnimation(thePlayerToCopyFrom) -- get the player animation<br />
if Block then -- if got the animation successfully then<br />
setPedAnimation(localPlayer, Block, Anim) -- set my animation the same<br />
outputChatBox("* Copied Successfully !") -- output chat message<br />
end<br />
else <br />
outputChatBox("* Please Enter a Player Name To Copy From !") -- if you didnt entered a player name , then output a chat box message<br />
end<br />
end<br />
addCommandHandler("copyanim", CopyAnimation) -- adding the Command Handler<br />
</syntaxhighlight><br />
<br />
==Example 2==<br />
<br />
This example shows what block and animation your player is currently performing. Note this will return "N/A" if you did not set an animation with [[setPedAnimation]]. If you want to see what your player is doing that is [[getPedTask]]<br />
<syntaxhighlight lang="lua"><br />
addEventHandler("onClientPreRender",root,<br />
function ()<br />
local block, animation = getPedAnimation(localPlayer)<br />
dxDrawText ( "CURRENT ANIMATION INFO...", 100, 300 )<br />
if not block then block = "N/A" end<br />
if not animation then animation = "N/A" end<br />
dxDrawText ( "Block = "..block.." Animation = "..animation, 100, 315 )<br />
end )<br />
</syntaxhighlight><br />
<br />
==See Also==<br />
{{Ped_functions}}</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=GetPedAnimation&diff=32403GetPedAnimation2012-08-20T03:49:13Z<p>Ransom: /* Example */ added one</p>
<hr />
<div>__NOTOC__<br />
{{Client function}}<br />
<br />
Gets the animation of a player or ped that was set using [[setPedAnimation]].<br />
<br />
''Note: Use [[getPedTask]] to monitor what movements the player is currently doing.''<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
string string getPedAnimation ( ped thePed )<br />
</syntaxhighlight><br />
<br />
===Required Arguments===<br />
*'''thePed:''' the player or ped you want to get the animation of.<br />
<br />
===Returns===<br />
Returns two ''strings'': the first is the name of the block, the second is the name of the animation. Returns ''false'' if there was an error or if the ped is not doing an animation.<br />
<br />
==Example==<br />
This example adds a command that allows you to copy the animation being used by another player using /copyanim theirName<br />
<syntaxhighlight lang="lua"><br />
function CopyAnimation(theCommand, thePlayer) -- The Command Function<br />
if thePlayer then -- If a player name entered then<br />
thePlayerToCopyFrom = getPlayerFromName(thePlayer) -- get player from his name<br />
Block, Anim = getPedAnimation(thePlayerToCopyFrom) -- get the player animation<br />
if Block then -- if got the animation successfully then<br />
setPedAnimation(localPlayer, Block, Anim) -- set my animation the same<br />
outputChatBox("* Copied Successfully !") -- output chat message<br />
end<br />
else <br />
outputChatBox("* Please Enter a Player Name To Copy From !") -- if you didnt entered a player name , then output a chat box message<br />
end<br />
end<br />
addCommandHandler("copyanim", CopyAnimation) -- adding the Command Handler<br />
</syntaxhighlight><br />
<br />
==Example 2==<br />
<br />
This example shows what block and animation your player is currently performing. Note this will return "N/A" if you did not set an animation. If you want to see what your player is doing that is [[getPedTask]]<br />
<syntaxhighlight lang="lua"><br />
addEventHandler("onClientPreRender",root,<br />
function ()<br />
local block, animation = getPedAnimation(localPlayer)<br />
dxDrawText ( "CURRENT ANIMATION INFO...", 100, 300 )<br />
if not block then block = "N/A" end<br />
if not animation then animation = "N/A" end<br />
dxDrawText ( "Block = "..block.." Animation = "..animation, 100, 315 )<br />
end )<br />
</syntaxhighlight><br />
<br />
==See Also==<br />
{{Ped_functions}}</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=SetTimer&diff=32402SetTimer2012-08-20T02:12:07Z<p>Ransom: /* Example */</p>
<hr />
<div>__NOTOC__<br />
{{Server client function}}<br />
This function allows you to trigger a function after a number of milliseconds have elapsed. You can call one of your own functions or a built-in function. For example, you could set a timer to spawn a player after a number of seconds have elapsed.<br />
<br />
Once a timer has finished repeating, it no longer exists.<br />
<br />
'''The minimum accepted interval is 50ms.'''<br />
<br />
Multi Theft Auto guarantees that the timer will be triggered after ''at least'' the interval you specify. The resolution of the timer is tied to the frame rate (server side and client-side). All the overdue timers are triggered at a single point each frame. This means that if, for example, the player is running at 30 frames per second, then two timers specified to occur after 100ms and 110ms would more than likely occur during the same frame, as the difference in time between the two timers (10ms) is less than half the length of the frame (33ms). As with most timers provided by other languages, you shouldn't rely on the timer triggering at an exact point in the future. <br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
timer setTimer ( function theFunction, int timeInterval, int timesToExecute, [ var arguments... ] )<br />
</syntaxhighlight> <br />
<br />
===Required Arguments=== <br />
*'''theFunction:''' The function you wish the timer to call. (Notice: Do not use a 'local' function, it must be global!)<br />
*'''timeInterval:''' The number of milliseconds that should elapse before the function is called. (the minimum is 50)(1000 milliseconds = 1 second)<br />
*'''timesToExecute:''' The number of times you want the timer to execute, or 0 for infinite repetitions.<br />
<br />
===Optional Arguments=== <br />
{{OptionalArg}} <br />
*'''arguments:''' Any arguments you wish to pass to the function can be listed after the ''timesToExecute'' argument. Note that any tables you want to pass will get cloned, whereas metatables will get lost. Also changes you make in the original table before the function gets called won't get transferred.<br />
<br />
===Returns===<br />
Returns a [[timer]] pointer if the timer was set successfully, ''false'' if the arguments are invalid or the timer could not be set.<br />
<br />
==Example==<br />
<section name="Example" class="both" show="true"><br />
This example will output some text after a small delay.<br />
<br />
<syntaxhighlight lang="lua"><br />
-- define function to be called<br />
function delayedChat ( text )<br />
outputChatBox ( "Delayed text: " .. text )<br />
end<br />
<br />
-- set a timer so the function is called after 1 second<br />
setTimer ( delayedChat, 1000, 1, "Hello, World!" )<br />
</syntaxhighlight><br />
<br />
1 second after the line above has been executed, the text ''Delayed text: Hello, World!'' will be displayed in the chat box.<br />
</section><br />
<br />
<section name="Example" class="both" show="true"><br />
This example will nest a whole function within a timer. This is nice for things like setting variables without having to call a function outside of your code block.<br />
<br />
<syntaxhighlight lang="lua"><br />
function mainFunction()<br />
outputChatBox ("Instant text!")<br />
setTimer ( function()<br />
outputChatBox ( "5 second delay text!" )<br />
end, 5000, 1 )<br />
end<br />
<br />
mainFunction() --call function<br />
</syntaxhighlight><br />
</section><br />
<br />
==See Also==<br />
{{Utility functions}}</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=SetTimer&diff=32401SetTimer2012-08-20T02:11:26Z<p>Ransom: /* Example */</p>
<hr />
<div>__NOTOC__<br />
{{Server client function}}<br />
This function allows you to trigger a function after a number of milliseconds have elapsed. You can call one of your own functions or a built-in function. For example, you could set a timer to spawn a player after a number of seconds have elapsed.<br />
<br />
Once a timer has finished repeating, it no longer exists.<br />
<br />
'''The minimum accepted interval is 50ms.'''<br />
<br />
Multi Theft Auto guarantees that the timer will be triggered after ''at least'' the interval you specify. The resolution of the timer is tied to the frame rate (server side and client-side). All the overdue timers are triggered at a single point each frame. This means that if, for example, the player is running at 30 frames per second, then two timers specified to occur after 100ms and 110ms would more than likely occur during the same frame, as the difference in time between the two timers (10ms) is less than half the length of the frame (33ms). As with most timers provided by other languages, you shouldn't rely on the timer triggering at an exact point in the future. <br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
timer setTimer ( function theFunction, int timeInterval, int timesToExecute, [ var arguments... ] )<br />
</syntaxhighlight> <br />
<br />
===Required Arguments=== <br />
*'''theFunction:''' The function you wish the timer to call. (Notice: Do not use a 'local' function, it must be global!)<br />
*'''timeInterval:''' The number of milliseconds that should elapse before the function is called. (the minimum is 50)(1000 milliseconds = 1 second)<br />
*'''timesToExecute:''' The number of times you want the timer to execute, or 0 for infinite repetitions.<br />
<br />
===Optional Arguments=== <br />
{{OptionalArg}} <br />
*'''arguments:''' Any arguments you wish to pass to the function can be listed after the ''timesToExecute'' argument. Note that any tables you want to pass will get cloned, whereas metatables will get lost. Also changes you make in the original table before the function gets called won't get transferred.<br />
<br />
===Returns===<br />
Returns a [[timer]] pointer if the timer was set successfully, ''false'' if the arguments are invalid or the timer could not be set.<br />
<br />
==Example==<br />
<section name="Example" class="both" show="true"><br />
This example will output some text after a small delay.<br />
<br />
<syntaxhighlight lang="lua"><br />
-- define function to be called<br />
function delayedChat ( text )<br />
outputChatBox ( "Delayed text: " .. text )<br />
end<br />
<br />
-- set a timer so the function is called after 1 second<br />
setTimer ( delayedChat, 1000, 1, "Hello, World!" )<br />
</syntaxhighlight><br />
<br />
1 second after the line above has been executed, the text ''Delayed text: Hello, World!'' will be displayed in the chat box.<br />
</section><br />
<br />
<section name="Example" class="both" show="true"><br />
This example will nest a whole function within a timer. This is nice for things like setting variables without having to call a function outside of your code block.<br />
<br />
<syntaxhighlight lang="lua"><br />
function mainFunction()<br />
outputChatBox ("Instant text!")<br />
setTimer ( function()<br />
outputChatBox ( "5 second delayed text!" )<br />
end, 5000, 1 )<br />
end<br />
<br />
mainFunction() --call function<br />
</syntaxhighlight><br />
</section><br />
<br />
==See Also==<br />
{{Utility functions}}</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=SetTimer&diff=32400SetTimer2012-08-20T02:10:28Z<p>Ransom: /* Example */ added nested function example</p>
<hr />
<div>__NOTOC__<br />
{{Server client function}}<br />
This function allows you to trigger a function after a number of milliseconds have elapsed. You can call one of your own functions or a built-in function. For example, you could set a timer to spawn a player after a number of seconds have elapsed.<br />
<br />
Once a timer has finished repeating, it no longer exists.<br />
<br />
'''The minimum accepted interval is 50ms.'''<br />
<br />
Multi Theft Auto guarantees that the timer will be triggered after ''at least'' the interval you specify. The resolution of the timer is tied to the frame rate (server side and client-side). All the overdue timers are triggered at a single point each frame. This means that if, for example, the player is running at 30 frames per second, then two timers specified to occur after 100ms and 110ms would more than likely occur during the same frame, as the difference in time between the two timers (10ms) is less than half the length of the frame (33ms). As with most timers provided by other languages, you shouldn't rely on the timer triggering at an exact point in the future. <br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua"><br />
timer setTimer ( function theFunction, int timeInterval, int timesToExecute, [ var arguments... ] )<br />
</syntaxhighlight> <br />
<br />
===Required Arguments=== <br />
*'''theFunction:''' The function you wish the timer to call. (Notice: Do not use a 'local' function, it must be global!)<br />
*'''timeInterval:''' The number of milliseconds that should elapse before the function is called. (the minimum is 50)(1000 milliseconds = 1 second)<br />
*'''timesToExecute:''' The number of times you want the timer to execute, or 0 for infinite repetitions.<br />
<br />
===Optional Arguments=== <br />
{{OptionalArg}} <br />
*'''arguments:''' Any arguments you wish to pass to the function can be listed after the ''timesToExecute'' argument. Note that any tables you want to pass will get cloned, whereas metatables will get lost. Also changes you make in the original table before the function gets called won't get transferred.<br />
<br />
===Returns===<br />
Returns a [[timer]] pointer if the timer was set successfully, ''false'' if the arguments are invalid or the timer could not be set.<br />
<br />
==Example==<br />
<section name="Example" class="both" show="true"><br />
This example will output some text after a small delay.<br />
<br />
<syntaxhighlight lang="lua"><br />
-- define function to be called<br />
function delayedChat ( text )<br />
outputChatBox ( "Delayed text: " .. text )<br />
end<br />
<br />
-- set a timer so the function is called after 1 second<br />
setTimer ( delayedChat, 1000, 1, "Hello, World!" )<br />
</syntaxhighlight><br />
<br />
1 second after the line above has been executed, the text ''Delayed text: Hello, World!'' will be displayed in the chat box.<br />
</section><br />
<br />
<section name="Example" class="both" show="true"><br />
This example will nest a whole function within a timer. This is nice for things like setting variables without having to call a function outside of your code block.<br />
<br />
<syntaxhighlight lang="lua"><br />
Function mainFunction()<br />
outputChatBox ("Instant text!")<br />
setTimer ( function()<br />
outputChatBox ( "5 second delayed text!" )<br />
end, 5000, 1 )<br />
end<br />
</syntaxhighlight><br />
</section><br />
<br />
==See Also==<br />
{{Utility functions}}</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=Help:Adding_Pages_to_Categories_and_Templates&diff=32227Help:Adding Pages to Categories and Templates2012-08-09T18:10:22Z<p>Ransom: </p>
<hr />
<div>==Introduction==<br />
Did you create a new page, such as a function, and it isn't showing up in a list? Did you try and edit it in only to see <nowiki>{{weird_tags_like_this}}</nowiki> instead of text relating to the page you viewed? Welcome to the world of templates. We have noticed in [[Special:RecentChanges|RecentChanges]] that people are making pages and not linking to them properly. '''These pages are being lost in the bowels of the Wiki!'''<br />
<br />
We also use categories in this wiki, but they are not as crucial as templates. Please read on to learn about both and to understand how to contribute to our wiki properly.<br />
<br />
=Template=<br />
===What is a Template===<br />
It is like a big copy paste on a clipboard. You write a template tag on another page and it writes everything that was on the template page.<br />
<br />
*'''Why Use Templates?'''<br />
It allows the same information to be represented in multiple places, without duplicating texts and updating them manually numerous times.<br />
<br />
*'''Example?''' <br />
Look at the page source (edit button) on our functions or event pages. You can see that the functions aren't actually listed there, each function group has its own template. The main use for this is to fill out the "See Also" section of individual functions with their related functions.<br />
<br />
===How Do You Make/Edit/Use a Template?===<br />
<br />
The best way to teach is by example. I will need a template to direct people to this guide from multiple pages in the wiki. Let's just create this template together! FUN!<br />
<br />
====1. Choosing a Template Name====<br />
The best template name explains what it is. Typically the best thing is to make the template URL identical to the actual page. Therefore I am going to use:<br />
<br />
<pre>http://wiki.multitheftauto.com/index.php?title=Template:Adding_Pages_to_Categories_and_Templates</pre><br />
<br />
'''IMPORTANT:''' Remember that all wiki pages are case sensitive. The same page can exist in uppercase and lowercase! Capitalize appropriately.<br />
<br />
If I tried to link to a template that doesn't exist this happens:<br />
{{link_to_nonexistant_template_click_here_to_create_lazypants}}<br />
<br />
So as you can see, it is better we create the template before attempting to link to it!<br />
<br />
====2. Filling out the Template====<br />
<br />
At the template page, hit create page, and you'll see the edit field box. Type in whatever you need to be said in other pages and save the page. It could be simple text, links to a set of functions, or even as advanced as a bit of code that determines something, such as our future functions template. If you were trying to add to our functions/events then you would just edit a link to your function into the template. Don't screw it up or I will be disappointed in you!<br />
<br />
From this point, you use the template page name as a tag inside the pages where you want to use it. My template tag is:<br />
<br />
<pre>{{Adding_Pages_to_Categories_and_Templates}}</pre><br />
<br />
====3. Demonstration====<br />
So here I will actually link to the template. If you check the template page source, you will see exactly what is printed below:<br />
<br />
{{Adding_Pages_to_Categories_and_Templates}}<br />
<br />
'''Note:''' The easiest way to reach a template that was used on a page is to edit the page and scroll to the bottom. A list of all templates used will appear with links to the template pages.<br />
<br />
=Category=<br />
===What is a Category===<br />
Categories group pages together. The categories have their own special page where all the grouped pages are alphabetized. Think of them like sorting the Wiki into folders for common pages. For example here is a link to the server functions category page: [[:Category:Server_functions]]<br />
<br />
===How do I Make/Edit/Use Categories===<br />
A page is put into a category by editing the following syntax into a page:<br />
<pre>[[:Category:pagename]]</pre><br />
<br />
You do need to create the category page just as you would a template. Again, you simply go to the URL of the category page you want to make. The format is:<br />
<pre>http://wiki.multitheftauto.com/index.php?title=Category:Page_Name_Here</pre><br />
<br />
For the category page itself, you simply write a small explanation what the category (folder) is about.<br />
<br />
If you look at the source of the pages listed in [[:Category:Server_functions]], you may notice that the category tag is not in them! It actually is there, but it is being applied through the clever combination of a template with the category embedded.<br />
<br />
Those nice colored stripes you see at the tops of pages are all templates that have a category tag embedded. This was designed to make it hard for people to mess-up categories. For example, look at the page source for the blue stripe that says "Client and Server Function" http://wiki.multitheftauto.com/index.php?title=Template:Server_client_function&action=edit<br />
<br />
===Demonstration===<br />
I have put a category tag in this page. This is reflected at the very bottom of the page you are reading right now. The category page just happens to be the exact same name. Unlike templates, it is not typical to name the category after a page. They are more like folder names. This is just for demonstration however.<br />
<br />
The category page is here: [[:Category:Adding_Pages_to_Categories_and_Templates]]<br />
<br />
[[Category:Adding_Pages_to_Categories_and_Templates]]<br />
<br />
=More Info=<br />
===Lists of Templates and Categories===<br />
Looking for template and category listings? This is one thing [[Special:SpecialPages|SpecialPages]] is for.<br />
<br />
'''Templates:'''<br />
*[[Special:UncategorizedTemplates]]<br />
:Templates not organized into templates (ie think of categories as folders).<br />
*[[Special:UnusedTemplates]]<br />
:Unused templates<br />
*[[Special:WantedTemplates]]<br />
:Tags are linked to this template, but the page itself doesn't exist. It still works de facto. You need to hit create on the template page.<br />
*[[Special:MostLinkedTemplates]]<br />
:Templates that were tagged in the most pages<br />
<br />
'''Categories:'''<br />
*[[Special:Categories]]<br />
:All categories overview.<br />
*[[Special:UncategorizedCategories]]<br />
:Categories not within another category (ie not used as subfolders of folders).<br />
*[[Special:UnusedCategories]]<br />
:Unused categories<br />
*[[Special:WantedCategories]]<br />
:Tags are linked to this category, but the page itself doesn't exist. It still works de facto. You need to hit create on the category page.<br />
*[[Special:MostLinkedCategories]]<br />
:Categories that were tagegd in the most places<br />
<br />
===Further Reference===<br />
http://en.wikipedia.org/wiki/Help:Template<br><br />
http://en.wikipedia.org/wiki/Help:Category<br />
<br />
===Questions?===<br />
Best way to discuss wiki is live on IRC. See the community box on the [[Main Page]] for more info.</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=Useful_Functions&diff=32226Useful Functions2012-08-09T18:08:41Z<p>Ransom: </p>
<hr />
<div><pageclass class="#228B22"></pageclass><br />
{{Adding_Pages_to_Categories_and_Templates}}<br />
{{Needs_Checking|Someone please write isElementInPhotograph, it will be used instead of making a hard-coded function. --[[User:Ransom|Ransom]] 18:08, 9 August 2012 (UTC)}}<br />
<br />
This page lists functions that are not included in the server or the client, but are still useful.<br />
<br/><br />
{{Useful_Functions}}<br />
<br/><br/><br />
[[ES:Funciones Útiles]]<br />
[[ru:Useful Functions]]</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=Template:Adding_Pages_to_Categories_and_Templates&diff=32223Template:Adding Pages to Categories and Templates2012-08-08T01:42:23Z<p>Ransom: </p>
<hr />
<div><noinclude>This is a template to teach people about templates and categories. This text is in a tag that prevents it from being used as part of the template. This allows me to write an explanation here.</noinclude><div style="background: #CEDFF2; border: 3px solid #CEDFF2;"><br />
'''Contributors:''' Did you create a page, but its not on this list? Confused? '''Read: [[Adding Pages to Categories and Templates]]'''</div></div>Ransomhttps://wiki.multitheftauto.com/index.php?title=Template:Adding_Pages_to_Categories_and_Templates&diff=32222Template:Adding Pages to Categories and Templates2012-08-08T01:41:57Z<p>Ransom: </p>
<hr />
<div><noinclude>This is a template to teach people about templates and categories. This text is in a tag that prevents it from being used as part of the template. This allows me to write an explanation here.</noinclude><br />
<div style="background: #CEDFF2; border: 3px solid #CEDFF2;"><br />
'''Contributors:''' Did you create a page, but its not on this list? Confused? '''Read: [[Adding Pages to Categories and Templates]]'''</div></div>Ransomhttps://wiki.multitheftauto.com/index.php?title=Template:Adding_Pages_to_Categories_and_Templates&diff=32221Template:Adding Pages to Categories and Templates2012-08-08T01:41:00Z<p>Ransom: test</p>
<hr />
<div><noinclude>A template to teach people about templates and categories. This text is in a tag that prevents it from being used as part of the template. This allows me to write an explanation here.</noinclude><br />
<br />
<div style="background: #CEDFF2; border: 3px solid #CEDFF2;"><br />
'''Contributors:''' Did you create a page, but its not on this list? Confused? '''Read: [[Adding Pages to Categories and Templates]]'''</div></div>Ransomhttps://wiki.multitheftauto.com/index.php?title=Template:Adding_Pages_to_Categories_and_Templates&diff=32220Template:Adding Pages to Categories and Templates2012-08-08T01:38:26Z<p>Ransom: </p>
<hr />
<div><noinclude>A template to teach people about templates and categories. This text is in a <nowiki><noinclude></noinclude></nowiki> tag that prevents it from being used as part of the template. This allows me to write an explanation here.</noinclude><br />
<br />
<div style="background: #CEDFF2; border: 3px solid #CEDFF2;"><br />
'''Contributors:''' Did you create a page, but its not on this list? Confused? '''Read: [[Adding Pages to Categories and Templates]]'''</div></div>Ransomhttps://wiki.multitheftauto.com/index.php?title=Template:Adding_Pages_to_Categories_and_Templates&diff=32219Template:Adding Pages to Categories and Templates2012-08-08T01:32:27Z<p>Ransom: </p>
<hr />
<div><div style="background: #CEDFF2; border: 3px solid #CEDFF2;"><br />
'''Contributors:''' Did you create a page, but its not on this list? Confused? '''Read: [[Adding Pages to Categories and Templates]]'''</div></div>Ransomhttps://wiki.multitheftauto.com/index.php?title=Template:Color_box&diff=32218Template:Color box2012-08-08T01:23:39Z<p>Ransom: Template that should help color stuff see http://en.wikipedia.org/wiki/Template:Colorbox</p>
<hr />
<div><span style="background-color:{{{1|white}}}; border:1px solid darkgray;">&nbsp;&nbsp;{{#if:{{{2|}}}|{{#if:{{{3|}}}|[[{{{3}}}|{{{2}}}]]|{{{2}}}}}|&nbsp;}}&nbsp;</span><noinclude>{{documentation}}<br />
[[category:color templates]]<br />
</noinclude></div>Ransomhttps://wiki.multitheftauto.com/index.php?title=Template:Useful_Functions&diff=32210Template:Useful Functions2012-08-07T19:23:32Z<p>Ransom: Added missing explanations</p>
<hr />
<div>*[[callClientFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any clientside function from the server's side.</span><br />
*[[callServerFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any server-side function from the client's side.</span><br />
*[[centerWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function center the window in any resolution.</span><br />
*[[Check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if it's arguments are of the right types and calls the error-function if one isn't.</span><br />
*[[coroutine.resume]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Fix for hidden coroutine error messages</span><br />
*[[dxDrawColorText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a dx text with #RRGGBB color codes support.</span><br />
*[[dxDrawGifImage]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function simulates the effect of a GIF image by using image sprites.</span><br />
*[[dxDrawImage3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D image.</span><br />
*[[dxDrawRectangle3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D rectangle.</span><br />
*[[dxGetFontSizeFromHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculate a font size from given height for dxDraw.</span><br />
*[[findRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Takes two points and returns the direction from point A to point B.</span><br />
*[[FormatDate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Formats a date on the basis of a format string and returns it.</span><br />
*[[GenerateString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» With this function you can generate a random string with any characters.</span><br />
*[[getAge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the age of a birthday.</span><br />
*[[getAlivePlayers (Client)]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns all the alive players by a client side, so you can store them into a Gridlist or something like that, faster.</span><br />
*[[getAlivePlayersInTeam]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the alive players in a team.</span><br />
*[[getCursorMoveOn]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks in which way the cursor is currently moving.</span><br />
*[[getDistanceBetweenPointAndSegment2D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Takes point coordinates and line (a segment) starting and ending coordinates. It returns the shortest distance between the point and the line.</span><br />
*[[getElementSpeed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to get element speed in kph or mph units.</span><br />
*[[getOffsetFromXYZ]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to take an entity and a position and calculate the relative offset between them accounting for rotations.</span><br />
*[[getOnlineAdmins]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function will give the online admins.</span><br />
*[[getOnlineStaff]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Returns all online staff, names separated by two spaces.</span><br />
*[[getPlayerFromNamePart]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to get player From his Name part.</span><br />
*[[getPlayersInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets all the players in a photograph.</span><br />
*[[getPointFromDistanceRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Finds a point based on a starting point, direction and distance.</span><br />
*[[getResourceSettings]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource settings.</span><br />
*[[getTimestamp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» With this function you can get the UNIX timestamp.</span><br />
*[[getXMLNodes]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Returns all children of a node</span><br />
*[[IfElse]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Returns one of two values based on a boolean expression.</span><br />
*[[isElementInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element was in the player's camera picture. This needs writing still. --Ransom 21:45, 2 May 2012 (UTC)</span><br />
*[[isElementInRange]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check is the element's range to the main point is smaller than (or as big as) the maximum range.</span><br />
*[[isLeapYear]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Checks if the given year is a leap year.</span><br />
*[[isVehicleOnRoof]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether vehicle is on roof.</span><br />
*[[iterElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Returns an iterator for your for loops saving time typing ipairs( getElementsByType( type ) ), instead you type: iterElements( type ).</span><br />
*[[math.round]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Rounds a number whereas the number of decimals to keep and the method may be set.</span><br />
*[[multi_check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks one element to many, handy and clean.</span><br />
*[[onVehicleWeaponFire]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This code implements an event that is triggered when a player in a vehicle fires a vehicles weapon.</span><br />
*[[RGBToHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string representing the color in hexadecimal.</span><br />
*[[setElementSpeed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to set moving element speed in kph or mph units.</span><br />
*[[setTableProtected]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Protects a table and makes it read-only.</span><br />
*[[setVehicleGravityPoint]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This clientside function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.</span><br />
*[[string.count]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function counts a text from a text.</span><br />
*[[string.explode]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function splits a string at a given separator pattern and returns a table with the pieces.</span><br />
*[[switch]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allow the value of a variable or expression to control the flow of program execution via a multiway branch.</span><br />
*[[table.copy]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function copies a whole table and all the tables in that table.</span><br />
*[[table.empty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function check is empty table or not.</span><br />
*[[table.map]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function goes through a table and replaces every field with the return of the passed function, where the field's value is passed as first argument and optionally more arguments.</span><br />
*[[table.random]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function retrieves a random variable from a table.</span><br />
*[[table.size]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Finds the absolute size of a table.</span><br />
*[[toHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a decimal number to a hexadecimal number, as a fix to be used clientside.</span><br />
*[[var dump]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function outputs information about one or more variables using outputConsole()</span><br />
[[Category:Useful Functions]]</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=Switch&diff=32209Switch2012-08-07T19:21:36Z<p>Ransom: Deleted weird explanation line...</p>
<hr />
<div>{{Useful Function}}<br />
__NOTOC__<br />
This function allow the value of a variable or expression to control the flow of program execution via a multiway branch.<br />
<br />
==Syntax==<br />
<syntaxhighlight lang="lua">var switch( arg )</syntaxhighlight><br />
<br />
===Required Arguments===<br />
* '''arg''': The expression to compare.<br />
<br />
===Returns===<br />
Returns false if failed.<br />
<br />
==Code==<br />
<section name="Server- and/or clientside Script" class="both" show="true"><br />
<syntaxhighlight lang="lua"><br />
function switch(arg)<br />
if(type(arg)~="table")then return switch end<br />
local switching, default, done; --Default is nil<br />
if(tostring(arg[1]):len()<=2)and(tostring(arg[2]):len()<=2)then switching=arg[1] end<br />
table.remove(arg, 1);<br />
for i=1, #arg do<br />
if(tostring(arg[i]):len()<=3)and(arg[i]==switching)then<br />
if(type(arg[i+1])=="function")then<br />
pcall(arg[i+1])<br />
done=true;<br />
break<br />
else<br />
break<br />
end<br />
end<br />
if(arg[i]==nil)and(arg[i]==switching)and(type(arg[i+1])=="function")then pcall(arg[i+1]) end<br />
end<br />
if(not done)then print("No action.") end<br />
end<br />
</syntaxhighlight><br />
</section><br />
<br />
==Example==<br />
<section name="Server" class="server" show="true"><br />
This example compares a variable value and print out the result.<br />
<syntaxhighlight lang="lua"><br />
Player = 0 -- The variable to compare<br />
switch -- Using the function<br />
{ -- Using curly braces as it's a table<br />
Player; -- Put the expression to compare in here and don't forget to end it with a semi-colon<br />
0, function() print("It's 0") end, -- [ compare the value, do the function ] The first argument compares the value and the second execute the command inside the function if that compare is true.<br />
1, function() print("It's 1") end,<br />
}<br />
</syntaxhighlight><br />
</section><br />
<br />
Author: TopAz<br />
<br />
==See Also==<br />
{{Useful_Functions}}</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=Template:Useful_Functions&diff=32208Template:Useful Functions2012-08-07T19:16:30Z<p>Ransom: </p>
<hr />
<div>*[[callClientFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any clientside function from the server's side.</span><br />
*[[callServerFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any server-side function from the client's side.</span><br />
*[[centerWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function center the window in any resolution.</span><br />
*[[Check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if it's arguments are of the right types and calls the error-function if one isn't.</span><br />
*[[coroutine.resume]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Fix for hidden coroutine error messages</span><br />
*[[dxDrawColorText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a dx text with #RRGGBB color codes support.</span><br />
*[[dxDrawGifImage]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function simulates the effect of a GIF image by using image sprites.</span><br />
*[[dxDrawImage3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D image.</span><br />
*[[dxDrawRectangle3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D rectangle.</span><br />
*[[dxGetFontSizeFromHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculate a font size from given height for dxDraw.</span><br />
*[[findRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Takes two points and returns the direction from point A to point B.</span><br />
*[[FormatDate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Formats a date on the basis of a format string and returns it.</span><br />
*[[GenerateString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» '''NEEDS EXPLANATION'''</span><br />
*[[getAge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the age of a birthday.</span><br />
*[[getAlivePlayers (Client)]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» '''NEEDS EXPLANATION'''</span><br />
*[[getAlivePlayersInTeam]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the alive players in a team.</span><br />
*[[getCursorMoveOn]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks in which way the cursor is currently moving.</span><br />
*[[getDistanceBetweenPointAndSegment2D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» '''NEEDS EXPLANATION'''</span><br />
*[[getElementSpeed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to get element speed in kph or mph units.</span><br />
*[[getOffsetFromXYZ]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to take an entity and a position and calculate the relative offset between them accounting for rotations.</span><br />
*[[getOnlineAdmins]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function will give the online admins.</span><br />
*[[getOnlineStaff]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» '''NEEDS EXPLANATION'''</span><br />
*[[getPlayerFromNamePart]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to get player From his Name part.</span><br />
*[[getPlayersInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets all the players in a photograph.</span><br />
*[[getPointFromDistanceRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Finds a point based on a starting point, direction and distance.</span><br />
*[[getResourceSettings]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource settings.</span><br />
*[[getTimestamp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» With this function you can get the UNIX timestamp.</span><br />
*[[getXMLNodes]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» '''NEEDS EXPLANATION'''</span><br />
*[[IfElse]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Returns one of two values based on a boolean expression.</span><br />
*[[isElementInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element was in the player's camera picture. This needs writing still. --Ransom 21:45, 2 May 2012 (UTC)</span><br />
*[[isElementInRange]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check is the element's range to the main point is smaller than (or as big as) the maximum range.</span><br />
*[[isLeapYear]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Checks if the given year is a leap year.</span><br />
*[[isVehicleOnRoof]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether vehicle is on roof.</span><br />
*[[isYearALeapYear]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» '''NEEDS EXPLANATION'''</span><br />
*[[iterElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Returns an iterator for your for loops saving time typing ipairs( getElementsByType( type ) ), instead you type: iterElements( type ).</span><br />
*[[math.round]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Rounds a number whereas the number of decimals to keep and the method may be set.</span><br />
*[[multi_check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks one element to many, handy and clean.</span><br />
*[[onVehicleWeaponFire]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This code implements an event that is triggered when a player in a vehicle fires a vehicles weapon.</span><br />
*[[RGBToHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string representing the color in hexadecimal.</span><br />
*[[setElementSpeed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to set moving element speed in kph or mph units.</span><br />
*[[setTableProtected]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Protects a table and makes it read-only.</span><br />
*[[setVehicleGravityPoint]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This clientside function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.</span><br />
*[[string.count]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function counts a text from a text.</span><br />
*[[string.explode]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function splits a string at a given separator pattern and returns a table with the pieces.</span><br />
*[[switch]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» '''NEEDS EXPLANATION'''</span><br />
*[[table.copy]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function copies a whole table and all the tables in that table.</span><br />
*[[table.empty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» '''NEEDS EXPLANATION'''</span><br />
*[[table.map]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function goes through a table and replaces every field with the return of the passed function, where the field's value is passed as first argument and optionally more arguments.</span><br />
*[[table.random]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» '''NEEDS EXPLANATION'''</span><br />
*[[table.size]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Finds the absolute size of a table.</span><br />
*[[toHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a decimal number to a hexadecimal number, as a fix to be used clientside.</span><br />
*[[var dump]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function outputs information about one or more variables using outputConsole()</span><br />
[[Category:Useful Functions]]</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=Template:Useful_Functions&diff=32207Template:Useful Functions2012-08-07T19:15:40Z<p>Ransom: Added useful function pages that people created and did not link to the template. They have no explanation currently. Also I alphabetized the list.</p>
<hr />
<div>*[[callClientFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any clientside function from the server's side.</span><br />
*[[callServerFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any server-side function from the client's side.</span><br />
*[[centerWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function center the window in any resolution.</span><br />
*[[Check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if it's arguments are of the right types and calls the error-function if one isn't.</span><br />
*[[coroutine.resume]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Fix for hidden coroutine error messages</span><br />
*[[dxDrawColorText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a dx text with #RRGGBB color codes support.</span><br />
*[[dxDrawGifImage]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function simulates the effect of a GIF image by using image sprites.</span><br />
*[[dxDrawImage3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D image.</span><br />
*[[dxDrawRectangle3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D rectangle.</span><br />
*[[dxGetFontSizeFromHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculate a font size from given height for dxDraw.</span><br />
*[[findRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Takes two points and returns the direction from point A to point B.</span><br />
*[[FormatDate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Formats a date on the basis of a format string and returns it.</span><br />
*[[GenerateString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» '''NEEDS EXPLANATION'''</span><br />
*[[getAge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the age of a birthday.</span><br />
*[[getAlivePlayers (Client)]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» '''NEEDS EXPLANATION'''</span><br />
*[[getAlivePlayersInTeam]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the alive players in a team.</span><br />
*[[getCursorMoveOn]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks in which way the cursor is currently moving.</span><br />
*[[getDistanceBetweenPointAndSegment2D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» '''NEEDS EXPLANATION'''</span><br />
*[[getElementSpeed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to get element speed in kph or mph units.</span><br />
*[[getOffsetFromXYZ]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to take an entity and a position and calculate the relative offset between them accounting for rotations.</span><br />
*[[getOnlineAdmins]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function will give the online admins.</span><br />
*[[getOnlineStaff]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» '''NEEDS EXPLANATION'''</span><br />
*[[getPlayerFromNamePart]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to get player From his Name part.</span><br />
*[[getPlayersInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets all the players in a photograph.</span><br />
*[[getPointFromDistanceRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Finds a point based on a starting point, direction and distance.</span><br />
*[[getResourceSettings]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource settings.</span><br />
*[[getTimestamp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» With this function you can get the UNIX timestamp.</span><br />
*[[getXMLNodes]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» '''NEEDS EXPLANATION'''</span><br />
*[[IfElse]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Returns one of two values based on a boolean expression.</span><br />
*[[isElementInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element was in the player's camera picture. This needs writing still. --Ransom 21:45, 2 May 2012 (UTC)</span><br />
*[[isElementInRange]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check is the element's range to the main point is smaller than (or as big as) the maximum range.</span><br />
*[[isLeapYear]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Checks if the given year is a leap year.</span><br />
*[[isVehicleOnRoof]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether vehicle is on roof.</span><br />
*[[isYearALeapYear]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» '''NEEDS EXPLANATION'''</span><br />
*[[iterElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Returns an iterator for your for loops saving time typing ipairs( getElementsByType( type ) ), instead you type: iterElements( type ).</span><br />
*[[math.round]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Rounds a number whereas the number of decimals to keep and the method may be set.</span><br />
*[[multi_check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks one element to many, handy and clean.</span><br />
*[[onVehicleWeaponFire]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This code implements an event that is triggered when a player in a vehicle fires a vehicles weapon.</span><br />
*[[RGBToHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string representing the color in hexadecimal.</span><br />
*[[setElementSpeed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to set moving element speed in kph or mph units.</span><br />
*[[setTableProtected]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Protects a table and makes it read-only.</span><br />
*[[setVehicleGravityPoint]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This clientside function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.</span><br />
*[[string.count]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function counts a text from a text.</span><br />
*[[string.explode]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function splits a string at a given separator pattern and returns a table with the pieces.</span><br />
*[[switch]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» '''NEEDS EXPLANATION'''</span><br />
*[[table.copy]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function copies a whole table and all the tables in that table.</span><br />
*[[table.empty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» '''NEEDS EXPLANATION'''</span><br />
*[[table.map]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function goes through a table and replaces every field with the return of the passed function, where the field's value is passed as first argument and optionally more arguments.</span><br />
*[[table.random]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» '''NEEDS EXPLANATION'''</span><br />
*[[table.size]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Finds the absolute size of a table.</span><br />
*[[toHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a decimal number to a hexadecimal number, as a fix to be used clientside.</span><br />
*[[var dump]] » This function outputs information about one or more variables using outputConsole()</span><br />
[[Category:Useful Functions]]</div>Ransomhttps://wiki.multitheftauto.com/index.php?title=Help:Adding_Pages_to_Categories_and_Templates&diff=32206Help:Adding Pages to Categories and Templates2012-08-07T16:42:42Z<p>Ransom: /* 1. Choosing a Template Name */</p>
<hr />
<div>==Introduction==<br />
Did you create a new page, such as a function, and it isn't showing up in a list? Did you try and edit it in only to see <nowiki>{{weird_tags_like_this}}</nowiki> instead of text relating to the page you viewed? Welcome to the world of templates. We have noticed in [[Special:RecentChanges|RecentChanges]] that people are making pages and not linking to them properly. '''These pages are being lost in the bowels of the Wiki!'''<br />
<br />
We also use categories in this wiki, but they are not as crucial as templates. Please read on to learn about both and to understand how to contribute to our wiki properly.<br />
<br />
=Template=<br />
===What is a Template===<br />
It is like a big copy paste on a clipboard. You write a template tag on another page and it writes everything that was on the template page.<br />
<br />
*'''Why Use Templates?'''<br />
It allows the same information to be represented in multiple places, without duplicating texts and updating them manually numerous times.<br />
<br />
*'''Example?''' <br />
Look at the page source (edit button) on our functions or event pages. You can see that the functions aren't actually listed there, each function group has its own template. The main use for this is to fill out the "See Also" section of individual functions with their related functions.<br />
<br />
===How Do You Make/Edit a Template?===<br />
<br />
The best way to teach is by example. I will need a template to direct people to this guide from multiple pages in the wiki. Let's just create this template together! FUN!<br />
<br />
====1. Choosing a Template Name====<br />
The best template name explains what it is. Typically the best thing is to make the template URL identical to the actual page. Therefore I am going to use:<br />
<br />
<pre>http://wiki.multitheftauto.com/index.php?title=Template:Adding_Pages_to_Categories_and_Templates</pre><br />
<br />
'''IMPORTANT:''' Remember that all wiki pages are case sensitive. The same page can exist in uppercase and lowercase! Capitalize appropriately.<br />
<br />
If I tried to link to a template that doesn't exist this happens:<br />
{{link_to_nonexistant_template_click_here_to_create_lazypants}}<br />
<br />
So as you can see, it is better we create the template before attempting to link to it!<br />
<br />
====2. Filling out the Template====<br />
<br />
At the template page, hit create page, and you'll see the edit field box. Type in whatever you need to be said in other pages and save the page. It could be simple text, links to a set of functions, or even as advanced as a bit of code that determines something, such as our future functions template. If you were trying to add to our functions/events then you would just edit a link to your function into the template. Don't screw it up or I will be disappointed in you!<br />
<br />
From this point, you use the template page name as a tag inside the pages where you want to use it. My template tag is:<br />
<br />
<pre>{{Adding_Pages_to_Categories_and_Templates}}</pre><br />
<br />
====3. Demonstration====<br />
So here I will actually link to the template. If you check the template page source, you will see exactly what is printed below:<br />
<br />
{{Adding_Pages_to_Categories_and_Templates}}<br />
<br />
'''Note:''' The easiest way to reach a template that was used on a page is to edit the page and scroll to the bottom. A list of all templates used will appear with links to the template pages.<br />
<br />
=Category=<br />
===What is a Category===<br />
Categories group pages together. The categories have their own special page where all the grouped pages are alphabetized. Think of them like sorting the Wiki into folders for common pages. For example here is a link to the server functions category page: [[:Category:Server_functions]]<br />
<br />
===How do I Use Categories===<br />
A page is put into a category by editing the following syntax into a page:<br />
<pre>[[:Category:pagename]]</pre><br />
<br />
You do need to create the category page just as you would a template. Again, you simply go to the URL of the category page you want to make. The format is:<br />
<pre>http://wiki.multitheftauto.com/index.php?title=Category:Page_Name_Here</pre><br />
<br />
For the category page itself, you simply write a small explanation what the category (folder) is about.<br />
<br />
If you look at the source of the pages listed in [[:Category:Server_functions]], you may notice that the category tag is not in them! It actually is there, but it is being applied through the clever combination of a template with the category embedded.<br />
<br />
Those nice colored stripes you see at the tops of pages are all templates that have a category tag embedded. This was designed to make it hard for people to mess-up categories. For example, look at the page source for the blue stripe that says "Client and Server Function" http://wiki.multitheftauto.com/index.php?title=Template:Server_client_function&action=edit<br />
<br />
===Demonstration===<br />
I have put a category tag in this page. This is reflected at the very bottom of the page you are reading right now. The category page just happens to be the exact same name. Unlike templates, it is not typical to name the category after a page. They are more like folder names. This is just for demonstration however.<br />
<br />
The category page is here: [[:Category:Adding_Pages_to_Categories_and_Templates]]<br />
<br />
[[Category:Adding_Pages_to_Categories_and_Templates]]<br />
<br />
=More Info=<br />
===Lists of Templates and Categories===<br />
Looking for template and category listings? This is one thing [[Special:SpecialPages|SpecialPages]] is for.<br />
<br />
'''Templates:'''<br />
*[[Special:UncategorizedTemplates]]<br />
:Templates not organized into templates (ie think of categories as folders).<br />
*[[Special:UnusedTemplates]]<br />
:Unused templates<br />
*[[Special:WantedTemplates]]<br />
:Tags are linked to this template, but the page itself doesn't exist. It still works de facto. You need to hit create on the template page.<br />
*[[Special:MostLinkedTemplates]]<br />
:Templates that were tagged in the most pages<br />
<br />
'''Categories:'''<br />
*[[Special:Categories]]<br />
:All categories overview.<br />
*[[Special:UncategorizedCategories]]<br />
:Categories not within another category (ie not used as subfolders of folders).<br />
*[[Special:UnusedCategories]]<br />
:Unused categories<br />
*[[Special:WantedCategories]]<br />
:Tags are linked to this category, but the page itself doesn't exist. It still works de facto. You need to hit create on the category page.<br />
*[[Special:MostLinkedCategories]]<br />
:Categories that were tagegd in the most places<br />
<br />
===Further Reference===<br />
http://en.wikipedia.org/wiki/Help:Template<br><br />
http://en.wikipedia.org/wiki/Help:Category<br />
<br />
===Questions?===<br />
Best way to discuss wiki is live on IRC. See the community box on the [[Main Page]] for more info.</div>Ransom