Multi Theft Auto: Wiki - User contributions [en]

Page d'accueil

2014-04-04T14:59:47Z

Gaetan Piette: /* Programmer */

<div style="background: #FFEEAA; padding: 5px; float:right; width: 30%;">Dernière version stable de '''Multi Theft Auto: San Andreas''' est '''{{Current Version|full}}'''. Rendez-vous sur la [http://mtasa.com/ page principale] pour la télécharger.
<p>
Vous pouvez aussi télécharger une [http://nightly.mtasa.com/ beta] pour avoir la dernière version ( non stable ).
</p>
</div>
__NOTOC__
Bienvenue sur le wiki de Multi Theft Auto. Sur ce wiki, vous trouverez toutes les informations sur Multi Theft Auto.

Il y a [[How you can help|différents moyens de nous aider]]: créer une map, un gamemode, rediger des articles sur des fonctions, écrire un exemple, écrire un tutorial ou juste jouer à MTA et nous rapportez les bugs trouvés.

<div style="clear:both;"></div>
{| width="100%" cellspacing="0" cellpadding="0"
| colspan="2" |

|-
| width="50%" style="vertical-align:top;" |
<div style="border: 1px dotted #AAAAAA;padding:4px 8px 8px 8px;margin:10px;">
====Pour commencer====

* [[FR/Manuel_Client|Manuel Client]] ( Traduction: [http://wiki.multitheftauto.com/wiki/User:DrawKiie DrawKiie] )
* [[FR/Manuel_Serveur|Manuel Serveur]] ( Traduction: [http://wiki.multitheftauto.com/wiki/User:Rouche Rouche] )
* [[FR/Problemes_connus|Problèmes connus]] ( Traduction: [http://wiki.multitheftauto.com/wiki/User:Rouche Rouche] )
* [[FR/Migrer_de_MTARace_a_MTASA_1.0.x|Migrer de MTA:Race à MTA:SA 1.0.x]] ( Traduction: [http://wiki.multitheftauto.com/wiki/User:Rouche Rouche] )
* [[FR/A propos des Map|A propos des Map]] ( Traduction: [http://wiki.multitheftauto.com/wiki/User:Rouche Rouche] )

</div>

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

====Programmer====

* [[FR/Introduction_Programmation|Introduction: La programmation]]
* [[FR/Introduction_GUI|Introduction: Le GUI]] ( Traduction: [http://wiki.multitheftauto.com/wiki/User:FatalTeror FatalTerror] )
* [[FR/Debugage|Tutoriel: Le débugage]] - Comment trouver les erreurs dans son script (Traduction:[http://wiki.multitheftauto.com/wiki/User:Vincenzo Vincenzo] alias Vincentdu90)
* [[FR/Ressources|Introduction: Les ressources]] (Traduction : [http://wiki.multitheftauto.com/wiki/User:Myk3L Myk3L])
** [[FR/Ressource_Acces_Internet|Introduction: L'accès depuis internet]] - Comment créer un site à partir d'une ressource (Traduction : [http://wiki.multitheftauto.com/wiki/User:Myk3L Myk3L])
** [[:Category:Resource|Catalogue des ressources]]
** [[FR/Meta.xml|Meta.xml]] - Derière chaque ressource ce trouve une meta pour la définir
** [[FR/ACL|ACL]] - Access Control List, pour définir les autorisations
* [[FR/Ecrire_Gamemode|Créer un gamemode]] ( Traduction: [http://wiki.multitheftauto.com/wiki/User:Rouche Rouche])
* [[FR/Fonctions_Utiles|Fonctions Utiles]]

</div>

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

====Bases de données====
Cette section décrit toutes les capacités fournies par le LUA/MTA ou par les ressources.
* [[:Category:Resource|Catalogue des ressources]] - Vous devriez le lire pour réaliser un script approprié.
* [[FR/Les_scripts_clients| Les scripts clients]]
</div>
<div style="border: 1px dotted #AAAAAA;padding:4px 8px 8px 8px;margin:10px;">

====Aide générale du LUA====
Des pages conçues pour aider votre compréhension du Lua
*[http://www.lua.org/pil/index.html "Programming in Lua"]
**[http://www.lua.org/manual/5.1/#index Les fonctions Lua]
*[http://lua-users.org/wiki/TutorialDirectory wiki Lua]
*[http://nixstaller.berlios.de/manual/0.2/nixstaller_9.html Un guide général au Lua de Nixstaller]
</div>

| width="50%" style="vertical-align:top;" |
<div style="border: 1px dotted #AAAAAA;padding:4px 8px 8px 8px;margin:10px;">

====Map Editor====
*[[Resource:Editor|Manuel]]
*[[Resource:Editor/EDF|Editor Definition Format]]
*[[Resource:Editor/Plugins|Plugins]]
*[[Resource:Editor#FAQ|Questions Fréquentes]]
</div>

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

====Développer Multi Theft Auto====
* [[FR/Compiler_MTASA|Compiler MTASA sur Windows]]
* [[FR/Compiler_MTASA_Server_sur_Mac_OS_X|Compiler MTASA sur Mac OS X]]
* [[FR/Compiler_MTASA_Server_sur_GNU_Linux|Compiler MTASA sur GNU/Linux]]
* [[FR/Directives_de_codage|Directives de codage]]
* [http://code.google.com/p/mtasa-blue Google Code SVN]
* [[FR/Roadmap|Roadmap]]
</div>

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

====Références====
* [[FR/Fonctions_Clients|Fonctions Clients]]
* [[FR/Events_Clients|Events Clients]]
* [[FR/Fonctions_Serveurs|Fonctions Clients]]
* [[FR/Events_Serveurs|Events Clients]]

* [[FR/MTA Classes|MTA Classes]] - Les descriptions détaillées de tous les types personnalisés MTA
** [[FR/Element|MTA Elements]] / [[Element tree]]
</div>

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

====[[Id|ID Listes]]====
*[[FR/Animations|Animations]]
*[[FR/Skins_Personnages|Skins Personnages]]
*[[FR/Vetements_CJ|Vêtements CJ]]
*[[FR/Garage|Garage IDs]]
*[[FR/Interieurs_IDs|Intérieurs IDs]]
*[[FR/Materiel_IDs|Matériel IDs]]
*[[FR/Projectiles|Projectiles]]
*[[FR/Radar Blips|Radar Blips]]
*[[FR/Sons|Sons]]
*[[FR/Vehicule_IDs|ID des véhicules]]
*[[FR/Vehicule_Couleurs|Couleurs véhicules]]
*[[FR/Vehicule_Upgrades|Tuning IDs]]
*[[FR/Armes|Armes]]
*[[FR/Meteos|Météos]]
</div>

|-
| colspan="2" |
|}
{{Languages list|fr}}

Créer un mode de jeu

2014-04-04T14:59:20Z

Gaetan Piette: /* Map cycler */

Ce guide à pour but de vous aprpendre à créer un mode de jeu. Si vous venez juste de commencer à scripter pour MTA, il serait préférable que vous lisiez les autres tutoriels de l apage principale.

==Introduction==
Un mode de jeu est une ressource qui une fois démarrée contrôle tout les éléments du gameplay. Cela inclus l'explication du mode de jeu aux joueurs. Par exemple expliquer comment gagner des points ou de l'argent. (Mode de jeu existans : race, deathmatch, ctf, freeroam et bien d'autres).

==Que signifie "coder proprement un mode de jeu" ?==
Pour faire simple, un mode de jeu doit utilisé les fonctionnalités du système de map dans MTA. Cela signifie que le code des maps doit être accompagné des position des véhicule, spawn des joueur et autres. Cela permet au mode de jeu d'être indépendant des maps proposées par les joueurs.

Instead, the gamemode should be able to load .map files which define these data. This way the gamemode can have multiple maps; also, people can create .map files for the gamemode with MTA's map editor, which is much more convenient than writing code.

An obvious example of a "proper gamemode" is MTA:Race. It allows usermade maps with lots of possibilities within the .map file. To alter spawnpoints, objects etc., the user doesn't need to edit the gamemode itself.

===Fichier MAP===
Les fichiers map sont en XML avec l'extension .map. Ils définissent l'environnement pour un mode de jeu ou plusieurs si la map est compatible avec d'aures. Ils ne sont cependant pas supposés changer les règles du jeu. Les règles sont définies dans le mode de jeu.

Chaque élémment dans une map correspond à un noeud dans le fichier .map. Il y a une syntaxe particulière pour les points de spawn, objets ou véhicules. Cependant il est possible, pour des cas d'ajouts d'objets spéciaux d'inventer votre propre syntaxe.

====Exemple====
Commencons par un mode de jeu bien connu, la capture de drapeau. Une map pour ce mode de jeu à besoin de point de spawn et de positions pour les drapeaux des deux équipes. On peut aussi y ajouter des véhicules et d'autres objets. Un fichier de map simplifié pourrait ressembler à ça :

<syntaxhighlight lang="xml">
<map>
<spawnpoint id="spawnpoint1" posX="1959.5487060547" posY="-1714.4613037109" posZ="877.25219726563" rot="63.350006103516" model="0"/>
<pickup id="Armor 1" posX="1911.083984375" posY="-1658.8798828125" posZ="885.40216064453" type="armor" health="50" respawn="60000"/>
<flag posX="1959.5487060547" posY="-1714.4613037109" posZ="877.25219726563" team="blue" />
...
</map>
</syntaxhighlight>

Dans le code ci-dessus on peut apercevoir trois éléments : un point de spawn,un pickup et un flag.
Le pickup permettera une fois pris par le joueur de lui rendre 50 points de vie, celui-ci respawn toute les 60 secondes.
Le flag est ici définit au niveau de sa position et de sa couleur (propre à l'équipe).
Le point de spawn et le pickup peuvent être utilisé par une ressource externe. Les éléments personnalisés doievent être gérés par le mode de jeu.

Pour résumé, votre objectif est de facilité la vie des mappeurs. Ceux-ci ne doivent pas avoir à se tracasser du script concernant le mode de jeu.

====Exemple de récupération d'informations sur un .map====
Votre mode de jeu doit appelés les éléments personnalisés définit dans le fichier .map afin des les utilisés. Ce n'est pas bien compliqué et voici une démonstration ci-dessous.
<syntaxhighlight lang="lua">
-- récupère une liste avec tout les éléments de type flag
local flagElements = getElementsByType ( "flag" )
-- On boucle sur cette liste pour récupérer les positions
for key, value in pairs(flagElements) do
-- Récupération des informations
local posX = getElementData ( value, "posX" )
local posY = getElementData ( value, "posY" )
local posZ = getElementData ( value, "posZ" )
local team = getElementData ( value, "team" )
-- Création de l'objet flag
createObject ( 1337, posX, posY, posZ )
-- Affichage dans le tchat que le dreapau est créé
outputChatBox ( "Base for team " .. team .. " created" )
end
</syntaxhighlight>
La fonction [[getElementsByType]] récupère une table de tout les éléments d'un certain type. (le type correspond au noeud créé dans le fichier .map)
Fonctionne pour les objets presonnalisé mais aussi pour les objets présents par défauts dans MTA comme "vehicle" ou "player".
[[getElementData]] peut être utilisé pour récupérer les atributs XML définis dans le fichier .map.
Pour exemple, un objet est créé à la position du drapeau et un message s'affiche dans le tchat pour prévenir les joueurs. En réalité, cette action sera plutôt réalisée lors du chargement de la map. Par contre on peut imaginer une action lorsqu'un joueur s'empare du drapeau ennemi.

==Map Manager==
Après avoir lu les sections ci-dessus il doit vous paraître clair qu'un mode de jeu est composé en deux parties :
* La ressource du mode de jeu (Unique)
* Les maps qui accompagnent le mode de jeu

A la place d'écrire un [[Map manager]] pour chaque mode de jeu différent, le [[Map manager]] de base fournit des fonctions pour charger mode de jeu et maps. Il suffit simplement d'entrer un commande correcte (par exemple 'gamemode ctf ctf-italy'), cette action va démarrer le mode de jeu et la map pendant que l'évênement déclenché ([[onGamemodeMapStart]]) avertira le mode de jeu q'une map est chargée. La ressource 'ctf' peut alors accéder au informations de la map. Le mode de jeu peut alors faire spawn les joueurs.

===Comment utiliser le Map Manager===
Pour utiliser le Map Manager, votre mode de jeu doit être ciblé en premier lieu. Vous devez en fait configurer l'attribut "type" dans la baile <info> du meta.xml avec le mode de jeu souhaité. L'attribut "name" peut contenir un non plus convivial comme 'Capture de drapeau', c'estl enom qui sera affiché dans la liste des serveurs à la place du om de la ressource par défaut.
<syntaxhighlight lang="xml">

<meta>
<info type="gamemode" name="Shooter Mode 2.0"/>
</meta>
</syntaxhighlight>

Si votre mode de jeu utilise des maps personnalisées, vous devriez utiliser les évênements suivant :
* onGamemodeMapStart
* onGamemodeMapStop (Si la map doit-être déchargée)

Les évênements ci-dessus sont appelés quand une map de votre mode démarre ou s'arrête. Le paramètre passé par ces évênement n'est rien d'autre que le nom de la ressource.
Avec les fonctions sur les évênements, vous pouvez extraire toute les informations de la map ainsi que du fichier de configuration.

====Example====
<syntaxhighlight lang="lua">
function startCtfMap( startedMap ) -- startedMap contient une référence vers la ressource de la map
local mapRoot = getResourceRootElement( startedMap ) -- recoit le noeud principal de la map démarrée
local flagElements = getElementsByType ( "flag" , mapRoot ) -- recoit tout les drapeausx de la map et les stocke dans un tableau
-- Démarrage du chargement des informations
-- Spawn les joueurs etc
end
addEventHandler("onGamemodeMapStart", getRootElement(), startCtfMap)
</syntaxhighlight>

===Faire des maps compatibles===
Les maps sont des ressources séparées du mode de jeu de telle sorte qu'il ne faut pas modofier le mode de jeu pour chaque nouvelle map. Les maps peuent aussi contenir des scripts et configurations propres à elles.

Pour faire une map compatible avec votre mode, il suffit d'ouvrir le meta.xml et de mettre l'attribut "type" à 'map' et l'attribut "gamemode" doit être composé d'une liste des mode de jeu compatible avec la map (modes séparé d'une virgule).
<syntaxhighlight lang="xml">

<meta>
<info type="map" gamemodes="shootermode,assault,tdm"/>
</meta>
</syntaxhighlight>

Une fois que tout est configuré, les administrateurs peuvent utiliser le panel ou les commandes start/stop suivit du nom du mode.
/gamemode gamemodeName [NomDeLaMap] (paramètre optionel qui permet de démarré une map avec le mode, par défaut pas de map)
/changemap mapName [NomDuModeDeJeu] (paramètre optionnel qui permet dans le cas ou la map est démarrée de lancé le mode de jeu qui lui convient, par défaut le mode de jeu actif)

[[Map manager]] possède d'autres fonctions qui pourrait vous être utliles, mais elle ne sont pas toutes présentées ici.

==Autres possibilités==
Il y a une multitude d'autres ressources avec lesquelles les modes de jeu peuvent interférer.

===Helpmanager===
L'Helpmanager est une interface en jeu pour les joueurs qui on besopin d'aide. Si vous utilisez l'HelpManager pour l'aide de votre mode de jeu, tous les joueurs qui l'on utilisé précédement serront plus à l'aise car la plupart des modes l'utilise. Il affiche aussi les différentes ressources dans des onglet, si configuré pour.

Il y à deux façons d'utiliser le HelpManager :
* Fournir un simple texte qui explique le mode de jeu.
* Utilisation des éléments graphiques (GUI) (Recommandé)

N'hésitez pas à lire la page sur le HelpManager pour en savoir plus.

===Scoreboard===
Il affiche les joueurs et les teams présentes sur le serveur. Vous pouvez y ajouter des colonnes supplémentaires pour afficher d'autres informations. Par exemple une colonne 'Points' peut être utile dans un mode de capture de drapeaux. Consultez la page sur le scoreboard pour plus d'information.

===Map cycler===
Il permet de controller quel mode de jeu et map sont joués sur le serveur. Vous pouvez spécifier combien de fois une map doit être jouée avant changement de mode de jeu apr exemple. Pour celà il faut dire au map cycler que votre mode de jeu est stoppé.

[[it:Scrivere una gamemode]]
[[ru:Writing Gamemodes]]
[[de:Gamemodes schreiben]]

Créer un mode de jeu

2014-04-04T14:57:34Z

Gaetan Piette: /* Scoreboard */

Ce guide à pour but de vous aprpendre à créer un mode de jeu. Si vous venez juste de commencer à scripter pour MTA, il serait préférable que vous lisiez les autres tutoriels de l apage principale.

==Introduction==
Un mode de jeu est une ressource qui une fois démarrée contrôle tout les éléments du gameplay. Cela inclus l'explication du mode de jeu aux joueurs. Par exemple expliquer comment gagner des points ou de l'argent. (Mode de jeu existans : race, deathmatch, ctf, freeroam et bien d'autres).

==Que signifie "coder proprement un mode de jeu" ?==
Pour faire simple, un mode de jeu doit utilisé les fonctionnalités du système de map dans MTA. Cela signifie que le code des maps doit être accompagné des position des véhicule, spawn des joueur et autres. Cela permet au mode de jeu d'être indépendant des maps proposées par les joueurs.

Instead, the gamemode should be able to load .map files which define these data. This way the gamemode can have multiple maps; also, people can create .map files for the gamemode with MTA's map editor, which is much more convenient than writing code.

An obvious example of a "proper gamemode" is MTA:Race. It allows usermade maps with lots of possibilities within the .map file. To alter spawnpoints, objects etc., the user doesn't need to edit the gamemode itself.

===Fichier MAP===
Les fichiers map sont en XML avec l'extension .map. Ils définissent l'environnement pour un mode de jeu ou plusieurs si la map est compatible avec d'aures. Ils ne sont cependant pas supposés changer les règles du jeu. Les règles sont définies dans le mode de jeu.

Chaque élémment dans une map correspond à un noeud dans le fichier .map. Il y a une syntaxe particulière pour les points de spawn, objets ou véhicules. Cependant il est possible, pour des cas d'ajouts d'objets spéciaux d'inventer votre propre syntaxe.

====Exemple====
Commencons par un mode de jeu bien connu, la capture de drapeau. Une map pour ce mode de jeu à besoin de point de spawn et de positions pour les drapeaux des deux équipes. On peut aussi y ajouter des véhicules et d'autres objets. Un fichier de map simplifié pourrait ressembler à ça :

<syntaxhighlight lang="xml">
<map>
<spawnpoint id="spawnpoint1" posX="1959.5487060547" posY="-1714.4613037109" posZ="877.25219726563" rot="63.350006103516" model="0"/>
<pickup id="Armor 1" posX="1911.083984375" posY="-1658.8798828125" posZ="885.40216064453" type="armor" health="50" respawn="60000"/>
<flag posX="1959.5487060547" posY="-1714.4613037109" posZ="877.25219726563" team="blue" />
...
</map>
</syntaxhighlight>

Dans le code ci-dessus on peut apercevoir trois éléments : un point de spawn,un pickup et un flag.
Le pickup permettera une fois pris par le joueur de lui rendre 50 points de vie, celui-ci respawn toute les 60 secondes.
Le flag est ici définit au niveau de sa position et de sa couleur (propre à l'équipe).
Le point de spawn et le pickup peuvent être utilisé par une ressource externe. Les éléments personnalisés doievent être gérés par le mode de jeu.

Pour résumé, votre objectif est de facilité la vie des mappeurs. Ceux-ci ne doivent pas avoir à se tracasser du script concernant le mode de jeu.

====Exemple de récupération d'informations sur un .map====
Votre mode de jeu doit appelés les éléments personnalisés définit dans le fichier .map afin des les utilisés. Ce n'est pas bien compliqué et voici une démonstration ci-dessous.
<syntaxhighlight lang="lua">
-- récupère une liste avec tout les éléments de type flag
local flagElements = getElementsByType ( "flag" )
-- On boucle sur cette liste pour récupérer les positions
for key, value in pairs(flagElements) do
-- Récupération des informations
local posX = getElementData ( value, "posX" )
local posY = getElementData ( value, "posY" )
local posZ = getElementData ( value, "posZ" )
local team = getElementData ( value, "team" )
-- Création de l'objet flag
createObject ( 1337, posX, posY, posZ )
-- Affichage dans le tchat que le dreapau est créé
outputChatBox ( "Base for team " .. team .. " created" )
end
</syntaxhighlight>
La fonction [[getElementsByType]] récupère une table de tout les éléments d'un certain type. (le type correspond au noeud créé dans le fichier .map)
Fonctionne pour les objets presonnalisé mais aussi pour les objets présents par défauts dans MTA comme "vehicle" ou "player".
[[getElementData]] peut être utilisé pour récupérer les atributs XML définis dans le fichier .map.
Pour exemple, un objet est créé à la position du drapeau et un message s'affiche dans le tchat pour prévenir les joueurs. En réalité, cette action sera plutôt réalisée lors du chargement de la map. Par contre on peut imaginer une action lorsqu'un joueur s'empare du drapeau ennemi.

==Map Manager==
Après avoir lu les sections ci-dessus il doit vous paraître clair qu'un mode de jeu est composé en deux parties :
* La ressource du mode de jeu (Unique)
* Les maps qui accompagnent le mode de jeu

A la place d'écrire un [[Map manager]] pour chaque mode de jeu différent, le [[Map manager]] de base fournit des fonctions pour charger mode de jeu et maps. Il suffit simplement d'entrer un commande correcte (par exemple 'gamemode ctf ctf-italy'), cette action va démarrer le mode de jeu et la map pendant que l'évênement déclenché ([[onGamemodeMapStart]]) avertira le mode de jeu q'une map est chargée. La ressource 'ctf' peut alors accéder au informations de la map. Le mode de jeu peut alors faire spawn les joueurs.

===Comment utiliser le Map Manager===
Pour utiliser le Map Manager, votre mode de jeu doit être ciblé en premier lieu. Vous devez en fait configurer l'attribut "type" dans la baile <info> du meta.xml avec le mode de jeu souhaité. L'attribut "name" peut contenir un non plus convivial comme 'Capture de drapeau', c'estl enom qui sera affiché dans la liste des serveurs à la place du om de la ressource par défaut.
<syntaxhighlight lang="xml">

<meta>
<info type="gamemode" name="Shooter Mode 2.0"/>
</meta>
</syntaxhighlight>

Si votre mode de jeu utilise des maps personnalisées, vous devriez utiliser les évênements suivant :
* onGamemodeMapStart
* onGamemodeMapStop (Si la map doit-être déchargée)

Les évênements ci-dessus sont appelés quand une map de votre mode démarre ou s'arrête. Le paramètre passé par ces évênement n'est rien d'autre que le nom de la ressource.
Avec les fonctions sur les évênements, vous pouvez extraire toute les informations de la map ainsi que du fichier de configuration.

====Example====
<syntaxhighlight lang="lua">
function startCtfMap( startedMap ) -- startedMap contient une référence vers la ressource de la map
local mapRoot = getResourceRootElement( startedMap ) -- recoit le noeud principal de la map démarrée
local flagElements = getElementsByType ( "flag" , mapRoot ) -- recoit tout les drapeausx de la map et les stocke dans un tableau
-- Démarrage du chargement des informations
-- Spawn les joueurs etc
end
addEventHandler("onGamemodeMapStart", getRootElement(), startCtfMap)
</syntaxhighlight>

===Faire des maps compatibles===
Les maps sont des ressources séparées du mode de jeu de telle sorte qu'il ne faut pas modofier le mode de jeu pour chaque nouvelle map. Les maps peuent aussi contenir des scripts et configurations propres à elles.

Pour faire une map compatible avec votre mode, il suffit d'ouvrir le meta.xml et de mettre l'attribut "type" à 'map' et l'attribut "gamemode" doit être composé d'une liste des mode de jeu compatible avec la map (modes séparé d'une virgule).
<syntaxhighlight lang="xml">

<meta>
<info type="map" gamemodes="shootermode,assault,tdm"/>
</meta>
</syntaxhighlight>

Une fois que tout est configuré, les administrateurs peuvent utiliser le panel ou les commandes start/stop suivit du nom du mode.
/gamemode gamemodeName [NomDeLaMap] (paramètre optionel qui permet de démarré une map avec le mode, par défaut pas de map)
/changemap mapName [NomDuModeDeJeu] (paramètre optionnel qui permet dans le cas ou la map est démarrée de lancé le mode de jeu qui lui convient, par défaut le mode de jeu actif)

[[Map manager]] possède d'autres fonctions qui pourrait vous être utliles, mais elle ne sont pas toutes présentées ici.

==Autres possibilités==
Il y a une multitude d'autres ressources avec lesquelles les modes de jeu peuvent interférer.

===Helpmanager===
L'Helpmanager est une interface en jeu pour les joueurs qui on besopin d'aide. Si vous utilisez l'HelpManager pour l'aide de votre mode de jeu, tous les joueurs qui l'on utilisé précédement serront plus à l'aise car la plupart des modes l'utilise. Il affiche aussi les différentes ressources dans des onglet, si configuré pour.

Il y à deux façons d'utiliser le HelpManager :
* Fournir un simple texte qui explique le mode de jeu.
* Utilisation des éléments graphiques (GUI) (Recommandé)

N'hésitez pas à lire la page sur le HelpManager pour en savoir plus.

===Scoreboard===
Il affiche les joueurs et les teams présentes sur le serveur. Vous pouvez y ajouter des colonnes supplémentaires pour afficher d'autres informations. Par exemple une colonne 'Points' peut être utile dans un mode de capture de drapeaux. Consultez la page sur le scoreboard pour plus d'information.

===Map cycler===
The map cycler controls what gamemodes and maps are played on a server. You can specifiy for example how many times in a row a map will be played until it switches to the next. To achieve this, you need to tell the map cycler when your gamemode finished (e.g. when a round ends).

[[it:Scrivere una gamemode]]
[[ru:Writing Gamemodes]]
[[de:Gamemodes schreiben]]

Créer un mode de jeu

2014-04-04T14:55:38Z

Gaetan Piette: /* Helpmanager */

Ce guide à pour but de vous aprpendre à créer un mode de jeu. Si vous venez juste de commencer à scripter pour MTA, il serait préférable que vous lisiez les autres tutoriels de l apage principale.

==Introduction==
Un mode de jeu est une ressource qui une fois démarrée contrôle tout les éléments du gameplay. Cela inclus l'explication du mode de jeu aux joueurs. Par exemple expliquer comment gagner des points ou de l'argent. (Mode de jeu existans : race, deathmatch, ctf, freeroam et bien d'autres).

==Que signifie "coder proprement un mode de jeu" ?==
Pour faire simple, un mode de jeu doit utilisé les fonctionnalités du système de map dans MTA. Cela signifie que le code des maps doit être accompagné des position des véhicule, spawn des joueur et autres. Cela permet au mode de jeu d'être indépendant des maps proposées par les joueurs.

Instead, the gamemode should be able to load .map files which define these data. This way the gamemode can have multiple maps; also, people can create .map files for the gamemode with MTA's map editor, which is much more convenient than writing code.

An obvious example of a "proper gamemode" is MTA:Race. It allows usermade maps with lots of possibilities within the .map file. To alter spawnpoints, objects etc., the user doesn't need to edit the gamemode itself.

===Fichier MAP===
Les fichiers map sont en XML avec l'extension .map. Ils définissent l'environnement pour un mode de jeu ou plusieurs si la map est compatible avec d'aures. Ils ne sont cependant pas supposés changer les règles du jeu. Les règles sont définies dans le mode de jeu.

Chaque élémment dans une map correspond à un noeud dans le fichier .map. Il y a une syntaxe particulière pour les points de spawn, objets ou véhicules. Cependant il est possible, pour des cas d'ajouts d'objets spéciaux d'inventer votre propre syntaxe.

====Exemple====
Commencons par un mode de jeu bien connu, la capture de drapeau. Une map pour ce mode de jeu à besoin de point de spawn et de positions pour les drapeaux des deux équipes. On peut aussi y ajouter des véhicules et d'autres objets. Un fichier de map simplifié pourrait ressembler à ça :

<syntaxhighlight lang="xml">
<map>
<spawnpoint id="spawnpoint1" posX="1959.5487060547" posY="-1714.4613037109" posZ="877.25219726563" rot="63.350006103516" model="0"/>
<pickup id="Armor 1" posX="1911.083984375" posY="-1658.8798828125" posZ="885.40216064453" type="armor" health="50" respawn="60000"/>
<flag posX="1959.5487060547" posY="-1714.4613037109" posZ="877.25219726563" team="blue" />
...
</map>
</syntaxhighlight>

Dans le code ci-dessus on peut apercevoir trois éléments : un point de spawn,un pickup et un flag.
Le pickup permettera une fois pris par le joueur de lui rendre 50 points de vie, celui-ci respawn toute les 60 secondes.
Le flag est ici définit au niveau de sa position et de sa couleur (propre à l'équipe).
Le point de spawn et le pickup peuvent être utilisé par une ressource externe. Les éléments personnalisés doievent être gérés par le mode de jeu.

Pour résumé, votre objectif est de facilité la vie des mappeurs. Ceux-ci ne doivent pas avoir à se tracasser du script concernant le mode de jeu.

====Exemple de récupération d'informations sur un .map====
Votre mode de jeu doit appelés les éléments personnalisés définit dans le fichier .map afin des les utilisés. Ce n'est pas bien compliqué et voici une démonstration ci-dessous.
<syntaxhighlight lang="lua">
-- récupère une liste avec tout les éléments de type flag
local flagElements = getElementsByType ( "flag" )
-- On boucle sur cette liste pour récupérer les positions
for key, value in pairs(flagElements) do
-- Récupération des informations
local posX = getElementData ( value, "posX" )
local posY = getElementData ( value, "posY" )
local posZ = getElementData ( value, "posZ" )
local team = getElementData ( value, "team" )
-- Création de l'objet flag
createObject ( 1337, posX, posY, posZ )
-- Affichage dans le tchat que le dreapau est créé
outputChatBox ( "Base for team " .. team .. " created" )
end
</syntaxhighlight>
La fonction [[getElementsByType]] récupère une table de tout les éléments d'un certain type. (le type correspond au noeud créé dans le fichier .map)
Fonctionne pour les objets presonnalisé mais aussi pour les objets présents par défauts dans MTA comme "vehicle" ou "player".
[[getElementData]] peut être utilisé pour récupérer les atributs XML définis dans le fichier .map.
Pour exemple, un objet est créé à la position du drapeau et un message s'affiche dans le tchat pour prévenir les joueurs. En réalité, cette action sera plutôt réalisée lors du chargement de la map. Par contre on peut imaginer une action lorsqu'un joueur s'empare du drapeau ennemi.

==Map Manager==
Après avoir lu les sections ci-dessus il doit vous paraître clair qu'un mode de jeu est composé en deux parties :
* La ressource du mode de jeu (Unique)
* Les maps qui accompagnent le mode de jeu

A la place d'écrire un [[Map manager]] pour chaque mode de jeu différent, le [[Map manager]] de base fournit des fonctions pour charger mode de jeu et maps. Il suffit simplement d'entrer un commande correcte (par exemple 'gamemode ctf ctf-italy'), cette action va démarrer le mode de jeu et la map pendant que l'évênement déclenché ([[onGamemodeMapStart]]) avertira le mode de jeu q'une map est chargée. La ressource 'ctf' peut alors accéder au informations de la map. Le mode de jeu peut alors faire spawn les joueurs.

===Comment utiliser le Map Manager===
Pour utiliser le Map Manager, votre mode de jeu doit être ciblé en premier lieu. Vous devez en fait configurer l'attribut "type" dans la baile <info> du meta.xml avec le mode de jeu souhaité. L'attribut "name" peut contenir un non plus convivial comme 'Capture de drapeau', c'estl enom qui sera affiché dans la liste des serveurs à la place du om de la ressource par défaut.
<syntaxhighlight lang="xml">

<meta>
<info type="gamemode" name="Shooter Mode 2.0"/>
</meta>
</syntaxhighlight>

Si votre mode de jeu utilise des maps personnalisées, vous devriez utiliser les évênements suivant :
* onGamemodeMapStart
* onGamemodeMapStop (Si la map doit-être déchargée)

Les évênements ci-dessus sont appelés quand une map de votre mode démarre ou s'arrête. Le paramètre passé par ces évênement n'est rien d'autre que le nom de la ressource.
Avec les fonctions sur les évênements, vous pouvez extraire toute les informations de la map ainsi que du fichier de configuration.

====Example====
<syntaxhighlight lang="lua">
function startCtfMap( startedMap ) -- startedMap contient une référence vers la ressource de la map
local mapRoot = getResourceRootElement( startedMap ) -- recoit le noeud principal de la map démarrée
local flagElements = getElementsByType ( "flag" , mapRoot ) -- recoit tout les drapeausx de la map et les stocke dans un tableau
-- Démarrage du chargement des informations
-- Spawn les joueurs etc
end
addEventHandler("onGamemodeMapStart", getRootElement(), startCtfMap)
</syntaxhighlight>

===Faire des maps compatibles===
Les maps sont des ressources séparées du mode de jeu de telle sorte qu'il ne faut pas modofier le mode de jeu pour chaque nouvelle map. Les maps peuent aussi contenir des scripts et configurations propres à elles.

Pour faire une map compatible avec votre mode, il suffit d'ouvrir le meta.xml et de mettre l'attribut "type" à 'map' et l'attribut "gamemode" doit être composé d'une liste des mode de jeu compatible avec la map (modes séparé d'une virgule).
<syntaxhighlight lang="xml">

<meta>
<info type="map" gamemodes="shootermode,assault,tdm"/>
</meta>
</syntaxhighlight>

Une fois que tout est configuré, les administrateurs peuvent utiliser le panel ou les commandes start/stop suivit du nom du mode.
/gamemode gamemodeName [NomDeLaMap] (paramètre optionel qui permet de démarré une map avec le mode, par défaut pas de map)
/changemap mapName [NomDuModeDeJeu] (paramètre optionnel qui permet dans le cas ou la map est démarrée de lancé le mode de jeu qui lui convient, par défaut le mode de jeu actif)

[[Map manager]] possède d'autres fonctions qui pourrait vous être utliles, mais elle ne sont pas toutes présentées ici.

==Autres possibilités==
Il y a une multitude d'autres ressources avec lesquelles les modes de jeu peuvent interférer.

===Helpmanager===
L'Helpmanager est une interface en jeu pour les joueurs qui on besopin d'aide. Si vous utilisez l'HelpManager pour l'aide de votre mode de jeu, tous les joueurs qui l'on utilisé précédement serront plus à l'aise car la plupart des modes l'utilise. Il affiche aussi les différentes ressources dans des onglet, si configuré pour.

Il y à deux façons d'utiliser le HelpManager :
* Fournir un simple texte qui explique le mode de jeu.
* Utilisation des éléments graphiques (GUI) (Recommandé)

N'hésitez pas à lire la page sur le HelpManager pour en savoir plus.

===Scoreboard===
Scoreboard displays players and teams currently ingame. You add custom columns to it to provide map specific information. For example the column 'points' in the 'ctf' gamemode could represent the player's points gained through kills or captures. As usual, see the scoreboard help page for more information.

===Map cycler===
The map cycler controls what gamemodes and maps are played on a server. You can specifiy for example how many times in a row a map will be played until it switches to the next. To achieve this, you need to tell the map cycler when your gamemode finished (e.g. when a round ends).

[[it:Scrivere una gamemode]]
[[ru:Writing Gamemodes]]
[[de:Gamemodes schreiben]]

Créer un mode de jeu

2014-04-04T14:54:20Z

Gaetan Piette: /* What else should you do */

Ce guide à pour but de vous aprpendre à créer un mode de jeu. Si vous venez juste de commencer à scripter pour MTA, il serait préférable que vous lisiez les autres tutoriels de l apage principale.

==Introduction==
Un mode de jeu est une ressource qui une fois démarrée contrôle tout les éléments du gameplay. Cela inclus l'explication du mode de jeu aux joueurs. Par exemple expliquer comment gagner des points ou de l'argent. (Mode de jeu existans : race, deathmatch, ctf, freeroam et bien d'autres).

==Que signifie "coder proprement un mode de jeu" ?==
Pour faire simple, un mode de jeu doit utilisé les fonctionnalités du système de map dans MTA. Cela signifie que le code des maps doit être accompagné des position des véhicule, spawn des joueur et autres. Cela permet au mode de jeu d'être indépendant des maps proposées par les joueurs.

Instead, the gamemode should be able to load .map files which define these data. This way the gamemode can have multiple maps; also, people can create .map files for the gamemode with MTA's map editor, which is much more convenient than writing code.

An obvious example of a "proper gamemode" is MTA:Race. It allows usermade maps with lots of possibilities within the .map file. To alter spawnpoints, objects etc., the user doesn't need to edit the gamemode itself.

===Fichier MAP===
Les fichiers map sont en XML avec l'extension .map. Ils définissent l'environnement pour un mode de jeu ou plusieurs si la map est compatible avec d'aures. Ils ne sont cependant pas supposés changer les règles du jeu. Les règles sont définies dans le mode de jeu.

Chaque élémment dans une map correspond à un noeud dans le fichier .map. Il y a une syntaxe particulière pour les points de spawn, objets ou véhicules. Cependant il est possible, pour des cas d'ajouts d'objets spéciaux d'inventer votre propre syntaxe.

====Exemple====
Commencons par un mode de jeu bien connu, la capture de drapeau. Une map pour ce mode de jeu à besoin de point de spawn et de positions pour les drapeaux des deux équipes. On peut aussi y ajouter des véhicules et d'autres objets. Un fichier de map simplifié pourrait ressembler à ça :

<syntaxhighlight lang="xml">
<map>
<spawnpoint id="spawnpoint1" posX="1959.5487060547" posY="-1714.4613037109" posZ="877.25219726563" rot="63.350006103516" model="0"/>
<pickup id="Armor 1" posX="1911.083984375" posY="-1658.8798828125" posZ="885.40216064453" type="armor" health="50" respawn="60000"/>
<flag posX="1959.5487060547" posY="-1714.4613037109" posZ="877.25219726563" team="blue" />
...
</map>
</syntaxhighlight>

Dans le code ci-dessus on peut apercevoir trois éléments : un point de spawn,un pickup et un flag.
Le pickup permettera une fois pris par le joueur de lui rendre 50 points de vie, celui-ci respawn toute les 60 secondes.
Le flag est ici définit au niveau de sa position et de sa couleur (propre à l'équipe).
Le point de spawn et le pickup peuvent être utilisé par une ressource externe. Les éléments personnalisés doievent être gérés par le mode de jeu.

Pour résumé, votre objectif est de facilité la vie des mappeurs. Ceux-ci ne doivent pas avoir à se tracasser du script concernant le mode de jeu.

====Exemple de récupération d'informations sur un .map====
Votre mode de jeu doit appelés les éléments personnalisés définit dans le fichier .map afin des les utilisés. Ce n'est pas bien compliqué et voici une démonstration ci-dessous.
<syntaxhighlight lang="lua">
-- récupère une liste avec tout les éléments de type flag
local flagElements = getElementsByType ( "flag" )
-- On boucle sur cette liste pour récupérer les positions
for key, value in pairs(flagElements) do
-- Récupération des informations
local posX = getElementData ( value, "posX" )
local posY = getElementData ( value, "posY" )
local posZ = getElementData ( value, "posZ" )
local team = getElementData ( value, "team" )
-- Création de l'objet flag
createObject ( 1337, posX, posY, posZ )
-- Affichage dans le tchat que le dreapau est créé
outputChatBox ( "Base for team " .. team .. " created" )
end
</syntaxhighlight>
La fonction [[getElementsByType]] récupère une table de tout les éléments d'un certain type. (le type correspond au noeud créé dans le fichier .map)
Fonctionne pour les objets presonnalisé mais aussi pour les objets présents par défauts dans MTA comme "vehicle" ou "player".
[[getElementData]] peut être utilisé pour récupérer les atributs XML définis dans le fichier .map.
Pour exemple, un objet est créé à la position du drapeau et un message s'affiche dans le tchat pour prévenir les joueurs. En réalité, cette action sera plutôt réalisée lors du chargement de la map. Par contre on peut imaginer une action lorsqu'un joueur s'empare du drapeau ennemi.

==Map Manager==
Après avoir lu les sections ci-dessus il doit vous paraître clair qu'un mode de jeu est composé en deux parties :
* La ressource du mode de jeu (Unique)
* Les maps qui accompagnent le mode de jeu

A la place d'écrire un [[Map manager]] pour chaque mode de jeu différent, le [[Map manager]] de base fournit des fonctions pour charger mode de jeu et maps. Il suffit simplement d'entrer un commande correcte (par exemple 'gamemode ctf ctf-italy'), cette action va démarrer le mode de jeu et la map pendant que l'évênement déclenché ([[onGamemodeMapStart]]) avertira le mode de jeu q'une map est chargée. La ressource 'ctf' peut alors accéder au informations de la map. Le mode de jeu peut alors faire spawn les joueurs.

===Comment utiliser le Map Manager===
Pour utiliser le Map Manager, votre mode de jeu doit être ciblé en premier lieu. Vous devez en fait configurer l'attribut "type" dans la baile <info> du meta.xml avec le mode de jeu souhaité. L'attribut "name" peut contenir un non plus convivial comme 'Capture de drapeau', c'estl enom qui sera affiché dans la liste des serveurs à la place du om de la ressource par défaut.
<syntaxhighlight lang="xml">

<meta>
<info type="gamemode" name="Shooter Mode 2.0"/>
</meta>
</syntaxhighlight>

Si votre mode de jeu utilise des maps personnalisées, vous devriez utiliser les évênements suivant :
* onGamemodeMapStart
* onGamemodeMapStop (Si la map doit-être déchargée)

Les évênements ci-dessus sont appelés quand une map de votre mode démarre ou s'arrête. Le paramètre passé par ces évênement n'est rien d'autre que le nom de la ressource.
Avec les fonctions sur les évênements, vous pouvez extraire toute les informations de la map ainsi que du fichier de configuration.

====Example====
<syntaxhighlight lang="lua">
function startCtfMap( startedMap ) -- startedMap contient une référence vers la ressource de la map
local mapRoot = getResourceRootElement( startedMap ) -- recoit le noeud principal de la map démarrée
local flagElements = getElementsByType ( "flag" , mapRoot ) -- recoit tout les drapeausx de la map et les stocke dans un tableau
-- Démarrage du chargement des informations
-- Spawn les joueurs etc
end
addEventHandler("onGamemodeMapStart", getRootElement(), startCtfMap)
</syntaxhighlight>

===Faire des maps compatibles===
Les maps sont des ressources séparées du mode de jeu de telle sorte qu'il ne faut pas modofier le mode de jeu pour chaque nouvelle map. Les maps peuent aussi contenir des scripts et configurations propres à elles.

Pour faire une map compatible avec votre mode, il suffit d'ouvrir le meta.xml et de mettre l'attribut "type" à 'map' et l'attribut "gamemode" doit être composé d'une liste des mode de jeu compatible avec la map (modes séparé d'une virgule).
<syntaxhighlight lang="xml">

<meta>
<info type="map" gamemodes="shootermode,assault,tdm"/>
</meta>
</syntaxhighlight>

Une fois que tout est configuré, les administrateurs peuvent utiliser le panel ou les commandes start/stop suivit du nom du mode.
/gamemode gamemodeName [NomDeLaMap] (paramètre optionel qui permet de démarré une map avec le mode, par défaut pas de map)
/changemap mapName [NomDuModeDeJeu] (paramètre optionnel qui permet dans le cas ou la map est démarrée de lancé le mode de jeu qui lui convient, par défaut le mode de jeu actif)

[[Map manager]] possède d'autres fonctions qui pourrait vous être utliles, mais elle ne sont pas toutes présentées ici.

==Autres possibilités==
Il y a une multitude d'autres ressources avec lesquelles les modes de jeu peuvent interférer.

===Helpmanager===
L'Helpmanager est une interface en jeu pour les joueurs qui on besopin d'aide. Si vous utilisez l'HelpManager pour l'aide de votre mode de jeu, tous les joueurs qui l'on utilisé précédement serront plus à l'aise car la plupart des modes l'utilise. Il affiche aussi les différentes ressources dans des onglet, si configuré pour.

Il y à deux façons d'utiliser le HelpManager :
* Fournir un simple texte qui explique le mode de jeu.
* Request a GUI element from the helpmanager that will be displayed in its own tab in the helpmanager window and lets you add any GUI elements to it. This is the recommended way for gamemodes that need to display more complex information that needs its own GUI.

Read the helpmanager page for details on how to do it.

===Scoreboard===
Scoreboard displays players and teams currently ingame. You add custom columns to it to provide map specific information. For example the column 'points' in the 'ctf' gamemode could represent the player's points gained through kills or captures. As usual, see the scoreboard help page for more information.

===Map cycler===
The map cycler controls what gamemodes and maps are played on a server. You can specifiy for example how many times in a row a map will be played until it switches to the next. To achieve this, you need to tell the map cycler when your gamemode finished (e.g. when a round ends).

[[it:Scrivere una gamemode]]
[[ru:Writing Gamemodes]]
[[de:Gamemodes schreiben]]

Créer un mode de jeu

2014-04-04T14:39:37Z

Gaetan Piette: /* Map Manager */

Ce guide à pour but de vous aprpendre à créer un mode de jeu. Si vous venez juste de commencer à scripter pour MTA, il serait préférable que vous lisiez les autres tutoriels de l apage principale.

==Introduction==
Un mode de jeu est une ressource qui une fois démarrée contrôle tout les éléments du gameplay. Cela inclus l'explication du mode de jeu aux joueurs. Par exemple expliquer comment gagner des points ou de l'argent. (Mode de jeu existans : race, deathmatch, ctf, freeroam et bien d'autres).

==Que signifie "coder proprement un mode de jeu" ?==
Pour faire simple, un mode de jeu doit utilisé les fonctionnalités du système de map dans MTA. Cela signifie que le code des maps doit être accompagné des position des véhicule, spawn des joueur et autres. Cela permet au mode de jeu d'être indépendant des maps proposées par les joueurs.

Instead, the gamemode should be able to load .map files which define these data. This way the gamemode can have multiple maps; also, people can create .map files for the gamemode with MTA's map editor, which is much more convenient than writing code.

An obvious example of a "proper gamemode" is MTA:Race. It allows usermade maps with lots of possibilities within the .map file. To alter spawnpoints, objects etc., the user doesn't need to edit the gamemode itself.

===Fichier MAP===
Les fichiers map sont en XML avec l'extension .map. Ils définissent l'environnement pour un mode de jeu ou plusieurs si la map est compatible avec d'aures. Ils ne sont cependant pas supposés changer les règles du jeu. Les règles sont définies dans le mode de jeu.

Chaque élémment dans une map correspond à un noeud dans le fichier .map. Il y a une syntaxe particulière pour les points de spawn, objets ou véhicules. Cependant il est possible, pour des cas d'ajouts d'objets spéciaux d'inventer votre propre syntaxe.

====Exemple====
Commencons par un mode de jeu bien connu, la capture de drapeau. Une map pour ce mode de jeu à besoin de point de spawn et de positions pour les drapeaux des deux équipes. On peut aussi y ajouter des véhicules et d'autres objets. Un fichier de map simplifié pourrait ressembler à ça :

<syntaxhighlight lang="xml">
<map>
<spawnpoint id="spawnpoint1" posX="1959.5487060547" posY="-1714.4613037109" posZ="877.25219726563" rot="63.350006103516" model="0"/>
<pickup id="Armor 1" posX="1911.083984375" posY="-1658.8798828125" posZ="885.40216064453" type="armor" health="50" respawn="60000"/>
<flag posX="1959.5487060547" posY="-1714.4613037109" posZ="877.25219726563" team="blue" />
...
</map>
</syntaxhighlight>

Dans le code ci-dessus on peut apercevoir trois éléments : un point de spawn,un pickup et un flag.
Le pickup permettera une fois pris par le joueur de lui rendre 50 points de vie, celui-ci respawn toute les 60 secondes.
Le flag est ici définit au niveau de sa position et de sa couleur (propre à l'équipe).
Le point de spawn et le pickup peuvent être utilisé par une ressource externe. Les éléments personnalisés doievent être gérés par le mode de jeu.

Pour résumé, votre objectif est de facilité la vie des mappeurs. Ceux-ci ne doivent pas avoir à se tracasser du script concernant le mode de jeu.

====Exemple de récupération d'informations sur un .map====
Votre mode de jeu doit appelés les éléments personnalisés définit dans le fichier .map afin des les utilisés. Ce n'est pas bien compliqué et voici une démonstration ci-dessous.
<syntaxhighlight lang="lua">
-- récupère une liste avec tout les éléments de type flag
local flagElements = getElementsByType ( "flag" )
-- On boucle sur cette liste pour récupérer les positions
for key, value in pairs(flagElements) do
-- Récupération des informations
local posX = getElementData ( value, "posX" )
local posY = getElementData ( value, "posY" )
local posZ = getElementData ( value, "posZ" )
local team = getElementData ( value, "team" )
-- Création de l'objet flag
createObject ( 1337, posX, posY, posZ )
-- Affichage dans le tchat que le dreapau est créé
outputChatBox ( "Base for team " .. team .. " created" )
end
</syntaxhighlight>
La fonction [[getElementsByType]] récupère une table de tout les éléments d'un certain type. (le type correspond au noeud créé dans le fichier .map)
Fonctionne pour les objets presonnalisé mais aussi pour les objets présents par défauts dans MTA comme "vehicle" ou "player".
[[getElementData]] peut être utilisé pour récupérer les atributs XML définis dans le fichier .map.
Pour exemple, un objet est créé à la position du drapeau et un message s'affiche dans le tchat pour prévenir les joueurs. En réalité, cette action sera plutôt réalisée lors du chargement de la map. Par contre on peut imaginer une action lorsqu'un joueur s'empare du drapeau ennemi.

==Map Manager==
Après avoir lu les sections ci-dessus il doit vous paraître clair qu'un mode de jeu est composé en deux parties :
* La ressource du mode de jeu (Unique)
* Les maps qui accompagnent le mode de jeu

A la place d'écrire un [[Map manager]] pour chaque mode de jeu différent, le [[Map manager]] de base fournit des fonctions pour charger mode de jeu et maps. Il suffit simplement d'entrer un commande correcte (par exemple 'gamemode ctf ctf-italy'), cette action va démarrer le mode de jeu et la map pendant que l'évênement déclenché ([[onGamemodeMapStart]]) avertira le mode de jeu q'une map est chargée. La ressource 'ctf' peut alors accéder au informations de la map. Le mode de jeu peut alors faire spawn les joueurs.

===Comment utiliser le Map Manager===
Pour utiliser le Map Manager, votre mode de jeu doit être ciblé en premier lieu. Vous devez en fait configurer l'attribut "type" dans la baile <info> du meta.xml avec le mode de jeu souhaité. L'attribut "name" peut contenir un non plus convivial comme 'Capture de drapeau', c'estl enom qui sera affiché dans la liste des serveurs à la place du om de la ressource par défaut.
<syntaxhighlight lang="xml">

<meta>
<info type="gamemode" name="Shooter Mode 2.0"/>
</meta>
</syntaxhighlight>

Si votre mode de jeu utilise des maps personnalisées, vous devriez utiliser les évênements suivant :
* onGamemodeMapStart
* onGamemodeMapStop (Si la map doit-être déchargée)

Les évênements ci-dessus sont appelés quand une map de votre mode démarre ou s'arrête. Le paramètre passé par ces évênement n'est rien d'autre que le nom de la ressource.
Avec les fonctions sur les évênements, vous pouvez extraire toute les informations de la map ainsi que du fichier de configuration.

====Example====
<syntaxhighlight lang="lua">
function startCtfMap( startedMap ) -- startedMap contient une référence vers la ressource de la map
local mapRoot = getResourceRootElement( startedMap ) -- recoit le noeud principal de la map démarrée
local flagElements = getElementsByType ( "flag" , mapRoot ) -- recoit tout les drapeausx de la map et les stocke dans un tableau
-- Démarrage du chargement des informations
-- Spawn les joueurs etc
end
addEventHandler("onGamemodeMapStart", getRootElement(), startCtfMap)
</syntaxhighlight>

===Faire des maps compatibles===
Les maps sont des ressources séparées du mode de jeu de telle sorte qu'il ne faut pas modofier le mode de jeu pour chaque nouvelle map. Les maps peuent aussi contenir des scripts et configurations propres à elles.

Pour faire une map compatible avec votre mode, il suffit d'ouvrir le meta.xml et de mettre l'attribut "type" à 'map' et l'attribut "gamemode" doit être composé d'une liste des mode de jeu compatible avec la map (modes séparé d'une virgule).
<syntaxhighlight lang="xml">

<meta>
<info type="map" gamemodes="shootermode,assault,tdm"/>
</meta>
</syntaxhighlight>

Une fois que tout est configuré, les administrateurs peuvent utiliser le panel ou les commandes start/stop suivit du nom du mode.
/gamemode gamemodeName [NomDeLaMap] (paramètre optionel qui permet de démarré une map avec le mode, par défaut pas de map)
/changemap mapName [NomDuModeDeJeu] (paramètre optionnel qui permet dans le cas ou la map est démarrée de lancé le mode de jeu qui lui convient, par défaut le mode de jeu actif)

[[Map manager]] possède d'autres fonctions qui pourrait vous être utliles, mais elle ne sont pas toutes présentées ici.

==What else should you do==
There are several other resources that gamemodes should use/be compliant with.

===Helpmanager===
The helpmanager is ought to be the standard interface for players when they need help. If you use the helpmanager to display your gamemode's help, every player that used helpmanager before (e.g. in other gamemodes) will immediately know how to get there. It also displays help for different resources running resources in one window, if necessary.

There are basicially two ways to use the helpmanager:
* Provide a simple text that explains how to use your gamemode
* Request a GUI element from the helpmanager that will be displayed in its own tab in the helpmanager window and lets you add any GUI elements to it. This is the recommended way for gamemodes that need to display more complex information that needs its own GUI.

Read the helpmanager page for details on how to do it.

===Scoreboard===
Scoreboard displays players and teams currently ingame. You add custom columns to it to provide map specific information. For example the column 'points' in the 'ctf' gamemode could represent the player's points gained through kills or captures. As usual, see the scoreboard help page for more information.

===Map cycler===
The map cycler controls what gamemodes and maps are played on a server. You can specifiy for example how many times in a row a map will be played until it switches to the next. To achieve this, you need to tell the map cycler when your gamemode finished (e.g. when a round ends).

[[it:Scrivere una gamemode]]
[[ru:Writing Gamemodes]]
[[de:Gamemodes schreiben]]

Créer un mode de jeu

2014-04-04T14:11:47Z

Gaetan Piette: /* Introduction */

Ce guide à pour but de vous aprpendre à créer un mode de jeu. Si vous venez juste de commencer à scripter pour MTA, il serait préférable que vous lisiez les autres tutoriels de l apage principale.

==Introduction==
Un mode de jeu est une ressource qui une fois démarrée contrôle tout les éléments du gameplay. Cela inclus l'explication du mode de jeu aux joueurs. Par exemple expliquer comment gagner des points ou de l'argent. (Mode de jeu existans : race, deathmatch, ctf, freeroam et bien d'autres).

==Que signifie "coder proprement un mode de jeu" ?==
Pour faire simple, un mode de jeu doit utilisé les fonctionnalités du système de map dans MTA. Cela signifie que le code des maps doit être accompagné des position des véhicule, spawn des joueur et autres. Cela permet au mode de jeu d'être indépendant des maps proposées par les joueurs.

Instead, the gamemode should be able to load .map files which define these data. This way the gamemode can have multiple maps; also, people can create .map files for the gamemode with MTA's map editor, which is much more convenient than writing code.

An obvious example of a "proper gamemode" is MTA:Race. It allows usermade maps with lots of possibilities within the .map file. To alter spawnpoints, objects etc., the user doesn't need to edit the gamemode itself.

===Fichier MAP===
Les fichiers map sont en XML avec l'extension .map. Ils définissent l'environnement pour un mode de jeu ou plusieurs si la map est compatible avec d'aures. Ils ne sont cependant pas supposés changer les règles du jeu. Les règles sont définies dans le mode de jeu.

Chaque élémment dans une map correspond à un noeud dans le fichier .map. Il y a une syntaxe particulière pour les points de spawn, objets ou véhicules. Cependant il est possible, pour des cas d'ajouts d'objets spéciaux d'inventer votre propre syntaxe.

====Exemple====
Commencons par un mode de jeu bien connu, la capture de drapeau. Une map pour ce mode de jeu à besoin de point de spawn et de positions pour les drapeaux des deux équipes. On peut aussi y ajouter des véhicules et d'autres objets. Un fichier de map simplifié pourrait ressembler à ça :

<syntaxhighlight lang="xml">
<map>
<spawnpoint id="spawnpoint1" posX="1959.5487060547" posY="-1714.4613037109" posZ="877.25219726563" rot="63.350006103516" model="0"/>
<pickup id="Armor 1" posX="1911.083984375" posY="-1658.8798828125" posZ="885.40216064453" type="armor" health="50" respawn="60000"/>
<flag posX="1959.5487060547" posY="-1714.4613037109" posZ="877.25219726563" team="blue" />
...
</map>
</syntaxhighlight>

Dans le code ci-dessus on peut apercevoir trois éléments : un point de spawn,un pickup et un flag.
Le pickup permettera une fois pris par le joueur de lui rendre 50 points de vie, celui-ci respawn toute les 60 secondes.
Le flag est ici définit au niveau de sa position et de sa couleur (propre à l'équipe).
Le point de spawn et le pickup peuvent être utilisé par une ressource externe. Les éléments personnalisés doievent être gérés par le mode de jeu.

Pour résumé, votre objectif est de facilité la vie des mappeurs. Ceux-ci ne doivent pas avoir à se tracasser du script concernant le mode de jeu.

====Exemple de récupération d'informations sur un .map====
Votre mode de jeu doit appelés les éléments personnalisés définit dans le fichier .map afin des les utilisés. Ce n'est pas bien compliqué et voici une démonstration ci-dessous.
<syntaxhighlight lang="lua">
-- récupère une liste avec tout les éléments de type flag
local flagElements = getElementsByType ( "flag" )
-- On boucle sur cette liste pour récupérer les positions
for key, value in pairs(flagElements) do
-- Récupération des informations
local posX = getElementData ( value, "posX" )
local posY = getElementData ( value, "posY" )
local posZ = getElementData ( value, "posZ" )
local team = getElementData ( value, "team" )
-- Création de l'objet flag
createObject ( 1337, posX, posY, posZ )
-- Affichage dans le tchat que le dreapau est créé
outputChatBox ( "Base for team " .. team .. " created" )
end
</syntaxhighlight>
La fonction [[getElementsByType]] récupère une table de tout les éléments d'un certain type. (le type correspond au noeud créé dans le fichier .map)
Fonctionne pour les objets presonnalisé mais aussi pour les objets présents par défauts dans MTA comme "vehicle" ou "player".
[[getElementData]] peut être utilisé pour récupérer les atributs XML définis dans le fichier .map.
Pour exemple, un objet est créé à la position du drapeau et un message s'affiche dans le tchat pour prévenir les joueurs. En réalité, cette action sera plutôt réalisée lors du chargement de la map. Par contre on peut imaginer une action lorsqu'un joueur s'empare du drapeau ennemi.

==Map Manager==
Après avoir lu les sections ci-dessus il doit vous paraître clair qu'un mode de jeu est composé en deux parties :
* La ressource du mode de jeu (Unique)
* Les maps qui accompagnent le mode de jeu

Now instead of writing a map-loader for every single gamemode, the [[Map manager]] provides functions to load gamemodes and maps. Simply put, when you enter the correct command (for example 'gamemode ctf ctf-italy') it will start both resources 'ctf' and 'ctf-italy' while triggering an event ([[onGamemodeMapStart]]) to tell the 'ctf' resource that a map was loaded. The 'ctf' resource can then access the information 'ctf-italy' contains and start spawning players etc.

===How to use the mapmanager===
To use the mapmanager service, your gamemode resource has to be tagged as such first. More specifically you'll be setting the "type" attribute of its <info> tag to "gamemode" inside meta.xml. Also, you can set the "name" attribute to a friendly name (like "Capture the flag") that will be shown on ASE instead of the resource name.
<syntaxhighlight lang="xml">

<meta>
<info type="gamemode" name="Cow catapulting 2.0"/>
</meta>
</syntaxhighlight>

If your gamemode is going to load custom maps, you should add handlers for
* onGamemodeMapStart
* onGamemodeMapStop (if any unloading is necessary)
These are fired when a map for your gamemode is started or stopped, and pass the map resource as a parameter.
Within the handler function for these events you can extract all info you need from the resource's map files and configuration files.

====Example====
<syntaxhighlight lang="lua">
function startCtfMap( startedMap ) -- startedMap contains a reference to the resource of the map
local mapRoot = getResourceRootElement( startedMap ) -- get the root node of the started map
local flagElements = getElementsByType ( "flag" , mapRoot ) -- get all flags in the map and store them in a table
-- go on loading information like in the example above
-- spawn players etc.
end
addEventHandler("onGamemodeMapStart", getRootElement(), startCtfMap)
</syntaxhighlight>

===Making maps compatible===
Maps are separate resources. This is done so no editing of the gamemode resource is ever necessary in order to create a custom map, and also allows you to pack map-specific scripts/config files with them.

To make a map compatible with your gamemode, open its resource's meta.xml and tag it as well: the "type" attribute must be set to "map", and the "gamemodes" attribute must be a comma-separated list (no spaces) of gamemode resource names that the map works with.
<syntaxhighlight lang="xml">

<meta>
<info type="map" gamemodes="cowcatapult,assault,tdm"/>
</meta>
</syntaxhighlight>

Once you have everything set up, admins will use these two commands to start/stop gamemodes:
/gamemode gamemodeName [mapName] (optional parameter allows picking an initial map, defaults to none)
/changemap mapName [gamemodeName] (optional parameter specifies the gamemode to start the map with, defaults to the current one)

[[Map manager]] exports a few more access functions which you don't have to use, but may be useful.

==What else should you do==
There are several other resources that gamemodes should use/be compliant with.

===Helpmanager===
The helpmanager is ought to be the standard interface for players when they need help. If you use the helpmanager to display your gamemode's help, every player that used helpmanager before (e.g. in other gamemodes) will immediately know how to get there. It also displays help for different resources running resources in one window, if necessary.

There are basicially two ways to use the helpmanager:
* Provide a simple text that explains how to use your gamemode
* Request a GUI element from the helpmanager that will be displayed in its own tab in the helpmanager window and lets you add any GUI elements to it. This is the recommended way for gamemodes that need to display more complex information that needs its own GUI.

Read the helpmanager page for details on how to do it.

===Scoreboard===
Scoreboard displays players and teams currently ingame. You add custom columns to it to provide map specific information. For example the column 'points' in the 'ctf' gamemode could represent the player's points gained through kills or captures. As usual, see the scoreboard help page for more information.

===Map cycler===
The map cycler controls what gamemodes and maps are played on a server. You can specifiy for example how many times in a row a map will be played until it switches to the next. To achieve this, you need to tell the map cycler when your gamemode finished (e.g. when a round ends).

[[it:Scrivere una gamemode]]
[[ru:Writing Gamemodes]]
[[de:Gamemodes schreiben]]

Créer un mode de jeu

2014-04-04T10:10:14Z

Gaetan Piette: /* Map manager */

Ce guide à pour but de vous aprpendre à créer un mode de jeu. Si vous venez juste de commencer à scripter pour MTA, il serait préférable que vous lisiez les autres tutoriels de l apage principale.

==Introduction==
Un mode de jeu est une ressource qu iune fois démarrée contrôle tout les éléments du gameplay. Cela inclus l'explication du mode de jeu aux joueurs. Par exemple expliquer comment gagner des points ou de l'argent. (Mode de jeu existans : race, deathmatch, ctf, freeroam et bien d'autres).

==Que signifie "coder proprement un mode de jeu" ?==
Pour faire simple, un mode de jeu doit utilisé les fonctionnalités du système de map dans MTA. Cela signifie que le code des maps doit être accompagné des position des véhicule, spawn des joueur et autres. Cela permet au mode de jeu d'être indépendant des maps proposées par les joueurs.

Instead, the gamemode should be able to load .map files which define these data. This way the gamemode can have multiple maps; also, people can create .map files for the gamemode with MTA's map editor, which is much more convenient than writing code.

An obvious example of a "proper gamemode" is MTA:Race. It allows usermade maps with lots of possibilities within the .map file. To alter spawnpoints, objects etc., the user doesn't need to edit the gamemode itself.

===Fichier MAP===
Les fichiers map sont en XML avec l'extension .map. Ils définissent l'environnement pour un mode de jeu ou plusieurs si la map est compatible avec d'aures. Ils ne sont cependant pas supposés changer les règles du jeu. Les règles sont définies dans le mode de jeu.

Chaque élémment dans une map correspond à un noeud dans le fichier .map. Il y a une syntaxe particulière pour les points de spawn, objets ou véhicules. Cependant il est possible, pour des cas d'ajouts d'objets spéciaux d'inventer votre propre syntaxe.

====Exemple====
Commencons par un mode de jeu bien connu, la capture de drapeau. Une map pour ce mode de jeu à besoin de point de spawn et de positions pour les drapeaux des deux équipes. On peut aussi y ajouter des véhicules et d'autres objets. Un fichier de map simplifié pourrait ressembler à ça :

<syntaxhighlight lang="xml">
<map>
<spawnpoint id="spawnpoint1" posX="1959.5487060547" posY="-1714.4613037109" posZ="877.25219726563" rot="63.350006103516" model="0"/>
<pickup id="Armor 1" posX="1911.083984375" posY="-1658.8798828125" posZ="885.40216064453" type="armor" health="50" respawn="60000"/>
<flag posX="1959.5487060547" posY="-1714.4613037109" posZ="877.25219726563" team="blue" />
...
</map>
</syntaxhighlight>

Dans le code ci-dessus on peut apercevoir trois éléments : un point de spawn,un pickup et un flag.
Le pickup permettera une fois pris par le joueur de lui rendre 50 points de vie, celui-ci respawn toute les 60 secondes.
Le flag est ici définit au niveau de sa position et de sa couleur (propre à l'équipe).
Le point de spawn et le pickup peuvent être utilisé par une ressource externe. Les éléments personnalisés doievent être gérés par le mode de jeu.

Pour résumé, votre objectif est de facilité la vie des mappeurs. Ceux-ci ne doivent pas avoir à se tracasser du script concernant le mode de jeu.

====Exemple de récupération d'informations sur un .map====
Votre mode de jeu doit appelés les éléments personnalisés définit dans le fichier .map afin des les utilisés. Ce n'est pas bien compliqué et voici une démonstration ci-dessous.
<syntaxhighlight lang="lua">
-- récupère une liste avec tout les éléments de type flag
local flagElements = getElementsByType ( "flag" )
-- On boucle sur cette liste pour récupérer les positions
for key, value in pairs(flagElements) do
-- Récupération des informations
local posX = getElementData ( value, "posX" )
local posY = getElementData ( value, "posY" )
local posZ = getElementData ( value, "posZ" )
local team = getElementData ( value, "team" )
-- Création de l'objet flag
createObject ( 1337, posX, posY, posZ )
-- Affichage dans le tchat que le dreapau est créé
outputChatBox ( "Base for team " .. team .. " created" )
end
</syntaxhighlight>
La fonction [[getElementsByType]] récupère une table de tout les éléments d'un certain type. (le type correspond au noeud créé dans le fichier .map)
Fonctionne pour les objets presonnalisé mais aussi pour les objets présents par défauts dans MTA comme "vehicle" ou "player".
[[getElementData]] peut être utilisé pour récupérer les atributs XML définis dans le fichier .map.
Pour exemple, un objet est créé à la position du drapeau et un message s'affiche dans le tchat pour prévenir les joueurs. En réalité, cette action sera plutôt réalisée lors du chargement de la map. Par contre on peut imaginer une action lorsqu'un joueur s'empare du drapeau ennemi.

==Map Manager==
Après avoir lu les sections ci-dessus il doit vous paraître clair qu'un mode de jeu est composé en deux parties :
* La ressource du mode de jeu (Unique)
* Les maps qui accompagnent le mode de jeu

Now instead of writing a map-loader for every single gamemode, the [[Map manager]] provides functions to load gamemodes and maps. Simply put, when you enter the correct command (for example 'gamemode ctf ctf-italy') it will start both resources 'ctf' and 'ctf-italy' while triggering an event ([[onGamemodeMapStart]]) to tell the 'ctf' resource that a map was loaded. The 'ctf' resource can then access the information 'ctf-italy' contains and start spawning players etc.

===How to use the mapmanager===
To use the mapmanager service, your gamemode resource has to be tagged as such first. More specifically you'll be setting the "type" attribute of its <info> tag to "gamemode" inside meta.xml. Also, you can set the "name" attribute to a friendly name (like "Capture the flag") that will be shown on ASE instead of the resource name.
<syntaxhighlight lang="xml">

<meta>
<info type="gamemode" name="Cow catapulting 2.0"/>
</meta>
</syntaxhighlight>

If your gamemode is going to load custom maps, you should add handlers for
* onGamemodeMapStart
* onGamemodeMapStop (if any unloading is necessary)
These are fired when a map for your gamemode is started or stopped, and pass the map resource as a parameter.
Within the handler function for these events you can extract all info you need from the resource's map files and configuration files.

====Example====
<syntaxhighlight lang="lua">
function startCtfMap( startedMap ) -- startedMap contains a reference to the resource of the map
local mapRoot = getResourceRootElement( startedMap ) -- get the root node of the started map
local flagElements = getElementsByType ( "flag" , mapRoot ) -- get all flags in the map and store them in a table
-- go on loading information like in the example above
-- spawn players etc.
end
addEventHandler("onGamemodeMapStart", getRootElement(), startCtfMap)
</syntaxhighlight>

===Making maps compatible===
Maps are separate resources. This is done so no editing of the gamemode resource is ever necessary in order to create a custom map, and also allows you to pack map-specific scripts/config files with them.

To make a map compatible with your gamemode, open its resource's meta.xml and tag it as well: the "type" attribute must be set to "map", and the "gamemodes" attribute must be a comma-separated list (no spaces) of gamemode resource names that the map works with.
<syntaxhighlight lang="xml">

<meta>
<info type="map" gamemodes="cowcatapult,assault,tdm"/>
</meta>
</syntaxhighlight>

Once you have everything set up, admins will use these two commands to start/stop gamemodes:
/gamemode gamemodeName [mapName] (optional parameter allows picking an initial map, defaults to none)
/changemap mapName [gamemodeName] (optional parameter specifies the gamemode to start the map with, defaults to the current one)

[[Map manager]] exports a few more access functions which you don't have to use, but may be useful.

==What else should you do==
There are several other resources that gamemodes should use/be compliant with.

===Helpmanager===
The helpmanager is ought to be the standard interface for players when they need help. If you use the helpmanager to display your gamemode's help, every player that used helpmanager before (e.g. in other gamemodes) will immediately know how to get there. It also displays help for different resources running resources in one window, if necessary.

There are basicially two ways to use the helpmanager:
* Provide a simple text that explains how to use your gamemode
* Request a GUI element from the helpmanager that will be displayed in its own tab in the helpmanager window and lets you add any GUI elements to it. This is the recommended way for gamemodes that need to display more complex information that needs its own GUI.

Read the helpmanager page for details on how to do it.

===Scoreboard===
Scoreboard displays players and teams currently ingame. You add custom columns to it to provide map specific information. For example the column 'points' in the 'ctf' gamemode could represent the player's points gained through kills or captures. As usual, see the scoreboard help page for more information.

===Map cycler===
The map cycler controls what gamemodes and maps are played on a server. You can specifiy for example how many times in a row a map will be played until it switches to the next. To achieve this, you need to tell the map cycler when your gamemode finished (e.g. when a round ends).

[[it:Scrivere una gamemode]]
[[ru:Writing Gamemodes]]
[[de:Gamemodes schreiben]]

Créer un mode de jeu

2014-04-04T10:07:51Z

Gaetan Piette: /* Exemple de récupération d'informations sur un .map */

Ce guide à pour but de vous aprpendre à créer un mode de jeu. Si vous venez juste de commencer à scripter pour MTA, il serait préférable que vous lisiez les autres tutoriels de l apage principale.

==Introduction==
Un mode de jeu est une ressource qu iune fois démarrée contrôle tout les éléments du gameplay. Cela inclus l'explication du mode de jeu aux joueurs. Par exemple expliquer comment gagner des points ou de l'argent. (Mode de jeu existans : race, deathmatch, ctf, freeroam et bien d'autres).

==Que signifie "coder proprement un mode de jeu" ?==
Pour faire simple, un mode de jeu doit utilisé les fonctionnalités du système de map dans MTA. Cela signifie que le code des maps doit être accompagné des position des véhicule, spawn des joueur et autres. Cela permet au mode de jeu d'être indépendant des maps proposées par les joueurs.

Instead, the gamemode should be able to load .map files which define these data. This way the gamemode can have multiple maps; also, people can create .map files for the gamemode with MTA's map editor, which is much more convenient than writing code.

An obvious example of a "proper gamemode" is MTA:Race. It allows usermade maps with lots of possibilities within the .map file. To alter spawnpoints, objects etc., the user doesn't need to edit the gamemode itself.

===Fichier MAP===
Les fichiers map sont en XML avec l'extension .map. Ils définissent l'environnement pour un mode de jeu ou plusieurs si la map est compatible avec d'aures. Ils ne sont cependant pas supposés changer les règles du jeu. Les règles sont définies dans le mode de jeu.

Chaque élémment dans une map correspond à un noeud dans le fichier .map. Il y a une syntaxe particulière pour les points de spawn, objets ou véhicules. Cependant il est possible, pour des cas d'ajouts d'objets spéciaux d'inventer votre propre syntaxe.

====Exemple====
Commencons par un mode de jeu bien connu, la capture de drapeau. Une map pour ce mode de jeu à besoin de point de spawn et de positions pour les drapeaux des deux équipes. On peut aussi y ajouter des véhicules et d'autres objets. Un fichier de map simplifié pourrait ressembler à ça :

<syntaxhighlight lang="xml">
<map>
<spawnpoint id="spawnpoint1" posX="1959.5487060547" posY="-1714.4613037109" posZ="877.25219726563" rot="63.350006103516" model="0"/>
<pickup id="Armor 1" posX="1911.083984375" posY="-1658.8798828125" posZ="885.40216064453" type="armor" health="50" respawn="60000"/>
<flag posX="1959.5487060547" posY="-1714.4613037109" posZ="877.25219726563" team="blue" />
...
</map>
</syntaxhighlight>

Dans le code ci-dessus on peut apercevoir trois éléments : un point de spawn,un pickup et un flag.
Le pickup permettera une fois pris par le joueur de lui rendre 50 points de vie, celui-ci respawn toute les 60 secondes.
Le flag est ici définit au niveau de sa position et de sa couleur (propre à l'équipe).
Le point de spawn et le pickup peuvent être utilisé par une ressource externe. Les éléments personnalisés doievent être gérés par le mode de jeu.

Pour résumé, votre objectif est de facilité la vie des mappeurs. Ceux-ci ne doivent pas avoir à se tracasser du script concernant le mode de jeu.

====Exemple de récupération d'informations sur un .map====
Votre mode de jeu doit appelés les éléments personnalisés définit dans le fichier .map afin des les utilisés. Ce n'est pas bien compliqué et voici une démonstration ci-dessous.
<syntaxhighlight lang="lua">
-- récupère une liste avec tout les éléments de type flag
local flagElements = getElementsByType ( "flag" )
-- On boucle sur cette liste pour récupérer les positions
for key, value in pairs(flagElements) do
-- Récupération des informations
local posX = getElementData ( value, "posX" )
local posY = getElementData ( value, "posY" )
local posZ = getElementData ( value, "posZ" )
local team = getElementData ( value, "team" )
-- Création de l'objet flag
createObject ( 1337, posX, posY, posZ )
-- Affichage dans le tchat que le dreapau est créé
outputChatBox ( "Base for team " .. team .. " created" )
end
</syntaxhighlight>
La fonction [[getElementsByType]] récupère une table de tout les éléments d'un certain type. (le type correspond au noeud créé dans le fichier .map)
Fonctionne pour les objets presonnalisé mais aussi pour les objets présents par défauts dans MTA comme "vehicle" ou "player".
[[getElementData]] peut être utilisé pour récupérer les atributs XML définis dans le fichier .map.
Pour exemple, un objet est créé à la position du drapeau et un message s'affiche dans le tchat pour prévenir les joueurs. En réalité, cette action sera plutôt réalisée lors du chargement de la map. Par contre on peut imaginer une action lorsqu'un joueur s'empare du drapeau ennemi.

==Map manager==
Having read the section above it should be clear that a gamemode should always consist of two parts:
* The gamemode resource that always stays the same
* Many different maps resources that give the gamemode map-specific information

Now instead of writing a map-loader for every single gamemode, the [[Map manager]] provides functions to load gamemodes and maps. Simply put, when you enter the correct command (for example 'gamemode ctf ctf-italy') it will start both resources 'ctf' and 'ctf-italy' while triggering an event ([[onGamemodeMapStart]]) to tell the 'ctf' resource that a map was loaded. The 'ctf' resource can then access the information 'ctf-italy' contains and start spawning players etc.

===How to use the mapmanager===
To use the mapmanager service, your gamemode resource has to be tagged as such first. More specifically you'll be setting the "type" attribute of its <info> tag to "gamemode" inside meta.xml. Also, you can set the "name" attribute to a friendly name (like "Capture the flag") that will be shown on ASE instead of the resource name.
<syntaxhighlight lang="xml">

<meta>
<info type="gamemode" name="Cow catapulting 2.0"/>
</meta>
</syntaxhighlight>

If your gamemode is going to load custom maps, you should add handlers for
* onGamemodeMapStart
* onGamemodeMapStop (if any unloading is necessary)
These are fired when a map for your gamemode is started or stopped, and pass the map resource as a parameter.
Within the handler function for these events you can extract all info you need from the resource's map files and configuration files.

====Example====
<syntaxhighlight lang="lua">
function startCtfMap( startedMap ) -- startedMap contains a reference to the resource of the map
local mapRoot = getResourceRootElement( startedMap ) -- get the root node of the started map
local flagElements = getElementsByType ( "flag" , mapRoot ) -- get all flags in the map and store them in a table
-- go on loading information like in the example above
-- spawn players etc.
end
addEventHandler("onGamemodeMapStart", getRootElement(), startCtfMap)
</syntaxhighlight>

===Making maps compatible===
Maps are separate resources. This is done so no editing of the gamemode resource is ever necessary in order to create a custom map, and also allows you to pack map-specific scripts/config files with them.

To make a map compatible with your gamemode, open its resource's meta.xml and tag it as well: the "type" attribute must be set to "map", and the "gamemodes" attribute must be a comma-separated list (no spaces) of gamemode resource names that the map works with.
<syntaxhighlight lang="xml">

<meta>
<info type="map" gamemodes="cowcatapult,assault,tdm"/>
</meta>
</syntaxhighlight>

Once you have everything set up, admins will use these two commands to start/stop gamemodes:
/gamemode gamemodeName [mapName] (optional parameter allows picking an initial map, defaults to none)
/changemap mapName [gamemodeName] (optional parameter specifies the gamemode to start the map with, defaults to the current one)

[[Map manager]] exports a few more access functions which you don't have to use, but may be useful.

==What else should you do==
There are several other resources that gamemodes should use/be compliant with.

===Helpmanager===
The helpmanager is ought to be the standard interface for players when they need help. If you use the helpmanager to display your gamemode's help, every player that used helpmanager before (e.g. in other gamemodes) will immediately know how to get there. It also displays help for different resources running resources in one window, if necessary.

There are basicially two ways to use the helpmanager:
* Provide a simple text that explains how to use your gamemode
* Request a GUI element from the helpmanager that will be displayed in its own tab in the helpmanager window and lets you add any GUI elements to it. This is the recommended way for gamemodes that need to display more complex information that needs its own GUI.

Read the helpmanager page for details on how to do it.

===Scoreboard===
Scoreboard displays players and teams currently ingame. You add custom columns to it to provide map specific information. For example the column 'points' in the 'ctf' gamemode could represent the player's points gained through kills or captures. As usual, see the scoreboard help page for more information.

===Map cycler===
The map cycler controls what gamemodes and maps are played on a server. You can specifiy for example how many times in a row a map will be played until it switches to the next. To achieve this, you need to tell the map cycler when your gamemode finished (e.g. when a round ends).

[[it:Scrivere una gamemode]]
[[ru:Writing Gamemodes]]
[[de:Gamemodes schreiben]]

Créer un mode de jeu

2014-04-04T09:53:53Z

Gaetan Piette: /* Exemple */

Ce guide à pour but de vous aprpendre à créer un mode de jeu. Si vous venez juste de commencer à scripter pour MTA, il serait préférable que vous lisiez les autres tutoriels de l apage principale.

==Introduction==
Un mode de jeu est une ressource qu iune fois démarrée contrôle tout les éléments du gameplay. Cela inclus l'explication du mode de jeu aux joueurs. Par exemple expliquer comment gagner des points ou de l'argent. (Mode de jeu existans : race, deathmatch, ctf, freeroam et bien d'autres).

==Que signifie "coder proprement un mode de jeu" ?==
Pour faire simple, un mode de jeu doit utilisé les fonctionnalités du système de map dans MTA. Cela signifie que le code des maps doit être accompagné des position des véhicule, spawn des joueur et autres. Cela permet au mode de jeu d'être indépendant des maps proposées par les joueurs.

Instead, the gamemode should be able to load .map files which define these data. This way the gamemode can have multiple maps; also, people can create .map files for the gamemode with MTA's map editor, which is much more convenient than writing code.

An obvious example of a "proper gamemode" is MTA:Race. It allows usermade maps with lots of possibilities within the .map file. To alter spawnpoints, objects etc., the user doesn't need to edit the gamemode itself.

===Fichier MAP===
Les fichiers map sont en XML avec l'extension .map. Ils définissent l'environnement pour un mode de jeu ou plusieurs si la map est compatible avec d'aures. Ils ne sont cependant pas supposés changer les règles du jeu. Les règles sont définies dans le mode de jeu.

Chaque élémment dans une map correspond à un noeud dans le fichier .map. Il y a une syntaxe particulière pour les points de spawn, objets ou véhicules. Cependant il est possible, pour des cas d'ajouts d'objets spéciaux d'inventer votre propre syntaxe.

====Exemple====
Commencons par un mode de jeu bien connu, la capture de drapeau. Une map pour ce mode de jeu à besoin de point de spawn et de positions pour les drapeaux des deux équipes. On peut aussi y ajouter des véhicules et d'autres objets. Un fichier de map simplifié pourrait ressembler à ça :

<syntaxhighlight lang="xml">
<map>
<spawnpoint id="spawnpoint1" posX="1959.5487060547" posY="-1714.4613037109" posZ="877.25219726563" rot="63.350006103516" model="0"/>
<pickup id="Armor 1" posX="1911.083984375" posY="-1658.8798828125" posZ="885.40216064453" type="armor" health="50" respawn="60000"/>
<flag posX="1959.5487060547" posY="-1714.4613037109" posZ="877.25219726563" team="blue" />
...
</map>
</syntaxhighlight>

Dans le code ci-dessus on peut apercevoir trois éléments : un point de spawn,un pickup et un flag.
Le pickup permettera une fois pris par le joueur de lui rendre 50 points de vie, celui-ci respawn toute les 60 secondes.
Le flag est ici définit au niveau de sa position et de sa couleur (propre à l'équipe).
Le point de spawn et le pickup peuvent être utilisé par une ressource externe. Les éléments personnalisés doievent être gérés par le mode de jeu.

Pour résumé, votre objectif est de facilité la vie des mappeurs. Ceux-ci ne doivent pas avoir à se tracasser du script concernant le mode de jeu.

====Exemple de récupération d'informations sur un .map====
As mentioned above, your gamemode needs de retrieve custom elements that are defined in a map file and process them. This is quite easy as demonstrated below.
<syntaxhighlight lang="lua">
-- retrieve a table with all flag elements
local flagElements = getElementsByType ( "flag" )
-- loop through them
for key, value in pairs(flagElements) do
-- get our info
local posX = getElementData ( value, "posX" )
local posY = getElementData ( value, "posY" )
local posZ = getElementData ( value, "posZ" )
local team = getElementData ( value, "team" )
-- create an object according to the flag position
createObject ( 1337, posX, posY, posZ )
-- output the team that we created a base for
outputChatBox ( "Base for team " .. team .. " created" )
end
</syntaxhighlight>
The [[getElementsByType]] function retrieves a table of all the elements of a certain type (the type corresponds to the node name in the .map file). This works for both custom types and built-in MTA types (like "vehicle" or "player").
[[getElementData]] can be used to retrieve the xml attributes set in the .map file.
In this simple example, an object is created at the flag's location and a message is outputted in the chatbox. In reality, you will of course need to do more during map loading, like in this case setting up collision shapes to detect players taking the flag.

==Map manager==
Having read the section above it should be clear that a gamemode should always consist of two parts:
* The gamemode resource that always stays the same
* Many different maps resources that give the gamemode map-specific information

Now instead of writing a map-loader for every single gamemode, the [[Map manager]] provides functions to load gamemodes and maps. Simply put, when you enter the correct command (for example 'gamemode ctf ctf-italy') it will start both resources 'ctf' and 'ctf-italy' while triggering an event ([[onGamemodeMapStart]]) to tell the 'ctf' resource that a map was loaded. The 'ctf' resource can then access the information 'ctf-italy' contains and start spawning players etc.

===How to use the mapmanager===
To use the mapmanager service, your gamemode resource has to be tagged as such first. More specifically you'll be setting the "type" attribute of its <info> tag to "gamemode" inside meta.xml. Also, you can set the "name" attribute to a friendly name (like "Capture the flag") that will be shown on ASE instead of the resource name.
<syntaxhighlight lang="xml">

<meta>
<info type="gamemode" name="Cow catapulting 2.0"/>
</meta>
</syntaxhighlight>

If your gamemode is going to load custom maps, you should add handlers for
* onGamemodeMapStart
* onGamemodeMapStop (if any unloading is necessary)
These are fired when a map for your gamemode is started or stopped, and pass the map resource as a parameter.
Within the handler function for these events you can extract all info you need from the resource's map files and configuration files.

====Example====
<syntaxhighlight lang="lua">
function startCtfMap( startedMap ) -- startedMap contains a reference to the resource of the map
local mapRoot = getResourceRootElement( startedMap ) -- get the root node of the started map
local flagElements = getElementsByType ( "flag" , mapRoot ) -- get all flags in the map and store them in a table
-- go on loading information like in the example above
-- spawn players etc.
end
addEventHandler("onGamemodeMapStart", getRootElement(), startCtfMap)
</syntaxhighlight>

===Making maps compatible===
Maps are separate resources. This is done so no editing of the gamemode resource is ever necessary in order to create a custom map, and also allows you to pack map-specific scripts/config files with them.

To make a map compatible with your gamemode, open its resource's meta.xml and tag it as well: the "type" attribute must be set to "map", and the "gamemodes" attribute must be a comma-separated list (no spaces) of gamemode resource names that the map works with.
<syntaxhighlight lang="xml">

<meta>
<info type="map" gamemodes="cowcatapult,assault,tdm"/>
</meta>
</syntaxhighlight>

Once you have everything set up, admins will use these two commands to start/stop gamemodes:
/gamemode gamemodeName [mapName] (optional parameter allows picking an initial map, defaults to none)
/changemap mapName [gamemodeName] (optional parameter specifies the gamemode to start the map with, defaults to the current one)

[[Map manager]] exports a few more access functions which you don't have to use, but may be useful.

==What else should you do==
There are several other resources that gamemodes should use/be compliant with.

===Helpmanager===
The helpmanager is ought to be the standard interface for players when they need help. If you use the helpmanager to display your gamemode's help, every player that used helpmanager before (e.g. in other gamemodes) will immediately know how to get there. It also displays help for different resources running resources in one window, if necessary.

There are basicially two ways to use the helpmanager:
* Provide a simple text that explains how to use your gamemode
* Request a GUI element from the helpmanager that will be displayed in its own tab in the helpmanager window and lets you add any GUI elements to it. This is the recommended way for gamemodes that need to display more complex information that needs its own GUI.

Read the helpmanager page for details on how to do it.

===Scoreboard===
Scoreboard displays players and teams currently ingame. You add custom columns to it to provide map specific information. For example the column 'points' in the 'ctf' gamemode could represent the player's points gained through kills or captures. As usual, see the scoreboard help page for more information.

===Map cycler===
The map cycler controls what gamemodes and maps are played on a server. You can specifiy for example how many times in a row a map will be played until it switches to the next. To achieve this, you need to tell the map cycler when your gamemode finished (e.g. when a round ends).

[[it:Scrivere una gamemode]]
[[ru:Writing Gamemodes]]
[[de:Gamemodes schreiben]]

Créer un mode de jeu

2014-04-04T09:47:12Z

Gaetan Piette: /* Fichier MAP */

Ce guide à pour but de vous aprpendre à créer un mode de jeu. Si vous venez juste de commencer à scripter pour MTA, il serait préférable que vous lisiez les autres tutoriels de l apage principale.

==Introduction==
Un mode de jeu est une ressource qu iune fois démarrée contrôle tout les éléments du gameplay. Cela inclus l'explication du mode de jeu aux joueurs. Par exemple expliquer comment gagner des points ou de l'argent. (Mode de jeu existans : race, deathmatch, ctf, freeroam et bien d'autres).

==Que signifie "coder proprement un mode de jeu" ?==
Pour faire simple, un mode de jeu doit utilisé les fonctionnalités du système de map dans MTA. Cela signifie que le code des maps doit être accompagné des position des véhicule, spawn des joueur et autres. Cela permet au mode de jeu d'être indépendant des maps proposées par les joueurs.

Instead, the gamemode should be able to load .map files which define these data. This way the gamemode can have multiple maps; also, people can create .map files for the gamemode with MTA's map editor, which is much more convenient than writing code.

An obvious example of a "proper gamemode" is MTA:Race. It allows usermade maps with lots of possibilities within the .map file. To alter spawnpoints, objects etc., the user doesn't need to edit the gamemode itself.

===Fichier MAP===
Les fichiers map sont en XML avec l'extension .map. Ils définissent l'environnement pour un mode de jeu ou plusieurs si la map est compatible avec d'aures. Ils ne sont cependant pas supposés changer les règles du jeu. Les règles sont définies dans le mode de jeu.

Chaque élémment dans une map correspond à un noeud dans le fichier .map. Il y a une syntaxe particulière pour les points de spawn, objets ou véhicules. Cependant il est possible, pour des cas d'ajouts d'objets spéciaux d'inventer votre propre syntaxe.

====Exemple====
Commencons par un mode de jeu bien connu, la capture de drapeau. Une map pour ce mode de jeu à besoin de point de spawn et de positions pour les drapeaux des deux équipes. On peut aussi y ajouter des véhicules et d'autres objets. Un fichier de map simplifié pourrait ressembler à ça :

<syntaxhighlight lang="xml">
<map>
<spawnpoint id="spawnpoint1" posX="1959.5487060547" posY="-1714.4613037109" posZ="877.25219726563" rot="63.350006103516" model="0"/>
<pickup id="Armor 1" posX="1911.083984375" posY="-1658.8798828125" posZ="885.40216064453" type="armor" health="50" respawn="60000"/>
<flag posX="1959.5487060547" posY="-1714.4613037109" posZ="877.25219726563" team="blue" />
...
</map>
</syntaxhighlight>

Dans le code ci-dessus on peut apercevoir deux éléments : un point de spawn et un pickup.
Le pickup permettera une fois pris par le joueur de lui rendre 50 points de vie, celui-ci respawn toute les 60 secondes.
More importantly, this .map has a custom "flag" node which defines the position and color of the flag. The spawnpoint and pickup can be handled by existing external resources, custom elements have to be processed by the gamemode.

To summarize - we want mass mapper input as we saw in MTA:Race. Users should NOT have to touch the gamemode script itself at all.

====Exemple de récupération d'informations sur un .map====
As mentioned above, your gamemode needs de retrieve custom elements that are defined in a map file and process them. This is quite easy as demonstrated below.
<syntaxhighlight lang="lua">
-- retrieve a table with all flag elements
local flagElements = getElementsByType ( "flag" )
-- loop through them
for key, value in pairs(flagElements) do
-- get our info
local posX = getElementData ( value, "posX" )
local posY = getElementData ( value, "posY" )
local posZ = getElementData ( value, "posZ" )
local team = getElementData ( value, "team" )
-- create an object according to the flag position
createObject ( 1337, posX, posY, posZ )
-- output the team that we created a base for
outputChatBox ( "Base for team " .. team .. " created" )
end
</syntaxhighlight>
The [[getElementsByType]] function retrieves a table of all the elements of a certain type (the type corresponds to the node name in the .map file). This works for both custom types and built-in MTA types (like "vehicle" or "player").
[[getElementData]] can be used to retrieve the xml attributes set in the .map file.
In this simple example, an object is created at the flag's location and a message is outputted in the chatbox. In reality, you will of course need to do more during map loading, like in this case setting up collision shapes to detect players taking the flag.

==Map manager==
Having read the section above it should be clear that a gamemode should always consist of two parts:
* The gamemode resource that always stays the same
* Many different maps resources that give the gamemode map-specific information

Now instead of writing a map-loader for every single gamemode, the [[Map manager]] provides functions to load gamemodes and maps. Simply put, when you enter the correct command (for example 'gamemode ctf ctf-italy') it will start both resources 'ctf' and 'ctf-italy' while triggering an event ([[onGamemodeMapStart]]) to tell the 'ctf' resource that a map was loaded. The 'ctf' resource can then access the information 'ctf-italy' contains and start spawning players etc.

===How to use the mapmanager===
To use the mapmanager service, your gamemode resource has to be tagged as such first. More specifically you'll be setting the "type" attribute of its <info> tag to "gamemode" inside meta.xml. Also, you can set the "name" attribute to a friendly name (like "Capture the flag") that will be shown on ASE instead of the resource name.
<syntaxhighlight lang="xml">

<meta>
<info type="gamemode" name="Cow catapulting 2.0"/>
</meta>
</syntaxhighlight>

If your gamemode is going to load custom maps, you should add handlers for
* onGamemodeMapStart
* onGamemodeMapStop (if any unloading is necessary)
These are fired when a map for your gamemode is started or stopped, and pass the map resource as a parameter.
Within the handler function for these events you can extract all info you need from the resource's map files and configuration files.

====Example====
<syntaxhighlight lang="lua">
function startCtfMap( startedMap ) -- startedMap contains a reference to the resource of the map
local mapRoot = getResourceRootElement( startedMap ) -- get the root node of the started map
local flagElements = getElementsByType ( "flag" , mapRoot ) -- get all flags in the map and store them in a table
-- go on loading information like in the example above
-- spawn players etc.
end
addEventHandler("onGamemodeMapStart", getRootElement(), startCtfMap)
</syntaxhighlight>

===Making maps compatible===
Maps are separate resources. This is done so no editing of the gamemode resource is ever necessary in order to create a custom map, and also allows you to pack map-specific scripts/config files with them.

To make a map compatible with your gamemode, open its resource's meta.xml and tag it as well: the "type" attribute must be set to "map", and the "gamemodes" attribute must be a comma-separated list (no spaces) of gamemode resource names that the map works with.
<syntaxhighlight lang="xml">

<meta>
<info type="map" gamemodes="cowcatapult,assault,tdm"/>
</meta>
</syntaxhighlight>

Once you have everything set up, admins will use these two commands to start/stop gamemodes:
/gamemode gamemodeName [mapName] (optional parameter allows picking an initial map, defaults to none)
/changemap mapName [gamemodeName] (optional parameter specifies the gamemode to start the map with, defaults to the current one)

[[Map manager]] exports a few more access functions which you don't have to use, but may be useful.

==What else should you do==
There are several other resources that gamemodes should use/be compliant with.

===Helpmanager===
The helpmanager is ought to be the standard interface for players when they need help. If you use the helpmanager to display your gamemode's help, every player that used helpmanager before (e.g. in other gamemodes) will immediately know how to get there. It also displays help for different resources running resources in one window, if necessary.

There are basicially two ways to use the helpmanager:
* Provide a simple text that explains how to use your gamemode
* Request a GUI element from the helpmanager that will be displayed in its own tab in the helpmanager window and lets you add any GUI elements to it. This is the recommended way for gamemodes that need to display more complex information that needs its own GUI.

Read the helpmanager page for details on how to do it.

===Scoreboard===
Scoreboard displays players and teams currently ingame. You add custom columns to it to provide map specific information. For example the column 'points' in the 'ctf' gamemode could represent the player's points gained through kills or captures. As usual, see the scoreboard help page for more information.

===Map cycler===
The map cycler controls what gamemodes and maps are played on a server. You can specifiy for example how many times in a row a map will be played until it switches to the next. To achieve this, you need to tell the map cycler when your gamemode finished (e.g. when a round ends).

[[it:Scrivere una gamemode]]
[[ru:Writing Gamemodes]]
[[de:Gamemodes schreiben]]

Créer un mode de jeu

2014-04-04T09:32:16Z

Gaetan Piette: /* Que signifie "coder proprement un mode de jeu" ? */

Ce guide à pour but de vous aprpendre à créer un mode de jeu. Si vous venez juste de commencer à scripter pour MTA, il serait préférable que vous lisiez les autres tutoriels de l apage principale.

==Introduction==
Un mode de jeu est une ressource qu iune fois démarrée contrôle tout les éléments du gameplay. Cela inclus l'explication du mode de jeu aux joueurs. Par exemple expliquer comment gagner des points ou de l'argent. (Mode de jeu existans : race, deathmatch, ctf, freeroam et bien d'autres).

==Que signifie "coder proprement un mode de jeu" ?==
Pour faire simple, un mode de jeu doit utilisé les fonctionnalités du système de map dans MTA. Cela signifie que le code des maps doit être accompagné des position des véhicule, spawn des joueur et autres. Cela permet au mode de jeu d'être indépendant des maps proposées par les joueurs.

Instead, the gamemode should be able to load .map files which define these data. This way the gamemode can have multiple maps; also, people can create .map files for the gamemode with MTA's map editor, which is much more convenient than writing code.

An obvious example of a "proper gamemode" is MTA:Race. It allows usermade maps with lots of possibilities within the .map file. To alter spawnpoints, objects etc., the user doesn't need to edit the gamemode itself.

===Fichier MAP===
Map files are basically XML documents with a .map extension. They define an environment to play one or more specific gamemodes in. They are however not supposed to change the rules of the game - those are defined by the gamemode.

Each element in a map corresponds to a node in the .map file. There is standard syntax for common things like spawnpoints, objects and vehicles; however, for "special", gamemode specific information, you need to invent your own syntax.

====Exemple====
Let's take a Capture the Flag gamemode as an example. A map for this gamemode needs to mainly define spawnpoints and flag locations, and eventually objects and vehicles. A simplified map file could look like this:
<syntaxhighlight lang="xml">
<map>
<spawnpoint id="spawnpoint1" posX="1959.5487060547" posY="-1714.4613037109" posZ="877.25219726563" rot="63.350006103516" model="0"/>
<pickup id="Armor 1" posX="1911.083984375" posY="-1658.8798828125" posZ="885.40216064453" type="armor" health="50" respawn="60000"/>
<flag posX="1959.5487060547" posY="-1714.4613037109" posZ="877.25219726563" team="blue" />
...
</map>
</syntaxhighlight>

Here you can see two MTA elements - a spawnpoint and a pickup. More importantly, this .map has a custom "flag" node which defines the position and color of the flag. The spawnpoint and pickup can be handled by existing external resources, custom elements have to be processed by the gamemode.

To summarize - we want mass mapper input as we saw in MTA:Race. Users should NOT have to touch the gamemode script itself at all.

====Exemple de récupération d'informations sur un .map====
As mentioned above, your gamemode needs de retrieve custom elements that are defined in a map file and process them. This is quite easy as demonstrated below.
<syntaxhighlight lang="lua">
-- retrieve a table with all flag elements
local flagElements = getElementsByType ( "flag" )
-- loop through them
for key, value in pairs(flagElements) do
-- get our info
local posX = getElementData ( value, "posX" )
local posY = getElementData ( value, "posY" )
local posZ = getElementData ( value, "posZ" )
local team = getElementData ( value, "team" )
-- create an object according to the flag position
createObject ( 1337, posX, posY, posZ )
-- output the team that we created a base for
outputChatBox ( "Base for team " .. team .. " created" )
end
</syntaxhighlight>
The [[getElementsByType]] function retrieves a table of all the elements of a certain type (the type corresponds to the node name in the .map file). This works for both custom types and built-in MTA types (like "vehicle" or "player").
[[getElementData]] can be used to retrieve the xml attributes set in the .map file.
In this simple example, an object is created at the flag's location and a message is outputted in the chatbox. In reality, you will of course need to do more during map loading, like in this case setting up collision shapes to detect players taking the flag.

==Map manager==
Having read the section above it should be clear that a gamemode should always consist of two parts:
* The gamemode resource that always stays the same
* Many different maps resources that give the gamemode map-specific information

Now instead of writing a map-loader for every single gamemode, the [[Map manager]] provides functions to load gamemodes and maps. Simply put, when you enter the correct command (for example 'gamemode ctf ctf-italy') it will start both resources 'ctf' and 'ctf-italy' while triggering an event ([[onGamemodeMapStart]]) to tell the 'ctf' resource that a map was loaded. The 'ctf' resource can then access the information 'ctf-italy' contains and start spawning players etc.

===How to use the mapmanager===
To use the mapmanager service, your gamemode resource has to be tagged as such first. More specifically you'll be setting the "type" attribute of its <info> tag to "gamemode" inside meta.xml. Also, you can set the "name" attribute to a friendly name (like "Capture the flag") that will be shown on ASE instead of the resource name.
<syntaxhighlight lang="xml">

<meta>
<info type="gamemode" name="Cow catapulting 2.0"/>
</meta>
</syntaxhighlight>

If your gamemode is going to load custom maps, you should add handlers for
* onGamemodeMapStart
* onGamemodeMapStop (if any unloading is necessary)
These are fired when a map for your gamemode is started or stopped, and pass the map resource as a parameter.
Within the handler function for these events you can extract all info you need from the resource's map files and configuration files.

====Example====
<syntaxhighlight lang="lua">
function startCtfMap( startedMap ) -- startedMap contains a reference to the resource of the map
local mapRoot = getResourceRootElement( startedMap ) -- get the root node of the started map
local flagElements = getElementsByType ( "flag" , mapRoot ) -- get all flags in the map and store them in a table
-- go on loading information like in the example above
-- spawn players etc.
end
addEventHandler("onGamemodeMapStart", getRootElement(), startCtfMap)
</syntaxhighlight>

===Making maps compatible===
Maps are separate resources. This is done so no editing of the gamemode resource is ever necessary in order to create a custom map, and also allows you to pack map-specific scripts/config files with them.

To make a map compatible with your gamemode, open its resource's meta.xml and tag it as well: the "type" attribute must be set to "map", and the "gamemodes" attribute must be a comma-separated list (no spaces) of gamemode resource names that the map works with.
<syntaxhighlight lang="xml">

<meta>
<info type="map" gamemodes="cowcatapult,assault,tdm"/>
</meta>
</syntaxhighlight>

Once you have everything set up, admins will use these two commands to start/stop gamemodes:
/gamemode gamemodeName [mapName] (optional parameter allows picking an initial map, defaults to none)
/changemap mapName [gamemodeName] (optional parameter specifies the gamemode to start the map with, defaults to the current one)

[[Map manager]] exports a few more access functions which you don't have to use, but may be useful.

==What else should you do==
There are several other resources that gamemodes should use/be compliant with.

===Helpmanager===
The helpmanager is ought to be the standard interface for players when they need help. If you use the helpmanager to display your gamemode's help, every player that used helpmanager before (e.g. in other gamemodes) will immediately know how to get there. It also displays help for different resources running resources in one window, if necessary.

There are basicially two ways to use the helpmanager:
* Provide a simple text that explains how to use your gamemode
* Request a GUI element from the helpmanager that will be displayed in its own tab in the helpmanager window and lets you add any GUI elements to it. This is the recommended way for gamemodes that need to display more complex information that needs its own GUI.

Read the helpmanager page for details on how to do it.

===Scoreboard===
Scoreboard displays players and teams currently ingame. You add custom columns to it to provide map specific information. For example the column 'points' in the 'ctf' gamemode could represent the player's points gained through kills or captures. As usual, see the scoreboard help page for more information.

===Map cycler===
The map cycler controls what gamemodes and maps are played on a server. You can specifiy for example how many times in a row a map will be played until it switches to the next. To achieve this, you need to tell the map cycler when your gamemode finished (e.g. when a round ends).

[[it:Scrivere una gamemode]]
[[ru:Writing Gamemodes]]
[[de:Gamemodes schreiben]]

Créer un mode de jeu

2014-04-04T09:31:22Z

Gaetan Piette:

Ce guide à pour but de vous aprpendre à créer un mode de jeu. Si vous venez juste de commencer à scripter pour MTA, il serait préférable que vous lisiez les autres tutoriels de l apage principale.

==Introduction==
Un mode de jeu est une ressource qu iune fois démarrée contrôle tout les éléments du gameplay. Cela inclus l'explication du mode de jeu aux joueurs. Par exemple expliquer comment gagner des points ou de l'argent. (Mode de jeu existans : race, deathmatch, ctf, freeroam et bien d'autres).

==Que signifie "coder proprement un mode de jeu" ?==
Pour faire simple, un mode de jeu doit utilisé les fonctionnalités du système de map dans MTA. Cela signifie que le code des maps doit être accompagné des position des véhicule, spawn des joueur et autres. Cela permet au mode de jeu d'être indépendant des maps proposées par les joueurs.

Instead, the gamemode should be able to load .map files which define these data. This way the gamemode can have multiple maps; also, people can create .map files for the gamemode with MTA's map editor, which is much more convenient than writing code.

An obvious example of a "proper gamemode" is MTA:Race. It allows usermade maps with lots of possibilities within the .map file. To alter spawnpoints, objects etc., the user doesn't need to edit the gamemode itself.

===Map Files===
Map files are basically XML documents with a .map extension. They define an environment to play one or more specific gamemodes in. They are however not supposed to change the rules of the game - those are defined by the gamemode.

Each element in a map corresponds to a node in the .map file. There is standard syntax for common things like spawnpoints, objects and vehicles; however, for "special", gamemode specific information, you need to invent your own syntax.

====Example====
Let's take a Capture the Flag gamemode as an example. A map for this gamemode needs to mainly define spawnpoints and flag locations, and eventually objects and vehicles. A simplified map file could look like this:
<syntaxhighlight lang="xml">
<map>
<spawnpoint id="spawnpoint1" posX="1959.5487060547" posY="-1714.4613037109" posZ="877.25219726563" rot="63.350006103516" model="0"/>
<pickup id="Armor 1" posX="1911.083984375" posY="-1658.8798828125" posZ="885.40216064453" type="armor" health="50" respawn="60000"/>
<flag posX="1959.5487060547" posY="-1714.4613037109" posZ="877.25219726563" team="blue" />
...
</map>
</syntaxhighlight>

Here you can see two MTA elements - a spawnpoint and a pickup. More importantly, this .map has a custom "flag" node which defines the position and color of the flag. The spawnpoint and pickup can be handled by existing external resources, custom elements have to be processed by the gamemode.

To summarize - we want mass mapper input as we saw in MTA:Race. Users should NOT have to touch the gamemode script itself at all.

====Example of getting the .map information====
As mentioned above, your gamemode needs de retrieve custom elements that are defined in a map file and process them. This is quite easy as demonstrated below.
<syntaxhighlight lang="lua">
-- retrieve a table with all flag elements
local flagElements = getElementsByType ( "flag" )
-- loop through them
for key, value in pairs(flagElements) do
-- get our info
local posX = getElementData ( value, "posX" )
local posY = getElementData ( value, "posY" )
local posZ = getElementData ( value, "posZ" )
local team = getElementData ( value, "team" )
-- create an object according to the flag position
createObject ( 1337, posX, posY, posZ )
-- output the team that we created a base for
outputChatBox ( "Base for team " .. team .. " created" )
end
</syntaxhighlight>
The [[getElementsByType]] function retrieves a table of all the elements of a certain type (the type corresponds to the node name in the .map file). This works for both custom types and built-in MTA types (like "vehicle" or "player").
[[getElementData]] can be used to retrieve the xml attributes set in the .map file.
In this simple example, an object is created at the flag's location and a message is outputted in the chatbox. In reality, you will of course need to do more during map loading, like in this case setting up collision shapes to detect players taking the flag.

==Map manager==
Having read the section above it should be clear that a gamemode should always consist of two parts:
* The gamemode resource that always stays the same
* Many different maps resources that give the gamemode map-specific information

Now instead of writing a map-loader for every single gamemode, the [[Map manager]] provides functions to load gamemodes and maps. Simply put, when you enter the correct command (for example 'gamemode ctf ctf-italy') it will start both resources 'ctf' and 'ctf-italy' while triggering an event ([[onGamemodeMapStart]]) to tell the 'ctf' resource that a map was loaded. The 'ctf' resource can then access the information 'ctf-italy' contains and start spawning players etc.

===How to use the mapmanager===
To use the mapmanager service, your gamemode resource has to be tagged as such first. More specifically you'll be setting the "type" attribute of its <info> tag to "gamemode" inside meta.xml. Also, you can set the "name" attribute to a friendly name (like "Capture the flag") that will be shown on ASE instead of the resource name.
<syntaxhighlight lang="xml">

<meta>
<info type="gamemode" name="Cow catapulting 2.0"/>
</meta>
</syntaxhighlight>

If your gamemode is going to load custom maps, you should add handlers for
* onGamemodeMapStart
* onGamemodeMapStop (if any unloading is necessary)
These are fired when a map for your gamemode is started or stopped, and pass the map resource as a parameter.
Within the handler function for these events you can extract all info you need from the resource's map files and configuration files.

====Example====
<syntaxhighlight lang="lua">
function startCtfMap( startedMap ) -- startedMap contains a reference to the resource of the map
local mapRoot = getResourceRootElement( startedMap ) -- get the root node of the started map
local flagElements = getElementsByType ( "flag" , mapRoot ) -- get all flags in the map and store them in a table
-- go on loading information like in the example above
-- spawn players etc.
end
addEventHandler("onGamemodeMapStart", getRootElement(), startCtfMap)
</syntaxhighlight>

===Making maps compatible===
Maps are separate resources. This is done so no editing of the gamemode resource is ever necessary in order to create a custom map, and also allows you to pack map-specific scripts/config files with them.

To make a map compatible with your gamemode, open its resource's meta.xml and tag it as well: the "type" attribute must be set to "map", and the "gamemodes" attribute must be a comma-separated list (no spaces) of gamemode resource names that the map works with.
<syntaxhighlight lang="xml">

<meta>
<info type="map" gamemodes="cowcatapult,assault,tdm"/>
</meta>
</syntaxhighlight>

Once you have everything set up, admins will use these two commands to start/stop gamemodes:
/gamemode gamemodeName [mapName] (optional parameter allows picking an initial map, defaults to none)
/changemap mapName [gamemodeName] (optional parameter specifies the gamemode to start the map with, defaults to the current one)

[[Map manager]] exports a few more access functions which you don't have to use, but may be useful.

==What else should you do==
There are several other resources that gamemodes should use/be compliant with.

===Helpmanager===
The helpmanager is ought to be the standard interface for players when they need help. If you use the helpmanager to display your gamemode's help, every player that used helpmanager before (e.g. in other gamemodes) will immediately know how to get there. It also displays help for different resources running resources in one window, if necessary.

There are basicially two ways to use the helpmanager:
* Provide a simple text that explains how to use your gamemode
* Request a GUI element from the helpmanager that will be displayed in its own tab in the helpmanager window and lets you add any GUI elements to it. This is the recommended way for gamemodes that need to display more complex information that needs its own GUI.

Read the helpmanager page for details on how to do it.

===Scoreboard===
Scoreboard displays players and teams currently ingame. You add custom columns to it to provide map specific information. For example the column 'points' in the 'ctf' gamemode could represent the player's points gained through kills or captures. As usual, see the scoreboard help page for more information.

===Map cycler===
The map cycler controls what gamemodes and maps are played on a server. You can specifiy for example how many times in a row a map will be played until it switches to the next. To achieve this, you need to tell the map cycler when your gamemode finished (e.g. when a round ends).

[[it:Scrivere una gamemode]]
[[ru:Writing Gamemodes]]
[[de:Gamemodes schreiben]]

Créer un mode de jeu

2014-04-04T09:22:47Z

Gaetan Piette:

Ce guide à pour but de vous aprpendre à créer un mode de jeu. Si vous venez juste de commencer à scripter pour MTA, il serait préférable que vous lisiez les autres tutoriels de l apage principale.

==Introduction==
Un mode de jeu est une ressource qu iune fois démarrée contrôle tout les éléments du gameplay. Cela inclus l'explication du mode de jeu aux joueurs. Par exemple expliquer comment gagner des points ou de l'argent. (Mode de jeu existans : race, deathmatch, ctf, freeroam et bien d'autres).

==Que signifie "coder proprement un mode de jeu" ?==
Pour faire simple, un mode de jeu doit utilisé les fonctionnalités du système de map dans MTA. Cela signifie que le code des maps pas être différent d'un autre mode de jeu. Les position des véhicule et joueur de gère dans le code du mode de jeu et non dans la map.

Instead, the gamemode should be able to load .map files which define these data. This way the gamemode can have multiple maps; also, people can create .map files for the gamemode with MTA's map editor, which is much more convenient than writing code.

An obvious example of a "proper gamemode" is MTA:Race. It allows usermade maps with lots of possibilities within the .map file. To alter spawnpoints, objects etc., the user doesn't need to edit the gamemode itself.

===Map Files===
Map files are basically XML documents with a .map extension. They define an environment to play one or more specific gamemodes in. They are however not supposed to change the rules of the game - those are defined by the gamemode.

Each element in a map corresponds to a node in the .map file. There is standard syntax for common things like spawnpoints, objects and vehicles; however, for "special", gamemode specific information, you need to invent your own syntax.

====Example====
Let's take a Capture the Flag gamemode as an example. A map for this gamemode needs to mainly define spawnpoints and flag locations, and eventually objects and vehicles. A simplified map file could look like this:
<syntaxhighlight lang="xml">
<map>
<spawnpoint id="spawnpoint1" posX="1959.5487060547" posY="-1714.4613037109" posZ="877.25219726563" rot="63.350006103516" model="0"/>
<pickup id="Armor 1" posX="1911.083984375" posY="-1658.8798828125" posZ="885.40216064453" type="armor" health="50" respawn="60000"/>
<flag posX="1959.5487060547" posY="-1714.4613037109" posZ="877.25219726563" team="blue" />
...
</map>
</syntaxhighlight>

Here you can see two MTA elements - a spawnpoint and a pickup. More importantly, this .map has a custom "flag" node which defines the position and color of the flag. The spawnpoint and pickup can be handled by existing external resources, custom elements have to be processed by the gamemode.

To summarize - we want mass mapper input as we saw in MTA:Race. Users should NOT have to touch the gamemode script itself at all.

====Example of getting the .map information====
As mentioned above, your gamemode needs de retrieve custom elements that are defined in a map file and process them. This is quite easy as demonstrated below.
<syntaxhighlight lang="lua">
-- retrieve a table with all flag elements
local flagElements = getElementsByType ( "flag" )
-- loop through them
for key, value in pairs(flagElements) do
-- get our info
local posX = getElementData ( value, "posX" )
local posY = getElementData ( value, "posY" )
local posZ = getElementData ( value, "posZ" )
local team = getElementData ( value, "team" )
-- create an object according to the flag position
createObject ( 1337, posX, posY, posZ )
-- output the team that we created a base for
outputChatBox ( "Base for team " .. team .. " created" )
end
</syntaxhighlight>
The [[getElementsByType]] function retrieves a table of all the elements of a certain type (the type corresponds to the node name in the .map file). This works for both custom types and built-in MTA types (like "vehicle" or "player").
[[getElementData]] can be used to retrieve the xml attributes set in the .map file.
In this simple example, an object is created at the flag's location and a message is outputted in the chatbox. In reality, you will of course need to do more during map loading, like in this case setting up collision shapes to detect players taking the flag.

==Map manager==
Having read the section above it should be clear that a gamemode should always consist of two parts:
* The gamemode resource that always stays the same
* Many different maps resources that give the gamemode map-specific information

Now instead of writing a map-loader for every single gamemode, the [[Map manager]] provides functions to load gamemodes and maps. Simply put, when you enter the correct command (for example 'gamemode ctf ctf-italy') it will start both resources 'ctf' and 'ctf-italy' while triggering an event ([[onGamemodeMapStart]]) to tell the 'ctf' resource that a map was loaded. The 'ctf' resource can then access the information 'ctf-italy' contains and start spawning players etc.

===How to use the mapmanager===
To use the mapmanager service, your gamemode resource has to be tagged as such first. More specifically you'll be setting the "type" attribute of its <info> tag to "gamemode" inside meta.xml. Also, you can set the "name" attribute to a friendly name (like "Capture the flag") that will be shown on ASE instead of the resource name.
<syntaxhighlight lang="xml">

<meta>
<info type="gamemode" name="Cow catapulting 2.0"/>
</meta>
</syntaxhighlight>

If your gamemode is going to load custom maps, you should add handlers for
* onGamemodeMapStart
* onGamemodeMapStop (if any unloading is necessary)
These are fired when a map for your gamemode is started or stopped, and pass the map resource as a parameter.
Within the handler function for these events you can extract all info you need from the resource's map files and configuration files.

====Example====
<syntaxhighlight lang="lua">
function startCtfMap( startedMap ) -- startedMap contains a reference to the resource of the map
local mapRoot = getResourceRootElement( startedMap ) -- get the root node of the started map
local flagElements = getElementsByType ( "flag" , mapRoot ) -- get all flags in the map and store them in a table
-- go on loading information like in the example above
-- spawn players etc.
end
addEventHandler("onGamemodeMapStart", getRootElement(), startCtfMap)
</syntaxhighlight>

===Making maps compatible===
Maps are separate resources. This is done so no editing of the gamemode resource is ever necessary in order to create a custom map, and also allows you to pack map-specific scripts/config files with them.

To make a map compatible with your gamemode, open its resource's meta.xml and tag it as well: the "type" attribute must be set to "map", and the "gamemodes" attribute must be a comma-separated list (no spaces) of gamemode resource names that the map works with.
<syntaxhighlight lang="xml">

<meta>
<info type="map" gamemodes="cowcatapult,assault,tdm"/>
</meta>
</syntaxhighlight>

Once you have everything set up, admins will use these two commands to start/stop gamemodes:
/gamemode gamemodeName [mapName] (optional parameter allows picking an initial map, defaults to none)
/changemap mapName [gamemodeName] (optional parameter specifies the gamemode to start the map with, defaults to the current one)

[[Map manager]] exports a few more access functions which you don't have to use, but may be useful.

==What else should you do==
There are several other resources that gamemodes should use/be compliant with.

===Helpmanager===
The helpmanager is ought to be the standard interface for players when they need help. If you use the helpmanager to display your gamemode's help, every player that used helpmanager before (e.g. in other gamemodes) will immediately know how to get there. It also displays help for different resources running resources in one window, if necessary.

There are basicially two ways to use the helpmanager:
* Provide a simple text that explains how to use your gamemode
* Request a GUI element from the helpmanager that will be displayed in its own tab in the helpmanager window and lets you add any GUI elements to it. This is the recommended way for gamemodes that need to display more complex information that needs its own GUI.

Read the helpmanager page for details on how to do it.

===Scoreboard===
Scoreboard displays players and teams currently ingame. You add custom columns to it to provide map specific information. For example the column 'points' in the 'ctf' gamemode could represent the player's points gained through kills or captures. As usual, see the scoreboard help page for more information.

===Map cycler===
The map cycler controls what gamemodes and maps are played on a server. You can specifiy for example how many times in a row a map will be played until it switches to the next. To achieve this, you need to tell the map cycler when your gamemode finished (e.g. when a round ends).

[[it:Scrivere una gamemode]]
[[ru:Writing Gamemodes]]
[[de:Gamemodes schreiben]]

Page d'accueil

2014-04-04T09:10:48Z

Gaetan Piette: /* Programmer */

<div style="background: #FFEEAA; padding: 5px; float:right; width: 30%;">Dernière version stable de '''Multi Theft Auto: San Andreas''' est '''{{Current Version|full}}'''. Rendez-vous sur la [http://mtasa.com/ page principale] pour la télécharger.
<p>
Vous pouvez aussi télécharger une [http://nightly.mtasa.com/ beta] pour avoir la dernière version ( non stable ).
</p>
</div>
__NOTOC__
Bienvenue sur le wiki de Multi Theft Auto. Sur ce wiki, vous trouverez toutes les informations sur Multi Theft Auto.

Il y a [[How you can help|différents moyens de nous aider]]: créer une map, un gamemode, rediger des articles sur des fonctions, écrire un exemple, écrire un tutorial ou juste jouer à MTA et nous rapportez les bugs trouvés.

<div style="clear:both;"></div>
{| width="100%" cellspacing="0" cellpadding="0"
| colspan="2" |

|-
| width="50%" style="vertical-align:top;" |
<div style="border: 1px dotted #AAAAAA;padding:4px 8px 8px 8px;margin:10px;">
====Pour commencer====

* [[FR/Manuel_Client|Manuel Client]] ( Traduction: [http://wiki.multitheftauto.com/wiki/User:DrawKiie DrawKiie] )
* [[FR/Manuel_Serveur|Manuel Serveur]] ( Traduction: [http://wiki.multitheftauto.com/wiki/User:Rouche Rouche] )
* [[FR/Problemes_connus|Problèmes connus]] ( Traduction: [http://wiki.multitheftauto.com/wiki/User:Rouche Rouche] )
* [[FR/Migrer_de_MTARace_a_MTASA_1.0.x|Migrer de MTA:Race à MTA:SA 1.0.x]] ( Traduction: [http://wiki.multitheftauto.com/wiki/User:Rouche Rouche] )
* [[FR/A propos des Map|A propos des Map]] ( Traduction: [http://wiki.multitheftauto.com/wiki/User:Rouche Rouche] )

</div>

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

====Programmer====

* [[FR/Introduction_Programmation|Introduction: La programmation]]
* [[FR/Introduction_GUI|Introduction: Le GUI]] ( Traduction: [http://wiki.multitheftauto.com/wiki/User:FatalTeror FatalTerror] )
* [[FR/Debugage|Tutoriel: Le débugage]] - Comment trouver les erreurs dans son script (Traduction:[http://wiki.multitheftauto.com/wiki/User:Vincenzo Vincenzo] alias Vincentdu90)
* [[FR/Ressources|Introduction: Les ressources]] (Traduction : [http://wiki.multitheftauto.com/wiki/User:Myk3L Myk3L])
** [[FR/Ressource_Acces_Internet|Introduction: L'accès depuis internet]] - Comment créer un site à partir d'une ressource (Traduction : [http://wiki.multitheftauto.com/wiki/User:Myk3L Myk3L])
** [[:Category:Resource|Catalogue des ressources]]
** [[FR/Meta.xml|Meta.xml]] - Derière chaque ressource ce trouve une meta pour la définir
** [[FR/ACL|ACL]] - Access Control List, pour définir les autorisations
* [[FR/Ecrire_Gamemode|Créer un gamemode]] ( Traduction: [http://wiki.multitheftauto.com/wiki/User:Rouche Rouche] - En Cours )
* [[FR/Fonctions_Utiles|Fonctions Utiles]]

</div>

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

====Bases de données====
Cette section décrit toutes les capacités fournies par le LUA/MTA ou par les ressources.
* [[:Category:Resource|Catalogue des ressources]] - Vous devriez le lire pour réaliser un script approprié.
* [[FR/Les_scripts_clients| Les scripts clients]]
</div>
<div style="border: 1px dotted #AAAAAA;padding:4px 8px 8px 8px;margin:10px;">

====Aide générale du LUA====
Des pages conçues pour aider votre compréhension du Lua
*[http://www.lua.org/pil/index.html "Programming in Lua"]
**[http://www.lua.org/manual/5.1/#index Les fonctions Lua]
*[http://lua-users.org/wiki/TutorialDirectory wiki Lua]
*[http://nixstaller.berlios.de/manual/0.2/nixstaller_9.html Un guide général au Lua de Nixstaller]
</div>

| width="50%" style="vertical-align:top;" |
<div style="border: 1px dotted #AAAAAA;padding:4px 8px 8px 8px;margin:10px;">

====Map Editor====
*[[Resource:Editor|Manuel]]
*[[Resource:Editor/EDF|Editor Definition Format]]
*[[Resource:Editor/Plugins|Plugins]]
*[[Resource:Editor#FAQ|Questions Fréquentes]]
</div>

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

====Développer Multi Theft Auto====
* [[FR/Compiler_MTASA|Compiler MTASA sur Windows]]
* [[FR/Compiler_MTASA_Server_sur_Mac_OS_X|Compiler MTASA sur Mac OS X]]
* [[FR/Compiler_MTASA_Server_sur_GNU_Linux|Compiler MTASA sur GNU/Linux]]
* [[FR/Directives_de_codage|Directives de codage]]
* [http://code.google.com/p/mtasa-blue Google Code SVN]
* [[FR/Roadmap|Roadmap]]
</div>

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

====Références====
* [[FR/Fonctions_Clients|Fonctions Clients]]
* [[FR/Events_Clients|Events Clients]]
* [[FR/Fonctions_Serveurs|Fonctions Clients]]
* [[FR/Events_Serveurs|Events Clients]]

* [[FR/MTA Classes|MTA Classes]] - Les descriptions détaillées de tous les types personnalisés MTA
** [[FR/Element|MTA Elements]] / [[Element tree]]
</div>

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

====[[Id|ID Listes]]====
*[[FR/Animations|Animations]]
*[[FR/Skins_Personnages|Skins Personnages]]
*[[FR/Vetements_CJ|Vêtements CJ]]
*[[FR/Garage|Garage IDs]]
*[[FR/Interieurs_IDs|Intérieurs IDs]]
*[[FR/Materiel_IDs|Matériel IDs]]
*[[FR/Projectiles|Projectiles]]
*[[FR/Radar Blips|Radar Blips]]
*[[FR/Sons|Sons]]
*[[FR/Vehicule_IDs|ID des véhicules]]
*[[FR/Vehicule_Couleurs|Couleurs véhicules]]
*[[FR/Vehicule_Upgrades|Tuning IDs]]
*[[FR/Armes|Armes]]
*[[FR/Meteos|Météos]]
</div>

|-
| colspan="2" |
|}
{{Languages list|fr}}

Page d'accueil

2014-04-04T09:10:35Z

Gaetan Piette: /* Programmer */

<div style="background: #FFEEAA; padding: 5px; float:right; width: 30%;">Dernière version stable de '''Multi Theft Auto: San Andreas''' est '''{{Current Version|full}}'''. Rendez-vous sur la [http://mtasa.com/ page principale] pour la télécharger.
<p>
Vous pouvez aussi télécharger une [http://nightly.mtasa.com/ beta] pour avoir la dernière version ( non stable ).
</p>
</div>
__NOTOC__
Bienvenue sur le wiki de Multi Theft Auto. Sur ce wiki, vous trouverez toutes les informations sur Multi Theft Auto.

Il y a [[How you can help|différents moyens de nous aider]]: créer une map, un gamemode, rediger des articles sur des fonctions, écrire un exemple, écrire un tutorial ou juste jouer à MTA et nous rapportez les bugs trouvés.

<div style="clear:both;"></div>
{| width="100%" cellspacing="0" cellpadding="0"
| colspan="2" |

|-
| width="50%" style="vertical-align:top;" |
<div style="border: 1px dotted #AAAAAA;padding:4px 8px 8px 8px;margin:10px;">
====Pour commencer====

* [[FR/Manuel_Client|Manuel Client]] ( Traduction: [http://wiki.multitheftauto.com/wiki/User:DrawKiie DrawKiie] )
* [[FR/Manuel_Serveur|Manuel Serveur]] ( Traduction: [http://wiki.multitheftauto.com/wiki/User:Rouche Rouche] )
* [[FR/Problemes_connus|Problèmes connus]] ( Traduction: [http://wiki.multitheftauto.com/wiki/User:Rouche Rouche] )
* [[FR/Migrer_de_MTARace_a_MTASA_1.0.x|Migrer de MTA:Race à MTA:SA 1.0.x]] ( Traduction: [http://wiki.multitheftauto.com/wiki/User:Rouche Rouche] )
* [[FR/A propos des Map|A propos des Map]] ( Traduction: [http://wiki.multitheftauto.com/wiki/User:Rouche Rouche] )

</div>

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

====Programmer====

* [[FR/Introduction_Programmation|Introduction: La programmation]]
* [[FR/Introduction_GUI|Introduction: Le GUI]] ( Traduction: [http://wiki.multitheftauto.com/wiki/User:FatalTeror FatalTerror] )
* [[FR/Debugage|Tutoriel: Le débugage]] - Comment trouver les erreurs dans son script (Traduction:[http://wiki.multitheftauto.com/wiki/User:Vincenzo Vincenzo] alias Vincentdu90)
* [[FR/Ressources|Introduction: Les ressources]] (Traduction : [http://wiki.multitheftauto.com/wiki/User:Myk3L Myk3L])
** [[FR/Ressource_Acces_Internet|Introduction: L'accès depuis internet]] - Comment créer un site à partir d'une ressource (Traduction : [http://wiki.multitheftauto.com/wiki/User:Myk3L Myk3L])
** [[:Category:Resource|Catalogue des ressources]]
** [[FR/Meta.xml|Meta.xml]] - Derière chaque ressource ce trouve une meta pour la définir
** [[FR/ACL|ACL]] - Access Control List, pour définir les autorisations
* [[FR/Ecrire_Gamemode|Créer un gamemode]] ( Traduction: [http://wiki.multitheftauto.com/wiki/User:Rouche Rouche] )
* [[FR/Fonctions_Utiles|Fonctions Utiles]]

</div>

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

====Bases de données====
Cette section décrit toutes les capacités fournies par le LUA/MTA ou par les ressources.
* [[:Category:Resource|Catalogue des ressources]] - Vous devriez le lire pour réaliser un script approprié.
* [[FR/Les_scripts_clients| Les scripts clients]]
</div>
<div style="border: 1px dotted #AAAAAA;padding:4px 8px 8px 8px;margin:10px;">

====Aide générale du LUA====
Des pages conçues pour aider votre compréhension du Lua
*[http://www.lua.org/pil/index.html "Programming in Lua"]
**[http://www.lua.org/manual/5.1/#index Les fonctions Lua]
*[http://lua-users.org/wiki/TutorialDirectory wiki Lua]
*[http://nixstaller.berlios.de/manual/0.2/nixstaller_9.html Un guide général au Lua de Nixstaller]
</div>

| width="50%" style="vertical-align:top;" |
<div style="border: 1px dotted #AAAAAA;padding:4px 8px 8px 8px;margin:10px;">

====Map Editor====
*[[Resource:Editor|Manuel]]
*[[Resource:Editor/EDF|Editor Definition Format]]
*[[Resource:Editor/Plugins|Plugins]]
*[[Resource:Editor#FAQ|Questions Fréquentes]]
</div>

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

====Développer Multi Theft Auto====
* [[FR/Compiler_MTASA|Compiler MTASA sur Windows]]
* [[FR/Compiler_MTASA_Server_sur_Mac_OS_X|Compiler MTASA sur Mac OS X]]
* [[FR/Compiler_MTASA_Server_sur_GNU_Linux|Compiler MTASA sur GNU/Linux]]
* [[FR/Directives_de_codage|Directives de codage]]
* [http://code.google.com/p/mtasa-blue Google Code SVN]
* [[FR/Roadmap|Roadmap]]
</div>

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

====Références====
* [[FR/Fonctions_Clients|Fonctions Clients]]
* [[FR/Events_Clients|Events Clients]]
* [[FR/Fonctions_Serveurs|Fonctions Clients]]
* [[FR/Events_Serveurs|Events Clients]]

* [[FR/MTA Classes|MTA Classes]] - Les descriptions détaillées de tous les types personnalisés MTA
** [[FR/Element|MTA Elements]] / [[Element tree]]
</div>

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

====[[Id|ID Listes]]====
*[[FR/Animations|Animations]]
*[[FR/Skins_Personnages|Skins Personnages]]
*[[FR/Vetements_CJ|Vêtements CJ]]
*[[FR/Garage|Garage IDs]]
*[[FR/Interieurs_IDs|Intérieurs IDs]]
*[[FR/Materiel_IDs|Matériel IDs]]
*[[FR/Projectiles|Projectiles]]
*[[FR/Radar Blips|Radar Blips]]
*[[FR/Sons|Sons]]
*[[FR/Vehicule_IDs|ID des véhicules]]
*[[FR/Vehicule_Couleurs|Couleurs véhicules]]
*[[FR/Vehicule_Upgrades|Tuning IDs]]
*[[FR/Armes|Armes]]
*[[FR/Meteos|Météos]]
</div>

|-
| colspan="2" |
|}
{{Languages list|fr}}

Créer un mode de jeu

2014-04-04T09:09:25Z

Gaetan Piette: Created page with "This guide tries to outline the process of how to write a proper gamemode. If you just started with scripting for MTA, you may want to check the other scripting tutorials at the ..."

This guide tries to outline the process of how to write a proper gamemode. If you just started with scripting for MTA, you may want to check the other scripting tutorials at the [[Main Page]] first.
==Introduction==
A gamemode is a resource that, once started, controls all of the gameplay. This may include telling the players what to do, spawning players, creating teams, defining what the players have to do to win or to get points and much more. Examples are Race and Deathmatch.

==What does "proper gamemode" mean?==
To put it simply, a proper gamemode is one that makes full use of MTA's .map file system. This means that the gamemode code does not have any map-specific data hardcoded in it, like positions of players or cars. Instead, the gamemode should be able to load .map files which define these data. This way the gamemode can have multiple maps; also, people can create .map files for the gamemode with MTA's map editor, which is much more convenient than writing code.

An obvious example of a "proper gamemode" is MTA:Race. It allows usermade maps with lots of possibilities within the .map file. To alter spawnpoints, objects etc., the user doesn't need to edit the gamemode itself.

===Map Files===
Map files are basically XML documents with a .map extension. They define an environment to play one or more specific gamemodes in. They are however not supposed to change the rules of the game - those are defined by the gamemode.

Each element in a map corresponds to a node in the .map file. There is standard syntax for common things like spawnpoints, objects and vehicles; however, for "special", gamemode specific information, you need to invent your own syntax.

====Example====
Let's take a Capture the Flag gamemode as an example. A map for this gamemode needs to mainly define spawnpoints and flag locations, and eventually objects and vehicles. A simplified map file could look like this:
<syntaxhighlight lang="xml">
<map>
<spawnpoint id="spawnpoint1" posX="1959.5487060547" posY="-1714.4613037109" posZ="877.25219726563" rot="63.350006103516" model="0"/>
<pickup id="Armor 1" posX="1911.083984375" posY="-1658.8798828125" posZ="885.40216064453" type="armor" health="50" respawn="60000"/>
<flag posX="1959.5487060547" posY="-1714.4613037109" posZ="877.25219726563" team="blue" />
...
</map>
</syntaxhighlight>

Here you can see two MTA elements - a spawnpoint and a pickup. More importantly, this .map has a custom "flag" node which defines the position and color of the flag. The spawnpoint and pickup can be handled by existing external resources, custom elements have to be processed by the gamemode.

To summarize - we want mass mapper input as we saw in MTA:Race. Users should NOT have to touch the gamemode script itself at all.

====Example of getting the .map information====
As mentioned above, your gamemode needs de retrieve custom elements that are defined in a map file and process them. This is quite easy as demonstrated below.
<syntaxhighlight lang="lua">
-- retrieve a table with all flag elements
local flagElements = getElementsByType ( "flag" )
-- loop through them
for key, value in pairs(flagElements) do
-- get our info
local posX = getElementData ( value, "posX" )
local posY = getElementData ( value, "posY" )
local posZ = getElementData ( value, "posZ" )
local team = getElementData ( value, "team" )
-- create an object according to the flag position
createObject ( 1337, posX, posY, posZ )
-- output the team that we created a base for
outputChatBox ( "Base for team " .. team .. " created" )
end
</syntaxhighlight>
The [[getElementsByType]] function retrieves a table of all the elements of a certain type (the type corresponds to the node name in the .map file). This works for both custom types and built-in MTA types (like "vehicle" or "player").
[[getElementData]] can be used to retrieve the xml attributes set in the .map file.
In this simple example, an object is created at the flag's location and a message is outputted in the chatbox. In reality, you will of course need to do more during map loading, like in this case setting up collision shapes to detect players taking the flag.

==Map manager==
Having read the section above it should be clear that a gamemode should always consist of two parts:
* The gamemode resource that always stays the same
* Many different maps resources that give the gamemode map-specific information

Now instead of writing a map-loader for every single gamemode, the [[Map manager]] provides functions to load gamemodes and maps. Simply put, when you enter the correct command (for example 'gamemode ctf ctf-italy') it will start both resources 'ctf' and 'ctf-italy' while triggering an event ([[onGamemodeMapStart]]) to tell the 'ctf' resource that a map was loaded. The 'ctf' resource can then access the information 'ctf-italy' contains and start spawning players etc.

===How to use the mapmanager===
To use the mapmanager service, your gamemode resource has to be tagged as such first. More specifically you'll be setting the "type" attribute of its <info> tag to "gamemode" inside meta.xml. Also, you can set the "name" attribute to a friendly name (like "Capture the flag") that will be shown on ASE instead of the resource name.
<syntaxhighlight lang="xml">

<meta>
<info type="gamemode" name="Cow catapulting 2.0"/>
</meta>
</syntaxhighlight>

If your gamemode is going to load custom maps, you should add handlers for
* onGamemodeMapStart
* onGamemodeMapStop (if any unloading is necessary)
These are fired when a map for your gamemode is started or stopped, and pass the map resource as a parameter.
Within the handler function for these events you can extract all info you need from the resource's map files and configuration files.

====Example====
<syntaxhighlight lang="lua">
function startCtfMap( startedMap ) -- startedMap contains a reference to the resource of the map
local mapRoot = getResourceRootElement( startedMap ) -- get the root node of the started map
local flagElements = getElementsByType ( "flag" , mapRoot ) -- get all flags in the map and store them in a table
-- go on loading information like in the example above
-- spawn players etc.
end
addEventHandler("onGamemodeMapStart", getRootElement(), startCtfMap)
</syntaxhighlight>

===Making maps compatible===
Maps are separate resources. This is done so no editing of the gamemode resource is ever necessary in order to create a custom map, and also allows you to pack map-specific scripts/config files with them.

To make a map compatible with your gamemode, open its resource's meta.xml and tag it as well: the "type" attribute must be set to "map", and the "gamemodes" attribute must be a comma-separated list (no spaces) of gamemode resource names that the map works with.
<syntaxhighlight lang="xml">

<meta>
<info type="map" gamemodes="cowcatapult,assault,tdm"/>
</meta>
</syntaxhighlight>

Once you have everything set up, admins will use these two commands to start/stop gamemodes:
/gamemode gamemodeName [mapName] (optional parameter allows picking an initial map, defaults to none)
/changemap mapName [gamemodeName] (optional parameter specifies the gamemode to start the map with, defaults to the current one)

[[Map manager]] exports a few more access functions which you don't have to use, but may be useful.

==What else should you do==
There are several other resources that gamemodes should use/be compliant with.

===Helpmanager===
The helpmanager is ought to be the standard interface for players when they need help. If you use the helpmanager to display your gamemode's help, every player that used helpmanager before (e.g. in other gamemodes) will immediately know how to get there. It also displays help for different resources running resources in one window, if necessary.

There are basicially two ways to use the helpmanager:
* Provide a simple text that explains how to use your gamemode
* Request a GUI element from the helpmanager that will be displayed in its own tab in the helpmanager window and lets you add any GUI elements to it. This is the recommended way for gamemodes that need to display more complex information that needs its own GUI.

Read the helpmanager page for details on how to do it.

===Scoreboard===
Scoreboard displays players and teams currently ingame. You add custom columns to it to provide map specific information. For example the column 'points' in the 'ctf' gamemode could represent the player's points gained through kills or captures. As usual, see the scoreboard help page for more information.

===Map cycler===
The map cycler controls what gamemodes and maps are played on a server. You can specifiy for example how many times in a row a map will be played until it switches to the next. To achieve this, you need to tell the map cycler when your gamemode finished (e.g. when a round ends).

[[it:Scrivere una gamemode]]
[[ru:Writing Gamemodes]]
[[de:Gamemodes schreiben]]

Page d'accueil

2014-04-03T14:30:44Z

Gaetan Piette: /* Programmer */

<div style="background: #FFEEAA; padding: 5px; float:right; width: 30%;">Dernière version stable de '''Multi Theft Auto: San Andreas''' est '''{{Current Version|full}}'''. Rendez-vous sur la [http://mtasa.com/ page principale] pour la télécharger.
<p>
Vous pouvez aussi télécharger une [http://nightly.mtasa.com/ beta] pour avoir la dernière version ( non stable ).
</p>
</div>
__NOTOC__
Bienvenue sur le wiki de Multi Theft Auto. Sur ce wiki, vous trouverez toutes les informations sur Multi Theft Auto.

Il y a [[How you can help|différents moyens de nous aider]]: créer une map, un gamemode, rediger des articles sur des fonctions, écrire un exemple, écrire un tutorial ou juste jouer à MTA et nous rapportez les bugs trouvés.

<div style="clear:both;"></div>
{| width="100%" cellspacing="0" cellpadding="0"
| colspan="2" |

|-
| width="50%" style="vertical-align:top;" |
<div style="border: 1px dotted #AAAAAA;padding:4px 8px 8px 8px;margin:10px;">
====Pour commencer====

* [[FR/Manuel_Client|Manuel Client]] ( Traduction: [http://wiki.multitheftauto.com/wiki/User:DrawKiie DrawKiie] )
* [[FR/Manuel_Serveur|Manuel Serveur]] ( Traduction: [http://wiki.multitheftauto.com/wiki/User:Rouche Rouche] )
* [[FR/Problemes_connus|Problèmes connus]] ( Traduction: [http://wiki.multitheftauto.com/wiki/User:Rouche Rouche] )
* [[FR/Migrer_de_MTARace_a_MTASA_1.0.x|Migrer de MTA:Race à MTA:SA 1.0.x]] ( Traduction: [http://wiki.multitheftauto.com/wiki/User:Rouche Rouche] )
* [[FR/A propos des Map|A propos des Map]] ( Traduction: [http://wiki.multitheftauto.com/wiki/User:Rouche Rouche] )

</div>

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

====Programmer====

* [[FR/Introduction_Programmation|Introduction: La programmation]] ( Traduction: [http://wiki.multitheftauto.com/wiki/User:Rouche Rouche] )
* [[FR/Introduction_GUI|Introduction: Le GUI]] ( Traduction: [http://wiki.multitheftauto.com/wiki/User:FatalTeror FatalTerror] )
* [[FR/Debugage|Tutoriel: Le débugage]] - Comment trouver les erreurs dans son script (Traduction:[http://wiki.multitheftauto.com/wiki/User:Vincenzo Vincenzo] alias Vincentdu90)
* [[FR/Ressources|Introduction: Les ressources]] (Traduction : [http://wiki.multitheftauto.com/wiki/User:Myk3L Myk3L])
** [[FR/Ressource_Acces_Internet|Introduction: L'accès depuis internet]] - Comment créer un site à partir d'une ressource (Traduction : [http://wiki.multitheftauto.com/wiki/User:Myk3L Myk3L])
** [[:Category:Resource|Catalogue des ressources]]
** [[FR/Meta.xml|Meta.xml]] - Derière chaque ressource ce trouve une meta pour la définir
** [[FR/ACL|ACL]] - Access Control List, pour définir les autorisations
* [[FR/Ecrire_Gamemode|Créer un gamemode]]
* [[FR/Fonctions_Utiles|Fonctions Utiles]]

</div>

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

====Bases de données====
Cette section décrit toutes les capacités fournies par le LUA/MTA ou par les ressources.
* [[:Category:Resource|Catalogue des ressources]] - Vous devriez le lire pour réaliser un script approprié.
* [[FR/Les_scripts_clients| Les scripts clients]]
</div>
<div style="border: 1px dotted #AAAAAA;padding:4px 8px 8px 8px;margin:10px;">

====Aide générale du LUA====
Des pages conçues pour aider votre compréhension du Lua
*[http://www.lua.org/pil/index.html "Programming in Lua"]
**[http://www.lua.org/manual/5.1/#index Les fonctions Lua]
*[http://lua-users.org/wiki/TutorialDirectory wiki Lua]
*[http://nixstaller.berlios.de/manual/0.2/nixstaller_9.html Un guide général au Lua de Nixstaller]
</div>

| width="50%" style="vertical-align:top;" |
<div style="border: 1px dotted #AAAAAA;padding:4px 8px 8px 8px;margin:10px;">

====Map Editor====
*[[Resource:Editor|Manuel]]
*[[Resource:Editor/EDF|Editor Definition Format]]
*[[Resource:Editor/Plugins|Plugins]]
*[[Resource:Editor#FAQ|Questions Fréquentes]]
</div>

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

====Développer Multi Theft Auto====
* [[FR/Compiler_MTASA|Compiler MTASA sur Windows]]
* [[FR/Compiler_MTASA_Server_sur_Mac_OS_X|Compiler MTASA sur Mac OS X]]
* [[FR/Compiler_MTASA_Server_sur_GNU_Linux|Compiler MTASA sur GNU/Linux]]
* [[FR/Directives_de_codage|Directives de codage]]
* [http://code.google.com/p/mtasa-blue Google Code SVN]
* [[FR/Roadmap|Roadmap]]
</div>

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

====Références====
* [[FR/Fonctions_Clients|Fonctions Clients]]
* [[FR/Events_Clients|Events Clients]]
* [[FR/Fonctions_Serveurs|Fonctions Clients]]
* [[FR/Events_Serveurs|Events Clients]]

* [[FR/MTA Classes|MTA Classes]] - Les descriptions détaillées de tous les types personnalisés MTA
** [[FR/Element|MTA Elements]] / [[Element tree]]
</div>

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

====[[Id|ID Listes]]====
*[[FR/Animations|Animations]]
*[[FR/Skins_Personnages|Skins Personnages]]
*[[FR/Vetements_CJ|Vêtements CJ]]
*[[FR/Garage|Garage IDs]]
*[[FR/Interieurs_IDs|Intérieurs IDs]]
*[[FR/Materiel_IDs|Matériel IDs]]
*[[FR/Projectiles|Projectiles]]
*[[FR/Radar Blips|Radar Blips]]
*[[FR/Sons|Sons]]
*[[FR/Vehicule_IDs|ID des véhicules]]
*[[FR/Vehicule_Couleurs|Couleurs véhicules]]
*[[FR/Vehicule_Upgrades|Tuning IDs]]
*[[FR/Armes|Armes]]
*[[FR/Meteos|Météos]]
</div>

|-
| colspan="2" |
|}
{{Languages list|fr}}

FR/A propos des Map

2014-04-03T14:27:37Z

Gaetan Piette: /* Paramètres d'une Map */

{{Needs Checking|Either complete the translation or remove it.}}
Le "Map manager" est une ressource inclue dans la suite serveur de MTA DM. Elle offre des commandes, fonctions et événements pour les modes de jeu afin de dynamiser vos maps. Par exemple, quand un serveur doit charger plusieurs routes pour plusieurs maps, au lieu d'avoir le tout dans un seul script principal, ces routes peuvent êtres stockée dans plusieurs ressources et chargée simplement grâce à la fonction "changeGamemodeMap" quand une map démarre.

Plus spécifiquement, le "Map manager" liste les modes de jeux et maps chargés sur le serveur. Il inclut un listing sur l'interface web, il rafraîchit cette liste fréquemment et met en gras les ressources et/ou maps actuellement entrain d'être utilisées.

== Un Simple Tutoriel ==
Dans cette section nous allons poursuivre le travail commencé dans [[FR/Introduction_Programmation|Introduction to Scripting]]. Nous allons ajouter une ressource qui enregistre l'endroit de spawn des joueurs sur la map, le chargement de ce script se fera depuis le script principal.

Premièrement, créez un dossier dans /Your MTA Server/mods/deathmatch/resources/, nommez-le "mymap". Ensuite dans ce dossier, créez un fichier texte et nommez-le "meta.xml", ce fichier est présent dans chaque scripts.

Ecrivez les lignes suivantes dans le fichier ''meta.xml'' :
<syntaxhighlight lang="xml">
<meta>
<info type="map" gamemodes="myserver"/>
<map src="mymap.map"/>
</meta>
</syntaxhighlight>
Prenez garde car ce fichier est "lié" avec le ''gamemodes=""'' choisit, qui contient le nom de la ressource principale qu'utilise ce mode. le paramètre ''map'', indique le nom de la map qui sera afficher sur le serveur.

Maintenant créez un nouveau fichier texte dans /mymap/ et nommez le "mymap.map", écrivez y les lignes suivantes:
<syntaxhighlight lang="xml">
<map>
<spawnpoint id="spawnpoint1" posX="1959.5487060547" posY="-1714.4613037109" posZ="18" rot="63.350006103516" model="0"/>
</map>
</syntaxhighlight>
Notez que "spawnpoint" est le type de l'élément utilisé dans la fonction [[getElementsByType]], "id" est utilisée dans la fonction [[getElementByID]]

Pour charger la map, le script principal doit pouvoir accéder aux maps par lui même. Quelques modifications sont à apportées dans script.lua situé dans "myserver". Entrez les lignes suivantes :

<syntaxhighlight lang="lua">
function loadMap(startedMap)
mapRoot = getResourceRootElement(startedMap)
end

addEventHandler("onGamemodeMapStart", getRootElement(), loadMap)
</syntaxhighlight>
Par défaut, l'evênement "onGamemodeMapStart" nous donne le "handle"(?) de la map ("startedMap"), lequel nous avons utilisé pour le "handle"(?) de la ressource contenant la map ("mapRoot").

Avec la ressource "handle"(?), nous pouvons extraire les informations relatives au spawnpoint. Jetez un œil à la fonction joinHandler() dans script.lua, à la place de x, y and z, nous pouvons utiliser les informations de la map comme suit :
<syntaxhighlight lang="lua">
function joinHandler()
local spawn = getElementsByType("spawnpoint", mapRoot)
local x,y,z,r
for key, value in pairs(spawn) do
x = getElementData(value, "posX")
y = getElementData(value, "posY")
z = getElementData(value, "posZ")
r = getElementData(value, "rot")
end
spawnPlayer(source, x, y, z)
fadeCamera(source, true)
end
</syntaxhighlight>
Lancez maintenant votre gamemode avec la commande suivante via la console:

'''gamemode myserver mymap'''

==Usage==
Pour utiliser le map manager, vos ressources doivent d'abord être reconnues en tant que gamemodes ou maps.

Vous devez remplir quelques informations pour votre fichier de configuration du '''gamemode resource''' :
<syntaxhighlight lang="xml"><info description="Votre Gamemode" type="gamemode" /></syntaxhighlight>

'''Map resources''' Les maps ont aussi besoin d'information dans le meta.xml, ''type="map"'' et un ou plusieurs ''gamemodes''. Une map peut en effet être compatible avec plusieurs mode de jeu pour se faire il faudra séparer les modes par une virgule ''sans espaces''.
<syntaxhighlight lang="xml"><info description="A gamemode map" type="map" gamemodes="ctv,koth" /></syntaxhighlight>

Il ne peut y avoir qu’un mode de jeu 'Gamemode' Actif ou une map chargée à la fois.

==Paramètres Supplémentaires==
Ces paramètres sont aussi à ajouter dans meta.xml.

'''name:''' Entrez ici un message sympa qui sera afficher lors du démarrage de la ressource. C'est en quelques sorte un alias au cas ou le nom de votre ressource ne vous correspond pas.

==Commandes==
'''changemap newmap [newgamemode]''' (changer le 'Gamemode' d'une map)

'''changemode newgamemode [newmap]''' (lancer un mode de jeu 'Gamemode' et démarrez une map)

'''gamemode newgamemode [newmap]''' (idem que la précédente)

'''stopmode''' (Arrête le mode de jeu et la map en cours)

'''stopmap''' (Arrête la map en cours)

'''maps [gamemode]''' (liste toutes les maps sur le serveurs, ajoutez en option le mode pour lequel vous voulez connaître les maps)

'''gamemodes''' (Liste tout les mode de jeu)

==Paramètres==
'''*mapmanager.color''' [hex color string] (change la couleur de sortie des message du mapmanager) (Par défaut : #E1AA5A)

'''*mapmanager.messages''' [boolean] (si les changements de map/gm sont activés) (Par défaut : true)

'''*mapmanager.ASE''' [boolean] (si le manager doit charger en mode ASE) (Par défaut : true)

==Autres fonctions==
<syntaxhighlight lang="lua">bool changeGamemode ( resource newGamemode, [ resource mapToLoadWith ] )</syntaxhighlight>
Changement de mode de jeu, on peut aussi lui donner une map initial à charger.
<syntaxhighlight lang="lua">bool changeGamemodeMap ( resource newMap, [ resource gamemodeToChangeTo ] )</syntaxhighlight>
Change le mode de jeu d'une map pour un nouveau, on peut choisir un mode de jeu à charger une fois cette map rechargée.
<syntaxhighlight lang="lua">table getGamemodes ( )</syntaxhighlight>
Renvoie une table des tout les modes de jeu et leur pointeurs.
<syntaxhighlight lang="lua">table getGamemodesCompatibleWithMap ( resource theMap )</syntaxhighlight>
Retourne une table de tout les modes de jeu compatibles.
<syntaxhighlight lang="lua">table getMaps ( )</syntaxhighlight>
Reourne une table de toutes les ressources en rapport avec la map.
<syntaxhighlight lang="lua">table getMapsCompatibleWithGamemode ( [ resource theGamemode ] )</syntaxhighlight>
Retourne une table de tout les modes de jeu compatibles. Si l'argument "theGamemode" est inexistant, ça retourne toutes les maps qui n'ont aucun mode de jeu compatible..
<syntaxhighlight lang="lua">resource getRunningGamemode ( )</syntaxhighlight>
Renvoie le mode de jeu actif.
<syntaxhighlight lang="lua">resource getRunningGamemodeMap ( )</syntaxhighlight>
Renvoie le mode de jeu de la map en cours.
<syntaxhighlight lang="lua">bool isGamemode ( resource theGamemode )</syntaxhighlight>
Déterminie si une ressources est un mode de jeu ou pas.
<syntaxhighlight lang="lua">bool isGamemodeCompatibleWithMap ( resource theGamemode, resource theMap )</syntaxhighlight>
Déterminie si une map est compatible avec un mode de jeu ou pas.
<syntaxhighlight lang="lua">bool isMap ( resource theMap )</syntaxhighlight>
Détermine si ressources est une map ou pas.
<syntaxhighlight lang="lua">bool isMapCompatibleWithGamemode ( resource theMap, resource theGamemode )</syntaxhighlight>
Déterminie si une map est compatible avec un gamemode ou pas.
<syntaxhighlight lang="lua">bool stopGamemode ( )</syntaxhighlight>
Arrêter le mode de jeux actif ainsi que la map chargée.
<syntaxhighlight lang="lua">bool stopGamemodeMap ( )</syntaxhighlight>
Arrêter la map active.

==Evênement Appelés==
''(Pour tous ces évênements, "source" est la ressource racine des élément.)''
<syntaxhighlight lang="lua">onGamemodeStart ( resource startedGamemode )</syntaxhighlight>
Appelé lors du démarrage d'un mode de jeu.
<syntaxhighlight lang="lua">onGamemodeStop ( resource stoppedGamemode )</syntaxhighlight>
Appelé quand on arrête un mode de jeu.
<syntaxhighlight lang="lua">onGamemodeMapStart ( resource startedMap )</syntaxhighlight>
Appelé quand la map d'un mode de jeu démarre.
<syntaxhighlight lang="lua">onGamemodeMapStop ( resource stoppedMap )</syntaxhighlight>
Appelé quand la map de mode de jeu est stoppée.

==Paramètres d'une Map==
Les paramètres suivants [[settings system|registry]] sont appliqué par le "Map Manager" quand une map est démarée :
<br>'''gamespeed''' [number]: la vitesse du jeu sur la map.
<br>'''gravity''' [number]: la gravité de la map.
<br>'''time''' [Sous la forme suivante '''hh:mm''']: l'heure du jeu avec cette map.
<br>'''weather''' [number]: la météo de la map.
<br>'''waveheight''' [number]: la hauteur de l'eau pour cette map.
<br>'''locked_time''' [boolean]: décide si le temps est verouillé ou non.
<br>'''minplayers''' [number]: décide du nombre minimum de joueurs pour démarrer la map.
<br>'''maxplayers''' [number]: décide du nombre maximum de joueurs que peut accepter la map.

[[it:Map manager]]
[[ru:Resource:Mapmanager]]

FR/A propos des Map

2014-04-03T14:27:17Z

Gaetan Piette: /* Supported map settings */

{{Needs Checking|Either complete the translation or remove it.}}
Le "Map manager" est une ressource inclue dans la suite serveur de MTA DM. Elle offre des commandes, fonctions et événements pour les modes de jeu afin de dynamiser vos maps. Par exemple, quand un serveur doit charger plusieurs routes pour plusieurs maps, au lieu d'avoir le tout dans un seul script principal, ces routes peuvent êtres stockée dans plusieurs ressources et chargée simplement grâce à la fonction "changeGamemodeMap" quand une map démarre.

Plus spécifiquement, le "Map manager" liste les modes de jeux et maps chargés sur le serveur. Il inclut un listing sur l'interface web, il rafraîchit cette liste fréquemment et met en gras les ressources et/ou maps actuellement entrain d'être utilisées.

== Un Simple Tutoriel ==
Dans cette section nous allons poursuivre le travail commencé dans [[FR/Introduction_Programmation|Introduction to Scripting]]. Nous allons ajouter une ressource qui enregistre l'endroit de spawn des joueurs sur la map, le chargement de ce script se fera depuis le script principal.

Premièrement, créez un dossier dans /Your MTA Server/mods/deathmatch/resources/, nommez-le "mymap". Ensuite dans ce dossier, créez un fichier texte et nommez-le "meta.xml", ce fichier est présent dans chaque scripts.

Ecrivez les lignes suivantes dans le fichier ''meta.xml'' :
<syntaxhighlight lang="xml">
<meta>
<info type="map" gamemodes="myserver"/>
<map src="mymap.map"/>
</meta>
</syntaxhighlight>
Prenez garde car ce fichier est "lié" avec le ''gamemodes=""'' choisit, qui contient le nom de la ressource principale qu'utilise ce mode. le paramètre ''map'', indique le nom de la map qui sera afficher sur le serveur.

Maintenant créez un nouveau fichier texte dans /mymap/ et nommez le "mymap.map", écrivez y les lignes suivantes:
<syntaxhighlight lang="xml">
<map>
<spawnpoint id="spawnpoint1" posX="1959.5487060547" posY="-1714.4613037109" posZ="18" rot="63.350006103516" model="0"/>
</map>
</syntaxhighlight>
Notez que "spawnpoint" est le type de l'élément utilisé dans la fonction [[getElementsByType]], "id" est utilisée dans la fonction [[getElementByID]]

Pour charger la map, le script principal doit pouvoir accéder aux maps par lui même. Quelques modifications sont à apportées dans script.lua situé dans "myserver". Entrez les lignes suivantes :

<syntaxhighlight lang="lua">
function loadMap(startedMap)
mapRoot = getResourceRootElement(startedMap)
end

addEventHandler("onGamemodeMapStart", getRootElement(), loadMap)
</syntaxhighlight>
Par défaut, l'evênement "onGamemodeMapStart" nous donne le "handle"(?) de la map ("startedMap"), lequel nous avons utilisé pour le "handle"(?) de la ressource contenant la map ("mapRoot").

Avec la ressource "handle"(?), nous pouvons extraire les informations relatives au spawnpoint. Jetez un œil à la fonction joinHandler() dans script.lua, à la place de x, y and z, nous pouvons utiliser les informations de la map comme suit :
<syntaxhighlight lang="lua">
function joinHandler()
local spawn = getElementsByType("spawnpoint", mapRoot)
local x,y,z,r
for key, value in pairs(spawn) do
x = getElementData(value, "posX")
y = getElementData(value, "posY")
z = getElementData(value, "posZ")
r = getElementData(value, "rot")
end
spawnPlayer(source, x, y, z)
fadeCamera(source, true)
end
</syntaxhighlight>
Lancez maintenant votre gamemode avec la commande suivante via la console:

'''gamemode myserver mymap'''

==Usage==
Pour utiliser le map manager, vos ressources doivent d'abord être reconnues en tant que gamemodes ou maps.

Vous devez remplir quelques informations pour votre fichier de configuration du '''gamemode resource''' :
<syntaxhighlight lang="xml"><info description="Votre Gamemode" type="gamemode" /></syntaxhighlight>

'''Map resources''' Les maps ont aussi besoin d'information dans le meta.xml, ''type="map"'' et un ou plusieurs ''gamemodes''. Une map peut en effet être compatible avec plusieurs mode de jeu pour se faire il faudra séparer les modes par une virgule ''sans espaces''.
<syntaxhighlight lang="xml"><info description="A gamemode map" type="map" gamemodes="ctv,koth" /></syntaxhighlight>

Il ne peut y avoir qu’un mode de jeu 'Gamemode' Actif ou une map chargée à la fois.

==Paramètres Supplémentaires==
Ces paramètres sont aussi à ajouter dans meta.xml.

'''name:''' Entrez ici un message sympa qui sera afficher lors du démarrage de la ressource. C'est en quelques sorte un alias au cas ou le nom de votre ressource ne vous correspond pas.

==Commandes==
'''changemap newmap [newgamemode]''' (changer le 'Gamemode' d'une map)

'''changemode newgamemode [newmap]''' (lancer un mode de jeu 'Gamemode' et démarrez une map)

'''gamemode newgamemode [newmap]''' (idem que la précédente)

'''stopmode''' (Arrête le mode de jeu et la map en cours)

'''stopmap''' (Arrête la map en cours)

'''maps [gamemode]''' (liste toutes les maps sur le serveurs, ajoutez en option le mode pour lequel vous voulez connaître les maps)

'''gamemodes''' (Liste tout les mode de jeu)

==Paramètres==
'''*mapmanager.color''' [hex color string] (change la couleur de sortie des message du mapmanager) (Par défaut : #E1AA5A)

'''*mapmanager.messages''' [boolean] (si les changements de map/gm sont activés) (Par défaut : true)

'''*mapmanager.ASE''' [boolean] (si le manager doit charger en mode ASE) (Par défaut : true)

==Autres fonctions==
<syntaxhighlight lang="lua">bool changeGamemode ( resource newGamemode, [ resource mapToLoadWith ] )</syntaxhighlight>
Changement de mode de jeu, on peut aussi lui donner une map initial à charger.
<syntaxhighlight lang="lua">bool changeGamemodeMap ( resource newMap, [ resource gamemodeToChangeTo ] )</syntaxhighlight>
Change le mode de jeu d'une map pour un nouveau, on peut choisir un mode de jeu à charger une fois cette map rechargée.
<syntaxhighlight lang="lua">table getGamemodes ( )</syntaxhighlight>
Renvoie une table des tout les modes de jeu et leur pointeurs.
<syntaxhighlight lang="lua">table getGamemodesCompatibleWithMap ( resource theMap )</syntaxhighlight>
Retourne une table de tout les modes de jeu compatibles.
<syntaxhighlight lang="lua">table getMaps ( )</syntaxhighlight>
Reourne une table de toutes les ressources en rapport avec la map.
<syntaxhighlight lang="lua">table getMapsCompatibleWithGamemode ( [ resource theGamemode ] )</syntaxhighlight>
Retourne une table de tout les modes de jeu compatibles. Si l'argument "theGamemode" est inexistant, ça retourne toutes les maps qui n'ont aucun mode de jeu compatible..
<syntaxhighlight lang="lua">resource getRunningGamemode ( )</syntaxhighlight>
Renvoie le mode de jeu actif.
<syntaxhighlight lang="lua">resource getRunningGamemodeMap ( )</syntaxhighlight>
Renvoie le mode de jeu de la map en cours.
<syntaxhighlight lang="lua">bool isGamemode ( resource theGamemode )</syntaxhighlight>
Déterminie si une ressources est un mode de jeu ou pas.
<syntaxhighlight lang="lua">bool isGamemodeCompatibleWithMap ( resource theGamemode, resource theMap )</syntaxhighlight>
Déterminie si une map est compatible avec un mode de jeu ou pas.
<syntaxhighlight lang="lua">bool isMap ( resource theMap )</syntaxhighlight>
Détermine si ressources est une map ou pas.
<syntaxhighlight lang="lua">bool isMapCompatibleWithGamemode ( resource theMap, resource theGamemode )</syntaxhighlight>
Déterminie si une map est compatible avec un gamemode ou pas.
<syntaxhighlight lang="lua">bool stopGamemode ( )</syntaxhighlight>
Arrêter le mode de jeux actif ainsi que la map chargée.
<syntaxhighlight lang="lua">bool stopGamemodeMap ( )</syntaxhighlight>
Arrêter la map active.

==Evênement Appelés==
''(Pour tous ces évênements, "source" est la ressource racine des élément.)''
<syntaxhighlight lang="lua">onGamemodeStart ( resource startedGamemode )</syntaxhighlight>
Appelé lors du démarrage d'un mode de jeu.
<syntaxhighlight lang="lua">onGamemodeStop ( resource stoppedGamemode )</syntaxhighlight>
Appelé quand on arrête un mode de jeu.
<syntaxhighlight lang="lua">onGamemodeMapStart ( resource startedMap )</syntaxhighlight>
Appelé quand la map d'un mode de jeu démarre.
<syntaxhighlight lang="lua">onGamemodeMapStop ( resource stoppedMap )</syntaxhighlight>
Appelé quand la map de mode de jeu est stoppée.

==Paramètres d'une Map==
Les paramètres suivants [[settings system|registry]] sont appliqué par le "Map Manager" quand une map est démarée :
<br>'''gamespeed''' [number]: la vitesse du jeu sur la map.
<br>'''gravity''' [number]: la gravité de la map.
<br>'''time''' [string of the form '''hh:mm''']: l'heure du jeu avec cette map.
<br>'''weather''' [number]: la météo de la map.
<br>'''waveheight''' [number]: la hauteur de l'eau pour cette map.
<br>'''locked_time''' [boolean]: décide si le temps est verouillé ou non.
<br>'''minplayers''' [number]: décide du nombre minimum de joueurs pour démarrer la map.
<br>'''maxplayers''' [number]: décide du nombre maximum de joueurs que peut accepter la map.

[[it:Map manager]]
[[ru:Resource:Mapmanager]]

FR/A propos des Map

2014-04-03T14:24:31Z

Gaetan Piette: /* Fired events */

{{Needs Checking|Either complete the translation or remove it.}}
Le "Map manager" est une ressource inclue dans la suite serveur de MTA DM. Elle offre des commandes, fonctions et événements pour les modes de jeu afin de dynamiser vos maps. Par exemple, quand un serveur doit charger plusieurs routes pour plusieurs maps, au lieu d'avoir le tout dans un seul script principal, ces routes peuvent êtres stockée dans plusieurs ressources et chargée simplement grâce à la fonction "changeGamemodeMap" quand une map démarre.

Plus spécifiquement, le "Map manager" liste les modes de jeux et maps chargés sur le serveur. Il inclut un listing sur l'interface web, il rafraîchit cette liste fréquemment et met en gras les ressources et/ou maps actuellement entrain d'être utilisées.

== Un Simple Tutoriel ==
Dans cette section nous allons poursuivre le travail commencé dans [[FR/Introduction_Programmation|Introduction to Scripting]]. Nous allons ajouter une ressource qui enregistre l'endroit de spawn des joueurs sur la map, le chargement de ce script se fera depuis le script principal.

Premièrement, créez un dossier dans /Your MTA Server/mods/deathmatch/resources/, nommez-le "mymap". Ensuite dans ce dossier, créez un fichier texte et nommez-le "meta.xml", ce fichier est présent dans chaque scripts.

Ecrivez les lignes suivantes dans le fichier ''meta.xml'' :
<syntaxhighlight lang="xml">
<meta>
<info type="map" gamemodes="myserver"/>
<map src="mymap.map"/>
</meta>
</syntaxhighlight>
Prenez garde car ce fichier est "lié" avec le ''gamemodes=""'' choisit, qui contient le nom de la ressource principale qu'utilise ce mode. le paramètre ''map'', indique le nom de la map qui sera afficher sur le serveur.

Maintenant créez un nouveau fichier texte dans /mymap/ et nommez le "mymap.map", écrivez y les lignes suivantes:
<syntaxhighlight lang="xml">
<map>
<spawnpoint id="spawnpoint1" posX="1959.5487060547" posY="-1714.4613037109" posZ="18" rot="63.350006103516" model="0"/>
</map>
</syntaxhighlight>
Notez que "spawnpoint" est le type de l'élément utilisé dans la fonction [[getElementsByType]], "id" est utilisée dans la fonction [[getElementByID]]

Pour charger la map, le script principal doit pouvoir accéder aux maps par lui même. Quelques modifications sont à apportées dans script.lua situé dans "myserver". Entrez les lignes suivantes :

<syntaxhighlight lang="lua">
function loadMap(startedMap)
mapRoot = getResourceRootElement(startedMap)
end

addEventHandler("onGamemodeMapStart", getRootElement(), loadMap)
</syntaxhighlight>
Par défaut, l'evênement "onGamemodeMapStart" nous donne le "handle"(?) de la map ("startedMap"), lequel nous avons utilisé pour le "handle"(?) de la ressource contenant la map ("mapRoot").

Avec la ressource "handle"(?), nous pouvons extraire les informations relatives au spawnpoint. Jetez un œil à la fonction joinHandler() dans script.lua, à la place de x, y and z, nous pouvons utiliser les informations de la map comme suit :
<syntaxhighlight lang="lua">
function joinHandler()
local spawn = getElementsByType("spawnpoint", mapRoot)
local x,y,z,r
for key, value in pairs(spawn) do
x = getElementData(value, "posX")
y = getElementData(value, "posY")
z = getElementData(value, "posZ")
r = getElementData(value, "rot")
end
spawnPlayer(source, x, y, z)
fadeCamera(source, true)
end
</syntaxhighlight>
Lancez maintenant votre gamemode avec la commande suivante via la console:

'''gamemode myserver mymap'''

==Usage==
Pour utiliser le map manager, vos ressources doivent d'abord être reconnues en tant que gamemodes ou maps.

Vous devez remplir quelques informations pour votre fichier de configuration du '''gamemode resource''' :
<syntaxhighlight lang="xml"><info description="Votre Gamemode" type="gamemode" /></syntaxhighlight>

'''Map resources''' Les maps ont aussi besoin d'information dans le meta.xml, ''type="map"'' et un ou plusieurs ''gamemodes''. Une map peut en effet être compatible avec plusieurs mode de jeu pour se faire il faudra séparer les modes par une virgule ''sans espaces''.
<syntaxhighlight lang="xml"><info description="A gamemode map" type="map" gamemodes="ctv,koth" /></syntaxhighlight>

Il ne peut y avoir qu’un mode de jeu 'Gamemode' Actif ou une map chargée à la fois.

==Paramètres Supplémentaires==
Ces paramètres sont aussi à ajouter dans meta.xml.

'''name:''' Entrez ici un message sympa qui sera afficher lors du démarrage de la ressource. C'est en quelques sorte un alias au cas ou le nom de votre ressource ne vous correspond pas.

==Commandes==
'''changemap newmap [newgamemode]''' (changer le 'Gamemode' d'une map)

'''changemode newgamemode [newmap]''' (lancer un mode de jeu 'Gamemode' et démarrez une map)

'''gamemode newgamemode [newmap]''' (idem que la précédente)

'''stopmode''' (Arrête le mode de jeu et la map en cours)

'''stopmap''' (Arrête la map en cours)

'''maps [gamemode]''' (liste toutes les maps sur le serveurs, ajoutez en option le mode pour lequel vous voulez connaître les maps)

'''gamemodes''' (Liste tout les mode de jeu)

==Paramètres==
'''*mapmanager.color''' [hex color string] (change la couleur de sortie des message du mapmanager) (Par défaut : #E1AA5A)

'''*mapmanager.messages''' [boolean] (si les changements de map/gm sont activés) (Par défaut : true)

'''*mapmanager.ASE''' [boolean] (si le manager doit charger en mode ASE) (Par défaut : true)

==Autres fonctions==
<syntaxhighlight lang="lua">bool changeGamemode ( resource newGamemode, [ resource mapToLoadWith ] )</syntaxhighlight>
Changement de mode de jeu, on peut aussi lui donner une map initial à charger.
<syntaxhighlight lang="lua">bool changeGamemodeMap ( resource newMap, [ resource gamemodeToChangeTo ] )</syntaxhighlight>
Change le mode de jeu d'une map pour un nouveau, on peut choisir un mode de jeu à charger une fois cette map rechargée.
<syntaxhighlight lang="lua">table getGamemodes ( )</syntaxhighlight>
Renvoie une table des tout les modes de jeu et leur pointeurs.
<syntaxhighlight lang="lua">table getGamemodesCompatibleWithMap ( resource theMap )</syntaxhighlight>
Retourne une table de tout les modes de jeu compatibles.
<syntaxhighlight lang="lua">table getMaps ( )</syntaxhighlight>
Reourne une table de toutes les ressources en rapport avec la map.
<syntaxhighlight lang="lua">table getMapsCompatibleWithGamemode ( [ resource theGamemode ] )</syntaxhighlight>
Retourne une table de tout les modes de jeu compatibles. Si l'argument "theGamemode" est inexistant, ça retourne toutes les maps qui n'ont aucun mode de jeu compatible..
<syntaxhighlight lang="lua">resource getRunningGamemode ( )</syntaxhighlight>
Renvoie le mode de jeu actif.
<syntaxhighlight lang="lua">resource getRunningGamemodeMap ( )</syntaxhighlight>
Renvoie le mode de jeu de la map en cours.
<syntaxhighlight lang="lua">bool isGamemode ( resource theGamemode )</syntaxhighlight>
Déterminie si une ressources est un mode de jeu ou pas.
<syntaxhighlight lang="lua">bool isGamemodeCompatibleWithMap ( resource theGamemode, resource theMap )</syntaxhighlight>
Déterminie si une map est compatible avec un mode de jeu ou pas.
<syntaxhighlight lang="lua">bool isMap ( resource theMap )</syntaxhighlight>
Détermine si ressources est une map ou pas.
<syntaxhighlight lang="lua">bool isMapCompatibleWithGamemode ( resource theMap, resource theGamemode )</syntaxhighlight>
Déterminie si une map est compatible avec un gamemode ou pas.
<syntaxhighlight lang="lua">bool stopGamemode ( )</syntaxhighlight>
Arrêter le mode de jeux actif ainsi que la map chargée.
<syntaxhighlight lang="lua">bool stopGamemodeMap ( )</syntaxhighlight>
Arrêter la map active.

==Evênement Appelés==
''(Pour tous ces évênements, "source" est la ressource racine des élément.)''
<syntaxhighlight lang="lua">onGamemodeStart ( resource startedGamemode )</syntaxhighlight>
Appelé lors du démarrage d'un mode de jeu.
<syntaxhighlight lang="lua">onGamemodeStop ( resource stoppedGamemode )</syntaxhighlight>
Appelé quand on arrête un mode de jeu.
<syntaxhighlight lang="lua">onGamemodeMapStart ( resource startedMap )</syntaxhighlight>
Appelé quand la map d'un mode de jeu démarre.
<syntaxhighlight lang="lua">onGamemodeMapStop ( resource stoppedMap )</syntaxhighlight>
Appelé quand la map de mode de jeu est stoppée.

==Supported map settings==
The following settings from the [[settings system|registry]] are applied by the map manager when a map is started:
<br>'''gamespeed''' [number]: The map's game speed.
<br>'''gravity''' [number]: The map's gravity.
<br>'''time''' [string of the form '''hh:mm''']: The map's time.
<br>'''weather''' [number]: The map's weather ID.
<br>'''waveheight''' [number]: The map's wave height.
<br>'''locked_time''' [boolean]: Whether the set time will be frozen by the manager or not.
<br>'''minplayers''' [number]: The required minimum number of players to start the map.
<br>'''maxplayers''' [number]: The allowed maximum number of players to start the map.

[[it:Map manager]]
[[ru:Resource:Mapmanager]]

FR/A propos des Map

2014-04-03T14:20:01Z

Gaetan Piette: /* Autres fonctions */

{{Needs Checking|Either complete the translation or remove it.}}
Le "Map manager" est une ressource inclue dans la suite serveur de MTA DM. Elle offre des commandes, fonctions et événements pour les modes de jeu afin de dynamiser vos maps. Par exemple, quand un serveur doit charger plusieurs routes pour plusieurs maps, au lieu d'avoir le tout dans un seul script principal, ces routes peuvent êtres stockée dans plusieurs ressources et chargée simplement grâce à la fonction "changeGamemodeMap" quand une map démarre.

Plus spécifiquement, le "Map manager" liste les modes de jeux et maps chargés sur le serveur. Il inclut un listing sur l'interface web, il rafraîchit cette liste fréquemment et met en gras les ressources et/ou maps actuellement entrain d'être utilisées.

== Un Simple Tutoriel ==
Dans cette section nous allons poursuivre le travail commencé dans [[FR/Introduction_Programmation|Introduction to Scripting]]. Nous allons ajouter une ressource qui enregistre l'endroit de spawn des joueurs sur la map, le chargement de ce script se fera depuis le script principal.

Premièrement, créez un dossier dans /Your MTA Server/mods/deathmatch/resources/, nommez-le "mymap". Ensuite dans ce dossier, créez un fichier texte et nommez-le "meta.xml", ce fichier est présent dans chaque scripts.

Ecrivez les lignes suivantes dans le fichier ''meta.xml'' :
<syntaxhighlight lang="xml">
<meta>
<info type="map" gamemodes="myserver"/>
<map src="mymap.map"/>
</meta>
</syntaxhighlight>
Prenez garde car ce fichier est "lié" avec le ''gamemodes=""'' choisit, qui contient le nom de la ressource principale qu'utilise ce mode. le paramètre ''map'', indique le nom de la map qui sera afficher sur le serveur.

Maintenant créez un nouveau fichier texte dans /mymap/ et nommez le "mymap.map", écrivez y les lignes suivantes:
<syntaxhighlight lang="xml">
<map>
<spawnpoint id="spawnpoint1" posX="1959.5487060547" posY="-1714.4613037109" posZ="18" rot="63.350006103516" model="0"/>
</map>
</syntaxhighlight>
Notez que "spawnpoint" est le type de l'élément utilisé dans la fonction [[getElementsByType]], "id" est utilisée dans la fonction [[getElementByID]]

Pour charger la map, le script principal doit pouvoir accéder aux maps par lui même. Quelques modifications sont à apportées dans script.lua situé dans "myserver". Entrez les lignes suivantes :

<syntaxhighlight lang="lua">
function loadMap(startedMap)
mapRoot = getResourceRootElement(startedMap)
end

addEventHandler("onGamemodeMapStart", getRootElement(), loadMap)
</syntaxhighlight>
Par défaut, l'evênement "onGamemodeMapStart" nous donne le "handle"(?) de la map ("startedMap"), lequel nous avons utilisé pour le "handle"(?) de la ressource contenant la map ("mapRoot").

Avec la ressource "handle"(?), nous pouvons extraire les informations relatives au spawnpoint. Jetez un œil à la fonction joinHandler() dans script.lua, à la place de x, y and z, nous pouvons utiliser les informations de la map comme suit :
<syntaxhighlight lang="lua">
function joinHandler()
local spawn = getElementsByType("spawnpoint", mapRoot)
local x,y,z,r
for key, value in pairs(spawn) do
x = getElementData(value, "posX")
y = getElementData(value, "posY")
z = getElementData(value, "posZ")
r = getElementData(value, "rot")
end
spawnPlayer(source, x, y, z)
fadeCamera(source, true)
end
</syntaxhighlight>
Lancez maintenant votre gamemode avec la commande suivante via la console:

'''gamemode myserver mymap'''

==Usage==
Pour utiliser le map manager, vos ressources doivent d'abord être reconnues en tant que gamemodes ou maps.

Vous devez remplir quelques informations pour votre fichier de configuration du '''gamemode resource''' :
<syntaxhighlight lang="xml"><info description="Votre Gamemode" type="gamemode" /></syntaxhighlight>

'''Map resources''' Les maps ont aussi besoin d'information dans le meta.xml, ''type="map"'' et un ou plusieurs ''gamemodes''. Une map peut en effet être compatible avec plusieurs mode de jeu pour se faire il faudra séparer les modes par une virgule ''sans espaces''.
<syntaxhighlight lang="xml"><info description="A gamemode map" type="map" gamemodes="ctv,koth" /></syntaxhighlight>

Il ne peut y avoir qu’un mode de jeu 'Gamemode' Actif ou une map chargée à la fois.

==Paramètres Supplémentaires==
Ces paramètres sont aussi à ajouter dans meta.xml.

'''name:''' Entrez ici un message sympa qui sera afficher lors du démarrage de la ressource. C'est en quelques sorte un alias au cas ou le nom de votre ressource ne vous correspond pas.

==Commandes==
'''changemap newmap [newgamemode]''' (changer le 'Gamemode' d'une map)

'''changemode newgamemode [newmap]''' (lancer un mode de jeu 'Gamemode' et démarrez une map)

'''gamemode newgamemode [newmap]''' (idem que la précédente)

'''stopmode''' (Arrête le mode de jeu et la map en cours)

'''stopmap''' (Arrête la map en cours)

'''maps [gamemode]''' (liste toutes les maps sur le serveurs, ajoutez en option le mode pour lequel vous voulez connaître les maps)

'''gamemodes''' (Liste tout les mode de jeu)

==Paramètres==
'''*mapmanager.color''' [hex color string] (change la couleur de sortie des message du mapmanager) (Par défaut : #E1AA5A)

'''*mapmanager.messages''' [boolean] (si les changements de map/gm sont activés) (Par défaut : true)

'''*mapmanager.ASE''' [boolean] (si le manager doit charger en mode ASE) (Par défaut : true)

==Autres fonctions==
<syntaxhighlight lang="lua">bool changeGamemode ( resource newGamemode, [ resource mapToLoadWith ] )</syntaxhighlight>
Changement de mode de jeu, on peut aussi lui donner une map initial à charger.
<syntaxhighlight lang="lua">bool changeGamemodeMap ( resource newMap, [ resource gamemodeToChangeTo ] )</syntaxhighlight>
Change le mode de jeu d'une map pour un nouveau, on peut choisir un mode de jeu à charger une fois cette map rechargée.
<syntaxhighlight lang="lua">table getGamemodes ( )</syntaxhighlight>
Renvoie une table des tout les modes de jeu et leur pointeurs.
<syntaxhighlight lang="lua">table getGamemodesCompatibleWithMap ( resource theMap )</syntaxhighlight>
Retourne une table de tout les modes de jeu compatibles.
<syntaxhighlight lang="lua">table getMaps ( )</syntaxhighlight>
Reourne une table de toutes les ressources en rapport avec la map.
<syntaxhighlight lang="lua">table getMapsCompatibleWithGamemode ( [ resource theGamemode ] )</syntaxhighlight>
Retourne une table de tout les modes de jeu compatibles. Si l'argument "theGamemode" est inexistant, ça retourne toutes les maps qui n'ont aucun mode de jeu compatible..
<syntaxhighlight lang="lua">resource getRunningGamemode ( )</syntaxhighlight>
Renvoie le mode de jeu actif.
<syntaxhighlight lang="lua">resource getRunningGamemodeMap ( )</syntaxhighlight>
Renvoie le mode de jeu de la map en cours.
<syntaxhighlight lang="lua">bool isGamemode ( resource theGamemode )</syntaxhighlight>
Déterminie si une ressources est un mode de jeu ou pas.
<syntaxhighlight lang="lua">bool isGamemodeCompatibleWithMap ( resource theGamemode, resource theMap )</syntaxhighlight>
Déterminie si une map est compatible avec un mode de jeu ou pas.
<syntaxhighlight lang="lua">bool isMap ( resource theMap )</syntaxhighlight>
Détermine si ressources est une map ou pas.
<syntaxhighlight lang="lua">bool isMapCompatibleWithGamemode ( resource theMap, resource theGamemode )</syntaxhighlight>
Déterminie si une map est compatible avec un gamemode ou pas.
<syntaxhighlight lang="lua">bool stopGamemode ( )</syntaxhighlight>
Arrêter le mode de jeux actif ainsi que la map chargée.
<syntaxhighlight lang="lua">bool stopGamemodeMap ( )</syntaxhighlight>
Arrêter la map active.

==Fired events==
''(For all these events, "source" is the resource's root element.)''
<syntaxhighlight lang="lua">onGamemodeStart ( resource startedGamemode )</syntaxhighlight>
Fired before a gamemode starts.
<syntaxhighlight lang="lua">onGamemodeStop ( resource stoppedGamemode )</syntaxhighlight>
Fired before a gamemode is stopped.
<syntaxhighlight lang="lua">onGamemodeMapStart ( resource startedMap )</syntaxhighlight>
Fired before a GM map starts.
<syntaxhighlight lang="lua">onGamemodeMapStop ( resource stoppedMap )</syntaxhighlight>
Fired before a GM map is stopped.

==Supported map settings==
The following settings from the [[settings system|registry]] are applied by the map manager when a map is started:
<br>'''gamespeed''' [number]: The map's game speed.
<br>'''gravity''' [number]: The map's gravity.
<br>'''time''' [string of the form '''hh:mm''']: The map's time.
<br>'''weather''' [number]: The map's weather ID.
<br>'''waveheight''' [number]: The map's wave height.
<br>'''locked_time''' [boolean]: Whether the set time will be frozen by the manager or not.
<br>'''minplayers''' [number]: The required minimum number of players to start the map.
<br>'''maxplayers''' [number]: The allowed maximum number of players to start the map.

[[it:Map manager]]
[[ru:Resource:Mapmanager]]

User:Rouche

2014-02-09T19:40:38Z

Gaetan Piette:

Name : Gaëtan<br>
Age : 29 July 1991<br>
Live in Belgium<br>
Langages : French and English<br><br>

MTA:SA<br>
- Owner of =KoG=Team (2 Servers)<br><br>
Website : [http://www.teamkog.com Team =KoG=]

Help Community :<br>
Translate : MTA:SA Wiki (French).

FR/Introduction GUI

2013-06-30T12:30:11Z

Gaetan Piette: /* Adding the components */

Une des grandes caractéristiques de MTA:SA c'est d'avoir la possibilité de personnaliser l'interface. Plus couramment appelé GUI(Graphic User Interface). L'interface graphique se compose de fenêtres, bouton, les boîtes d'édition, des cases à cocher ... Les GUI peuvent être affichés lorsque l'utilisateur est en jeu.

[[Image:AdminGUI.png|thumb|Le panel admin(GUI)]]

==Un tutoriel pour créer une fenêtre de connexion==
Dans ce tutoriel, nous allons faire une fenêtre de connexion simple avec deux boites de saisie et un bouton.
La fenêtre apparaîtra lorsque le joueur rejoindra le jeu et une fois que le joueur appuiera sur le bouton.

===Créer la fenêtre de connexion===
Tous les GUI doivent être crée dans le coté client. Pour vous simplifier la vie, créez votre code dans des dossiers séparé.
Les fichiers client vous les mettez dans le dossier client que vous avez créer.

Allez sur /Votre Server MTA/mods/deathmatch/resources/votreserver/, et créez un dossier du nom de "login".
Puis dans ce répertoire créer le dosser "client". (login/client)
Créez un fichier texte et nommez le "gui.lua".

Dans ce fichier nous allons écrire une fonction pour créer notre fenêtre. Pour créer une fenetre vous allez devoir utiliser [[guiCreateWindow]]:
<syntaxhighlight lang="lua">
function createLoginWindow()
-- on définie les positions de la fenêtre
local X = 0.375
local Y = 0.375
-- on définie la taille de la fenêtre
local Width = 0.25
local Height = 0.25
-- créez la fenêtre et sauvegardez cette élément sous la variable 'wdwLogin'
-- cliquez sur le nom de la fonction pour regarder sa documentation
wdwLogin = guiCreateWindow(X, Y, Width, Height, "Veuillez vous connecter", true)
end
</syntaxhighlight>

===Relatif et Absolu ===
Notez que l'argument final passé à guiCreateWindow dans l'exemple ci-dessus est ''true''. Cela indique que l'ensemble et les dimensions de la fenêtre sont ''relative'', en signifiant qu'ils sont un ''percentage'' de la grandeur d'écran totale. Cela signifie que si le côté gauche lointain de l'écran est 0 et le droit lointain est 1, une position X de 0.5 représenterait le point de centre de l'écran. De même si le haut de l'écran est 0 et le fond est 1, une position Y de 0.2 serait 20 % de la voie en bas l'écran. Les mêmes principes s'appliquent tant à Largeur qu'à Hauteur aussi (avec une valeur de Largeur de 0.5 sens la fenêtre sera la moitié aussi large que l'écran).

L'alternative à l'utilisation des valeurs relatives utilise absolu (en passant ''false'' au lieu de ''true'' pour guiCreateWindow). Les valeurs absolues sont calculées comme le nombre total de pixels du coin gauche-supérieur du parent (si aucun parent d'élément gui n'est spécifié, le parent est l'écran lui-même). Si nous supposons une résolution d'écran de 1920x1200, le côté gauche lointain de l'écran étant 0 pixels et le droit lointain étant 1920 pixels, une position X de 960 représentera le point de centre de l'écran. De même si le haut de l'écran est 0 pixels et le fond est 1200, une position Y de 20 serait 20 pixels en bas du haut de l'écran. La même pomme de principes tant à la Largeur qu'à la Hauteur aussi (avec une valeur de Largeur de 50 sens la fenêtre sera 50 pixels larges). Vous pouvez utiliser guiGetScreenSize et des petites mathématiques pour calculer certaines positions absolues.

Les différences entre l'utilisation des valeurs relatives et absolues sont tout à fait simples; les valeurs absolues utilisatrices de données de gui resteront toujours exactement la même grandeur de pixel et la position, pendant que les valeurs relatives utilisatrices de données de gui seront toujours un pourcentage de sa grandeur parentale.

L'absolu est généralement plus facile de maintenir en révisant le code à la main, pourtant votre choix de type dépend de la situation dont vous l'utilisez.

Pour les buts de cette introduction nous utiliserons des valeurs relatives.

===Ajouter les composants===
Next, we'll add the text labels (saying "username:" and "password:"), edit boxes (for entering your data) and a button to log in.

To create buttons we use [[guiCreateButton]] and to create edit boxes use [[guiCreateEdit]]:

'''Note that we are now writing more code for our existing 'createLoginWindow' function. This is not a new function and is meant to replace what you already have.'''
<syntaxhighlight lang="lua">
function createLoginWindow()
local X = 0.375
local Y = 0.375
local Width = 0.25
local Height = 0.25
wdwLogin = guiCreateWindow(X, Y, Width, Height, "Please Log In", true)

-- define new X and Y positions for the first label
X = 0.0825
Y = 0.2
-- define new Width and Height values for the first label
Width = 0.25
Height = 0.25
-- create the first label, note the final argument passed is 'wdwLogin' meaning the window
-- we created above is the parent of this label (so all the position and size values are now relative to the position of that window)
guiCreateLabel(X, Y, Width, Height, "Username", true, wdwLogin)
-- alter the Y value, so the second label is slightly below the first
Y = 0.5
guiCreateLabel(X, Y, Width, Height, "Password", true, wdwLogin)

X = 0.415
Y = 0.2
Width = 0.5
Height = 0.15
edtUser = guiCreateEdit(X, Y, Width, Height, "", true, wdwLogin)
Y = 0.5
edtPass = guiCreateEdit(X, Y, Width, Height, "", true, wdwLogin)
-- set the maximum character length for the username and password fields to 50
guiEditSetMaxLength(edtUser, 50)
guiEditSetMaxLength(edtPass, 50)

X = 0.415
Y = 0.7
Width = 0.25
Height = 0.2
btnLogin = guiCreateButton(X, Y, Width, Height, "Log In", true, wdwLogin)

-- make the window invisible
guiSetVisible(wdwLogin, false)
end
</syntaxhighlight>
Note that every GUI component created is a child of the window, this is done by specifying the parent element (wdwLogin, in this case) when creating the component.

This is very useful because not only does it mean that all the components are attached to the window and will move with it, but also that any changes done to the parent window will be applied down the tree to these child components. For example, we can now hide all of the GUI we just created by simply hiding the window:
<syntaxhighlight lang="lua">
guiSetVisible(wdwLogin, false) --hides all the GUI we made so we can show them to the player at the appropriate moment.
</syntaxhighlight>

===Using the function we wrote===
The createLoginWindow function is now complete, but it won't do anything until we call it. It is recommended to create all GUI when the client resource starts, hide them, and show them to the player later when needed. Therefore, we'll write an event handler for "[[onClientResourceStart]]" to create the window:
<syntaxhighlight lang="lua">
-- attach the event handler to the root element of the resource
-- this means it will only trigger when its own resource is started
addEventHandler("onClientResourceStart", getResourceRootElement(getThisResource()),
function ()
createLoginWindow()
end
)
</syntaxhighlight>

As this is a log in window, we now need to show the window when the player joins the game.
This can be done using the same event, "[[onClientResourceStart]]", so we can modify the above code to include showing the window:

'''Note that we are now writing more code for our existing 'onClientResourceStart' handler. This is not a new event handler and is meant to replace what you already have.'''
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart", getResourceRootElement(getThisResource()),
function ()
-- create the log in window and its components
createLoginWindow()

-- output a brief welcome message to the player
outputChatBox("Welcome to My MTA:SA Server, please log in.")

-- if the GUI was successfully created, then show the GUI to the player
if (wdwLogin ~= nil) then
guiSetVisible(wdwLogin, true)
else
-- if the GUI hasnt been properly created, tell the player
outputChatBox("An unexpected error has occurred and the log in GUI has not been created.")
end

-- enable the players cursor (so they can select and click on the components)
showCursor(true)
-- set the input focus onto the GUI, allowing players (for example) to press 'T' without the chatbox opening
guiSetInputEnabled(true)
end
)
</syntaxhighlight>

Note that we have a simple security check before making the window visible, so in the unlikely event that the window has not been created, meaning wdwLogin is not a valid element, we don't get an error and just inform the player what has happened.
In the next step, we will create the button functionality for the log in button.

==Scripting the button==
Now that we have created our GUI and shown it to the player, we need to make it work.

===Detecting the click===
When the player clicks on any part of the GUI, the event "[[onClientGUIClick]]" will be triggered for the GUI component you clicked on. This allows us to easily detect any clicks on the GUI elements we want to use.
For example, we can attach the event to the btnLogin button to catch any clicks on it:
<syntaxhighlight lang="lua">
-- attach the event onClientGUIClick to btnLogin and set it to trigger the 'clientSubmitLogin' function
addEventHandler("onClientGUIClick", btnLogin, clientSubmitLogin, false)
</syntaxhighlight>
'''Note the final argument passed is "false". This indicates that the event will only trigger directly on btnLogin, not if the event has propagated up or down the tree. Setting this to "true" while attaching to gui elements will mean that clicking on any element in the same branch will trigger this event.'''

This line of code can now be added inside the createLoginWindow function. It is a common mistake to try and attach events to non-existant GUI elements, so make sure you always attach your events '''after''' the gui element (in this case, the button) has been created:

'''Note that we are now writing more code for our existing 'createLoginWindow' function.'''
<syntaxhighlight lang="lua">
function createLoginWindow()
-- create all our GUI elements
...

-- now add our onClientGUIClick event to the button we just created
addEventHandler("onClientGUIClick", btnLogin, clientSubmitLogin, false)
</syntaxhighlight>

===Managing the click===
Now that we can detect when the player clicks on the button, we need to write code to manage what happens when they do.
In our [[onClientGUIClick]] event handle, we told it to call the function clientSubmitLogin whenever btnLogin is clicked.
Therefore, we can now use the function clientSubmitLogin to control what happens when the button is clicked:
<syntaxhighlight lang="lua">
-- create the function and define the 'button' and 'state' parameters
-- (these are passed automatically by onClientGUIClick)
function clientSubmitLogin(button,state)
-- if our login button was clicked with the left mouse button, and the state of the mouse button is up
if button == "left" and state == "up" then
-- move the input focus back onto the game (allowing players to move around, open the chatbox, etc)
guiSetInputEnabled(false)
-- hide the window and all the components
guiSetVisible(wdwLogin, false)
-- hide the mouse cursor
showCursor(false)
end
end
</syntaxhighlight>
Now, when the button is clicked, the window will be hidden and all controls will be returned to the player. Next, we will tell the server to allow the player to spawn.

===Triggering the server===
Triggering the server can be done using [[triggerServerEvent]]. This allows you to trigger a specified event on the server from the client. The same can be done in reverse using [[triggerClientEvent]].
Here, we use the [[triggerServerEvent]] function to call our own custom event on the server, named "submitLogin", which will then control the spawning of the player serverside.

'''Note that we are now writing more code for our existing 'clientSubmitLogin' function. This is not a new function and is meant to replace what you already have.'''
<syntaxhighlight lang="lua">
function clientSubmitLogin(button,state)
if button == "left" and state == "up" then
-- get the text entered in the 'username' field
local username = guiGetText(edtUser)
-- get the text entered in the 'password' field
local password = guiGetText(edtPass)

-- if the username and password both exist
if username and password then
-- trigger the server event 'submitLogin' and pass the username and password to it
triggerServerEvent("submitLogin", getRootElement(), username, password)

-- hide the gui, hide the cursor and return control to the player
guiSetInputEnabled(false)
guiSetVisible(wdwLogin, false)
showCursor(false)
else
-- otherwise, output a message to the player, do not trigger the server
-- and do not hide the gui
outputChatBox("Please enter a username and password.")
end
end
end
</syntaxhighlight>

===Creating the serverside event===
At this point we now have all the code needed on the client side, so open up your serverside 'script.lua' file (from the [[Scripting Introduction|Introduction to Scripting]]) or another suitable serverside file to work with.

On the server side, recall that we are spawning the player as soon as they login.
So, first of all, we will need to define the custom event that we used before on the client. This can be done using [[addEvent]] and [[addEventHandler]].
<syntaxhighlight lang="lua">
-- create our loginHandler function, with username and password parameters (passed from the client gui)
function loginHandler(username,password)

end

-- define our custom event, and allow it to be triggered from the client ('true')
addEvent("submitLogin",true)
-- add an event handler so that when submitLogin is triggered, the function loginHandler is called
addEventHandler("submitLogin",root,loginHandler)
</syntaxhighlight>

===Logging in===
Now we have a function that is called through the custom event 'submitLogin', we can start to work on logging in and spawning the player, using our 'loginHandler' function:
<syntaxhighlight lang="lua">
function loginHandler(username,password)
-- check that the username and password are correct
if username == "user" and password == "apple" then
-- the player has successfully logged in, so spawn them
if (client) then
spawnPlayer(client, 1959.55, -1714.46, 10)
fadeCamera(client, true)
setCameraTarget(client, client)
outputChatBox("Welcome to My Server.", client)
end
else
-- if the username or password are not correct, output a message to the player
outputChatBox("Invalid username and password. Please re-connect and try again.",client)
end
end

addEvent("submitLogin",true)
addEventHandler("submitLogin",root,loginHandler)
</syntaxhighlight>
'''For the purposes of this tutorial, a very basic username and password system is shown. For a more comprehensive alternative, you can use the Account System or a MySQL database.'''

Also note the use of the variable "client", it's an internal variable used by MTA to identify the player who triggered the event.

Finally, do not forget to include the new gui.lua file in the meta.xml of the main resource, and label it as a client script:
<syntaxhighlight lang="xml">
<script src="client/gui.lua" type="client" />
</syntaxhighlight>

At this point, we now have a basic login window that checks the player's username and password when the login button is clicked. If they are correct, the player is automatically spawned.

For further help with GUI, see the [[:Category:GUI_Tutorials|GUI tutorials]].

[[Category:GUI_Tutorials]]
[[it:Introduzione_allo_scripting_della_GUI]]
[[ru:Introduction to Scripting the GUI]]

User:Rouche

2011-08-27T16:20:59Z

Gaetan Piette:

Name : Gaëtan<br>
Age : 20 Ans<br>
Live in Belgium<br>
Langages : French and English<br><br>

MTA:SA<br>
- Owner of =KoG=Team (2 Servers)<br><br>
Website : [http://www.teamkog.tk Team =KoG=]

Help Community :<br>
Translate : MTA:SA Wiki (French).

User:Rouche

2011-08-27T16:14:57Z

Gaetan Piette:

Name : Gaëtan<br>
Age : 20 Ans<br>
Live in Belgium<br>
Langages : French and English<br><br>

MTA:SA<br>
- Owner of =KoG=Team (2 Servers)<br><br>

Help Community :<br>
Translate : MTA:SA Wiki (French).

User:Rouche

2011-08-27T16:14:35Z

Gaetan Piette:

Name : Gaëtan<br>
Age : 20 Ans
Live in Belgium
Langages : French and English

MTA:SA
- Owner of =KoG=Team (2 Servers)

Help Community :
Translate : MTA:SA Wiki (French).

User:Rouche

2011-08-27T16:14:19Z

Gaetan Piette: Created page with "Name : Gaëtan Age : 20 Ans Live in Belgium Langages : French and English MTA:SA - Owner of =KoG=Team (2 Servers) Help Community : Translate : MTA:SA Wiki (French)."

Name : Gaëtan
Age : 20 Ans
Live in Belgium
Langages : French and English

MTA:SA
- Owner of =KoG=Team (2 Servers)

Help Community :
Translate : MTA:SA Wiki (French).