Difference between revisions of "ARCC Guide FR"

Revision as of 12:12, 9 August 2014

DeutschEnglishEspañolFrançaisРусский219 FR pages.

Translation requested, please.

Manuel d’utilisation de l' A.R.C.C.

Les fonctions de script

Ce guide a pour but d’indiquer comment se servir des fonctions de script de l’A.R.C.C., l’Advanced Ryzom Content Creator. Il est recommandé d'avoir lu le volume I pour un usage global de l’A.R.C.C.. Les fonctions du script sont classées en cinq groupes.

Visualizations
Actions without player intervention
Checks
Captures information
Steps to be validated by player

Visualizations

Ce groupe n'a qu'une seule fonction, l'une des plus simples et fréquentes.

Elle servira de référence en ce qui concerne zones et les boutons communs à toutes les fonctions détaillés dans des page distinctes pour faciliter la maintenances des documentations de l'ARRC.

Les objets communs seront signalés dans la documentation par [commun].
La marque [expert] correspondra au mode d'édition avancée (voir plus bas le point 10).

window title and function name

Ce mode d'édition est aussi signalé par une icone à côté de la fonction qui a été éditée dans ce mode.

Displaying a message

Nom interne de la fonction : weVMessage_v3

window title and function name

Cette fonction affiche un message dans une fenêtre de type WebIG, avec un titre de fenêtre (ici en haut : Unit_test : « May the Force be with you »)

weVMessage_v3

1) [commun] Nom de la fonction.
2) [expert] Afficher le message en permanence (Oui/Non)
3) [expert] Le joueur devra cliquer sur un lien dans le message (Oui/Non)
4) Champ texte pour le message.

Text field

5) [commun] onglet d'agrandissement de la zone (4)
6) [commun] bouton de bascule d'éditeur. (mode assisté ou non)

7) [expert] Le format:

bbcode (recommandé ; un aide-mémoire du bbcode ryzom est fourni dans un document dédié.)

Exemple :
[session=url_validated][scriptinfos]is_valid_url[/scriptinfos][/session]

html (spécifique, étudié plus tard, mais immédiatement testable sur le web)

Exemple :
<hr/>Hello!
<br/>oren pyr, Deles silam, Lordoy ad toll, Woha mik'ito
<hr>External link!
<img src="http://wiki.blender.org/skins/naiad/images/blender_logo.png"/><hr/>

lua (très spécifique ; étudié plus tard)

Exemple :
[lua]
function game:onMissionSelected(index)
disableModalWindow()
self:updateCurrMissionComboBox()
local missionWnd = getMissionWindow()
setOnDraw(missionWnd, "game:updateArccMissionCustomDesc()")
end
...
updateArccMissionCustomDesc_loop = 100
game:updateArccMissionCustomDesc(1)
[/lua]

8) [commun] Nom interne de la fonction. Ce nom est utilisé notamment pour les sauts, boucles...
9) [commun] bouton d'enregistrement des modifications.
10) [commun] bascule du mode « Basic Edition » au mode « Advanced Edition ». Une fois en mode « Advanced Edition », il n'est plus possible de revenir au mode « Basic Edition ». La description des fonctions se fera toujours en mode « Advanced Edition ». Les spécificités sont indiqués par [expert]

Actions without player intervention

End of script →

Migration

Please use the migrated document at URL shown below.

Migrated to fr:ARK/End of script at 2014-08-09

Nom interne de la fonction : lEnd_v4

Il est « sage » de terminer les scripts systématiquement par un « End of Script ». Le « End of script » peut être judicieusement utilisé pour avorter un script. En fin de script il permet d'avoir une sortie unique accédée par des branchements conditionnels comme {weAJump_short_description}.

function name

Cette fonction n'a qu'un seul paramètre : le nom. Le nom de toutes les fonctions est toujours initialisé par un code unique, mais il peut être modifié pour faciliter l'écriture et la relecture du script, par exemple et surtout lorsque la fonction peut être appelée par une autre, notamment les sauts et les branchements. (ici la fonction a été renommée : « Terminator »).

