ES/Resources: Difference between revisions
(Cambios en la redacción, cambio en el nombre del contributor que soy yo) |
|||
| Line 1: | Line 1: | ||
Los '''resources''' son | Los '''resources''' son 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.xml'' que describe cómo el resource debe ser cargado. Un resource puede ser comparado con un programa que se ejecuta en un sistema operativo; se puede iniciar y detener, y se pueden ejecutar varios de ellos al mismo tiempo. Eso sí, cada resource sólo puede poseer una instancia ejecutándose al mismo tiempo. | ||
Usualmente, un resource tendrá 2 tipos de archivo: aquellos a cargar del lado del servidor, y aquellos que un cliente recibirá (descargará) al conectarse al servidor, y ejecutará una vez completadas sus descargas. En este ámbito, podemos distinguir que los usuarios siempre recibirán archivos de medios, tales como imágenes y música, y aquellos scripts que sean marcados como "scripts de cliente", incluidos dentro de un resource. Es importante entender que los usuarios podrán ver el código fuente de dichos scripts de cliente, así como no podrán ver aquello que se indique sea del lado del servidor. | |||
== Terminología == | == Terminología == | ||
| Line 5: | Line 7: | ||
*'''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/''. | *'''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. | *'''Item de resource''' - Un archivo contenido dentro de un resource. Puede ser un mapa, un archivo de música, una imagen, un script, etc. | ||
== El archivo meta.xml == | == 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 | 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: | ||
<syntaxhighlight lang="xml"> | <syntaxhighlight lang="xml"> | ||
<meta> | <meta> | ||
<info author="eAi" description="Ejemplo básico de script" version="4"/> | <!-- Información del resource; opcional, pero un buen estándar a incluir siempre --> | ||
<info author="eAi" description="Ejemplo básico de script" version="4" name="Resource completo" /> | |||
<!-- Dependencias: si un resource indicado con <include> no se puede iniciar o no se encuentra, éste tampoco se podrá iniciar --> | |||
<include resource="radarblips"/> | <include resource="radarblips"/> | ||
<include resource="markermanagement" /> | <include resource="markermanagement" /> | ||
<!-- Scripts: aquellos que lleven el atributo type="client" son considerados "del lado cliente" --> | |||
<script src="ctf.lua" /> | <script src="ctf.lua" /> | ||
<script src="flag.lua" /> | <script src="flag.lua" /> | ||
<script src="ctf_client.lua" type="client" /> | <script src="ctf_client.lua" type="client" /> | ||
<!-- Archivos de medios --> | |||
<file src="model.dff" /> | <file src="model.dff" /> | ||
<file src="quitbutton.png" /> | <file src="quitbutton.png" /> | ||
<file src="texture.txd" /> | <file src="texture.txd" /> | ||
<html src="test.htm" default="true"/> | <html src="test.htm" default="true"/> | ||
<html src="logo.png" raw="true" /> | <html src="logo.png" raw="true" /> | ||
<!-- Funciones exportadas: para usarlas en scripts fuera de este resource --> | |||
<!-- Un buen uso de las dependencias permite la correcta implementación de esta característica --> | |||
<export function="multiply" http="true" /> | <export function="multiply" http="true" /> | ||
<export function="getPlayerList" /> | <export function="getPlayerList" /> | ||
<export function="getElementOwner" type="client"/> | <export function="getElementOwner" type="client"/> | ||
<!-- Archivos de configuración, usables por los scripts --> | |||
<config src="vehicle-list.xml" type="client" /> | <config src="vehicle-list.xml" type="client" /> | ||
<config src="markerconfig.xml" type="server" /> | <config src="markerconfig.xml" type="server" /> | ||
<!-- Mapas --> | |||
<map src="somestuff.map" dimension="99" /> | <map src="somestuff.map" dimension="99" /> | ||
</meta> | </meta> | ||
| Line 50: | Line 59: | ||
</meta> | </meta> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Los scripts se envían a los clientes para que se inicien tan pronto como hayan sido descargados. | Los scripts se envían a los clientes para que se inicien tan pronto como hayan sido descargados. | ||
| Line 65: | Line 64: | ||
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]]. | 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]]. | ||
== Archivos almacenados == | == Archivos almacenados == | ||
| Line 100: | Line 99: | ||
*Kzman | *Kzman | ||
*F4ST3R | *F4ST3R | ||
* | *[[User:12g]] | ||
Revision as of 15:50, 3 December 2017
Los resources son 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.xml que describe cómo el resource debe ser cargado. Un resource puede ser comparado con un programa que se ejecuta en un sistema operativo; se puede iniciar y detener, y se pueden ejecutar varios de ellos al mismo tiempo. Eso sí, cada resource sólo puede poseer una instancia ejecutándose al mismo tiempo.
Usualmente, un resource tendrá 2 tipos de archivo: aquellos a cargar del lado del servidor, y aquellos que un cliente recibirá (descargará) al conectarse al servidor, y ejecutará una vez completadas sus descargas. En este ámbito, podemos distinguir que los usuarios siempre recibirán archivos de medios, tales como imágenes y música, y aquellos scripts que sean marcados como "scripts de cliente", incluidos dentro de un resource. Es importante entender que los usuarios podrán ver el código fuente de dichos scripts de cliente, así como no podrán ver aquello que se indique sea del lado del servidor.
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, un script, 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:
<meta>
<!-- Información del resource; opcional, pero un buen estándar a incluir siempre -->
<info author="eAi" description="Ejemplo básico de script" version="4" name="Resource completo" />
<!-- Dependencias: si un resource indicado con <include> no se puede iniciar o no se encuentra, éste tampoco se podrá iniciar -->
<include resource="radarblips"/>
<include resource="markermanagement" />
<!-- Scripts: aquellos que lleven el atributo type="client" son considerados "del lado cliente" -->
<script src="ctf.lua" />
<script src="flag.lua" />
<script src="ctf_client.lua" type="client" />
<!-- Archivos de medios -->
<file src="model.dff" />
<file src="quitbutton.png" />
<file src="texture.txd" />
<html src="test.htm" default="true"/>
<html src="logo.png" raw="true" />
<!-- Funciones exportadas: para usarlas en scripts fuera de este resource -->
<!-- Un buen uso de las dependencias permite la correcta implementación de esta característica -->
<export function="multiply" http="true" />
<export function="getPlayerList" />
<export function="getElementOwner" type="client"/>
<!-- Archivos de configuración, usables por los scripts -->
<config src="vehicle-list.xml" type="client" />
<config src="markerconfig.xml" type="server" />
<!-- Mapas -->
<map src="somestuff.map" dimension="99" />
</meta>
Mientras que un mapa de CTF, por ejemplo, puede tener un meta.xml parecido a esto:
<meta>
<include resource="ctf" />
<map src="myuberl33tctfmap.map" />
<info author="Tom" instructions="this is uber l33t !!!!!1111111" type="map" />
</meta>
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 ACL.
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:
- abortRemoteRequest
- call
- fetchRemote
- getResourceConfig
- getResourceDynamicElementRoot
- getResourceExportedFunctions
- getResourceFromName
- getResourceName
- getResourceRootElement
- getResourceState
- getThisResource
- getRemoteRequests
- getRemoteRequestInfo
Eventos
Los siguientes eventos también están ligados a los resources:
Traductores
- Kzman
- F4ST3R
- User:12g