Manuel d'utilisation de l' A.R.K.
- Volume I : Guide de démarrage rapide (Quick Start Guide)
- Volume II : Guide d'utilisation
- Volume III: Guide d'utilisation avancée
Ce qui n'est pas clair et validé est surligné en jaune.
Les images sont de deux types pour simplifier le portage interlinguistique:
Les images IG sont aléatoirement choisies dans n'importe laquelle des 5 langues de Ryzom.
Les images des scripts sont toujours (sauf oubli) en anglais.
À l'exception de paragraphe 2.1,
tous les paragraphes de niveau 2, sont éditables et visualisables en cliquant sur la flèche (⇒) derrière le titre des fonctions.Sommaire
- 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 Window (webig windows management) ⇒
- 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 ⇒
- 3.14 Dans les fonction il faudra analyser:
- 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:updateARKMissionCustomDesc()")
end
...
updateARKMissionCustomDesc_loop = 100
game:updateARKMissionCustomDesc(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 ⇒
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 ⇒
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 .
Include ⇒
La dernière édition était de Zorroargh le 2019-09-21.
===Include===</noinclude>
Nom interne de la fonction : lInclude_v4 |
Cette fonction permet de faire appel à un autre script de l'event puis de reprendre l'execution des étapes .
While ⇒
Nom interne de la fonction : weAWhile |
WIP
Window (webig windows management) ⇒
La dernière édition était de Zorroargh le 2019-09-21.
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...) ⇒
===DisplayIgMessage===</noinclude>
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 ⇒
La dernière édition était de Zorroargh le 2019-09-21.
Nom interne de la fonction : weAShapeManager_v2 |
- {shape}: <un_objet>.ps
- {shapeName}: Nom donné à l'objet.
- {shapeUrl}: ???
- {texture}: ???
- {posX}: Position x en position absolue dans la carte de Ryzom.
- {posY}: Position y en position absolue dans la carte de Ryzom.
- {posZ}: Position z en position absolue dans la carte de Ryzom.
- {posA}: Position A ?
Save value in the database ⇒
Nom interne de la fonction : weADatabase_v2 |
Cette fonction sert à stocker une information dans une base locale exploitable par la 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 ⇒
===ItemsDatabase===</noinclude>
Nom interne de la fonction : weAItemsDatabase |
Player received item ⇒
===ReceiveItems===</noinclude>
La dernière édition était de Zorroargh le 2019-09-21.
Nom interne de la fonction : weAReceiveItems |
DeleteItems ⇒
Nom interne de la fonction : weADeleteItems |
NpcManager ⇒
La dernière édition était de Zorroargh le 2019-09-21.
===NpcManager===</noinclude>
Nom interne de la fonction : weANpcManager |
Gestion du PNJ.
weAGroupScript
|
weASpawnBot
|
weADeSpawnBot
|
weAGroupScriptSay
|
weAGroupScriptEmote
|
weAGroupScriptAiAction
|
</noinclude>
Send command to server ⇒
===Hmagic===</noinclude>
La dernière édition était de Zorroargh le 2019-09-21.
Nom interne de la fonction : Hmagic |
Hmagic permet d'envoyer une commande au serveur.
weASendUrl
But de cette fonction?
weATeleport
Téléportage du joueur et éventuellement de sa monture.
weATeleportToEntity
weAManageMoney
Donner ou Prendre des Dappers
|
weAChangeFame
|
weAChangeFactionPoints
|
weAManageGuildMoney
|
weAManageBuilding
Vendre / Rendre accessible un appartement de joueur ou de guilde
|
weATriggerPacs
Déclencher un évènement PACS (pour activer un ascenseur ou vortex)
|
weASetOrganization
Définir la Tierce Faction du joueur
|
weAFixOldBuildings
|
Dans les fonction il faudra analyser:
Les Data Processors
- processor bbcode
- Timestamp
- processor splitdata
- processor splitparam
- processor randint
- Random number
Checks
All these check offers action after a logical evaluation, TRUE or FALSE.
Datas ⇒
===Datas===</noinclude>
Nom interne de la fonction : weCDatas |
Cette fonction est l'équivalent d'un si test VRAI alors A sinon B .
Switch ⇒
===Switch===</noinclude>
La dernière édition était de Zorroargh le 2019-09-21.
Nom interne de la fonction : weCSwitch_v2 |
Cette fonction permet de proposer 10 branchements conditionnels + 1 par défaut en fonction d'une valeur fournie en premier paramètre de comparaison.
Verification of value in database ⇒
===Check Database===</noinclude>
Nom interne de la fonction : weCDatabase |
Cette fonction permet d'enchainer un action ou une autre selon une valeur contenue dans une pase de donnée de l'event.
Player verification check from server (Fames, Dapper, Position...) ⇒
Nom interne de la fonction : weCPlayerInfos |
weCPlayerInfos permet de tester toutes les informations stockées sur le serveur concernant le joueur.
weCPlayerFaction
Teste si le joueur appartient à la faction demandée.
weCPlayerDappers
Teste si le joueur a une certaine quantité de dappers.
|
weCPlayerPosition
Examine la position du joueur. Si le joueur se trouve dans le rectangle délimité parles coordonnées min/max de x/y la valeur retournée est VRAI.
weCPlayerItem
Teste si une certaine quantité d'item d'une certain niveau est présent dans l'un des emplacements du joueur.
weCPlayerTarget
Teste si la cible est celle souhaitée.
|
weCPlayerFame
Teste la réputation dans les nations et factions standard.
weCPlayerGuild
Teste le grade du joueur dans sa guilde
|
weCPlayerGuildDappers
Teste si une quantité minimum de dappers est dans le trésor de la guilde.
|
weCPlayerFreetrial
Test si le joueur est en version gratuite ou non.
no params |
Captures information
Captures information on the player ⇒
===PlayerInfos===</noinclude>
Nom interne de la fonction : weGPlayerInfos |
weGPlayerInfos permet de prendre toutes les informations stockées concernant la cible du joueur ou la position de ce dernier.
Steps to be validated by player
NewGiveItems ⇒
Nom interne de la fonction : weSNewGiveItems |
weSNewGiveItems permet de donner des items de qui à qui?
Description des items demandés.
NPC dialog bubble option (like classic missions) ⇒
La dernière édition était de Zorroargh le 2019-09-21.
Nom interne de la fonction : weSNpcDialog_v2 |
Cette fonction permet de créer une bulle de dialogue d'un PNJ.
The player must wait X seconds for validation (automated validation possible) ⇒
La dernière édition était de Zorroargh le 2019-09-21.
Nom interne de la fonction : weSTimer |
Mission ⇒
La dernière édition était de Zorroargh le 2019-09-21.
Mission
Nom interne de la fonction : weSMission |
La fonction mission ne permet d'activer qu'une seule mission à la fois.
weAMissionGeneric
|
weAMissionLoot
|
weAMissionTalkTo
|
weAMissionKillFauna
|
weAMissionKillNpc
|
weAMissionRemove
|
Itemshop ⇒
Nom interne de la fonction : weSItemshop |
Achat d'item? comment le PNJ a ces items?
La fonction Itemshop ne permet d'acheter qu'une seule type d'item à la fois.
weItems
Description technique de l'item
|
Items in bag: Il est possible d'afficher le contenu du sac, mais comment s'en servir IG?
weNamedItem
Nom de l'item. Pourquoi ne pas passer par la fonction traduction?
|
weVirtualItem