Jump →

Nom interne de la fonction : weAJump_v2

Cette fonction permet d'interrompre l’enchaînement des étapes en le déroutant vers une autre fonction. Cette fonction ne permet que de sauter en « avant ». Comme elle ne peut revenir en arrière,ll vaut mieux utiliser pour cela la fonction weAWhile.

weAJump_V2

Le seul paramètre à fournir, est la fonction qui sera exécutée ensuite.

AInclude →

Nom interne de la fonction : weAInclude

Cette fonction permet de faire appel à un autre script de l'event.

WeAInclude

1) [expert] réinitialisation du script lancé (Oui/Non)
2) Nom du script à lancer.

While} →

Nom interne de la fonction : weAWhile

WIP

1) WIP
2) WIP

Gestion des fenêtres webig →

Nom interne de la fonction : weAWindow_v3

Cette fonction permet de gérer les fenêtres de dialogues ( ouverture/fermeture, taille et position)

WeAWindow IG

WeAWindow ARCC

1) Action à effectuer : (Activer/Fermer). Utilisé pour ouvrir une nouvelle fenêtre ou fermer une existante (voir point plus bas).
2) Redimensionner : (Oui/Non), si oui, utiliser les valeurs données dans W(3) et H(4) .
3) W : Largeur en pixel (ici 400)
4) H : Hauteur en pixels (ici 300)
5) Déplacer : (Oui/Non), si oui, utiliser les valeurs données dans X(6) et Y(7) . Ces valeurs sont en pourcentage par rapport aux dimensions de la fenêtre Ryzom.
6) X en %: Position relative en X, 100 % cadre à droite (Comme ici).
7) Y en %: Position relative en Y, 100 % cadre en haut. (Ici, 50 % positionne à mi-hauteur)
8) [expert] Fenêtre Webig. Par défaut « Current » en mode basic. Ce paramètre permet de choisir qu'elle fenêtre IG controlée.

→ BBCode :Permet de définir le nom de la fenêtre IG à utiliser

→$_GET[« current_window »] :Le nom de la fenetre est donnée par l'url et le parametre current_window

→Webig :Est la fenêtre qui s'ouvre quand on fait <ctrl>+w. C'est celle qui affiche les web apps

→Browse Npc :Est la fenêtre qui s'ouvre quand on parle à un PNJ. Donc, c'est celle qui s'ouvre quand on lie un script à un PNJ.

→Web Transaction :C'est une fenêtre cachée qui reçoit les réponses du serveur. Le joueur ne devrait jamais la voir.

Display message in game (broadcast, crafting information...) →

Nom interne de la fonction : weADisplayIgMessage

WeADisplayIgMessage IG

Cette fonction permet d'afficher des messages dans les canaux de discussions (2).

Il faut noter que l'utilisation de la traduction permet d'avoir le texte dans la langue du joueur. Le texte en anglais étant : « We call it Voight-Kampff for short. » (Blade Runner).

WeADisplayIgMessagewindow

Le tableau suivant donne la liste les caractéristiques des choix de canaux offerts par la fonction (4).

