Les scripts

Sur Celendel, chaque chose est une entitée, et chaque entitée est définie par un script écrit en Lua. Pas de panique cependant, ils sont très simple d'utilisation.

Le code de base

data = {};
 
function onUpdate(this, elapsed) end
 
function once(this) end
 
function onInit(this) end
 
function onDeath(this) end

Ce code peut paraitre un peu effrayant au premier abord, pour ceux qui ne connaissent pas le Lua par exemple. Il est en réalité très simple.
A la ligne 1, on déclare la table 'data' - cette table, présente dans toutes les entitées, indiquera à Celendel les informations à afficher. Nous y reviendrons plus tard.
Les autres lignes sont des fonctions (actuellement vides) dites 'callback'. Elles seront automatiquement appelée par le serveur, chacune dans des conditions différentes, qui seront détaillées par la suite.

La table data

En Lua, une variable se déclare de manière très simple :

maVariable = "Texte";
uneAutreVariable = 25.2
uneVariableEncore = {"Salut", 24, maVariable};

Comme vous le voyez, le ';' à la fin des lignes d'instructions n'est pas obligatoire, et une variable Lua peut contenir à peut près n'importe quoi : du texte ('string' en anglais), un réel, une table, ou même une fonction.
Pour que cette variable apparaisse dans le client de Celendel, vous devez la renseigner dans la table 'data', de cette manière :

data={};
name = "Jean-Paul";
data["name"] = "Nom";

Il est également possible d'utiliser des réels, ou des tables (à condition que les indexs et les valeurs sont convertibles en texte.

data={};
age = 25;
data["age"] = "Age";
attributes = {};
attributes["force"]=12;
attributes["charisme"]=2;
data["attributes"] = "Caractéristiques";

La meilleure façon de comprendre comment ce système marche est encore d'experimenter par soi-même. N'hésitez pas à tester !

Les fonctions callback

Il existe plusieurs fonctions callback, appellées à différents moment par Celendel :

onUpdate(this, elapsed) : appellée régulièrement (toutes les secondes)
once(this) : appellée en même temps que onUpdate, mais remise à zéro après execution
onDeath(this) : appellée à la destruction de l'entitée
onInit(this) : appelée à la création de l'entitée

Vous n'aurez pas manqué de remarquer les paramètres de ces fonctions. Le 'this' correspond à l'objet C++ matérialisant l'entitée - pour faire simple, il permet au script d'agir sur son environnement.
La fonction 'onUpdate' contient aussi un paramètre 'elapsed', qui est un entier contenant le nombre de millisecondes écoulées depuis le dernier appel de cette fonction.

THIS §

Attardons-nous un instant sur cette variable 'this', un peu spéciale. Elle ne peut pas être appellée en dehors des fonctions callback, et est un objet. Vous pouvez acceder aux méthodes (=fonctions) d'un objet de cette manière :

monObjet:maMethode();
-- Dans notre cas :
function once(this)
        this:isSparta();
end

Actuellement, ces méthodes ne sont pas très nombreuses :

syncData() : demande à Celendel de mettre à jour les clients depuis la table 'data'. Appellez-là une fois que vous avez fini de tripatouiller vos variables.
sendMessageToGM(msg) : envoie un message au Game Master uniquement
sendMessageToAll(msg) : idem, avec tous les joueurs
sendMessageToOwner(msg) : idem, avec le propriétaire de l'entitée. Si vous n'avez pas défini une variable 'owner', ça ne fera strictement rien.
sendMessageToPlayer(msg, regexp) : idem, avec tous les joueurs dont le pseudo correspond à l'expression régulière en second paramètre.

Je réfléchis également à rajouter la possibilité d'acceder à d'autres entitées.

L'éditeur d'entitée : le Graal des flemmards

Pour les GM les plus allergiques au code, l'éditeur d'entitée permet de génerer simplement les données du script. Son utilisation est très intuitive, vous verrez.

Limitations du Lua

Le système de script est cependant limité sur quelques aspects :

Pas plus de 50ms de temps d'execution ! C'est un script d'entitée que vous faites, pas un générateur de fractales !
Pas de script envoyé par les joueurs ! Seul le GM, pour des raisons évidentes, peut en mettre en ligne.
Pas d'accès aux fichiers. J'ai désactivé la bibliothèques Lua i/o, pour, là aussi, des raisons évidentes.

Ces limitations tombent sous le sens, et dans le cadre d'une utilisation normale de Celendel, personne ne devrait s'y frotter.

Celendel :