From EncyclopAtys
| Line 13: | Line 13: | ||
*[[ARCC intro EN|Volume I : Quick Start Guide]] | *[[ARCC intro EN|Volume I : Quick Start Guide]] | ||
| β | *[[ARCC | + | *[[ARCC ARK, guide|Volume II : User guide]] |
*[[ARCC Expert EN|Volume III: Advanced user guide]] | *[[ARCC Expert EN|Volume III: Advanced user guide]] | ||
Revision as of 13:49, 16 June 2018
User guide for Ark, short for Ryzom Arkitect.
For historical reasons, those manuals refers very often, almost always, to A.R.C.C.. This is due to the fact that the full documentation has been started with the initial name, ARCC, meaning Advanced Ryzom Content Creator.
Note: with the exception of paragraph 2.1, all paragraphs Level 2 are in single page that can be accessed by clicking on the arrow (β) behind the title of the functions.
Contents
- 1 The script functions
- 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 DisplayIgMessage (Display message in game: broadcast, crafting information...) β
- 3.7 ShapeManager β
- 3.8 Database (Save value in the database) β
- 3.9 ReceiveItems (Player received item) β
- 3.10 DeleteItems β
- 3.11 NpcManager β
- 3.12 Hmagic (Send command to server) β
- 4 Checks
- 5 Captures information
- 6 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; an 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]
Actions without player intervention
End of script β
Jump β
Include β
While β
Window (webig windows management) β
DisplayIgMessage (Display message in game: broadcast, crafting information...) β
ShapeManager β
Database (Save value in the database) β
ReceiveItems (Player received item) β
DeleteItems β
NpcManager β
Hmagic (Send command to server) β
Checks
All these check offers action after a logical evaluation, TRUE or FALSE.
Check Datas β
Switch β
Check Database (Verification of value in database) β
Check PlayerInfos (Player verification check from server: Fames, Dapper, Position...) β
Captures information
PlayerInfos (Captures information on the player) β
Steps to be validated by player
NewGiveItems β
NpcDialog (NPC dialog bubble option like classic missions) β
Timer (The player must wait X seconds for validation, automated validation possible) β
Mission β
Itemshop β
There are currently 34 elements in the category ARK.