Mode	où	couleur	canal	SYS. INFOS
Default message system		blanc		Oui
Only in arround channel		jaune	alentours	Non
Ambiance	haut	jaune		Oui (3)
Task	bas	blanc		Oui
Broadcast messages	haut	blanc	alentours	Oui
Title	bas	jaune		Oui (1)
Taged broadcast messages...	haut	blanc	alentours	Oui
XP gain	bas	jaune		Oui (1)
SP gain	bas	jaune		Oui (1)
Zone	haut	blanc		Oui
Damage to me		rouge		Oui (2)
Damage to me		rouge		Oui (2)
Damage to me from player		rouge foncé		Oui
Damage from me		orange		Oui
The opponent misses		gris		Oui (4)
I miss		blanc		Oui
Item	bas	vert		Oui
Item other in group	bas	gris
Item failed	bas	magenta		Oui
Spell to me		bleu		Oui
Spell from me		bleu clair		Oui
Emote		rose		Oui
Message of the day	bas	jaune		Oui (1)
Forage Locate Deposit	bas	vert
False	haut	orange		Oui
False in battle	haut	jaune		Oui (3)
PVP timer	bas	orange
Thema finished	bas	jaune		Oui (1)
Item special effec		cyan-gris		Oui (4)
Item special effect with center text	haut	cyan-gris		Oui
Outpost state message	haut	bleu clair		Oui
Ring invitation		vert	alentour

ShapeManager →

Nom de la fonction : weAShapeManager_v2 WIP

Nom interne de la fonction : weAShapeManager_v2

WIP

1) WIP
2) WIP

WIP MC » SpawnBags

Save value in the database →

Nom interne de la fonction : weADatabase_v2

Cette fonction sert à stocker une information dans une base locale réexplotable parla suite dans le même script ou dans un autre du même event. Elle peut aussi incrémenter les valeurs numériques.

Il est préférable d'utiliser le mode d'édition assisté dans un premier temps, comme visualisé ici.

WeADatabase window

1) Database name : une base de l'event (omega dans l'exemple).
2) {databaseRow} : une colonne de la base(1) (Khi, dans l'exemple)

WIP
in Arbeit - work in progress - trabajo en curso - travaux en cours - незавершенное

3) {databaseId} :

- player,... : signification ?
- [get]bag[/get] signification, fonctionnement ?

4) Conversion method : (setvalue/addvalue) : il y a deux mode d'insertion dans la base, soit en écrasant le contenu antérieur, soit en ajoutant au sens algébrique du terme une autre valeur.
5) {param} : peut être différente valeurs statiques, récupérée ailleurs ou calculée :
- Le champ vide en mode « setvalue » met à « vide » la cellule de la base consernée. Dans un calcul, le « vide » peut-être assimilé à « zéro ».
- Une constante : « -1 » en mode « addvalue » permet de créer une décrémentation.

- Un paramètre commun à l'event : [param]Max_player_bag[/param] (comment a été créé ce paramètre?)

- Une valeur contenue dans une base : [db=Player_Bag]Last[/db]
- Une fonction : [func]now[/func]
- Un calcul :

[func=min]
  [math]
    ([func]now[/func]
    -
    [db=Bags]
      Status:[get]bag[/get]
    [/db])
  [/math]
..|12
[/func]

<empty>

[db=Player_Bag]Last[/db]

[param]Max_player_bag[/param]

Save items given by the player in the event database →

Nom interne de la fonction : weAItemsDatabase

WIP

Obsolète ??

Player received item →

Nom interne de la fonction : weAReceiveItems

WIP

1) WIP
2) WIP

DeleteItems →

Nom interne de la fonction : weADeleteItems

WIP

1) WIP
2) WIP

ANpcManager →

Nom interne de la fonction : weANpcManager

WIP

1) WIP
2) WIP

Send command to server →

Nom interne de la fonction : Wand

WIP

1) WIP
2) WIP

Checks

Switch →

Nom interne de la fonction : weCSwitch_v2

WIP

1) WIP
2) WIP

MC » StartMission MC » SpawnBags

Verification of value in database →

Nom de la fonction : weCDatabase WIP

Nom interne de la fonction : WIP

WIP

1) WIP
2) WIP

Player verification check from server (Fames, Dapper, Position...) →

Nom de la fonction : weCPlayerInfos WIP

Nom interne de la fonction : WIP

WIP

1) WIP
2) WIP

Datas →

Nom de la fonction : weCDatas WIP

Nom interne de la fonction : WIP

WIP

1) WIP
2) WIP

Captures information

Captures information on the player →

