View source for ARCC Guide EN

{{tabLang|EN|ARCC Guide DE|ARCC Guide EN|ARCC Guide ES|ARCC Guide FR|ARCC Guide RU}}

{{toTrad|DE}}
{{toTrad|EN|To check the quality of the text itself}}
{{toTrad|ES}}
{{toTrad|FR|À corriger par rapport à l'anglais}}
{{toTrad|RU}}

<big>'''User guide for Ark, short for Ryzom Arkitect.'''</big>

''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 '''A'''dvanced '''R'''yzom '''C'''ontent '''C'''reator.

*[[ARCC intro EN|Volume I : Quick Start Guide]]
*[[ARCC Guide EN|Volume II : User guide]]
*[[ARCC Expert EN|Volume III: Advanced user guide]]

<!--{{Banner|ff0|Important Note|[[File:WarningRyzom.png |left|]] To coming on documentation and made quicly enable translations, I try to write as much as possible what I have understood and tested. 

'''What is not clear and validated is highlighted in yellow'''.

You are welcome to improve the documentation.}}

{{Banner|ff0|Important Note|[[File:WarningRyzom.png|left|]] This page is actually a merger of other pages (wiki transclusion). 

With the exception of paragraph 2.1,

'''all paragraphs Level 2 are editable and can be viewed by clicking on the arrow (→) behind the title of the functions'''.}}-->
'''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 [[ARCC intro EN|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 <span style="color:#f0f">'''[common]'''</span>.
*The tag <span style="color:#f00">'''[expert]'''</span> corresponds to the advanced editing mode (see below paragraph 10).
<div style="overflow: hidden">
[[File:Advanced.png|200px|thumb|left|window title and function name]]
{|
|[[File:User suit.png|32px|Home]]
|The edit mode is also indicated by an icon alongside the function which was published in this mode.
|}
</div>

===weVMessage (Displaying a message)===
{|
|[[File:Style.png|32px|Home]]
|Internal function name: ''' ''weVMessage'' '''
|}
<div style="overflow: hidden">
[[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 style="overflow: hidden">
[[File:WeVMessage.png|200px|thumb|left|weVMessage_v3]]
*'''1)''' <span style="color:#f0f">'''[commun]'''</span> Function name.
*'''2)''' <span style="color:#f00">'''[expert]'''</span> Always display this message (Yes/No)
*'''3)''' <span style="color:#f00">'''[expert]'''</span> Player must click the link in the message (Yes/No)
*'''4)''' Text field for the message.
</div>
<div style="overflow: hidden">
[[File:WeVMessage 2.png|200px|thumb|left|Text field]]
*'''5)''' <span style="color:#f0f">'''[commun]'''</span> enlargement zone corner '''(4)'''
*'''6)''' <span style="color:#f0f">'''[commun]'''</span> toggle button editor. (assisted mode or not)
</div>
*'''7)''' <span style="color:#f00">'''[expert]'''</span> Type of message content:
:*'''bbcode''' (recommended; an 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}};">
<poem>
	Exemple :
[session=url_validated][scriptinfos]is_valid_url[/scriptinfos][/session]
</poem>
</div>
:*'''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}};">
<poem>
	Exemple :
<nowiki><hr/>Hello!
<br/>this is a new line
<hr>External link!
<img src="http://wiki.blender.org/skins/naiad/images/blender_logo.png"/><hr/></nowiki>
</poem>
</div>
:*'''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}};">
<poem>
	Exemple :
[lua]
function game:onMissionSelected(index)	
	disableModalWindow()
	self:updateCurrMissionComboBox()
	local missionWnd = getMissionWindow()
	setOnDraw(missionWnd, "game:updateArccMissionCustomDesc()")
end
...
updateArccMissionCustomDesc_loop = 100
game:updateArccMissionCustomDesc(1)
[/lua]
</poem>
</div>
*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> Save Changes button.
*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>

==Actions without player intervention==
===End of script [[End of script ARCC EN|→]]===
{{:End of script ARCC EN}}

===Jump [[Jump ARCC EN |→]]===
{{: Jump ARCC EN }}

===Include [[Include ARCC EN |→]]===
{{: Include ARCC EN }}

===While  [[While ARCC EN |→]]===
{{: While ARCC EN }}

===Window (webig windows management)  [[Window ARCC EN |→]]===
{{: Window ARCC EN }}

===DisplayIgMessage (Display message in game: broadcast, crafting information...) [[DisplayIgMessage ARCC EN |→]]===
{{: DisplayIgMessage ARCC EN }}

===ShapeManager [[ShapeManager ARCC EN |→]]===
{{: ShapeManager ARCC EN }}

===Database (Save value in the database) [[Database ARCC EN |→]]===
{{: Database ARCC EN }}

===ReceiveItems (Player received item) [[ReceiveItems ARCC EN |→]]===
{{: ReceiveItems ARCC EN }}

=== DeleteItems [[DeleteItems ARCC EN |→]]===
{{: DeleteItems ARCC EN }}

===NpcManager [[NpcManager ARCC EN |→]]===
{{: NpcManager ARCC EN }}

===Hmagic (Send command to server) [[Hmagic ARCC EN|→]]===
{{: Hmagic ARCC EN }}

==Checks==
All these check offers action after a logical evaluation, TRUE or FALSE.
===Check Datas [[Datas ARCC EN |→]]===
{{: Datas ARCC EN }}

===Switch [[Switch ARCC EN |→]]===
{{: Switch ARCC EN }}

===Check Database (Verification of value in database) [[Check Database ARCC EN |→]]===
{{: Check Database ARCC EN }}

===Check PlayerInfos (Player verification check from server: Fames, Dapper, Position...) [[Check PlayerInfos ARCC EN |→]]===
{{: Check PlayerInfos ARCC EN }}

==Captures information==
===PlayerInfos (Captures information on the player) [[PlayerInfos ARCC EN |→]]===
{{: PlayerInfos ARCC EN }}

==Steps to be validated by player==
===NewGiveItems [[NewGiveItems ARCC EN |→]]===
{{: NewGiveItems ARCC EN }}

===NpcDialog (NPC dialog bubble option like classic missions) [[NpcDialog ARCC EN |→]]===
{{: NpcDialog ARCC EN }}

===Timer (The player must wait X seconds for validation, automated validation possible) [[Timer ARCC EN |→]]===
{{: Timer ARCC EN }}

===Mission [[Mission ARCC EN |→]]===
{{: Mission ARCC EN }}

===Itemshop [[Itemshop ARCC EN |→]]===
{{: Itemshop ARCC EN }}

{{In_Category|ARCC}}
{{TPInWikiRyzom‎}}
[[Category:Tutorials]] 
[[Category:ARCC]]
[[Category:EN]]