From Ryzom Forge Wiki
Line 43: | Line 43: | ||
</div> | </div> | ||
− | |||
===weVMessage (Displaying a message)=== | ===weVMessage (Displaying a message)=== | ||
{| | {| | ||
|[[File:Style.png|32px|Home]] | |[[File:Style.png|32px|Home]] | ||
− | | | + | |Internal function name: ''' ''weVMessage'' ''' |
|} | |} | ||
<div style="overflow: hidden"> | <div style="overflow: hidden"> | ||
[[File:WeVMessage 3.png|200px|thumb|left|window title and function name]] | [[File:WeVMessage 3.png|200px|thumb|left|window title and function name]] | ||
− | + | This function displays a message in a WebIG window, with a title (in the sample here: Unit_test: " ''May the Force be with you'' " ) | |
</div> | </div> | ||
<div style="overflow: hidden"> | <div style="overflow: hidden"> | ||
[[File:WeVMessage.png|200px|thumb|left|weVMessage_v3]] | [[File:WeVMessage.png|200px|thumb|left|weVMessage_v3]] | ||
− | *'''1)''' <span style="color:#f0f">'''[commun]'''</span> | + | *'''1)''' <span style="color:#f0f">'''[commun]'''</span> Function name. |
− | *'''2)''' <span style="color:#f00">'''[expert]'''</span> | + | *'''2)''' <span style="color:#f00">'''[expert]'''</span> Always display this message (Yes/No) |
− | *'''3)''' <span style="color:#f00">'''[expert]'''</span> | + | *'''3)''' <span style="color:#f00">'''[expert]'''</span> Player must click the link in the message (Yes/No) |
− | *'''4)''' | + | *'''4)''' Text field for the message. |
</div> | </div> | ||
<div style="overflow: hidden"> | <div style="overflow: hidden"> | ||
[[File:WeVMessage 2.png|200px|thumb|left|Text field]] | [[File:WeVMessage 2.png|200px|thumb|left|Text field]] | ||
− | *'''5)''' <span style="color:#f0f">'''[commun]'''</span> | + | *'''5)''' <span style="color:#f0f">'''[commun]'''</span> enlargement zone corner '''(4)''' |
− | *'''6)''' <span style="color:#f0f">'''[commun]'''</span> | + | *'''6)''' <span style="color:#f0f">'''[commun]'''</span> toggle button editor. (assisted mode or not) |
</div> | </div> | ||
− | *'''7)''' <span style="color:#f00">'''[expert]'''</span> | + | *'''7)''' <span style="color:#f00">'''[expert]'''</span> Type of message content: |
− | :*'''bbcode''' ( | + | :*'''bbcode''' (recommended; a aide-memoire of ryzom bbcode is provided in a [[ARCC Expert EN|dedicated page]].) |
<div style="margin:0em; padding:1em 2em;border: thin inset #{{ColorAtys|type=dark|group=HRP}};background:#{{ColorAtys|type=light|group=HRP}};color:#{{ColorAtys|type=fg|group=HRP}};"> | <div style="margin:0em; padding:1em 2em;border: thin inset #{{ColorAtys|type=dark|group=HRP}};background:#{{ColorAtys|type=light|group=HRP}};color:#{{ColorAtys|type=fg|group=HRP}};"> | ||
<poem> | <poem> | ||
Line 73: | Line 72: | ||
</poem> | </poem> | ||
</div> | </div> | ||
− | :*'''html''' ( | + | :*'''html''' (Specific, studied later, but immediately testable in web page) |
<div style="margin:0em; padding:1em 2em;border: thin inset #{{ColorAtys|type=dark|group=HRP}};background:#{{ColorAtys|type=light|group=HRP}};color:#{{ColorAtys|type=fg|group=HRP}};"> | <div style="margin:0em; padding:1em 2em;border: thin inset #{{ColorAtys|type=dark|group=HRP}};background:#{{ColorAtys|type=light|group=HRP}};color:#{{ColorAtys|type=fg|group=HRP}};"> | ||
<poem> | <poem> | ||
Exemple : | Exemple : | ||
<nowiki><hr/>Hello! | <nowiki><hr/>Hello! | ||
− | <br/> | + | <br/>this is a new line |
<hr>External link! | <hr>External link! | ||
<img src="http://wiki.blender.org/skins/naiad/images/blender_logo.png"/><hr/></nowiki> | <img src="http://wiki.blender.org/skins/naiad/images/blender_logo.png"/><hr/></nowiki> | ||
</poem> | </poem> | ||
</div> | </div> | ||
− | :*'''lua''' ( | + | :*'''lua''' (very specific; to see later) |
<div style="margin:0em; padding:1em 2em;border: thin inset #{{ColorAtys|type=dark|group=HRP}};background:#{{ColorAtys|type=light|group=HRP}};color:#{{ColorAtys|type=fg|group=HRP}};"> | <div style="margin:0em; padding:1em 2em;border: thin inset #{{ColorAtys|type=dark|group=HRP}};background:#{{ColorAtys|type=light|group=HRP}};color:#{{ColorAtys|type=fg|group=HRP}};"> | ||
<poem> | <poem> | ||
Line 100: | Line 99: | ||
</poem> | </poem> | ||
</div> | </div> | ||
− | *8) <span style="color:#f0f">'''[commun]'''</span> | + | *8) <span style="color:#f0f">'''[commun]'''</span> Internal name of the function. This name is used especially for jumps, loops ... |
− | *9) <span style="color:#f0f">'''[commun]'''</span> | + | *9) <span style="color:#f0f">'''[commun]'''</span> Save Changes button. |
− | *10) <span style="color:#f0f">'''[commun]'''</span> | + | *10) <span style="color:#f0f">'''[commun]'''</span> toggle the "Basic Edition" mode to "Advanced Edit" mode. |
+ | Once in "Advanced Edit" mode, it is no longer possible to return to the "Basic Edition" mode. | ||
+ | The description of functions in that guide will always be in "Advanced Edit" mode. | ||
+ | The specific "Advanced objects" are indicated by <span style="color:#f00">'''[expert]'''</span> | ||
+ | |||
+ | ==⇒OK till here⇐== | ||
==Actions without player intervention== | ==Actions without player intervention== | ||
===End of script [[End of script ARCC FR|→]]=== | ===End of script [[End of script ARCC FR|→]]=== |
Revision as of 14:27, 11 September 2014
WIP
in Arbeit -
work in progress -
trabajo en curso -
travaux en cours -
незавершенное
{\{toTrad}}
Manuel d’utilisation de l' A.R.C.C.
Important Note
Important Note
Contents
- 1 The script functions
- 2 Visualizations
- 3 ⇒OK till here⇐
- 4 Actions without player intervention
- 4.1 End of script →
- 4.2 Jump →
- 4.3 Include →
- 4.4 While →
- 4.5 Gestion des fenêtres webig →
- 4.6 Display message in game (broadcast, crafting information...) →
- 4.7 ShapeManager →
- 4.8 Save value in the database →
- 4.9 Save items given by the player in the event database →
- 4.10 Player received item →
- 4.11 DeleteItems →
- 4.12 NpcManager →
- 4.13 Send command to server →
- 4.14 Dans les fonction il faudra analyser:
- 5 Checks
- 6 Captures information
- 7 Steps to be validated by player
The script functions
This guide is intended to show how to use the scripting capabilities of the ARCC, Advanced Ryzom Content Creator. It is recommended to read the volume I for having an overview of the use of the ARCC. The functions of the script are classified into five groups.
- Visualizations
- Actions without player intervention
- Checks
- Captures information
- Steps to be validated by player
Visualizations
This group has only one function, one of the simplest and most common.
It serves as a reference with regard to the areas and buttons common to all functions detailed in separate pages for an easy maintenance of the ARRC documentation.
- Common objects will be reported in the documentation by [common].
- The tag [expert] corresponds to the advanced editing mode (see below paragraph 10).
weVMessage (Displaying a message)
Internal function name: weVMessage |
- 7) [expert] Type of message content:
- bbcode (recommended; a aide-memoire of ryzom bbcode is provided in a dedicated page.)
Exemple :
[session=url_validated][scriptinfos]is_valid_url[/scriptinfos][/session]
- html (Specific, studied later, but immediately testable in web page)
Exemple :
<hr/>Hello!
<br/>this is a new line
<hr>External link!
<img src="http://wiki.blender.org/skins/naiad/images/blender_logo.png"/><hr/>
- lua (very specific; to see later)
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] Internal name of the function. This name is used especially for jumps, loops ...
- 9) [commun] Save Changes button.
- 10) [commun] toggle the "Basic Edition" mode to "Advanced Edit" mode.
Once in "Advanced Edit" mode, it is no longer possible to return to the "Basic Edition" mode.
The description of functions in that guide will always be in "Advanced Edit" mode. The specific "Advanced objects" are indicated by [expert]
⇒OK till here⇐
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 .
Include →
Migration
Please use the migrated document at URL shown below.
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 →
Migration
Please use the migrated document at URL shown below.
Nom interne de la fonction : weAWhile |
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)
Display message in game (broadcast, crafting information...) →
Migration
Please use the migrated document at URL shown below.
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 : 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 ?
- {scale}: Échelle. Par défaut = 1.
Save value in the database →
Migration
Please use the migrated document at URL shown below.
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 →
Migration
Please use the migrated document at URL shown below.
Nom interne de la fonction : weAItemsDatabase |
Player received item →
Migration
Please use the migrated document at URL shown below.
Nom interne de la fonction : weAReceiveItems |
DeleteItems →
Migration
Please use the migrated document at URL shown below.
Nom interne de la fonction : weADeleteItems |
NpcManager →
Migration
Please use the migrated document at URL shown below.
Nom interne de la fonction : weANpcManager |
Gestion du PNJ.
weAGroupScript
|
weASpawnBot
|
weADeSpawnBot
|
weAGroupScriptSay
|
weAGroupScriptEmote
|
weAGroupScriptAiAction
|
Send command to server →
Migration
Please use the migrated document at URL shown below.
WIP
in Arbeit -
work in progress -
trabajo en curso -
travaux en cours -
незавершенное
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
Datas →
Migration
Please use the migrated document at URL shown below.
Nom interne de la fonction : weCDatas |
Cette fonction est l'équivalent d'un si test VRAI alors A sinon B .
Switch →
Migration
Please use the migrated document at URL shown below.
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 →
Migration
Please use the migrated document at URL shown below.
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 →
Migration
Please use the migrated document at URL shown below.
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 →
Migration
Please use the migrated document at URL shown below.
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) →
Migration
Please use the migrated document at URL shown below.
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) →
Migration
Please use the migrated document at URL shown below.
Nom interne de la fonction : weSTimer |
Mission →
Migration
Please use the migrated document at URL shown below.
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 →
Migration
Please use the migrated document at URL shown below.
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