Nom de la fonction : weGPlayerInfos WIP

Nom interne de la fonction : WIP

WIP

1) WIP
2) WIP

Steps to be validated by player

NewGiveItems →

Nom de la fonction : weSNewGiveItems WIP

Nom interne de la fonction : WIP

WIP

1) WIP
2) WIP

NPC dialog bubble option (like classic missions) →

Nom de la fonction : weSNpcDialog_v2 WIP

Nom interne de la fonction : WIP

WIP

1) WIP
2) WIP

MC »  StartMission

The player must wait X seconds for validation (automated validation possible) →

Nom de la fonction : weSTimer WIP

Nom interne de la fonction : WIP

WIP

1) WIP
2) WIP

MC » StartMission MC » AddBoost

Mission →

WIP

Nom interne de la fonction : WIP

WIP

1) WIP
2) WIP

Nom de la fonction : weSMission MC » SpawnBags

Itemshop →

Nom de la fonction : weSItemshop WIP

Nom interne de la fonction : WIP

WIP

1) WIP
2) WIP

Ryzom Wiki: Ryzom Commons | DE • EN • ES • FR • RU | Ryzom Forge

@@ Line 96: / Line 96: @@
 ==Actions without player intervention==
 ===End of script [[ARCC End of script|→]]===
-{{:ARCC End of script}}<!--
+{{:ARCC End of script}}
-{|
-|[[File:End.png|32px|Home]]
-|Nom interne de la fonction : ''' ''weAEnd_v3'' '''
-|}
-Il est « sage » de terminer les scripts systématiquement par un « End of Script ».
-Le « End of script » peut être judicieusement utilisé pour avorter un script. En fin de script il permet d'avoir une sortie unique accédée par des branchements conditionnels comme {weAJump_short_description}.
-<div style="overflow: hidden">
-[[File:WeAEnd.png|200px|thumb|left|function name]]
-Cette fonction n'a qu'un seul paramètre : le nom.
-Le nom de toutes les fonctions est toujours initialisé par un code unique, mais il peut être modifié pour faciliter l'écriture et la relecture du script, par exemple et surtout lorsque la fonction peut être appelée par une autre, notamment les sauts et les branchements. (ici la fonction a été renommée : « Terminator »).
-</div>-->
-==={weAJump_short_description}===
+===Jump [[ARCC xxx |→]]===
 {|
 |[[File:Arrow undo.png|32px|Home]]
@@ Line 122: / Line 111: @@
 </div>
-==={weAInclude_short_description}===
+===AInclude [[ARCC xxx |→]]===
 {|
 |[[File: Arrow down.png|32px]]
@@ Line 135: / Line 124: @@
 </div>
-==={weAWhile_short_description}===
+===While}  [[ARCC xxx |→]]===
 {|
 |[[File: Arrow turn left.png|32px]]
@@ Line 147: / Line 136: @@
 </div>
-===Gestion des fenêtres webig ===
+===Gestion des fenêtres webig  [[ARCC xxx |→]]===
 {|
 |[[File: Application xp.png|32px]]
@@ Line 171: / Line 160: @@
 </div>
-===Display message in game (broadcast, crafting information...)===
+===Display message in game (broadcast, crafting information...) [[ARCC xxx |→]]===
 {|
 |[[File: Page red.png|32px]]
@@ Line 386: / Line 375: @@
 |}
-==={weAShapeManager_short_description}===
+===ShapeManager [[ARCC xxx |→]]===
 Nom de la fonction : weAShapeManager_v2
 WIP
@@ Line 403: / Line 392: @@
 MC »  SpawnBags
-===Save value in the database===
+===Save value in the database [[ARCC xxx |→]]===
 {|
 |[[File: Database add value.png|32px]]
@@ Line 449: / Line 438: @@
 </div>
-===Save items given by the player in the event database===
+===Save items given by the player in the event database [[ARCC xxx |→]]===
 {|
 |[[File: Database_add_item.png|32px]]
@@ Line 459: / Line 448: @@
 </div>
-===Player received item===
+===Player received item [[ARCC xxx |→]]===
 {|
 |[[File: Basket add.png|32px]]
@@ Line 471: / Line 460: @@
 </div>
-=== {weADeleteItems_short_description}===
+=== DeleteItems [[ARCC xxx |→]]===
 {|
 |[[File: Basket delete.png|32px]]
@@ Line 483: / Line 472: @@
 </div>
-==={weANpcManager_short_description}===
+===ANpcManager [[ARCC xxx |→]]===
 {|
 |[[File: Group link.png|32px]]
@@ Line 495: / Line 484: @@
 </div>
-===Send command to server===
+===Send command to server [[ARCC xxx |→]]===
 {|
 |[[File: Wand.png|32px]]
@@ Line 508: / Line 497: @@
 ==Checks==
-==={weCSwitch_short_description}===
+===Switch [[ARCC xxx |→]]===
 {|
 |[[File: Arrow switch.png|32px]]
@@ Line 523: / Line 512: @@
 MC »  SpawnBags
-===Verification of value in database===
+===Verification of value in database [[ARCC xxx |→]]===
 Nom de la fonction : weCDatabase
 WIP
@@ Line 537: / Line 526: @@
 </div>
-===Player verification check from server (Fames, Dapper, Position...)===
+===Player verification check from server (Fames, Dapper, Position...) [[ARCC xxx |→]]===
 Nom de la fonction : weCPlayerInfos
 WIP
@@ Line 551: / Line 540: @@
 </div>
-==={weCDatas_short_description}===
+===Datas [[ARCC xxx |→]]===
 Nom de la fonction : weCDatas
 WIP
@@ Line 566: / Line 555: @@
 ==Captures information==
-.1- Captures information on the player
+===Captures information on the player [[ARCC xxx |→]]===
 Nom de la fonction : weGPlayerInfos
 WIP
@@ Line 581: / Line 570: @@
 ==Steps to be validated by player==
-==={weSNewGiveItems_short_description}===
+===NewGiveItems [[ARCC xxx |→]]===
 Nom de la fonction : weSNewGiveItems
 WIP
@@ Line 595: / Line 584: @@
 </div>
-===NPC dialog bubble option (like classic missions)===
+===NPC dialog bubble option (like classic missions) [[ARCC xxx |→]]===
 Nom de la fonction : weSNpcDialog_v2
 WIP
@@ Line 611: / Line 600: @@
   MC »  StartMission
-===The player must wait X seconds for validation (automated validation possible)===
+===The player must wait X seconds for validation (automated validation possible) [[ARCC xxx |→]]===
 Nom de la fonction : weSTimer
 WIP
@@ Line 628: / Line 617: @@
 MC »  AddBoost
-==={weSMission_short_description}===
+===Mission [[ARCC xxx |→]]===
 WIP
 {|
@@ Line 644: / Line 633: @@
 MC »  SpawnBags
-==={weSItemshop_short_description}===
+===Itemshop [[ARCC xxx |→]]===
 Nom de la fonction : weSItemshop
 WIP

From Ryzom Forge Wiki

Revision as of 12:12, 9 August 2014

Contents

Les fonctions de script

Visualizations

Displaying a message

Actions without player intervention

End of script →

Jump →

AInclude →

While} →

Gestion des fenêtres webig →

Display message in game (broadcast, crafting information...) →

ShapeManager →

Save value in the database →

Save items given by the player in the event database →

Player received item →

DeleteItems →

ANpcManager →

Send command to server →

Checks

Switch →

Verification of value in database →

Player verification check from server (Fames, Dapper, Position...) →

Datas →

Captures information

Captures information on the player →

Steps to be validated by player

NewGiveItems →

NPC dialog bubble option (like classic missions) →

The player must wait X seconds for validation (automated validation possible) →

Mission →

Itemshop →