Multi Theft Auto: Wiki - User contributions [en]

User:The Kid

2014-07-11T17:13:01Z

The Kid:

= Contributions =

=== Scripts ===

*[http://community.mtasa.com/index.php?p=resources&s=details&id=1129 Camera "Hack" Script]

*[http://community.mtasa.com/index.php?p=resources&s=details&id=1064 Real Time]

*[http://community.mtasa.com/index.php?p=resources&s=details&id=1604 Extra Health]

=== Maps ===

*[http://community.mtasa.com/index.php?p=resources&s=details&id=826| Zombotech Admin Base]

=== Useful Functions ===

*[[GetAlivePlayers (Client)]]

*[[Table.random]]

=== Others ===

*Translating Wiki to Spanish.

*Giving a helping hand to some scripters on forum.

User:The Kid

2014-07-11T17:12:47Z

The Kid:

User:The Kid

2014-07-11T17:12:26Z

The Kid: /* Contributions */

= Story =

I've started on MTA SA when I was free from the school, in my dear summer, on January. I was known as "BenHacksFriday13". First I played a lot on zombie servers, like "Lithuanian Zombie Infestation" or "Gamenet 100% Zombie Mod", etc... Then I played on Chile servers (because my country is Chile). I was bored, and changed my name to "Benxamix2". Then I started to make resources. My first "resource" was a (noob) freeroam modification, made it on spanish and with less things... But I understood how Lua works, and I just started creating self-made resources. I knew "Maurize", an old user of MTA, from one of the zombie servers: "Zombie Virus: Lost Squads". He was with "Castillo14". Then I started to script for him (for free). We made a good server... Until I had to leave MTA for a long time, because summer ended, and my (real) house didn't has internet due to several problems with an earthquake.
3 months later, the server changed a lot. During my offline time, I made a cellphone script. Anyway, I returned to MTA, with a lot of new knowledge about Lua. "Maurize" suggested me to change my nick to "Ben" for simpliest and cool admin nick (yes, I was admin of his server). Then, I knew "Castillo14", he made some few scripts on the old "Maurize" server, like the PDA, a weapons shop, and a spawn system. Some time later, server got "bugged" (resources were getting reset), so we had to delete whole MTA server software, and re-install it. Then, I knew FFS Racing server. I was very happy with this server, it was really good. I knew spanish speakers, admins, etc... I suggested JesseUnit to join us (Maurize and me). He accepted, and we made a new server (Jesse and me), called "Code: Black|Army VS Gangsters". It was pretty cool, but JesseUnit didn't help more than with few mapping and tried to make nooby scripts. Finally, he "killed" the idea of the gamemode I made, so I left the project. And I stopped working for "Maurize", and got "independence". I created a clan: AD (Advanced Drivers). By 1 month, it had about 20 members. Some few members got out, but the clan got cool. I changed my nick to "The_Kid". My clan had own server, own forum... And I left it too, finally. After that, I was working on a gamemode project, called "Minecraft Classic". I changed my name to "Tony_Montana" after I saw "Scarface: The World is Yours", but finally I returned to "The_Kid" because everyone knows me with that name huh. I was getting bored of playing so much races, all them were pretty cool and hard, lots of feats racing. But I just stopped playing at FFS Racing and finally, I decided to make my own Zombie server. Thanks to Delux Host, I got a free 32-Player slots server by 1 month. My server got popularity and was fighting against Zombie RPG to decide which was better. Whatever, my server was winning that. I created account-based inventory system, missions, lots of complex stuff... And the server crashed... The reason is because the server's PC had too few RAM memory, and was crashing every 5-6 hours. So my server got less popularity due to the hoster company, Delux Host... People began to leave it... And after a hard decission, I left MTA on March, 2011.

But I came back recently on October, working on Garry's Mod Map Editing System (GMES), as a new "open-source" project. I know enough about Lua

= Contributions =

=== Scripts ===

*[http://community.mtasa.com/index.php?p=resources&s=details&id=1129 Camera "Hack" Script]

*[http://community.mtasa.com/index.php?p=resources&s=details&id=1064 Real Time]

*[http://community.mtasa.com/index.php?p=resources&s=details&id=1604 Extra Health]

=== Maps ===

*[http://community.mtasa.com/index.php?p=resources&s=details&id=826| Zombotech Admin Base]

=== Useful Functions ===

*[[GetAlivePlayers (Client)]]

*[[Table.random]]

=== Others ===

*Translating Wiki to Spanish.

*Giving a helping hand to some scripters on forum.

= Projects =

*[http://forum.mtasa.com/viewtopic.php?f=108&t=36600 Garry's Mod Map Editing System]
*[http://forum.mtasa.com/viewtopic.php?f=108&t=32083 Easy3DText]

ES/Página Principal

2014-07-04T21:25:04Z

The Kid:

__NOTOC__
__NOEDITSECTION__

{| width="100%" cellspacing="0" cellpadding="0"
| colspan="2" |
<div style="border: 1px solid #D8D8D8; padding: 10px; height: 140px;">
[[File:Mtalogo.png|left|100px]]'''
Bienvenid@ a la Wiki de Multi Theft Auto: San Andreas en español.''' Aquí puedes encontrar mucha información sobre el uso de Multi Theft Auto.

Hay muchas [[ES/Cómo puedes ayudar|cosas que puedes hacer para ayudarnos]] a mejorar MTA - crea un mapa, un modo de juego, escribe códigos de ejemplo, tutoriales, traduce páginas del inglés al español, o simplemente juega y reporta los bugs que encuentres.

</div>
|}
{| width="100%" cellspacing="0" cellpadding="0"
| colspan="2" |
|-
|width="50%" style="vertical-align:top;" |<div style="border: 1px solid #D8D8D8; padding:10px 8px 8px 8px; margin:10px;">
<div style="float:right; width: 32px;">[[File:Input-gaming.png‎]]</div>
=== El Juego ===
<div style="background: #FFEEAA;">
[[File:Go-down.png|link=http://mtasa.com/]] ''' [http://mtasa.com/ Descargar Multi Theft Auto: San Andreas {{Current Version|full}}]'''</div>
* [[ES/Manual del Cliente|Manual del Cliente]] [[Image:flag_es.png|En Español|20px]]
* [[ES/Cambios en la versión 1.3|Cambios de la versión 1.3]] [[Image:flag_es.png|En Español|20px]] (Traducción 80%)
* [[ES/Problemas_Conocidos_-_FAQ|Problemas Conocidos]] [[Image:flag_es.png|En Español|20px]] (Traducción: 10%)
* [[Upgrading_from_MTA:Race|Cambiando MTA:Race a MTA:SA 1.0.x]] [[Image:flag_us.png|En Inglés|20px]]
* [[ES/Manual del Servidor|Manual del Servidor]] [[Image:flag_es.png|En Español|20px]]
* [[Map_manager|El Resource "Map Manager"]] [[Image:flag_us.png|En Inglés|20px]]

====Editor de Mapas====
*[[ES/Resource:Editor|Manual del Editor]] [[Image:flag_es.png|En Español|20px]]
*[[Resource:Editor/EDF|EDF: Formato de Definiciones del Editor]] [[Image:flag_us.png|En Inglés|20px]]
*[[Resource:Editor/Plugins|Plugins para el Editor]] [[Image:flag_us.png|En Inglés|20px]]
*[[ES/Resource:Editor#Preguntas_Frecuentes|Preguntas Frecuentes]] [[Image:flag_es.png|En Español|20px]]

====Bases de Datos====
* [[:Category:Resource|Catálogo de Resources]] [[Image:flag_us.png|En Inglés|20px]]
* [[ES/Scripts de Cliente|Scripts de Cliente]] [[Image:flag_es.png|En Español|20px]]
* [[Modules| Módulos]] [[Image:flag_us.png|En Inglés|20px]]
</div>

<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px;">
<div style="float:right; width: 32px;">[[File:Applications-development.png‎‎‎]]</div>
====Desarrollando Multi Theft Auto====
[[File:Go-down.png|link=http://nightly.mtasa.com/]] [http://nightly.mtasa.com/ Nightly builds]
* [[Compiling_MTASA|Compilando MTA:SA en Windows]] [[Image:flag_us.png|En Inglés|20px]]
* [[Building_MTASA_Server_on_Mac_OS_X|Compilando MTA:SA en Mac OS X]] [[Image:flag_us.png|En Inglés|20px]]
* [[Building_MTASA_Server_on_GNU_Linux|Compilando MTA:SA en GNU/Linux]] [[Image:flag_us.png|En Inglés|20px]]
* [[Coding guidelines|Guías de Codificación]] [[Image:flag_us.png|En Inglés|20px]]
* [http://code.google.com/p/mtasa-blue Google Code SVN] [[Image:flag_us.png|En Inglés|20px]]
* [http://bugs.mtasa.com/roadmap_page.php Seguimiento de Versiones] [[Image:flag_us.png|En Inglés|20px]]
* [http://bugs.mtasa.com/ Central de Reportes de Bugs] [[Image:flag_us.png|En Inglés|20px]]
</div>

<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px;">
<div style="float:right; width: 32px;">[[File:Applications-office.png‎]]</div>
===Wiki - Cómo puedes ayudar===
* Termina la documentación para [[:Category:Incomplete|funciones incompletas]].
* [[:Category:Needs_Example|Crea ejemplos para eventos y funciones]].
* Revisa y verifica [[:Category:Needs Checking|páginas que necesitan revisión]].
* Escribe tutoriales para ayudar a la gente.
* Traduce las páginas del wiki.
</div>

<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px;">
<div style="float:right; width: 32px;">[[File:Internet-group-chat.png‎]]</div>
=== Comunidad ===
* [http://forum.multitheftauto.com/ Foro] [[Image:flag_us.png|En Inglés|20px]]
** [http://forum.multitheftauto.com/viewforum.php?f=122&sid=72be1c29dd00c4442f8112cc09818283 Sección en español] [[Image:flag_es.png|En Español|20px]]
* [irc://irc.multitheftauto.com/mta Canal IRC] [[Image:flag_us.png|En Inglés|20px]]
* [http://community.mtasa.com/ Comunidad MTA] [[Image:flag_us.png|En Inglés|20px]]
* [http://www.youtube.com/user/MTAQA Canal de YouTube oficial] [[Image:flag_us.png|En Inglés|20px]]
</div>
<div style="padding:4px 8px 8px 8px; margin:10px; text-align:center">
[[File:Osi symbol.png|75px|link=http://opensource.org/]]
'''Multi Theft Auto''' es un '''Proyecto de Código Abierto'''.
¡Todos podemos contribuir a mejorar Multi Theft Auto!
</div>

| width="50%" style="vertical-align:top;" |

<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px;">
<div style="float:right; width: 32px;">[[File:Accessories-text-editor.png]]</div>
=== Scripting ===
* [[ES/Resources|Introducción a los Resources]] [[Image:flag_es.png|En Español|20px]]
** [[Resource Web Access|Acceso Web con Resources]] [[Image:flag_us.png|En Inglés|20px]]
** [[Meta.xml|Sobre el archivo "meta.xml"]] [[Image:flag_us.png|En Inglés|20px]]
** [[:Category:Resource|Catálogo de Resources]] [[Image:flag_us.png|En Inglés|20px]]
** [[ES/ACL|Lista de Control del Acceso (ACL)]] [[Image:flag_es.png|En Español|20px]]
* [[ES/Introducción a Lua|Introducción a Lua]] [[Image:flag_es.png|En Español|20px]]
** [[ES/Introducción a la Programación de GUI|Introducción al GUI]] [[Image:flag_es.png|En Español|20px]]
** [[Debugging|Tutorial de Depuración]] [[Image:flag_us.png|En Inglés|20px]] - Encontrar errores en scripts.
** [http://forum.mtasa.com/viewtopic.php?f=145&t=70852 Tutoriales]
* [[ES/Useful_Functions| Funciones útiles]] [[Image:flag_es.png|En Español|20px]]
* [[Writing_Gamemodes|Escribiendo Modos de Juego]] [[Image:flag_us.png|En Inglés|20px]]
====Ayuda General de Lua====
*[http://www.lua.org/manual/5.1/es/manual.html Manual de Referencia de Lua 5.1] [[Image:flag_es.png|En Español|20px]]
*[http://www.lua.org/pil/index.html Manual Programando en Lua] [[Image:flag_us.png|En Inglés|20px]]
*[http://lua-users.org/wiki/TutorialDirectory Lua Wiki] [[Image:flag_us.png|En Inglés|20px]]
*[http://nixstaller.berlios.de/manual/0.2/nixstaller_9.html Guía general de Lua de Nixstaller] [[Image:flag_us.png|En Inglés|20px]]
</div>

<div style="border: 1px dotted #AAAAAA;padding:4px 8px 8px 8px;margin:10px;">
====Referencia====
* [[ES/Funciones de Cliente|Funciones de Cliente]] [[Image:flag_us.png|En Inglés|20px]]
* [[Client Scripting Events|Eventos de Cliente]] [[Image:flag_us.png|En Inglés|20px]]
* [[ES/Funciones de Servidor|Funciones de Servidor]] [[Image:flag_es.png|En Español|20px]]
* [[Server Scripting Events|Eventos de Servidor]] [[Image:flag_us.png|En Inglés|20px]]

* [[ES/Clases MTA| Clases de MTA]] [[Image:flag_es.png|En Español|20px]]
**[[Element tree| Árbol de Elementos]] [[Image:flag_us.png|En Inglés|20px]]
</div>

<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px;">
<div style="float:right; width: 32px;">[[File:System-file-manager.png]]</div>
====[[Id|Lista de ID's]]====
*[[Animations|Animaciones]]
*[[ES/Skins de Personajes|Skins]]
*[[CJ_Clothes|Ropa]]
*[[Garage|Garajes]]
*[[Interior IDs|Interiores]]
*[[Projectiles|Proyectiles]]
*[[Radar Blips|Iconos de Radar]]
*[[Sounds|Sonidos]]
*[[Vehicle IDs|ID's de Vehículos]]
*[[Vehicle Colors|Colores de Vehículos]]
*[[Vehicle Upgrades|Mejoras de Vehículos]]
*[[Weapons|Armas]]
*[[ES/Climas|Climas]]
</div>

<div style="border: 1px dotted #AAAAAA;padding:4px 8px 8px 8px;margin:10px;">

====Equipo de Traducción====
* [mailto:zorrigas@gtagamingchile.com zorrigas@gtagamingchile.com]<br>
* [mailto:Brijido_XD@hotmail.com Brijido_XD@hotmail.com]<br>
* [mailto:lambebasan@gmail.com Seben (The Kid)]<br>
* [mailto:matiuno@gmail.com matiuno@gmail.com]<br>
* [mailto:cesarcastillo4@gmail.com cesarcastillo4@gmail.com]<br>
* [mailto:alex_firexx@hotmail.com alex_firexx@hotmail.com]<br>
* [mailto:carlos_olivo@msn.com carlos_olivo@msn.com]<br>
* AlexD
* Alexs_Steel[mailto:alexTO123@hotmail.com]<br>
* Rockero [mailto:ac_dcrocker@hotmail.com ac_dcrocker@hotmail.com]<br>
<br>
'''¡NO ELIMINES CONTENIDO SIN AUTORIZACIÓN!'''<br> Tampoco uses modismos, usa el Castellano (Internacional), y trata de que al traducir todo quede tan claro como puedas, y la ortografía sea la mejor posible.
</div>
|-
| colspan="2" |
|}
{{Languages list|es}}

ES/Resources

2012-01-07T01:57:01Z

The Kid: /* Archivos almacenados */

Los '''resources''' son una parte clave de MTA. Un resource es básicamente una carpeta o archivo ''.zip'' (carpeta comprimida) que contiene una colección de archivos de script ''.lua'', además de un archivo ''meta'' que describe cómo el resource debe ser cargado. Un resource puede ser comparado con un programa que se ejecuta en un sistema operativo; que puede ser iniciado y detenido, y se pueden ejecutar varios de ellos al mismo tiempo. Es necesario recordar, sin embargo, que a diferencia de los programas en un sistema operativo, no hay multitarea entre los resources.

== Terminología ==

*'''Resource''' - Un archivo ''.zip'' o carpeta que contiene un archivo '''meta.xml''' y una serie de archivos. Estos se colocan en la carpeta de instalación de MTA San Andreas, en "MTA San Andreas/server/mods/deathmatch/resources/''.

*'''Item de resource''' - Un archivo contenido dentro de un resource. Puede ser un mapa, un archivo de música, una imagen, etc.

== El archivo meta.xml ==

El archivo ''meta.xml'' es el núcleo de cada resource. En él se describe exactamente los archivos que el resource debe utilizar y cómo debe hacerlo. El siguiente es un ejemplo que cubre todas las opciones que hay, los archivos de metadatos puede tener tantas o tan pocas de estas etiquetas como tú quieras:

<syntaxhighlight lang="xml">
<meta>
<info author="eAi" description="Ejemplo básico de script" version="4"/>

<include resource="radarblips"/>
<include resource="markermanagement" />

<script src="ctf.lua" />
<script src="flag.lua" />
<script src="ctf_client.lua" type="client" />

<file src="model.dff" />
<file src="quitbutton.png" />
<file src="texture.txd" />

<html src="test.htm" default="true"/>
<html src="logo.png" raw="true" />

<export function="multiply" http="true" />
<export function="getPlayerList" />
<export function="getElementOwner" type="client"/>

<config src="vehicle-list.xml" type="client" />
<config src="markerconfig.xml" type="server" />

<map src="somestuff.map" dimension="99" />
</meta>
</syntaxhighlight>

Mientras que un mapa de CTF, por ejemplo, puede tener un meta.xml parecido a esto:
<syntaxhighlight lang="xml">
<meta>
<include resource="ctf" />
<map src="myuberl33tctfmap.map" />

<info author="Tom" instructions="this is uber l33t !!!!!1111111" type="map" />
</meta>
</syntaxhighlight>

Los atributos Script/type, Config/type y File/type especifican si el script/resource se debe enviar a los clientes o no, este valor por defecto es "server".

Las etiquetas incluyen especificaciones como resources que se deben iniciar antes de un resource se ha iniciado.
Por ejemplo, si su resource tiene dependencia a otro, puede incluirlo en meta.xml para que el resource, al que el suyo depende, se inicie primero.

Cada resource tiene su propia máquina virtual (VM). Esta contiene todos los scripts en el resource. Esto significa que las variables no se comparten con otros resources. La mejor manera de comunicarte con otros resources es mediante las etiquetas de ''exportación'' y exportar una función. Esto permitira que otros resources puedan activar esa funcion con el comando de scripting [[call]]

Los scripts se envían a los clientes para que se inicien tan pronto como hayan sido descargados.

Los scripts son capaces que se pueden leer y escribir en su propia carpeta de resources con funciones tales como [[xmlCreateFile]] y [[fileCreate]]. También pueden leer y escribir dentro de otros resources, pero debe tener permisos de [[Access_Control_List | ACL]].

Cada resource sólo puede ser cargado una vez, el servidor se asegura de esto. Si un resources se incluye más de una vez, la misma instancia será utilizada por cada resource que incluya.

== Archivos almacenados ==
Los archivos ''Resources'' pueden ser almacenados en un .zip o un directorio. Se encuentran en:

MTA San Andreas/server/mods/deathmatch/resources/

Dentro de la carpeta "resources" hay un grupo de carpetas que usan paréntesis cerrados [ y ]. Éstas carpetas no son tomadas en cuenta como resources, sino que se aplican como "categorías". Puedes crear subcarpetas que usen este sistema, sin ningún problema.

Cada resource puede ser un archivo ZIP, un directorio o ambos. En el último caso, el directorio tiene preferencia sobre el archivo ZIP, así, los archivos pueden ser puestos en directorios para pasar por encima de los archivos dentro del archivo ZIP. Esto permite que los directorios sean usados para pruebas y desarrollo de mapas/scripts y los archivos ZIP sean usados por los usuarios finales.

==Otras cosas a notar==
*Los nombres de los resources no pueden contener puntos, espacios o caracteres raros como "?", "$" o "%".
*Si el resource guarda algún archivo, éstos no deben aparecer en el archivo ''meta.xml''.
*Los archivos mostrados en ''meta.xml'' sólo deberían ser leídos por tus scripts. No los modifiques con [[xmlSaveFile]], [[FileSave]], etc.
*Cuando hagas la versión ZIP de tu resource, no incluyas archivos de guardado. Si tu resource los usa, que los cree cuando sea necesario.

==Véase También==
===Funciones===
Actualmente, los resources pueden ser manipulados por medio de scripts. Más abajo se muestran las funciones correspondientes:
{{Resource functions}}

===Eventos===
Los siguientes eventos también están ligados a los resources:
{{Resource_events}}

[[en:Resources]]
[[it:Introduzione alle Risorse]]
[[ru:Resources]]

==Traductores==

*Kzman
*F4ST3R
*Benxamix2/The Kid

ES/Resources

2012-01-07T01:55:38Z

The Kid:

Los '''resources''' son una parte clave de MTA. Un resource es básicamente una carpeta o archivo ''.zip'' (carpeta comprimida) que contiene una colección de archivos de script ''.lua'', además de un archivo ''meta'' que describe cómo el resource debe ser cargado. Un resource puede ser comparado con un programa que se ejecuta en un sistema operativo; que puede ser iniciado y detenido, y se pueden ejecutar varios de ellos al mismo tiempo. Es necesario recordar, sin embargo, que a diferencia de los programas en un sistema operativo, no hay multitarea entre los resources.

== Terminología ==

*'''Resource''' - Un archivo ''.zip'' o carpeta que contiene un archivo '''meta.xml''' y una serie de archivos. Estos se colocan en la carpeta de instalación de MTA San Andreas, en "MTA San Andreas/server/mods/deathmatch/resources/''.

*'''Item de resource''' - Un archivo contenido dentro de un resource. Puede ser un mapa, un archivo de música, una imagen, etc.

== El archivo meta.xml ==

El archivo ''meta.xml'' es el núcleo de cada resource. En él se describe exactamente los archivos que el resource debe utilizar y cómo debe hacerlo. El siguiente es un ejemplo que cubre todas las opciones que hay, los archivos de metadatos puede tener tantas o tan pocas de estas etiquetas como tú quieras:

<syntaxhighlight lang="xml">
<meta>
<info author="eAi" description="Ejemplo básico de script" version="4"/>

<include resource="radarblips"/>
<include resource="markermanagement" />

<script src="ctf.lua" />
<script src="flag.lua" />
<script src="ctf_client.lua" type="client" />

<file src="model.dff" />
<file src="quitbutton.png" />
<file src="texture.txd" />

<html src="test.htm" default="true"/>
<html src="logo.png" raw="true" />

<export function="multiply" http="true" />
<export function="getPlayerList" />
<export function="getElementOwner" type="client"/>

<config src="vehicle-list.xml" type="client" />
<config src="markerconfig.xml" type="server" />

<map src="somestuff.map" dimension="99" />
</meta>
</syntaxhighlight>

Mientras que un mapa de CTF, por ejemplo, puede tener un meta.xml parecido a esto:
<syntaxhighlight lang="xml">
<meta>
<include resource="ctf" />
<map src="myuberl33tctfmap.map" />

<info author="Tom" instructions="this is uber l33t !!!!!1111111" type="map" />
</meta>
</syntaxhighlight>

Los atributos Script/type, Config/type y File/type especifican si el script/resource se debe enviar a los clientes o no, este valor por defecto es "server".

Las etiquetas incluyen especificaciones como resources que se deben iniciar antes de un resource se ha iniciado.
Por ejemplo, si su resource tiene dependencia a otro, puede incluirlo en meta.xml para que el resource, al que el suyo depende, se inicie primero.

Cada resource tiene su propia máquina virtual (VM). Esta contiene todos los scripts en el resource. Esto significa que las variables no se comparten con otros resources. La mejor manera de comunicarte con otros resources es mediante las etiquetas de ''exportación'' y exportar una función. Esto permitira que otros resources puedan activar esa funcion con el comando de scripting [[call]]

Los scripts se envían a los clientes para que se inicien tan pronto como hayan sido descargados.

Los scripts son capaces que se pueden leer y escribir en su propia carpeta de resources con funciones tales como [[xmlCreateFile]] y [[fileCreate]]. También pueden leer y escribir dentro de otros resources, pero debe tener permisos de [[Access_Control_List | ACL]].

Cada resource sólo puede ser cargado una vez, el servidor se asegura de esto. Si un resources se incluye más de una vez, la misma instancia será utilizada por cada resource que incluya.

== Archivos almacenados ==
Los archivos ''Resources'' pueden ser almacenados en un .zip o un directorio. Se encuentran en:

MTA San Andreas/server/mods/deathmatch/resources/

Cada resource puede ser un archivo ZIP, un directorio o ambos. En el último caso, el directorio tiene preferencia sobre el archivo ZIP, así, los archivos pueden ser puestos en directorios para pasar por encima de los archivos dentro del archivo ZIP. Esto permite que los directorios sean usados para pruebas y desarrollo de mapas/scripts y los archivos ZIP sean usados por los usuarios finales.

==Otras cosas a notar==
*Los nombres de los resources no pueden contener puntos, espacios o caracteres raros como "?", "$" o "%".
*Si el resource guarda algún archivo, éstos no deben aparecer en el archivo ''meta.xml''.
*Los archivos mostrados en ''meta.xml'' sólo deberían ser leídos por tus scripts. No los modifiques con [[xmlSaveFile]], [[FileSave]], etc.
*Cuando hagas la versión ZIP de tu resource, no incluyas archivos de guardado. Si tu resource los usa, que los cree cuando sea necesario.

==Véase También==
===Funciones===
Actualmente, los resources pueden ser manipulados por medio de scripts. Más abajo se muestran las funciones correspondientes:
{{Resource functions}}

===Eventos===
Los siguientes eventos también están ligados a los resources:
{{Resource_events}}

[[en:Resources]]
[[it:Introduzione alle Risorse]]
[[ru:Resources]]

==Traductores==

*Kzman
*F4ST3R
*Benxamix2/The Kid

ES/Sobre el archivo "meta.xml"

2011-12-17T19:47:16Z

The Kid:

El archivo ''meta.xml'' presenta un conjunto de datos, como el nombre del resource, los scripts para incluir en el resource, qué archivos enviar a los clientes, entre otras cosas. Es también el ámbito de aplicación de los ''elementos''. Está escrito en XML, que se basa en HTML y es el pariente de XHTML.

==Tags==
XML es un formato de datos de texto que es ampliamente utilizado para la representación de datos. MTA utiliza un lenguaje basado en XML para describir los datos de los recursos mediante el uso de las etiquetas a continuación:

*'''<info />''' Información sobre este ''resource'', los posibles parámetros (que se pueden utilizar y leer con [[getResourceInfo]]) son:
** '''author:''' El autor del'' resource''.
** '''version:''' La versión del ''resource''.
** '''name:''' El nombre del ''resource''.
** '''description:''' La descripción sobre el ''resource''.
** '''type:''' El tipo de ''resource'' (puede ser "gamemode", "script", "map" o "misc").
*'''<script />''' Script. Para para el resource, los atributos pueden ser:
** '''src:''' El nombre del archivo del script.
** '''type:''' El tipo de script: "client" (cliente) o "server" (servidor).
*'''<map />''' El mapa para gamemode, los posibles parámetros son:
**'''src:''' Nombre del archivo '''.map''' (la ruta puede ser, por ejemplo, "mapas/mi-mapa-freeroam.map").
**'''dimension:''' Dimensión en la que el mapa será cargado (opcional).
*'''<file />''' Un archivo de cliente. Generalmente se usan imágenes, archivos '''.txd''', '''.col''', '''.dff''' o archivos '''.xml'''. Estos se cargan por el cliente cuando el archivo está iniciado.
**'''src:''' Nombre del archivo client-side (La ruta puede ser, por ejemplo, "imagenes/imagen.png")
*'''<include />''' Para incluir ''resources'' extras, que se carguen con el '''resource''' que modificas.
**'''resource:''' El nombre del ''resource''.
**'''minversion:''' Versión mínima que el ''resource'' debe tener (opcional).
**'''maxversion:''' Versión máxima que el ''resource'' debe tener (opcional).
*'''<config />''' Configuración del archivo '''.xml''' con el que se puede acceder a los parámetros del resource:
**'''src:''' La ruta del archivo de configuración.
**'''type:''' El tipo de archivo de configuración. Puede ser "client" o "server".
*'''<export />''' Las funciones de esta exportacion para el resource, para otros recursos se pueden utilizar con [[call]]
**'''function:''' El nombre de la función.
**'''type''' El lado de la exportación (cliente o servidor). Los valores válidos son "server" y "client".
**'''http:''' Si la función se usa a través de HTTP. Se puede usar "true" o "false".
*'''<html />'''
**'''src:''' La ruta del archivo.
**'''default:''' The html file is one that is shown by default when visiting /resourceName/ on the server. Only one html can be default, the rest are ignored. (true/false)
**'''raw:''' The html file is not parsed by the LUA interpreter and is treated as binary data. Must be used for binary files (images mainly) (true/false)
*'''<settings> <setting name="" value=""/> </settings>:''' Most gamemodes use [[settings system]] to let server admins to configure it how they like. For instance you could set round time and then use [[get]] and [[set]] to get the value or change it, respectively.
*'''<min_mta_version />''' Minimum version requirements for this resource to run correctly. When authoring resources, the minimum version should usually be set to the current released version of MTA:SA (which at the moment is "{{Current Version|full}}").
**'''client:''' The minimum client version
**'''server:''' The minimum server version

== Ejemplo ==
Heres an example of a meta file using some of the tags mentioned:
{{#tag:code |
<meta>
<info author="Slothman" type="gamemode" name="Stealth" />
<config src="help.xml" type="client"/>
<min_mta_version client="{{Current Version|full}}" server="{{Current Version|full}}" />

<script src="stealthmain_server.lua" />
<script src="noiseblip.lua" />
<script src="mission_timer.lua" />
<script src="gadgets_server.lua" />
<script src="gadgets_client.lua" type="client"/>
<script src="stealthmain_client.lua" type="client"/>
<script src="noisebar.lua" type="client"/>
<script src="spycam.lua" type="client"/>

<file src="riot_shield.txd" />
<file src="riot_shield.dff" />
<file src="riot_shield.col" />
<file src="armor.png" />
<file src="camera.png" />
<file src="cloak.png" />
<file src="goggles.png" />
<file src="mine.png" />
<file src="radar.png" />
<file src="shield.png" />

<include resource="scoreboard" />
<include resource="killmessages" />
<include resource="maplimits" />

<settings>
<setting name="roundlimit" value="[6]" /> 
<setting name="teamdamage" value="[1]" /> 
<setting name="teambalance" value="[1]" /> 
<setting name="spazammo" value="[25]" /> 
<setting name="m4ammo" value="[100]" />
<setting name="shotgunammo" value="[25]" />
<setting name="sniperammo" value="[20]" />
<setting name="ak47ammo" value="[120]" />
<setting name="rifleammo" value="[40]" />
<setting name="deserteagleammo" value="[45]" />
<setting name="pistolammo" value="[132]" />
<setting name="uziammo" value="[150]" />
<setting name="tec9ammo" value="[150]" />
<setting name="silencedammo" value="[65]" />
<setting name="grenadeammo" value="[4]" />
<setting name="satchelammo" value="[4]" />
<setting name="teargasammo" value="[4]" />
<setting name="molatovammo" value="[4]" />
</settings>
</meta>
|lang="xml"}}

==Traductores==

*Benxamix2/The Kid
*pekio123

[[Category:Scripting Concepts]]
[[ru:Meta.xml]]
[[en:meta.xml]]

ES/Sobre el archivo "meta.xml"

2011-12-17T19:45:52Z

The Kid:

El archivo ''meta.xml'' presenta un conjunto de datos, como el nombre del resource, los scripts para incluir en el resource, qué archivos enviar a los clientes, entre otras cosas. Es también el ámbito de aplicación de los ''elementos''. Está escrito en XML, que se basa en HTML y es el pariente de XHTML.

==Tags==
XML es un formato de datos de texto que es ampliamente utilizado para la representación de datos. MTA utiliza un lenguaje basado en XML para describir los datos de los recursos mediante el uso de las etiquetas a continuación:

*'''<info />''' Información sobre este ''resource'', los posibles parámetros (que se pueden utilizar y leer con [[getResourceInfo]]) son:
** '''author:''' El autor del'' resource''.
** '''version:''' La versión del ''resource''.
** '''name:''' El nombre del ''resource''.
** '''description:''' La descripción sobre el ''resource''.
** '''type:''' El tipo de ''resource'' (puede ser "gamemode", "script", "map" o "misc").
*'''<script />''' Script. Para para el resource, los atributos pueden ser:
** '''src:''' El nombre del archivo del script.
** '''type:''' El tipo de script: "client" (cliente) o "server" (servidor).
*'''<map />''' El mapa para gamemode, los posibles parámetros son:
**'''src:''' Nombre del archivo '''.map''' (la ruta puede ser, por ejemplo, "mapas/mi-mapa-freeroam.map").
**'''dimension:''' Dimensión en la que el mapa será cargado (opcional).
*'''<file />''' Un archivo de cliente. Generalmente se usan imágenes, archivos '''.txd''', '''.col''', '''.dff''' o archivos '''.xml'''. Estos se cargan por el cliente cuando el archivo está iniciado.
**'''src:''' Nombre del archivo client-side (La ruta puede ser, por ejemplo, "imagenes/imagen.png")
*'''<include />''' Para incluir ''resources'' extras, que se carguen con el '''resource''' que modificas.
**'''resource:''' El nombre del ''resource''.
**'''minversion:''' Versión mínima que el ''resource'' debe tener (opcional).
**'''maxversion:''' Versión máxima que el ''resource'' debe tener (opcional).
*'''<config />''' Configuración del archivo '''.xml''' con el que se puede acceder a los parámetros del resource:
**'''src:''' La ruta del archivo de configuración.
**'''type:''' El tipo de archivo de configuración. Puede ser "client" o "server".
*'''<export />''' Las funciones de esta exportacion para el resource, para otros recursos se pueden utilizar con [[call]]
**'''function:''' El nombre de la función.
**'''type''' El lado de la exportación (cliente o servidor). Los valores válidos son "server" y "client".
**'''http:''' Si la función se usa a través de HTTP. Se puede usar "true" o "false".
*'''<html />'''
**'''src:''' La ruta del archivo.
**'''default:''' The html file is one that is shown by default when visiting /resourceName/ on the server. Only one html can be default, the rest are ignored. (true/false)
**'''raw:''' The html file is not parsed by the LUA interpreter and is treated as binary data. Must be used for binary files (images mainly) (true/false)
*'''<settings> <setting name="" value=""/> </settings>:''' Most gamemodes use [[settings system]] to let server admins to configure it how they like. For instance you could set round time and then use [[get]] and [[set]] to get the value or change it, respectively.
*'''<min_mta_version />''' Minimum version requirements for this resource to run correctly. When authoring resources, the minimum version should usually be set to the current released version of MTA:SA (which at the moment is "{{Current Version|full}}").
**'''client:''' The minimum client version
**'''server:''' The minimum server version

== Example ==
Heres an example of a meta file using some of the tags mentioned:
{{#tag:code |
<meta>
<info author="Slothman" type="gamemode" name="Stealth" />
<config src="help.xml" type="client"/>
<min_mta_version client="{{Current Version|full}}" server="{{Current Version|full}}" />

<script src="stealthmain_server.lua" />
<script src="noiseblip.lua" />
<script src="mission_timer.lua" />
<script src="gadgets_server.lua" />
<script src="gadgets_client.lua" type="client"/>
<script src="stealthmain_client.lua" type="client"/>
<script src="noisebar.lua" type="client"/>
<script src="spycam.lua" type="client"/>

<file src="riot_shield.txd" />
<file src="riot_shield.dff" />
<file src="riot_shield.col" />
<file src="armor.png" />
<file src="camera.png" />
<file src="cloak.png" />
<file src="goggles.png" />
<file src="mine.png" />
<file src="radar.png" />
<file src="shield.png" />

<include resource="scoreboard" />
<include resource="killmessages" />
<include resource="maplimits" />

<settings>
<setting name="roundlimit" value="[6]" /> 
<setting name="teamdamage" value="[1]" /> 
<setting name="teambalance" value="[1]" /> 
<setting name="spazammo" value="[25]" /> 
<setting name="m4ammo" value="[100]" />
<setting name="shotgunammo" value="[25]" />
<setting name="sniperammo" value="[20]" />
<setting name="ak47ammo" value="[120]" />
<setting name="rifleammo" value="[40]" />
<setting name="deserteagleammo" value="[45]" />
<setting name="pistolammo" value="[132]" />
<setting name="uziammo" value="[150]" />
<setting name="tec9ammo" value="[150]" />
<setting name="silencedammo" value="[65]" />
<setting name="grenadeammo" value="[4]" />
<setting name="satchelammo" value="[4]" />
<setting name="teargasammo" value="[4]" />
<setting name="molatovammo" value="[4]" />
</settings>
</meta>
|lang="xml"}}

==Traductores==

*Benxamix2/The Kid
*pekio123

[[Category:Scripting Concepts]]
[[ru:Meta.xml]]
[[en:meta.xml]]

ES/Sobre el archivo "meta.xml"

2011-12-17T19:44:35Z

The Kid:

El archivo ''meta.xml'' presenta un conjunto de datos, como el nombre del resource, los scripts para incluir en el resource, qué archivos enviar a los clientes, entre otras cosas. Es también el ámbito de aplicación de los ''elementos''. Está escrito en XML, que se basa en HTML y es el pariente de XHTML.

=Tags=
XML es un formato de datos de texto que es ampliamente utilizado para la representación de datos. MTA utiliza un lenguaje basado en XML para describir los datos de los recursos mediante el uso de las etiquetas a continuación:

*'''<info />''' Información sobre este ''resource'', los posibles parámetros (que se pueden utilizar y leer con [[getResourceInfo]]) son:
** '''author:''' El autor del'' resource''.
** '''version:''' La versión del ''resource''.
** '''name:''' El nombre del ''resource''.
** '''description:''' La descripción sobre el ''resource''.
** '''type:''' El tipo de ''resource'' (puede ser "gamemode", "script", "map" o "misc").
*'''<script />''' Script. Para para el resource, los atributos pueden ser:
** '''src:''' El nombre del archivo del script.
** '''type:''' El tipo de script: "client" (cliente) o "server" (servidor).
*'''<map />''' El mapa para gamemode, los posibles parámetros son:
**'''src:''' Nombre del archivo '''.map''' (la ruta puede ser, por ejemplo, "mapas/mi-mapa-freeroam.map").
**'''dimension:''' Dimensión en la que el mapa será cargado (opcional).
*'''<file />''' Un archivo de cliente. Generalmente se usan imágenes, archivos '''.txd''', '''.col''', '''.dff''' o archivos '''.xml'''. Estos se cargan por el cliente cuando el archivo está iniciado.
**'''src:''' Nombre del archivo client-side (La ruta puede ser, por ejemplo, "imagenes/imagen.png")
*'''<include />''' Para incluir ''resources'' extras, que se carguen con el '''resource''' que modificas.
**'''resource:''' El nombre del ''resource''.
**'''minversion:''' Versión mínima que el ''resource'' debe tener (opcional).
**'''maxversion:''' Versión máxima que el ''resource'' debe tener (opcional).
*'''<config />''' Configuración del archivo '''.xml''' con el que se puede acceder a los parámetros del resource:
**'''src:''' La ruta del archivo de configuración.
**'''type:''' El tipo de archivo de configuración. Puede ser "client" o "server".
*'''<export />''' Las funciones de esta exportacion para el resource, para otros recursos se pueden utilizar con [[call]]
**'''function:''' El nombre de la función.
**'''type''' El lado de la exportación (cliente o servidor). Los valores válidos son "server" y "client".
**'''http:''' Si la función se usa a través de HTTP. Se puede usar "true" o "false".
*'''<html />'''
**'''src:''' La ruta del archivo.
**'''default:''' The html file is one that is shown by default when visiting /resourceName/ on the server. Only one html can be default, the rest are ignored. (true/false)
**'''raw:''' The html file is not parsed by the LUA interpreter and is treated as binary data. Must be used for binary files (images mainly) (true/false)
*'''<settings> <setting name="" value=""/> </settings>:''' Most gamemodes use [[settings system]] to let server admins to configure it how they like. For instance you could set round time and then use [[get]] and [[set]] to get the value or change it, respectively.
*'''<min_mta_version />''' Minimum version requirements for this resource to run correctly. When authoring resources, the minimum version should usually be set to the current released version of MTA:SA (which at the moment is "{{Current Version|full}}").
**'''client:''' The minimum client version
**'''server:''' The minimum server version

== Example ==
Heres an example of a meta file using some of the tags mentioned:
{{#tag:code |
<meta>
<info author="Slothman" type="gamemode" name="Stealth" />
<config src="help.xml" type="client"/>
<min_mta_version client="{{Current Version|full}}" server="{{Current Version|full}}" />

<script src="stealthmain_server.lua" />
<script src="noiseblip.lua" />
<script src="mission_timer.lua" />
<script src="gadgets_server.lua" />
<script src="gadgets_client.lua" type="client"/>
<script src="stealthmain_client.lua" type="client"/>
<script src="noisebar.lua" type="client"/>
<script src="spycam.lua" type="client"/>

<file src="riot_shield.txd" />
<file src="riot_shield.dff" />
<file src="riot_shield.col" />
<file src="armor.png" />
<file src="camera.png" />
<file src="cloak.png" />
<file src="goggles.png" />
<file src="mine.png" />
<file src="radar.png" />
<file src="shield.png" />

<include resource="scoreboard" />
<include resource="killmessages" />
<include resource="maplimits" />

<settings>
<setting name="roundlimit" value="[6]" /> 
<setting name="teamdamage" value="[1]" /> 
<setting name="teambalance" value="[1]" /> 
<setting name="spazammo" value="[25]" /> 
<setting name="m4ammo" value="[100]" />
<setting name="shotgunammo" value="[25]" />
<setting name="sniperammo" value="[20]" />
<setting name="ak47ammo" value="[120]" />
<setting name="rifleammo" value="[40]" />
<setting name="deserteagleammo" value="[45]" />
<setting name="pistolammo" value="[132]" />
<setting name="uziammo" value="[150]" />
<setting name="tec9ammo" value="[150]" />
<setting name="silencedammo" value="[65]" />
<setting name="grenadeammo" value="[4]" />
<setting name="satchelammo" value="[4]" />
<setting name="teargasammo" value="[4]" />
<setting name="molatovammo" value="[4]" />
</settings>
</meta>
|lang="xml"}}
[[Category:Scripting Concepts]]
[[ru:Meta.xml]]
[[en:meta.xml]]

ES/Sobre el archivo "meta.xml"

2011-12-17T19:43:49Z

The Kid: /* Tags */

El archivo ''meta.xml'' presenta un conjunto de datos, como el nombre del resource, los scripts para incluir en el resource, qué archivos enviar a los clientes, entre otras cosas. Es también el ámbito de aplicación de los ''elementos''. Está escrito en XML, que se basa en HTML y es el pariente de XHTML.

=Tags=
XML es un formato de datos de texto que es ampliamente utilizado para la representación de datos. MTA utiliza un lenguaje basado en XML para describir los datos de los recursos mediante el uso de las etiquetas a continuación:

*'''<info />''' Información sobre este ''resource'', los posibles parámetros (que se pueden utilizar y leer con [[getResourceInfo]]) son:
** '''author:''' El autor del'' resource''.
** '''version:''' La versión del ''resource''.
** '''name:''' El nombre del ''resource''.
** '''description:''' La descripción sobre el ''resource''.
** '''type:''' El tipo de ''resource'' (puede ser "gamemode", "script", "map" o "misc").
*'''<script />''' Script. Para para el resource, los atributos pueden ser:
** '''src:''' El nombre del archivo del script.
** '''type:''' El tipo de script: "client" (cliente) o "server" (servidor).
*'''<map />''' El mapa para gamemode, los posibles parámetros son:
**'''src:''' Nombre del archivo '''.map''' (la ruta puede ser, por ejemplo, "mapas/mi-mapa-freeroam.map").
**'''dimension:''' Dimensión en la que el mapa será cargado (opcional).
*'''<file />''' Un archivo de cliente. Generalmente se usan imágenes, archivos '''.txd''', '''.col''', '''.dff''' o archivos '''.xml'''. Estos se cargan por el cliente cuando el archivo está iniciado.
**'''src:''' Nombre del archivo client-side (La ruta puede ser, por ejemplo, "imagenes/imagen.png")
*'''<include />''' Para incluir ''resources'' extras, que se carguen con el '''resource''' que modificas.
**'''resource:''' El nombre del ''resource''.
**'''minversion:''' Versión mínima que el ''resource'' debe tener (opcional).
**'''maxversion:''' Versión máxima que el ''resource'' debe tener (opcional).
*'''<config />''' Configuración del archivo '''.xml''' con el que se puede acceder a los parámetros del resource:
**'''src:''' La ruta del archivo de configuración.
**'''type:''' El tipo de archivo de configuración. Puede ser "client" o "server".
*'''<export />''' Las funciones de esta exportacion para el resource, para otros recursos se pueden utilizar con [[call]]
**'''function:''' El nombre de la función.
**'''type''' El lado de la exportación (cliente o servidor). Los valores válidos son "server" y "client".
**'''http:''' Si la función se usa a través de HTTP. Se puede usar "true" o "false".
*'''<html />'''
**'''src:''' La ruta del archivo.
**'''default:''' The html file is one that is shown by default when visiting /resourceName/ on the server. Only one html can be default, the rest are ignored. (true/false)
**'''raw:''' The html file is not parsed by the LUA interpreter and is treated as binary data. Must be used for binary files (images mainly) (true/false)
*'''<settings> <setting name="" value=""/> </settings>:''' Most gamemodes use [[settings system]] to let server admins to configure it how they like. For instance you could set round time and then use [[get]] and [[set]] to get the value or change it, respectively.
*'''<min_mta_version />''' Minimum version requirements for this resource to run correctly. When authoring resources, the minimum version should usually be set to the current released version of MTA:SA (which at the moment is "{{Current Version|full}}").
**'''client:''' The minimum client version
**'''server:''' The minimum server version

== Example ==
Heres an example of a meta file using some of the tags mentioned:
{{#tag:code |
<meta>
<info author="Slothman" type="gamemode" name="Stealth" />
<config src="help.xml" type="client"/>
<min_mta_version client="{{Current Version|full}}" server="{{Current Version|full}}" />

<script src="stealthmain_server.lua" />
<script src="noiseblip.lua" />
<script src="mission_timer.lua" />
<script src="gadgets_server.lua" />
<script src="gadgets_client.lua" type="client"/>
<script src="stealthmain_client.lua" type="client"/>
<script src="noisebar.lua" type="client"/>
<script src="spycam.lua" type="client"/>

<file src="riot_shield.txd" />
<file src="riot_shield.dff" />
<file src="riot_shield.col" />
<file src="armor.png" />
<file src="camera.png" />
<file src="cloak.png" />
<file src="goggles.png" />
<file src="mine.png" />
<file src="radar.png" />
<file src="shield.png" />

<include resource="scoreboard" />
<include resource="killmessages" />
<include resource="maplimits" />

<settings>
<setting name="roundlimit" value="[6]" /> 
<setting name="teamdamage" value="[1]" /> 
<setting name="teambalance" value="[1]" /> 
<setting name="spazammo" value="[25]" /> 
<setting name="m4ammo" value="[100]" />
<setting name="shotgunammo" value="[25]" />
<setting name="sniperammo" value="[20]" />
<setting name="ak47ammo" value="[120]" />
<setting name="rifleammo" value="[40]" />
<setting name="deserteagleammo" value="[45]" />
<setting name="pistolammo" value="[132]" />
<setting name="uziammo" value="[150]" />
<setting name="tec9ammo" value="[150]" />
<setting name="silencedammo" value="[65]" />
<setting name="grenadeammo" value="[4]" />
<setting name="satchelammo" value="[4]" />
<setting name="teargasammo" value="[4]" />
<setting name="molatovammo" value="[4]" />
</settings>
</meta>
|lang="xml"}}
[[Category:Scripting Concepts]]
[[ru:Meta.xml]]
[[es:Sobre el archivo "meta.xml"]]

ES/Sobre el archivo "meta.xml"

2011-12-17T19:43:07Z

The Kid: MUCHOS errores ortográficos corregidos.

El archivo ''meta.xml'' presenta un conjunto de datos, como el nombre del resource, los scripts para incluir en el resource, qué archivos enviar a los clientes, entre otras cosas. Es también el ámbito de aplicación de los ''elementos''. Está escrito en XML, que se basa en HTML y es el pariente de XHTML.

=Tags=
XML es un formato de datos de texto que es ampliamente utilizado para la representación de datos. MTA utiliza un lenguaje basado en XML para describir los datos de los recursos mediante el uso de las etiquetas a continuación:

*'''<info />''' Información sobre este recource, posibles parámetros incluidos (Los parámetros arbitrarios se pueden utilizar y leer con [[getResourceInfo]]):
** '''author:''' El autor del'' resource''.
** '''version:''' La versión del ''resource''.
** '''name:''' El nombre del ''resource''.
** '''description:''' La descripción sobre el ''resource''.
** '''type:''' El tipo de ''resource'' (puede ser "gamemode", "script", "map" o "misc").
*'''<script />''' Script. Para para el resource, los atributos pueden ser:
** '''src:''' El nombre del archivo del script.
** '''type:''' El tipo de script: "client" (cliente) o "server" (servidor).
*'''<map />''' El mapa para gamemode, los posibles parámetros son:
**'''src:''' Nombre del archivo '''.map''' (la ruta puede ser, por ejemplo, "mapas/mi-mapa-freeroam.map").
**'''dimension:''' Dimensión en la que el mapa será cargado (opcional).
*'''<file />''' Un archivo de cliente. Generalmente se usan imágenes, archivos '''.txd''', '''.col''', '''.dff''' o archivos '''.xml'''. Estos se cargan por el cliente cuando el archivo está iniciado.
**'''src:''' Nombre del archivo client-side (La ruta puede ser, por ejemplo, "imagenes/imagen.png")
*'''<include />''' Para incluir ''resources'' extras, que se carguen con el '''resource''' que modificas.
**'''resource:''' El nombre del ''resource''.
**'''minversion:''' Versión mínima que el ''resource'' debe tener (opcional).
**'''maxversion:''' Versión máxima que el ''resource'' debe tener (opcional).
*'''<config />''' Configuración del archivo '''.xml''' con el que se puede acceder a los parámetros del resource:
**'''src:''' La ruta del archivo de configuración.
**'''type:''' El tipo de archivo de configuración. Puede ser "client" o "server".
*'''<export />''' Las funciones de esta exportacion para el resource, para otros recursos se pueden utilizar con [[call]]
**'''function:''' El nombre de la función.
**'''type''' El lado de la exportación (cliente o servidor). Los valores válidos son "server" y "client".
**'''http:''' Si la función se usa a través de HTTP. Se puede usar "true" o "false".
*'''<html />'''
**'''src:''' La ruta del archivo.
**'''default:''' The html file is one that is shown by default when visiting /resourceName/ on the server. Only one html can be default, the rest are ignored. (true/false)
**'''raw:''' The html file is not parsed by the LUA interpreter and is treated as binary data. Must be used for binary files (images mainly) (true/false)
*'''<settings> <setting name="" value=""/> </settings>:''' Most gamemodes use [[settings system]] to let server admins to configure it how they like. For instance you could set round time and then use [[get]] and [[set]] to get the value or change it, respectively.
*'''<min_mta_version />''' Minimum version requirements for this resource to run correctly. When authoring resources, the minimum version should usually be set to the current released version of MTA:SA (which at the moment is "{{Current Version|full}}").
**'''client:''' The minimum client version
**'''server:''' The minimum server version

== Example ==
Heres an example of a meta file using some of the tags mentioned:
{{#tag:code |
<meta>
<info author="Slothman" type="gamemode" name="Stealth" />
<config src="help.xml" type="client"/>
<min_mta_version client="{{Current Version|full}}" server="{{Current Version|full}}" />

<script src="stealthmain_server.lua" />
<script src="noiseblip.lua" />
<script src="mission_timer.lua" />
<script src="gadgets_server.lua" />
<script src="gadgets_client.lua" type="client"/>
<script src="stealthmain_client.lua" type="client"/>
<script src="noisebar.lua" type="client"/>
<script src="spycam.lua" type="client"/>

<file src="riot_shield.txd" />
<file src="riot_shield.dff" />
<file src="riot_shield.col" />
<file src="armor.png" />
<file src="camera.png" />
<file src="cloak.png" />
<file src="goggles.png" />
<file src="mine.png" />
<file src="radar.png" />
<file src="shield.png" />

<include resource="scoreboard" />
<include resource="killmessages" />
<include resource="maplimits" />

<settings>
<setting name="roundlimit" value="[6]" /> 
<setting name="teamdamage" value="[1]" /> 
<setting name="teambalance" value="[1]" /> 
<setting name="spazammo" value="[25]" /> 
<setting name="m4ammo" value="[100]" />
<setting name="shotgunammo" value="[25]" />
<setting name="sniperammo" value="[20]" />
<setting name="ak47ammo" value="[120]" />
<setting name="rifleammo" value="[40]" />
<setting name="deserteagleammo" value="[45]" />
<setting name="pistolammo" value="[132]" />
<setting name="uziammo" value="[150]" />
<setting name="tec9ammo" value="[150]" />
<setting name="silencedammo" value="[65]" />
<setting name="grenadeammo" value="[4]" />
<setting name="satchelammo" value="[4]" />
<setting name="teargasammo" value="[4]" />
<setting name="molatovammo" value="[4]" />
</settings>
</meta>
|lang="xml"}}
[[Category:Scripting Concepts]]
[[ru:Meta.xml]]
[[es:Sobre el archivo "meta.xml"]]

ES/Resources

2011-12-11T19:45:55Z

The Kid:

Los '''resources''' son una parte clave de MTA. Un resource es básicamente una carpeta o archivo ''.zip'' (carpeta comprimida) que contiene una colección de archivos de script ''.lua'', además de un archivo ''meta'' que describe cómo el resource debe ser cargado. Un resource puede ser comparado con un programa que se ejecuta en un sistema operativo; que puede ser iniciado y detenido, y se pueden ejecutar varios de ellos al mismo tiempo. Es necesario recordar, sin embargo, que a diferencia de los programas en un sistema operativo, no hay multitarea entre los resources.

== Terminología ==

*'''Resource''' - Un archivo ''.zip'' o carpeta que contiene un archivo '''meta.xml''' y una serie de archivos. Estos se colocan en la carpeta de instalación de MTA San Andreas, en "MTA San Andreas/server/mods/deathmatch/resources/''.

*'''Item de resource''' - Un archivo contenido dentro de un resource. Puede ser un mapa, un archivo de música, una imagen, etc.

== El archivo meta.xml ==

El archivo ''meta.xml'' es el núcleo de cada resource. En él se describe exactamente los archivos que el resource debe utilizar y cómo debe hacerlo. El siguiente es un ejemplo que cubre todas las opciones que hay, los archivos de metadatos puede tener tantas o tan pocas de estas etiquetas como tú quieras:

<syntaxhighlight lang="xml">
<meta>
<info author="eAi" description="Ejemplo básico de script" version="4"/>

<include resource="radarblips"/>
<include resource="markermanagement" />

<script src="ctf.lua" />
<script src="flag.lua" />
<script src="ctf_client.lua" type="client" />

<file src="model.dff" />
<file src="quitbutton.png" />
<file src="texture.txd" />

<html src="test.htm" default="true"/>
<html src="logo.png" raw="true" />

<export function="multiply" http="true" />
<export function="getPlayerList" />
<export function="getElementOwner" type="client"/>

<config src="vehicle-list.xml" type="client" />
<config src="markerconfig.xml" type="server" />

<map src="somestuff.map" dimension="99" />
</meta>
</syntaxhighlight>

Mientras que un mapa de CTF, por ejemplo, puede tener un meta.xml parecido a esto:
<syntaxhighlight lang="xml">
<meta>
<include resource="ctf" />
<map src="myuberl33tctfmap.map" />

<info author="Tom" instructions="this is uber l33t !!!!!1111111" type="map" />
</meta>
</syntaxhighlight>

Los atributos Script/type, Config/type y File/type especifican si el script/resource se debe enviar a los clientes o no, este valor por defecto es "server".

Las etiquetas incluyen especificaciones como resources que se deben iniciar antes de un resource se ha iniciado.
Por ejemplo, si su resource tiene dependencia a otro, puede incluirlo en meta.xml para que el resource, al que el suyo depende, se inicie primero.

Cada resource tiene su propia máquina virtual (VM). Esta contiene todos los scripts en el resource. Esto significa que las variables no se comparten con otros resources. La mejor manera de comunicarte con otros resources es mediante las etiquetas de ''exportación'' y exportar una función. Esto permitira que otros resources puedan activar esa funcion con el comando de scripting [[call]]

Los scripts se envían a los clientes para que se inicien tan pronto como hayan sido descargados.

Los scripts son capaces que se pueden leer y escribir en su propia carpeta de resources con funciones tales como [[xmlCreateFile]] y [[fileCreate]]. También pueden leer y escribir dentro de otros resources, pero debe tener permisos de [[Access_Control_List | ACL]].

Cada resource sólo puede ser cargado una vez, el servidor se asegura de esto. Si un resources se incluye más de una vez, la misma instancia será utilizada por cada resource que incluya.

== Archivos almacenados ==
Los archivos ''Resources'' pueden ser almacenados en un .zip o un directorio. Se encuentran en:

server/mods/deathmatch/resources/ (Si tienes el server instalado con el cliente)

o

mods/deathmatch/resources/ (para server dedicados)

Cada resource puede ser un archivo ZIP, un directorio o ambos. En el último caso, el directorio tiene preferencia sobre el archivo ZIP, así, los archivos pueden ser puestos en directorios para pasar por encima de los archivos dentro del archivo ZIP. Esto permite que los directorios sean usados para pruebas y desarrollo de mapas/scripts y los archivos ZIP sean usados por los usuarios finales.

==Otras cosas a notar==
*Los nombres de los resources no pueden contener puntos, espacios o caracteres raros como "?", "$" o "%".
*Si el resource guarda algún archivo, éstos no deben aparecer en el archivo ''meta.xml''.
*Los archivos mostrados en ''meta.xml'' sólo deberían ser leídos por tus scripts. No los modifiques con [[xmlSaveFile]], [[FileSave]], etc.
*Cuando hagas la versión ZIP de tu resource, no incluyas archivos de guardado. Si tu resource los usa, que los cree cuando sea necesario.

==Véase También==
===Funciones===
Actualmente, los resources pueden ser manipulados por medio de scripts. Más abajo se muestran las funciones correspondientes:
{{Resource functions}}

===Eventos===
Los siguientes eventos también están ligados a los resources:
{{Resource_events}}

[[en:Resources]]
[[it:Introduzione alle Risorse]]
[[ru:Resources]]

==Traductores==

*Kzman
*F4ST3R
*Benxamix2/The Kid

GuiComboBoxGetSelected

2011-12-05T19:48:05Z

The Kid:

{{Needs Example}}
{{Client function}}
__NOTOC__
This function returns the index of the selected combobox item.

==Syntax==
<syntaxhighlight lang="lua">
int guiComboBoxGetSelected ( element comboBox )
</syntaxhighlight>

===Required Arguments===
*'''comboBox:''' the combobox you want to know the selected item index of

===Returns===
Returns the index of the selected item if the specified combobox is valid and has a selected item, ''-1'' if no item is selected, ''false'' or ''nil'' otherwise.

==Example==
<syntaxhighlight lang="lua">
--Todo..
</syntaxhighlight>

==See Also==
{{GUI functions}}

SetElementCollidableWith

2011-11-17T18:56:33Z

The Kid:

{{Client function}}
{{Needs Example}}
__NOTOC__
This function can be used to set an element to collide with another element. An element with collisions disabled does not interact physically with the other element.<br>
'''Note:''' You can only use this function with the element types listed below.
*[[Player]]
*[[Ped]]
*[[Vehicle]]
*[[Object]]

==Syntax==
<syntaxhighlight lang="lua">
bool setElementCollidableWith ( element theElement, element withElement, bool enabled )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The [[element]] which colliding you want to change
*'''withElement:''' The other [[element]] you wish the first entity to collide with
*'''enabled:''' A boolean to indicate whether elements should be able to collide with eachother (''true'') or not (''false'')

===Returns===
Returns ''true'' if the collisions were set succesfully, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
-- TODO
</syntaxhighlight>
</section>

==See Also==
{{Client element functions}}

User talk:X86dev

2011-11-16T19:11:05Z

The Kid:

Cmon x86, not all scripters knew that about setGameSpeed. Why to delete it? Was it specified somewhere else or what? --[[User:The Kid|Benxamix2]] 20:10, 16 November 2011 (CET)

User talk:X86dev

2011-11-16T19:10:18Z

The Kid: Created page with "Cmon x86, not all scripters knew that about setGameSpeed. Why to delete it? --~~~~"

Cmon x86, not all scripters knew that about setGameSpeed. Why to delete it? --[[User:The Kid|Benxamix2]] 20:10, 16 November 2011 (CET)

SpawnPlayer

2011-11-16T19:09:24Z

The Kid: grammar fix

__NOTOC__
{{Server function}}
This function spawns the player at an arbitary point on the map.<br>

'''''Note:''' [[setCameraTarget]] must be used to focus on the player. Also, all players have their camera initially faded out after connect. To ensure that the camera is faded in, please do a [[fadeCamera]] after.''

==Syntax==
<syntaxhighlight lang="lua">
bool spawnPlayer ( player thePlayer, float x, float y, float z, [ int rotation = 0, int skinID = 0, int interior = 0, int dimension = 0, team theTeam = nil ] )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player you want to spawn.
*'''x:''' The x co-ordinate to spawn the player at.
*'''y:''' The y co-ordinate to spawn the player at.
*'''z:''' The z co-ordinate to spawn the player at.

===Optional Arguments===
*'''rotation:''' rotation of the player on spawn.
*'''skinID:''' player's skin on spawn.
*'''interior:''' interior the player will spawn into.
*'''dimension:''' The ID of the [[dimension]] that the player should be in.
*'''theTeam:''' the team the player will join.

===Returns===
Returns ''true'' if the player was spawned successfully, ''false'' otherwise.

==Example==
This example spawns all the players in the middle of the game map.
<syntaxhighlight lang="lua">
-- Get a table of all the players
players = getElementsByType ( "player" )
-- Go through every player
for playerKey, playerValue in ipairs(players) do
-- Spawn them at the desired coordinates
spawnPlayer ( playerValue, 0.0, 0.0, 5.0, 90.0, 0 )
end
</syntaxhighlight>

This example spawns a player when he logs in.
<syntaxhighlight lang="lua">
spawnTeam = createTeam ("Teamname", 255, 0, 0) -- Create team to spawn.
function spawnOnLogin (prevA, curA, autoLogin)
outputChatBox ("Welcome to ...", source, 255, 0, 0, false)
spawnPlayer (source, 0, 0, 5, 0, math.random (0,288), 0, 0, spawnTeam) -- spawns player with random skin
fadeCamera (source, true)
setCameraTarget (source, source)
end
addEventHandler("onPlayerLogin", getRootElement(), spawnOnLogin)
</syntaxhighlight>

==See Also==
{{Player_functions}}
[[ru:spawnPlayer]]

SetGameSpeed

2011-11-16T17:23:02Z

The Kid: About client and server properties.

__NOTOC__
{{Server client function}}
{{Note box|Server function set all players' game speed. Client sets local player's game speed only.}}
This function sets the game speed to the given value.

==Syntax==
<syntaxhighlight lang="lua">bool setGameSpeed ( float value )</syntaxhighlight>

===Required Arguments===
*'''value''': The float value of the game speed (Range 0 - 10)

===Returns===
Returns ''true'' if the gamespeed was set successfully, ''false'' otherwise.
The normal game speed is '1'.

==Example==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
addCommandHandler("setgamespeed",
function(sourcePlayer, command, value)
setGameSpeed(tonumber(value))
end
)
</syntaxhighlight>
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
addCommandHandler("setgamespeed",
function(command, value)
setGameSpeed(tonumber(value))
end
)
</syntaxhighlight>
</section>

==See Also==
{{World functions}}

[[ru:setGameSpeed]]

User:Winky-

2011-11-16T16:43:09Z

The Kid: About Winky

Great wiki contributor.
He created the new wiki concept, added icons to the templates, and updated many wiki pages to fit their categories.

ES/setAccountData

2011-11-15T20:35:00Z

The Kid:

{{Server function}}
__NOTOC__
{{Note_box|Es fuertemente recomendado que uses como estándar ''módulo.clave'' para nombrar a tus claves, como se muestra en el ejemplo más abajo. Esto previene contradicciones con otros scripts.}}
Esta función establece un string para ser guardado en una cuenta. Esta información puede ser obtenida luego, usando la función [[getAccountData]]. Los datos guardados en las cuentas (''account data'') son persistentes a través de sesiones de usuario y cambios de mapa, a menos que los usuarios estén logueados en una cuenta de invitado (''guest account''). Incluso si están logueados en la cuenta de invitado, los datos de cuenta pueden ser útiles como una vía para guardar referencia de tu propio sistema de cuentas, sin embargo sus usos son equivalentes al de [[setElementData]] en el jugador.

==Sintax==
<syntaxhighlight lang="lua">
bool setAccountData ( account laCuenta, string clave, string valor )
</syntaxhighlight>

===Argumentos Requeridos===
*'''laCuenta:''' La cuenta desde la cual deseas recobrar los datos.
*'''clave:''' La clave en la que deseas almacenar la información.
*'''valor:''' El valor que desees guardar.

===Regresa===
Regresa ''true'' si los datos fueron establecidos en la cuenta, ''false'' si se especificaron argumentos inválidos.

==Ejemplo==
Para un tipo de juego roleplay pirata, la cantidad de dinero que un jugador posee se mantendrá almacenada guardándola en su cuenta. Se debe notar que el codigo usa ''piraterpg.money'' como la clave en lugar de sólo "money", dado que el jugador podría estar participando en otros tipos de juego que también guardan su cantidad de dinero en las cuentas. Si ambos tipos de juego usaran "money" como la clave, cada uno estaría sobre-escribiendo en los datos del otro.
<syntaxhighlight lang="lua">
function onPlayerQuit ( )
-- cuando un jugador sale, se guarda su cantidad de dinero actual en un dato de cuenta
local cuentaDelJugador = getPlayerAccount ( source )
if ( cuentaDelJugador ) and not isGuestAccount ( cuentaDelJugador ) then -- si el jugador estaba logueado
local dineroDelJugador = getPlayerMoney ( source ) -- obtener el dinero del jugador
setAccountData ( cuentaDelJugador, "piraterpg.money", dineroDelJugador ) -- guardar la cantidad en la cuenta del jugador
end
end

function onPlayerLogin (_, cuentaDelJugador )
-- cuando un jugador logea, se obtiene la cantidad su dinero desde los datos de cuenta y se le da al jugador el dinero
if ( cuentaDelJugador ) then
local dineroDelJugador = getAccountData ( cuentaDelJugador, "piraterpg.money" )
-- hay que estar seguros si de hecho habia un valor guardado bajo esta clave (verificar si dineroDelJugador no es false).
-- Esto seria por ejemplo si es la primera vez que el jugador juega este tipo de juego
if ( dineroDelJugador ) then
setPlayerMoney ( source, dineroDelJugador )
end
end
end

addEventHandler ( "onPlayerQuit", getRootElement ( ), onPlayerQuit )
addEventHandler ( "onPlayerLogin", getRootElement ( ), onPlayerLogin)
</syntaxhighlight>

==Vease tambien==
{{Account_functions}}

SetAccountData

2011-11-15T20:31:16Z

The Kid:

{{Server function}}
__NOTOC__
{{Note_box|It is strongly recommended that you use the standard ''module.key'' naming for your keys, as shown in the example below. This prevents collisions between different scripts.}}
This function sets a string to be stored in an account. This can then be retrieved using [[getAccountData]]. Data stored as account data is persistent across user's sessions and maps, unless they are logged into a guest account. Even if logged into a guest account, account data can be useful as a way to store a reference to your own account system, though it's persistence is equivalent to that of using [[setElementData]] on the player's element.

==Syntax==
<syntaxhighlight lang="lua">
bool setAccountData ( account theAccount, string key, string value )
</syntaxhighlight>

===Required Arguments===
*'''theAccount:''' The account you wish to retrieve the data from.
*'''key:''' The key under which you wish to store the data
*'''value:''' The value you wish to store. '''NOTE:''' you cannot store tables as values, but you can use [[toJSON]] strings.

===Returns===
Returns a ''true'' if the account data was set, ''false'' if an invalid argument was specified.

==Example==
For a pirate roleplaying gametype, the amount of money a player has is made persistent by storing it in his account. Note the code uses "piraterpg.money" as key instead of just "money", as the player may be participating in other gametypes that also save his money amount to his account. If both gametypes would use "money" as the account key, they'd overwrite each other's data.
<syntaxhighlight lang="lua">
function onPlayerQuit ( )
-- when a player leaves, store his current money amount in his account data
local playeraccount = getPlayerAccount ( source )
if ( playeraccount ) and not isGuestAccount ( playeraccount ) then -- if the player is logged in
local playermoney = getPlayerMoney ( source ) -- get the player money
setAccountData ( playeraccount, "piraterpg.money", playermoney ) -- save it in his account
end
end

function onPlayerLogin (_, playeraccount )
-- when a player logins, retrieve his money amount from his account data and set it
if ( playeraccount ) then
local playermoney = getAccountData ( playeraccount, "piraterpg.money" )
-- make sure there was actually a value saved under this key (check if playermoney is not false).
-- this will for example not be the case when a player plays the gametype for the first time
if ( playermoney ) then
setPlayerMoney ( source, playermoney )
end
end
end

addEventHandler ( "onPlayerQuit", getRootElement ( ), onPlayerQuit )
addEventHandler ( "onPlayerLogin", getRootElement ( ), onPlayerLogin)
</syntaxhighlight>

==See Also==
{{Account_functions}}

[[es:setAccountData]]

SetAccountData

2011-11-15T20:29:59Z

The Kid: added helpful note

{{Server function}}
__NOTOC__
{{Note_box|It is strongly recommended that you use the standard ''module.key'' naming for your keys, as shown in the example below. This prevents collisions between different scripts.}}
This function sets a string to be stored in an account. This can then be retrieved using [[getAccountData]]. Data stored as account data is persistent across user's sessions and maps, unless they are logged into a guest account. Even if logged into a guest account, account data can be useful as a way to store a reference to your own account system, though it's persistence is equivalent to that of using [[setElementData]] on the player's element.

==Syntax==
<syntaxhighlight lang="lua">
bool setAccountData ( account theAccount, string key, string value )
</syntaxhighlight>

===Required Arguments===
*'''theAccount:''' The account you wish to retrieve the data from.
*'''key:''' The key under which you wish to store the data
*'''value:''' The value you wish to store.

'''NOTE:''' "value" cannot be a table.

===Returns===
Returns a ''true'' if the account data was set, ''false'' if an invalid argument was specified.

==Example==
For a pirate roleplaying gametype, the amount of money a player has is made persistent by storing it in his account. Note the code uses "piraterpg.money" as key instead of just "money", as the player may be participating in other gametypes that also save his money amount to his account. If both gametypes would use "money" as the account key, they'd overwrite each other's data.
<syntaxhighlight lang="lua">
function onPlayerQuit ( )
-- when a player leaves, store his current money amount in his account data
local playeraccount = getPlayerAccount ( source )
if ( playeraccount ) and not isGuestAccount ( playeraccount ) then -- if the player is logged in
local playermoney = getPlayerMoney ( source ) -- get the player money
setAccountData ( playeraccount, "piraterpg.money", playermoney ) -- save it in his account
end
end

function onPlayerLogin (_, playeraccount )
-- when a player logins, retrieve his money amount from his account data and set it
if ( playeraccount ) then
local playermoney = getAccountData ( playeraccount, "piraterpg.money" )
-- make sure there was actually a value saved under this key (check if playermoney is not false).
-- this will for example not be the case when a player plays the gametype for the first time
if ( playermoney ) then
setPlayerMoney ( source, playermoney )
end
end
end

addEventHandler ( "onPlayerQuit", getRootElement ( ), onPlayerQuit )
addEventHandler ( "onPlayerLogin", getRootElement ( ), onPlayerLogin)
</syntaxhighlight>

==See Also==
{{Account_functions}}

[[es:setAccountData]]

User talk:The Kid

2011-11-15T12:42:59Z

The Kid:

Don't add section blocks if it's the same side as the function (i.e. look at my redos). --[[User:X86dev|X86dev]] 11:55, 15 November 2011 (CET)

So if a function is server-only or client-only, no section blocks? Okay --[[User:The Kid|Benxamix2]] 13:42, 15 November 2011 (CET)

User talk:The Kid

2011-11-15T12:42:37Z

The Kid:

Don't add section blocks if it's the same side as the function (i.e. look at my redos). --[[User:X86dev|X86dev]] 11:55, 15 November 2011 (CET)

So if a function is server-only, no section blocks? Okay --[[User:The Kid|Benxamix2]] 13:42, 15 November 2011 (CET)

OnClientPlayerVehicleExit

2011-11-15T00:04:11Z

The Kid: Needs Example

[[Category:Incomplete Event]]
{{Client event}}
{{Needs Example}}
__NOTOC__
This event is triggered when a player exits a vehicle.

==Parameters==
<syntaxhighlight lang="lua">
vehicle theVehicle, int seat
</syntaxhighlight>
*'''theVehicle:''' the vehicle that the player exited.
*'''seat:''' the number of the seat that the player was sitting on.

==Source==
The source of this event is the [[player]] that exited the vehicle.

==Example==
<syntaxhighlight lang="lua">
--TODO
</syntaxhighlight>

==See Also==
===Client player events===
{{Client_player_events}}
===Client event functions===
{{Client_event_functions}}

OnClientPlayerVehicleEnter

2011-11-15T00:03:40Z

The Kid: Needs Example

{{Client event}}
{{Needs Example}}
__NOTOC__
This event is fired when a player enters a vehicle.

==Parameters==
<syntaxhighlight lang="lua">
vehicle theVehicle, int seat
</syntaxhighlight>
*'''vehicle:''' the vehicle that the player entered
*'''seat:''' the seat that the player now is on. Driver's seat = 0, higher numbers are passenger seats.

==Source==
The source of this event is the player that entered the vehicle.

==Example==

<syntaxhighlight lang="lua">
--TODO
</syntaxhighlight>

==See Also==
===Client player events===
{{Client_player_events}}
===Client event functions===
{{Client_event_functions}}

GivePlayerMoney

2011-11-14T23:34:47Z

The Kid: fixed grammar

__NOTOC__
{{Server client function}}
This function adds money to a [[player]]'s current money amount. To set absolute values, [[setPlayerMoney]] can be used.<br>
'''Note:''' Using this function client side (not recommended) will not change a players money server side.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">bool givePlayerMoney ( player thePlayer, int amount )</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' the [[player]] you are giving the money to.
*'''amount:''' a positive integer number specifying the amount of money to give to the player.
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">bool givePlayerMoney ( int amount )</syntaxhighlight>

===Required Arguments===
*'''amount:''' a positive integer number specifying the amount of money to give to the player.
</section>

===Returns===
Returns ''true'' if the money was added, or ''false'' if invalid parameters were passed.

==Example==
<section show="true" name="Example 1 - Client and Server" class="server">
This example gives a player money when using "givecash" command.
<syntaxhighlight lang="lua">
function consoleGiveCash ( thePlayer, command, amount ) --when the givecash command is called
givePlayerMoney ( thePlayer, amount ) --give the player money according to the amount
end
addCommandHandler ( "givecash", consoleGiveCash ) --add a handler function for the command "givecash"
</syntaxhighlight>
</section>

<section show="true" name="Example 2 - Server" class="server">
This example gives a player one thousand dollars, as a reward for killing another player.
<syntaxhighlight lang="lua">
function rewardOnWasted ( ammo, killer, killerweapon, bodypart )
--if there is a killer, and that killer is not the same person as whoever died
if ( killer ) and ( killer ~= source ) then
givePlayerMoney ( killer, 1000 ) --reward the killer with 1000 cash.
end
end
addEventHandler ( "onPlayerWasted", getRootElement(), rewardOnWasted ) --attach the rewardOnWasted function to the relevant event.
</syntaxhighlight>
</section>

==See Also==
{{Player functions}}

GivePlayerMoney

2011-11-14T23:34:18Z

The Kid:

__NOTOC__
{{Server client function}}
This function adds money to a [[player]]'s current money amount. To set absolute values, [[setPlayerMoney]] can be used.<br>
'''Note:''' Using this function client side (not recommended) will not change a players money server side.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">bool givePlayerMoney ( player thePlayer, int amount )</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' the [[player]] to whom you are giving the money.
*'''amount:''' a positive integer number specifying the amount of money to give to the player.
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">bool givePlayerMoney ( int amount )</syntaxhighlight>

===Required Arguments===
*'''amount:''' a positive integer number specifying the amount of money to give to the player.
</section>

===Returns===
Returns ''true'' if the money was added, or ''false'' if invalid parameters were passed.

==Example==
<section show="true" name="Example 1 - Client and Server" class="server">
This example gives a player money when using "givecash" command.
<syntaxhighlight lang="lua">
function consoleGiveCash ( thePlayer, command, amount ) --when the givecash command is called
givePlayerMoney ( thePlayer, amount ) --give the player money according to the amount
end
addCommandHandler ( "givecash", consoleGiveCash ) --add a handler function for the command "givecash"
</syntaxhighlight>
</section>

<section show="true" name="Example 2 - Server" class="server">
This example gives a player one thousand dollars, as a reward for killing another player.
<syntaxhighlight lang="lua">
function rewardOnWasted ( ammo, killer, killerweapon, bodypart )
--if there is a killer, and that killer is not the same person as whoever died
if ( killer ) and ( killer ~= source ) then
givePlayerMoney ( killer, 1000 ) --reward the killer with 1000 cash.
end
end
addEventHandler ( "onPlayerWasted", getRootElement(), rewardOnWasted ) --attach the rewardOnWasted function to the relevant event.
</syntaxhighlight>
</section>

==See Also==
{{Player functions}}

SetPlayerMoney

2011-11-14T23:29:20Z

The Kid:

__NOTOC__
{{Server client function}}
Sets a player's money to a certain value, regardless of current player money. It should be noted that setting negative values does not work and in fact gives the player large amounts of money.

'''Note:''' Using this function client side (not recommended) will not change a players money server side.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool setPlayerMoney ( player thePlayer, int amount ) </syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' Which player to set the money of.
*'''amount:''' A whole integer specifying the new amount of money the player will have.
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
bool setPlayerMoney ( int amount ) </syntaxhighlight>

===Required Arguments===
*'''amount:''' A whole integer specifying the new amount of money the local player will have.
</section>

===Returns===
Returns ''true'' if the money was added, or ''false'' if invalid parameters were passed.

==Example==
'''Example 1:''' This example sets the player's money to the desired amount when he types "setcash" in console.
<syntaxhighlight lang="lua">
function setCash ( thePlayer, command, amount ) -- when the setcash function is called
setPlayerMoney ( thePlayer, tonumber(amount) ) -- change player's money to the desired amount
end
addCommandHandler ( "setcash", setCash ) -- add a command handler for setcash
</syntaxhighlight>
'''Example 2:''' This gives all players the amount of 1337 money when "leet" is typed in console.
<syntaxhighlight lang="lua">
function leetmoney()
setPlayerMoney( getRootElement(), 1337 )
end
addCommandHandler("leet", leetmoney)
</syntaxhighlight>

==See Also==
{{Player functions}}

SetPlayerMoney

2011-11-14T23:29:08Z

The Kid: Minor update; grammar.

__NOTOC__
{{Server client function}}
Sets a player's money to a certain value, regardless of current player money. It should be noted that setting negative values does not work and in fact gives the player large amounts of money.

'''Note:''' Using this function client side (not recommended) will not change a players money server side.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool setPlayerMoney ( player thePlayer, int amount ) </syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' Which player to set the money of
*'''amount:''' A whole integer specifying the new amount of money the player will have.
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
bool setPlayerMoney ( int amount ) </syntaxhighlight>

===Required Arguments===
*'''amount:''' A whole integer specifying the new amount of money the local player will have.
</section>

===Returns===
Returns ''true'' if the money was added, or ''false'' if invalid parameters were passed.

==Example==
'''Example 1:''' This example sets the player's money to the desired amount when he types "setcash" in console.
<syntaxhighlight lang="lua">
function setCash ( thePlayer, command, amount ) -- when the setcash function is called
setPlayerMoney ( thePlayer, tonumber(amount) ) -- change player's money to the desired amount
end
addCommandHandler ( "setcash", setCash ) -- add a command handler for setcash
</syntaxhighlight>
'''Example 2:''' This gives all players the amount of 1337 money when "leet" is typed in console.
<syntaxhighlight lang="lua">
function leetmoney()
setPlayerMoney( getRootElement(), 1337 )
end
addCommandHandler("leet", leetmoney)
</syntaxhighlight>

==See Also==
{{Player functions}}

GetPlayerMoney

2011-11-14T23:28:31Z

The Kid: Fixed client syntax, added sections

__NOTOC__
{{Server client function}}
Returns the amount of money a player currently has.

==Syntax==
<section show="true" name="Server" class="server">
<syntaxhighlight lang="lua">int/bool getPlayerMoney ( player thePlayer )</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player you wish the retrieve the amount of money from.

===Returns===
Returns an integer with the amount of money the specified player has, ''false'' if the player is invalid.
</section>

<section show="true" name="Client" class="client">
<syntaxhighlight lang="lua">int getPlayerMoney ( )</syntaxhighlight>

===Returns===
Returns an integer with the amount of money the local player has.
</section>

==Example==
<section show="true" name="Server" class="server">
When a player types '/checkMoney' this example retrieves the player's money and outputs a message according to the value.
<syntaxhighlight lang="lua">
function checkMoney(thePlayer, command)
local money = getPlayerMoney(thePlayer) -- get the amount of money from the player who entered the command
if (money > 1000) then -- if money is more than 1000
outputChatBox("You are rich: " .. tostring(money), thePlayer) -- output this message together with the money
else
outputChatBox("Poor guy...", thePlayer) -- and else, output this message
end
end
addCommandHandler("checkMoney", checkMoney) -- add the console command
</syntaxhighlight>
</section>

==See Also==
{{Player functions}}

GetPlayerCount

2011-11-14T22:29:31Z

The Kid: Syntax section

{{Server function}}
__NOTOC__
This function returns the number of players currently connected to the server.

Note: #getElementsByType("player") works the same as this function but also works client side unlike this function.

==Syntax==
<section show="true" name="Server" class="server">
<syntaxhighlight lang="lua">
int getPlayerCount ( )
</syntaxhighlight>

===Returns===
Returns the number of players connected to the server as an [[int]].
</section>

==Example==
<section show="true" name="Server" class="server">
This example displays a chat message with the number of players connected to the server when a player joins or quits.
<syntaxhighlight lang="lua">
function playerCount ( )
outputChatBox ( "There are now " .. getPlayerCount() .. " players on this server!" )
end
addEventHandler ( "onPlayerJoin", getRootElement(), playerCount )
addEventHandler ( "onPlayerQuit", getRootElement(), playerCount )
</syntaxhighlight>
</section>

==See Also==
{{Player functions}}

GetPlayerAnnounceValue

2011-11-14T22:29:05Z

The Kid: Syntax section

__NOTOC__
{{Server function}}
This function retrieves a players ASE announce value under a certain key.

==Syntax==
<section show="true" name="Server" class="server">
<syntaxhighlight lang="lua">string getPlayerAnnounceValue ( element thePlayer, string key )</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' This is the [[Player]] whos value you want to retrieve.
*'''key:''' The name of the key.

===Returns===
This function returns a ''string'' containing the requested value if a valid key was specified or ''false'' otherwise.
</section>

==Example==
<section show="true" name="Server" class="server">
This example adds a command named "getscore" which outputs a players "score" value to his chatbox.
<syntaxhighlight lang="lua">function getScore ( playerSource, cmdName )
local scoreValue = getPlayerAnnounceValue ( playerSource, "score" )
if ( scoreValue ) then
outputChatBox ( "Your score: "..scoreValue, playerSource )
end
end

addCommandHandler ( "getscore", getScore )
</syntaxhighlight>
</section>

==See Also==
{{Player functions}}

GetDeadPlayers

2011-11-14T22:28:49Z

The Kid: Syntax section

{{Server function}}
__NOTOC__
This function returns a table of all currently dead players on the server.

==Syntax==
<section show="true" name="Server" class="server">
<syntaxhighlight lang="lua">
table getDeadPlayers()
</syntaxhighlight>

===Returns===
Returns a table of all the dead players.
</section>

==Example==
<section show="true" name="Server" class="server">
This example prints the list of dead players to the chat box.
<syntaxhighlight lang="lua">
-- Print a list of all the dead players
deadPlayers = getDeadPlayers ()
if ( deadPlayers ) then -- if we got the table
deadPlayersList = "none"
-- Loop through the table
for playerKey, playerValue in deadPlayers do
-- add their name to the list
if ( deadPlayersList == "none" ) then
deadPlayersList = getPlayerName ( playerValue )
else
deadPlayersList = deadPlayersList .. ", " .. getPlayerName ( playerValue )
end
end
outputChatBox ( "Dead Players: " .. deadPlayersList )
end
</syntaxhighlight>
</section>

==See Also==
{{Player functions}}

GetAlivePlayers

2011-11-14T22:28:33Z

The Kid: quickfix

{{Server function}}
__NOTOC__
This function returns a table of all the alive players on the server. Opposite function of [[getDeadPlayers]].

==Syntax==
<section show="true" name="Server" class="server">
<syntaxhighlight lang="lua">
table getAlivePlayers ( )
</syntaxhighlight>

===Returns===
Returns a table of all the alive players.
</section>

==Example==
<section show="true" name="Server" class="server">
This example prints a list of all alive players in a "name, name2, name3" format. If no players are alive then it outputs "none".
<syntaxhighlight lang="lua">
-- Print a list of all the alive players
alivePlayers = getAlivePlayers ()
if ( alivePlayers ) then -- if we got the table
alivePlayersList = "none"
-- Loop through the table
for playerKey, playerValue in ipairs(alivePlayers) do
-- add their name to the list
if ( alivePlayersList == "none" ) then
alivePlayersList = getPlayerName ( playerValue )
else
alivePlayersList = alivePlayersList .. ", " .. getPlayerName ( playerValue )
end
end
outputChatBox ( "Alive Players: " .. alivePlayersList )
end
</syntaxhighlight>
</section>

==See Also==
{{Player functions}}

GetAlivePlayers

2011-11-14T22:28:17Z

The Kid: Syntax section

{{Server function}}
__NOTOC__
This function returns a table of all the alive players on the server. Opposite function of [[getDeadPlayers]].

==Syntax==
<section show="true" name="Server" class="server">
<syntaxhighlight lang="lua">
table getAlivePlayers ( )
</syntaxhighlight>

===Returns===
Returns a table of all the alive players.
</section

==Example==
<section show="true" name="Server" class="server">
This example prints a list of all alive players in a "name, name2, name3" format. If no players are alive then it outputs "none".
<syntaxhighlight lang="lua">
-- Print a list of all the alive players
alivePlayers = getAlivePlayers ()
if ( alivePlayers ) then -- if we got the table
alivePlayersList = "none"
-- Loop through the table
for playerKey, playerValue in ipairs(alivePlayers) do
-- add their name to the list
if ( alivePlayersList == "none" ) then
alivePlayersList = getPlayerName ( playerValue )
else
alivePlayersList = alivePlayersList .. ", " .. getPlayerName ( playerValue )
end
end
outputChatBox ( "Alive Players: " .. alivePlayersList )
end
</syntaxhighlight>
</section>

==See Also==
{{Player functions}}

ForcePlayerMap

2011-11-14T22:27:58Z

The Kid: Syntax section using

{{Server function}}
__NOTOC__
This function is used to forcefully show a player's radar map.

==Syntax==
<section show="true" name="Server" class="server">
<syntaxhighlight lang="lua">bool forcePlayerMap ( player thePlayer, bool forceOn )</syntaxhighlight>

===Required Arguments===
*'''thePlayer''': A [[player]] object referencing the specified player
*'''forceOn''': A boolean value representing whether or not the players radar map will be forced on

===Returns===
Returns ''true'' if the player's radar map was forced on, ''false'' otherwise.
</section>

==Example==
<section show="true" name="Server" class="server">
This example forces the radar map of the player named "dave" on for 10 seconds, if it hasn't been already
<syntaxhighlight lang="lua">
-- Get the player named "dave"
dave = getPlayerFromName ( "dave" )
-- Make sure we found him
if ( dave ) then
if not isPlayerMapForced ( dave ) then -- if his radar map isn't already forced on
forcePlayerMap ( dave, true ) -- force it on
setTimer ( forcePlayerMap, 10000, 1, dave, false ) -- stop forcing in 10 seconds
end
end
</syntaxhighlight>
</section>

==See Also==
{{Player functions}}

GetPlayerCount

2011-11-14T22:26:45Z

The Kid: Example section using.

{{Server function}}
__NOTOC__
This function returns the number of players currently connected to the server.

Note: #getElementsByType("player") works the same as this function but also works client side unlike this function.

==Syntax==
<syntaxhighlight lang="lua">
int getPlayerCount ( )
</syntaxhighlight>

===Returns===
Returns the number of players connected to the server as an [[int]].

==Example==
<section show="true" name="Server" class="server">
This example displays a chat message with the number of players connected to the server when a player joins or quits.
<syntaxhighlight lang="lua">
function playerCount ( )
outputChatBox ( "There are now " .. getPlayerCount() .. " players on this server!" )
end
addEventHandler ( "onPlayerJoin", getRootElement(), playerCount )
addEventHandler ( "onPlayerQuit", getRootElement(), playerCount )
</syntaxhighlight>
</section>

==See Also==
{{Player functions}}

GetPlayerBlurLevel

2011-11-14T22:26:12Z

The Kid: Deleted client's "Required Arguments" part, there are no required arguments for client.

__NOTOC__
{{Server client function}}

This function allows you to check the current blur level of a specified [[player]].

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
int getPlayerBlurLevel ( player thePlayer )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The [[player]] whose blur level you want to check.

===Returns===
Returns the player's blur level if successful, ''false'' if an invalid player was given.
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
int getBlurLevel ()
</syntaxhighlight>

===Returns===
Returns the local blur level.
</section>

==Example==
<section name="Server" class="server" show="true">
This example adds a command ''blurlevel'' with which you can check your current blur level.
<syntaxhighlight lang="lua">
function checkBlurLevel( playerSource )
local blur = getPlayerBlurLevel( playerSource )
if blur then
outputChatBox( "Blur level: " .. blur, playerSource )
end
end
addCommandHandler("blurlevel", checkBlurLevel)
</syntaxhighlight>
</section>

==See Also==
{{Player functions}}

GetPlayerAnnounceValue

2011-11-14T22:25:15Z

The Kid:

__NOTOC__
{{Server function}}
This function retrieves a players ASE announce value under a certain key.

==Syntax==
<syntaxhighlight lang="lua">string getPlayerAnnounceValue ( element thePlayer, string key )</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' This is the [[Player]] whos value you want to retrieve.
*'''key:''' The name of the key.

===Returns===
This function returns a ''string'' containing the requested value if a valid key was specified or ''false'' otherwise.

==Example==
<section show="true" name="Server" class="server">
This example adds a command named "getscore" which outputs a players "score" value to his chatbox.
<syntaxhighlight lang="lua">function getScore ( playerSource, cmdName )
local scoreValue = getPlayerAnnounceValue ( playerSource, "score" )
if ( scoreValue ) then
outputChatBox ( "Your score: "..scoreValue, playerSource )
end
end

addCommandHandler ( "getscore", getScore )
</syntaxhighlight>
</section>

==See Also==
{{Player functions}}

GetDeadPlayers

2011-11-14T22:24:53Z

The Kid:

{{Server function}}
__NOTOC__
This function returns a table of all currently dead players on the server.

==Syntax==
<syntaxhighlight lang="lua">
table getDeadPlayers()
</syntaxhighlight>

===Returns===
Returns a table of all the dead players.

==Example==
<section show="true" name="Server" class="server">
This example prints the list of dead players to the chat box.
<syntaxhighlight lang="lua">
-- Print a list of all the dead players
deadPlayers = getDeadPlayers ()
if ( deadPlayers ) then -- if we got the table
deadPlayersList = "none"
-- Loop through the table
for playerKey, playerValue in deadPlayers do
-- add their name to the list
if ( deadPlayersList == "none" ) then
deadPlayersList = getPlayerName ( playerValue )
else
deadPlayersList = deadPlayersList .. ", " .. getPlayerName ( playerValue )
end
end
outputChatBox ( "Dead Players: " .. deadPlayersList )
end
</syntaxhighlight>
</section>

==See Also==
{{Player functions}}

ForcePlayerMap

2011-11-14T22:24:39Z

The Kid: Section using

{{Server function}}
__NOTOC__
This function is used to forcefully show a player's radar map.

==Syntax==
<syntaxhighlight lang="lua">bool forcePlayerMap ( player thePlayer, bool forceOn )</syntaxhighlight>

===Required Arguments===
*'''thePlayer''': A [[player]] object referencing the specified player
*'''forceOn''': A boolean value representing whether or not the players radar map will be forced on

===Returns===
Returns ''true'' if the player's radar map was forced on, ''false'' otherwise.

==Example==
<section show="true" name="Server" class="server">
This example forces the radar map of the player named "dave" on for 10 seconds, if it hasn't been already
<syntaxhighlight lang="lua">
-- Get the player named "dave"
dave = getPlayerFromName ( "dave" )
-- Make sure we found him
if ( dave ) then
if not isPlayerMapForced ( dave ) then -- if his radar map isn't already forced on
forcePlayerMap ( dave, true ) -- force it on
setTimer ( forcePlayerMap, 10000, 1, dave, false ) -- stop forcing in 10 seconds
end
end
</syntaxhighlight>
</section>

==See Also==
{{Player functions}}

GetAlivePlayers

2011-11-14T22:24:17Z

The Kid: Section using

{{Server function}}
__NOTOC__
This function returns a table of all the alive players on the server. Opposite function of [[getDeadPlayers]].

==Syntax==
<syntaxhighlight lang="lua">
table getAlivePlayers ( )
</syntaxhighlight>

===Returns===
Returns a table of all the alive players.

==Example==
<section show="true" name="Server" class="server">
This example prints a list of all alive players in a "name, name2, name3" format. If no players are alive then it outputs "none".
<syntaxhighlight lang="lua">
-- Print a list of all the alive players
alivePlayers = getAlivePlayers ()
if ( alivePlayers ) then -- if we got the table
alivePlayersList = "none"
-- Loop through the table
for playerKey, playerValue in ipairs(alivePlayers) do
-- add their name to the list
if ( alivePlayersList == "none" ) then
alivePlayersList = getPlayerName ( playerValue )
else
alivePlayersList = alivePlayersList .. ", " .. getPlayerName ( playerValue )
end
end
outputChatBox ( "Alive Players: " .. alivePlayersList )
end
</syntaxhighlight>
</section>

==See Also==
{{Player functions}}

GetDeadPlayers

2011-11-14T22:23:57Z

The Kid: Section using

{{Server function}}
__NOTOC__
This function returns a table of all currently dead players on the server.

==Syntax==
<syntaxhighlight lang="lua">
table getDeadPlayers()
</syntaxhighlight>

===Returns===
Returns a table of all the dead players.

==Example==
This example prints the list of dead players to the chat box.
<section show="true" name="Server" class="server">
<syntaxhighlight lang="lua">
-- Print a list of all the dead players
deadPlayers = getDeadPlayers ()
if ( deadPlayers ) then -- if we got the table
deadPlayersList = "none"
-- Loop through the table
for playerKey, playerValue in deadPlayers do
-- add their name to the list
if ( deadPlayersList == "none" ) then
deadPlayersList = getPlayerName ( playerValue )
else
deadPlayersList = deadPlayersList .. ", " .. getPlayerName ( playerValue )
end
end
outputChatBox ( "Dead Players: " .. deadPlayersList )
end
</syntaxhighlight>
</section>

==See Also==
{{Player functions}}

IsVoiceEnabled

2011-11-14T22:21:30Z

The Kid: Needs Example

{{Server function}}
__NOTOC__
{{Needs Example}}
This function allows you to make the server reveal whether or not voice is currently enabled.

==Syntax==

<syntaxhighlight lang="lua">
bool isVoiceEnabled ()
</syntaxhighlight>

===Returns===
Returns ''true'' if the voice is enabled on the server, ''false'' otherwise.

==Example==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
--TODO
</syntaxhighlight>
</section>

==See Also==
{{Player_functions}}

OnPlayerChat

2011-11-14T22:19:36Z

The Kid:

__NOTOC__
{{Server event}}
This event is triggered when a player chats inside the chat box.

==Parameters==
<syntaxhighlight lang="lua">
string message, int messageType
</syntaxhighlight>

*'''message''': A string representing the message typed into the chat.
*'''messageType''': An integer value representing the message type:
**'''0''': normal message
**'''1''': action message (/me)
**'''2''': team message

==Source==
The [[event system#Event source|source]] of this event is the [[player]] who sent the chatbox message.

==Cancel effect==
If this event is [[Event system#Canceling|canceled]], the game's chat system won't deliver the posts. You may use [[outputChatBox]] to send the messages then.
Cancelling this event also means the chat will not appear in the server console or logs. If you want chat logging, you will have to add a call to outputServerLog - See the second example.

==Examples==

<section name="Example 1" class="server" show="true">
This example limits receiving of chat messages to a spherical area around the player who sent the message, also blocking action and team text.

<syntaxhighlight lang="lua">
-- define our chat radius
local chatRadius = 20 --units

-- define a handler that will distribute the message to all nearby players
function sendMessageToNearbyPlayers( message, messageType )
-- we will only send normal chat messages, action and team types will be ignored
if messageType == 0 then
-- get the chatting player's position
local posX, posY, posZ = getElementPosition( source )

-- create a sphere of the specified radius in that position
local chatSphere = createColSphere( posX, posY, posZ, chatRadius )
-- get a table all player elements inside it
local nearbyPlayers = getElementsWithinColShape( chatSphere, "player" )
-- and destroy the sphere, since we're done with it
destroyElement( chatSphere )

-- deliver the message to each player in that table
for index, nearbyPlayer in ipairs( nearbyPlayers ) do
outputChatBox( message, nearbyPlayer )
end
end
end
-- attach our new chat handler to onPlayerChat
addEventHandler( "onPlayerChat", getRootElement(), sendMessageToNearbyPlayers )

-- define another handler function that cancels the event so that the message won't be delivered through the
function blockChatMessage()
cancelEvent()
end
-- attach it as a handler to onPlayerChat
addEventHandler( "onPlayerChat", getRootElement(), blockChatMessage )
</syntaxhighlight>
</section>

<section name="Example 2" class="server" show="true">
This example implements colored player names in chat.

<syntaxhighlight lang="lua">
--This function is executed when a player joins, it sets the player's name-tag color to a random color.
local function playerJoin()
local red, green, blue = math.random (50, 255), math.random (50, 255), math.random (50, 255)
setPlayerNametagColor(source, red, green, blue)
end
addEventHandler ("onPlayerJoin", root, playerJoin)

--This function is executed when a player says something in chat, it outputs the player's message, with their nick colored to match their name tag color.
local function playerChat(message, messageType)
if messageType == 0 then --Global (main) chat
cancelEvent()
local red, green, blue = getPlayerNametagColor(source)
outputChatBox(getPlayerName(source)..": #FFFFFF"..message, root, red, green, blue, true )
outputServerLog("CHAT: "..getPlayerName(source)..": "..message)--NOTE: Beacuse we cancelled the onPlayerChat event, we need to log chat manually.
end
end
addEventHandler("onPlayerChat", root, playerChat)
</syntaxhighlight>
</section>

{{See also/Server event|Player events}}

Multi Theft Auto: Wiki:General disclaimer

2011-11-14T15:18:26Z

The Kid: Created page with "{{Needs Checking|Needs filling}}"

Multi Theft Auto: Wiki:About

2011-11-14T15:18:04Z

The Kid:

Multi Theft Auto: Wiki:Privacy policy

2011-11-14T15:17:30Z

The Kid:

Multi Theft Auto: Wiki:Privacy policy

2011-11-14T15:17:11Z

The Kid: Created page with "{{Needs Checking}}"