From Ryzom Forge Wiki
Manuel d’utilisation de l' A.R.C.C.
- Volume I : Guide de démarrage rapide (Quick Start Guide)
- Volume II : Guide d'utilisation
- Volume III: Guide d'utilisation avancée
Contents
- 1 Les fonctions de script
- 2 Visualizations
- 3 Actions without player intervention
- 3.1 End of script →
- 3.2 Jump →
- 3.3 Include →
- 3.4 While →
- 3.5 Gestion des fenêtres webig →
- 3.6 Display message in game (broadcast, crafting information...) →
- 3.7 ShapeManager →
- 3.8 Save value in the database →
- 3.9 Save items given by the player in the event database →
- 3.10 Player received item →
- 3.11 DeleteItems →
- 3.12 NpcManager →
- 3.13 Send command to server →
- 4 Checks
- 5 Captures information
- 6 Steps to be validated by player
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).
Displaying a message
Nom interne de la fonction : weVMessage_v3 |
- 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.
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}.
Jump →
Migration
Please use the migrated document at URL shown below.
Nom interne de la fonction : lJump_v4 |
Cette fonction permet d'interrompre l’enchaînement des étapes en le déroutant vers une autre fonction à l'intérieur du script. Elle ne permet que de sauter en « avant ». Pour revenir en arrière, il faut utiliser la fonction weAWhile .
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.
Include →
Migration
Please use the migrated document at URL shown below.
Nom interne de la fonction : lJump_v4 |
Cette fonction permet d'interrompre l’enchaînement des étapes en le déroutant vers une autre fonction à l'intérieur du script. Elle ne permet que de sauter en « avant ». Pour revenir en arrière, il faut utiliser la fonction weAWhile .
Nom interne de la fonction : weAInclude |
Cette fonction permet de faire appel à un autre script de l'event.
While →
Migration
Please use the migrated document at URL shown below.
Nom interne de la fonction : lJump_v4 |
Cette fonction permet d'interrompre l’enchaînement des étapes en le déroutant vers une autre fonction à l'intérieur du script. Elle ne permet que de sauter en « avant ». Pour revenir en arrière, il faut utiliser la fonction weAWhile .
Nom interne de la fonction : weAWhile |
WIP
Gestion des fenêtres webig →
Migration
Please use the migrated document at URL shown below.
Nom interne de la fonction : lJump_v4 |
Cette fonction permet d'interrompre l’enchaînement des étapes en le déroutant vers une autre fonction à l'intérieur du script. Elle ne permet que de sauter en « avant ». Pour revenir en arrière, il faut utiliser la fonction weAWhile .
Nom interne de la fonction : weAWindow_v3 |
Cette fonction permet de gérer les fenêtres de dialogues ( ouverture/fermeture, taille et position)
Display message in game (broadcast, crafting information...) →
Migration
Please use the migrated document at URL shown below.
Nom interne de la fonction : lJump_v4 |
Cette fonction permet d'interrompre l’enchaînement des étapes en le déroutant vers une autre fonction à l'intérieur du script. Elle ne permet que de sauter en « avant ». Pour revenir en arrière, il faut utiliser la fonction weAWhile .
Nom interne de la fonction : weADisplayIgMessage |
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 →
Migration
Please use the migrated document at URL shown below.
Nom interne de la fonction : lJump_v4 |
Cette fonction permet d'interrompre l’enchaînement des étapes en le déroutant vers une autre fonction à l'intérieur du script. Elle ne permet que de sauter en « avant ». Pour revenir en arrière, il faut utiliser la fonction weAWhile .
Nom de la fonction : weAShapeManager_v2 WIP
Nom interne de la fonction : weAShapeManager_v2 |
WIP
WIP MC » SpawnBags
Save value in the database →
Migration
Please use the migrated document at URL shown below.
Nom interne de la fonction : lJump_v4 |
Cette fonction permet d'interrompre l’enchaînement des étapes en le déroutant vers une autre fonction à l'intérieur du script. Elle ne permet que de sauter en « avant ». Pour revenir en arrière, il faut utiliser la fonction weAWhile .
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.
Save items given by the player in the event database →
Migration
Please use the migrated document at URL shown below.
Nom interne de la fonction : lJump_v4 |
Cette fonction permet d'interrompre l’enchaînement des étapes en le déroutant vers une autre fonction à l'intérieur du script. Elle ne permet que de sauter en « avant ». Pour revenir en arrière, il faut utiliser la fonction weAWhile .
Nom interne de la fonction : weAItemsDatabase |
Player received item →
Migration
Please use the migrated document at URL shown below.
Nom interne de la fonction : lJump_v4 |
Cette fonction permet d'interrompre l’enchaînement des étapes en le déroutant vers une autre fonction à l'intérieur du script. Elle ne permet que de sauter en « avant ». Pour revenir en arrière, il faut utiliser la fonction weAWhile .
Nom interne de la fonction : weAReceiveItems |
WIP
DeleteItems →
Migration
Please use the migrated document at URL shown below.
Nom interne de la fonction : lJump_v4 |
Cette fonction permet d'interrompre l’enchaînement des étapes en le déroutant vers une autre fonction à l'intérieur du script. Elle ne permet que de sauter en « avant ». Pour revenir en arrière, il faut utiliser la fonction weAWhile .
Nom interne de la fonction : weADeleteItems |
WIP
NpcManager →
Migration
Please use the migrated document at URL shown below.
Nom interne de la fonction : lJump_v4 |
Cette fonction permet d'interrompre l’enchaînement des étapes en le déroutant vers une autre fonction à l'intérieur du script. Elle ne permet que de sauter en « avant ». Pour revenir en arrière, il faut utiliser la fonction weAWhile .
Nom interne de la fonction : weANpcManager |
WIP
Send command to server →
Migration
Please use the migrated document at URL shown below.
Nom interne de la fonction : lJump_v4 |
Cette fonction permet d'interrompre l’enchaînement des étapes en le déroutant vers une autre fonction à l'intérieur du script. Elle ne permet que de sauter en « avant ». Pour revenir en arrière, il faut utiliser la fonction weAWhile .
Nom interne de la fonction : Hmagic |
WIP
Checks
Switch →
Migration
Please use the migrated document at URL shown below.
Nom interne de la fonction : lJump_v4 |
Cette fonction permet d'interrompre l’enchaînement des étapes en le déroutant vers une autre fonction à l'intérieur du script. Elle ne permet que de sauter en « avant ». Pour revenir en arrière, il faut utiliser la fonction weAWhile .
Nom interne de la fonction : weCSwitch_v2 |
WIP
MC » StartMission MC » SpawnBags
Verification of value in database →
Migration
Please use the migrated document at URL shown below.
Nom interne de la fonction : lJump_v4 |
Cette fonction permet d'interrompre l’enchaînement des étapes en le déroutant vers une autre fonction à l'intérieur du script. Elle ne permet que de sauter en « avant ». Pour revenir en arrière, il faut utiliser la fonction weAWhile .
Nom de la fonction : weCDatabase WIP
Nom interne de la fonction : WIP |
WIP
Player verification check from server (Fames, Dapper, Position...) →
Migration
Please use the migrated document at URL shown below.
Nom interne de la fonction : lJump_v4 |
Cette fonction permet d'interrompre l’enchaînement des étapes en le déroutant vers une autre fonction à l'intérieur du script. Elle ne permet que de sauter en « avant ». Pour revenir en arrière, il faut utiliser la fonction weAWhile .
Nom de la fonction : weCPlayerInfos WIP
Nom interne de la fonction : WIP |
WIP
Datas →
Migration
Please use the migrated document at URL shown below.
Nom interne de la fonction : lJump_v4 |
Cette fonction permet d'interrompre l’enchaînement des étapes en le déroutant vers une autre fonction à l'intérieur du script. Elle ne permet que de sauter en « avant ». Pour revenir en arrière, il faut utiliser la fonction weAWhile .
Nom de la fonction : weCDatas WIP
Nom interne de la fonction : WIP |
WIP
Captures information
Captures information on the player →
Migration
Please use the migrated document at URL shown below.
Nom interne de la fonction : lJump_v4 |
Cette fonction permet d'interrompre l’enchaînement des étapes en le déroutant vers une autre fonction à l'intérieur du script. Elle ne permet que de sauter en « avant ». Pour revenir en arrière, il faut utiliser la fonction weAWhile .
Nom de la fonction : weGPlayerInfos WIP
Nom interne de la fonction : WIP |
WIP
Steps to be validated by player
NewGiveItems →
Migration
Please use the migrated document at URL shown below.
Nom interne de la fonction : lJump_v4 |
Cette fonction permet d'interrompre l’enchaînement des étapes en le déroutant vers une autre fonction à l'intérieur du script. Elle ne permet que de sauter en « avant ». Pour revenir en arrière, il faut utiliser la fonction weAWhile .
Nom de la fonction : weSNewGiveItems WIP
Nom interne de la fonction : WIP |
WIP
NPC dialog bubble option (like classic missions) →
Migration
Please use the migrated document at URL shown below.
Nom interne de la fonction : lJump_v4 |
Cette fonction permet d'interrompre l’enchaînement des étapes en le déroutant vers une autre fonction à l'intérieur du script. Elle ne permet que de sauter en « avant ». Pour revenir en arrière, il faut utiliser la fonction weAWhile .
Nom de la fonction : weSNpcDialog_v2 WIP
Nom interne de la fonction : WIP |
WIP
MC » StartMission
The player must wait X seconds for validation (automated validation possible) →
Migration
Please use the migrated document at URL shown below.
Nom interne de la fonction : lJump_v4 |
Cette fonction permet d'interrompre l’enchaînement des étapes en le déroutant vers une autre fonction à l'intérieur du script. Elle ne permet que de sauter en « avant ». Pour revenir en arrière, il faut utiliser la fonction weAWhile .
Nom de la fonction : weSTimer WIP
Nom interne de la fonction : WIP |
WIP
MC » StartMission MC » AddBoost
Mission →
Migration
Please use the migrated document at URL shown below.
Nom interne de la fonction : lJump_v4 |
Cette fonction permet d'interrompre l’enchaînement des étapes en le déroutant vers une autre fonction à l'intérieur du script. Elle ne permet que de sauter en « avant ». Pour revenir en arrière, il faut utiliser la fonction weAWhile .
WIP
Nom interne de la fonction : Mission |
WIP
Nom de la fonction : weSMission MC » SpawnBags
Itemshop →
Migration
Please use the migrated document at URL shown below.
Nom interne de la fonction : lJump_v4 |
Cette fonction permet d'interrompre l’enchaînement des étapes en le déroutant vers une autre fonction à l'intérieur du script. Elle ne permet que de sauter en « avant ». Pour revenir en arrière, il faut utiliser la fonction weAWhile .
Nom de la fonction : weSItemshop WIP
Nom interne de la fonction : Itemshop |
WIP