Translation to review

Don't blame the contributors, but come and help them 😎

Reference text ( Maintained text, used as reference ) :
Notes: (Zorroargh, 2018-06-16)

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.

• Volume I : Quick Start Guide
• Volume II : User guide
• Volume III: Advanced user guide

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.

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.

1. Visualizations
2. Actions without player intervention
3. Checks
4. Captures information
5. 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).

window title and function name

The edit mode is also indicated by an icon alongside the function which was published in this mode.

weVMessage (Displaying a message)

Internal function name: weVMessage

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 " )

weVMessage_v3

• 1) [commun] Function name.
• 2) [expert] Always display this message (Yes/No)
• 3) [expert] Player must click the link in the message (Yes/No)
• 4) Text field for the message.

Text field

• 5) [commun] enlargement zone corner (4)
• 6) [commun] toggle button editor. (assisted mode or not)

• 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 →

End of script ARCC EN

Jump →

Jump ARCC EN

Include →

Include ARCC EN

While →

While ARCC EN

Window (webig windows management) →

Window ARCC EN

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

DisplayIgMessage ARCC EN

ShapeManager →

ShapeManager ARCC EN

Database (Save value in the database) →

Database ARCC EN

ReceiveItems (Player received item) →

ReceiveItems ARCC EN

DeleteItems →

DeleteItems ARCC EN

NpcManager →

NpcManager ARCC EN

Hmagic (Send command to server) →

Hmagic ARCC EN

Checks

All these check offers action after a logical evaluation, TRUE or FALSE.

Check Datas →

Datas ARCC EN

Switch →

Switch ARCC EN

Check Database (Verification of value in database) →

Check Database ARCC EN

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

Check PlayerInfos ARCC EN

Captures information

PlayerInfos (Captures information on the player) →

PlayerInfos ARCC EN

Steps to be validated by player

NewGiveItems →

Function name : weSNewGiveItems

weSNewGiveItems can give items.

WeSNewGiveItems main window

• 1) Items wanted (one). ([commun] tool for multi sub-selections)
• 2) [commun] Internal name of the function. This name is used especially for jumps, loops ...

Description of items requested.

WeSNewGiveItems item sub window

• 1) Sheet name: *.sitem
• 2) Quantity: the required quantity of the item
• 3) Quality: the required quality of the item
• 4) quantity_max: maximum amount.
• 5) quality_max: maximum quality.

NpcDialog (NPC dialog bubble option like classic missions) →

NpcDialog ARCC EN

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

Timer ARCC EN

Mission →

Mission ARCC EN

Itemshop →

Itemshop ARCC EN

There are currently 34 elements in the category ARK.

Portal of the Forge of Ryzom