Difference between revisions of "ARCC Expert EN"

From Ryzom Forge Wiki

Jump to: navigation, search
 
(32 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
{{tabLang|EN|DE|ARCC Expert EN|ES|ARCC Expert FR|RU}}
+
{{Migrated to|:en:ARK, expert}}
−
{{WIP}}
+
{{tabLang|EN|ARCC Expert DE|ARCC Expert EN|ARCC Expert ES|ARCC Expert FR|ARCC Expert RU}}
  
 
{{toTrad|DE}}
 
{{toTrad|DE}}
 
{{toTrad|EN|To check the quality of the text itself}}
 
{{toTrad|EN|To check the quality of the text itself}}
 
{{toTrad|ES}}
 
{{toTrad|ES}}
−
{{toTrad|FR|À corriger par rapport à l'anglais}}
+
{{toTrad|FR|À corriger par rapport à l'anglais. Attendre qu'il n'y ait plus de "WIP" (marques jaunes) }}
 
{{toTrad|RU}}
 
{{toTrad|RU}}
  
Line 19: Line 19:
  
 
==Ryzom specific BBCODE==
 
==Ryzom specific BBCODE==
 +
 +
===data===
 +
====Settings====
 +
*'''text'''
 +
*'''attribute'''
 +
====Exemples====
 +
<hr/>
  
 
===date===
 
===date===
 
''' ''date'' ''' displays date in "human". See also ''[[#time|time]]''.
 
''' ''date'' ''' displays date in "human". See also ''[[#time|time]]''.
 
====Settings====
 
====Settings====
−
*text: If empty or zero gives the actual date.
+
*'''text''': If empty or zero gives the actual date.
 
:otherwise, seconds to add to 1970-01-01 00:00.
 
:otherwise, seconds to add to 1970-01-01 00:00.
−
*attribute: format for the date. By default if empty: "YYYY-MM-DD hh:mm"
+
*'''attribute''': format for the date. By default if empty: "YYYY-MM-DD hh:mm"
 
====Exemples====
 
====Exemples====
−
*[date]0[/date] => 2014-10-24 15:31
+
*[date]0[/date] ⇒ 2014-10-24 15:31
−
*[date]3600[/date] => 1970-01-01 02:00
+
*[date]3600[/date] ⇒ 1970-01-01 02:00
−
*[date]-3600[/date ]=> 1970-01-01 00:00
+
*[date]-3600[/date ] ⇒ 1970-01-01 00:00
  
−
*[date="%d/%m/%Y %H:%M"]3600[/date] => "01/01/1970 02:00"
+
*[date="%d/%m/%Y %H:%M"]3600[/date] ⇒ "01/01/1970 02:00"
 
<hr/>
 
<hr/>
  
Line 40: Line 47:
 
Columns can be named, otherwise they are referred by the sequential numeration 0 to n
 
Columns can be named, otherwise they are referred by the sequential numeration 0 to n
 
==== Settings ====   
 
==== Settings ====   
−
* Text:  
+
* '''text''': (general form: xxx:xxx:xxx)
−
* # store a data in a cell
+
*# store a data in a cell
−
* # read the contents in a cell
+
*# read the contents in a cell
−
: A cell is defined as: ''line'': ''scope''  where:
+
: A cell is defined as: ''line'':''scope''  where:
 
# ''line'' is a specific kind of data.  
 
# ''line'' is a specific kind of data.  
 
# ''scope'' is associated to the characteristics of the players who are:
 
# ''scope'' is associated to the characteristics of the players who are:
Line 53: Line 60:
 
## org  
 
## org  
 
## race  
 
## race  
−
* attribute: Name of the database.  
+
* '''attribute''': Name of the database.
  
 
==== Examples ====   
 
==== Examples ====   
Line 64: Line 71:
 
That container can divide the page in sections containing the style and other attributes of a HTML bloc.
 
That container can divide the page in sections containing the style and other attributes of a HTML bloc.
 
====Settings====
 
====Settings====
−
*text: Any kind of data who can be included in a HTML bloc: text, images... and their format.
+
*'''text''': Any kind of data who can be included in a HTML bloc: text, images... and their format.
−
*attribut: normaly an array composed by three elements:
+
*'''attribute''': normaly an array composed by three elements:
 
** class
 
** class
 
** id
 
** id
Line 73: Line 80:
 
displays:
 
displays:
 
<div style="margin:1em; padding:1em;border: none;background:#fed;color:#300;">Blabla<br/>blabla<br/>...</div>
 
<div style="margin:1em; padding:1em;border: none;background:#fed;color:#300;">Blabla<br/>blabla<br/>...</div>
 +
<hr/>
 +
 +
===expr===
 +
====Settings====
 +
*'''text'''
 +
*'''attribute'''
 +
====Exemples====
 +
<hr/>
 +
 +
===func===
 +
''' ''func'' ''' allow the execution of some functions known in Ryzom.
 +
====Settings====
 +
*'''text''': (general form: <1st_part_of_text>|<2nd_part_of_text>|...). Parameters for the functions (except if function has no parameters, in that cas could be the function itself).
 +
*'''attribute''':one of the next functions:
 +
**now: internal server time in tics
 +
**rand: random value in a range of two limits.
 +
**sqrt: square root.
 +
**log: natural logarithm.
 +
**pow: power of <1st_number_in_text> by <2nd_number_in_text>.
 +
**round: round of a number.
 +
**floor: floor of a number.
 +
**min: min between two numbers.
 +
**max: max between two numbers.
 +
**find: find in the <1st_string_in_text> the <2nd_string_in_text>: return 1 if found, otherwise, 0.
 +
**split: split the <1st_part_of_text> (a string) by the <2nd_part_of_text> (a char) and return the nth element of the split gift by the <3rd_part_of_text> (a number), if define otherwise the first element counting from 0.
 +
**substr: extract a substring from the <1st_part_of_text> (a string) begininh at the <2nd_part_of_text> (a number) till the <3rd_part_of_text> (a number), if define otherwise till the end of the given string. Chars are counted from 0.
 +
**unset_url_param: unset parameters.
 +
**building: include if not already defined an alias to the  <1st_string_in_text>.
 +
 +
====Exemples====
 +
*now: [func]now[/func] or [func=now]100[/func]
 +
*rand: [func=rand]0|10[/func]
 +
*sqrt: [func=sqrt]64[/func] = 8
 +
*log: [func=log]10[/func] = 2.302585092994
 +
*pow: [func=pow]10|2[/func] = 100
 +
*round: [func=round]2.85092994[/func] = 3
 +
*floor: [func=floor]2.85092994[/func] = 2
 +
*min: [func=min]10|2[/func] = 2
 +
*max: [func=max]10|2[/func] = 10
 +
*find:
 +
**[func=find]AZERTYUIOP|Y[/func] = 1
 +
**[func=find]azertyuiop|Y[/func] = 0
 +
*split:
 +
**[func=split]A_B_C_D|_[/func] = A
 +
**[func=split]A_B_C_D|_|2[/func] = C
 +
*substr:
 +
**[func=substr]A_B_C_D|2[/func] =  B_C_D
 +
**[func=substr]A_B_C_D|2|4[/func] = B_C_
 +
<hr/>
 +
 +
===gender===
 +
''' ''gender'' ''' returns a text according to the gender.
 +
====Settings====
 +
*'''text''': text to display if the char has the gender of the attribute.
 +
*'''attribute''': '''''m''''' or '''''f'''''
 +
====Exemples====
 +
''We assume that the player is male.''
 +
*[gender=m]Sir![/gender] returns '''''Sir!'''''
 +
*[gender=f]Miss![/gender] returns nothing.
 +
<hr/>
 +
 +
===get===
 +
====Settings====
 +
*'''text''':
 +
*'''attribute''': None.
 +
====Exemples====
 
<hr/>
 
<hr/>
  
 
===hack===
 
===hack===
 
Empty function!
 
Empty function!
 +
<hr/>
 +
 +
===if===
 +
''' ''if'' ''' displays a text if attribute is OK
 +
====Settings====
 +
*'''text''': text to display if attribute is OK
 +
*'''attribute''': math evaluation.
 +
<hr/>
 +
 +
===ifnot===
 +
''' ''ifnot'' ''' displays a text if attribute is NOT OK
 +
====Settings====
 +
*'''text''': text to display if attribute is NOT OK
 +
*'''attribute''': math evaluation.
 
<hr/>
 
<hr/>
  
Line 83: Line 170:
 
''Something is wrong because, I (Bepock) obtain always a '' " title="" /> '' after the image. Use [imgurl] instead: it works fine.''
 
''Something is wrong because, I (Bepock) obtain always a '' " title="" /> '' after the image. Use [imgurl] instead: it works fine.''
 
====Settings====
 
====Settings====
−
*text: image_URL
+
*'''text''': image_URL
−
*attribute: does not work
+
*'''attribute''': does not work
  
 
====Exemples====
 
====Exemples====
Line 95: Line 182:
 
''' ''imgurl'' ''' displays an image linking to an URL.
 
''' ''imgurl'' ''' displays an image linking to an URL.
 
====Settings====
 
====Settings====
−
*text: 2 kind of data:
+
*'''text''': (general form: xxx xxx xxx). 2 kinds of data:
 
*# URL of the image, mandatory: clickable image;  
 
*# URL of the image, mandatory: clickable image;  
 
*# Display name of the URL when mouse goes over the image. Preceded by the underscore character ("_"), it is a text that will be translated. It remains enclosed by brackets "{}" if it is not translated.  
 
*# Display name of the URL when mouse goes over the image. Preceded by the underscore character ("_"), it is a text that will be translated. It remains enclosed by brackets "{}" if it is not translated.  
−
*attribut: URL
+
*'''attribute''': URL
  
 
====Exemples====
 
====Exemples====
Line 105: Line 192:
 
:[http://forge.ryzom.com/wiki/ARCC_Expert_EN [[file:emotion_tongue.png|The_ARCC]] ]
 
:[http://forge.ryzom.com/wiki/ARCC_Expert_EN [[file:emotion_tongue.png|The_ARCC]] ]
 
<hr/>
 
<hr/>
 +
 +
===itemicon===
 +
''' ''itemicon'' ''' displays a thumbnail of an item.
 +
====Paramètres====
 +
*'''text''': the item ([[Sitem|SITEM file]])
 +
*'''attribute''': None.
 +
====Exemples====
 +
*[itemicon]teddyubo.sitem[/itemicon] or
 +
*[itemicon]teddyubo[/itemicon] displays: http://api.ryzom.com/data/cache/item_icons/0cf49e1620be972028c29a613d11ef2a.png
 +
 +
An anexistant or erroneous file such [itemicon]NoExist[/itemicon] displays : http://api.ryzom.com/data/cache/item_icons/c37962969910e09734d859a89e32085c.png
 +
<hr>
 +
 +
===link===
 +
''' ''link'' ''' builds a internal link.
 +
====Settings====
 +
*'''attribute'''
 +
** if "#", the text is the url name.
 +
** if empty, the text is a list of selected parameters in the script.
 +
====Exemples====
 +
''We assume that the number of the script is 2124.''
 +
*<nowiki>[link=#]A name for that link[/link] ⇒ displays a link with the name "A name for that link" to the URL http://app.ryzom.com/app_arcc/index.php?action=mScript_Edit&script=2124&select=0</nowiki>
 +
*<nowiki>[link]#A B Cl[/link] ⇒ displays the </nowiki>'''text'''<nowiki> (not a link) http://app.ryzom.com/app_arcc/index.php?action=mScript_Edit&script=2124&select=A+B+C</nowiki>
 +
<hr/>
 +
 
===lua===
 
===lua===
 
''' ''lua'' ''' passes the ''text'' to the [[Ryzom Lua]] interpreter.
 
''' ''lua'' ''' passes the ''text'' to the [[Ryzom Lua]] interpreter.
 
====Settings====
 
====Settings====
−
*text: Lua script.
+
*'''text''': Lua script.
−
*attribute: None.
+
*'''attribute''': None.
 +
<hr/>
 +
 
 +
===map===
 +
''' ''map'' ''' displays a square map of 2000 units around a given point marked by a magenta flag.
 +
====Settings====
 +
*'''text''' :  name of a point (for instance city name) or Ryzom coordinates.
 +
*'''attribute''': '' "flags" '' displays with green flags all outposts.
 +
====Exemples====
 +
<div style="overflow: hidden">
 +
[[File:mapLoria.jpeg|200px|thumb|left|Loria map]]
 +
<nowiki>[map]18176,-29492[/map]</nowiki>
 +
</div>
 +
<div style="overflow: hidden">
 +
[[File:mapPyr.jpeg|200px|thumb|left|Pyr map]]
 +
<nowiki>[map flags=markers]pyr[map]</nowiki>
 +
</div>
 +
<hr/>
 +
 
 +
===math===
 +
''' ''math'' ''' calculates basic calculations.
 +
====Settings====
 +
*'''text''' : a basic calculations with the four arithmetical operators: +, -, *,  /.
 +
*'''attribute''': no significative.
 +
====Exemples====
 +
*[math]1+2*3-4/6[/math] = 6.3333333333333
 +
*[math=toto][/math] and [math=toto]1+2*3-4/6t[/math] ⇒ no output
 +
 
 +
*[math][func=round]6.45[/func][/math] = 6
 +
*[math][func=round]6.45[/func]*2[/math] = 12
 +
<hr/>
 +
 
 +
===param===
 +
====Settings====
 +
*'''text'''
 +
*'''attribute'''
 +
====Exemples====
 +
<hr/>
 +
 
 +
===playerbackup===
 +
====Settings====
 +
*'''text''' :
 +
*'''attribute''':
 +
====Exemples====
 +
<hr/>
 +
 
 +
===playerinfos===
 +
''' ''playerinfos'' ''' gives some informations concerning the player.
 +
====Settings====
 +
*'''text''': (general form: xxx|xxx|xxx) . One of the next keys: 'name', 'fullname', 'id', 'guild', 'guild_id', 'pvp_points', 'money',  'cid', 'gender' or 'api'.
 +
** <small>next fields up to 2: values of that key if needed for api.</small>
 +
*'''attribute''':
 +
** Empty
 +
** #<name>
 +
** <name>
 +
====Exemples tested  by Bepock====
 +
*name: [playerinfos]name[/playerinfos] ⇒ Bepock (for instance)
 +
*fullname: [playerinfos]fullname[/playerinfos] ⇒ fullname: Bepock(Atys)
 +
*id: [playerinfos]id[/playerinfos] ⇒ 19089
 +
*guild: [playerinfos]guild[/playerinfos] ⇒ Animation
 +
*guild_id: [playerinfos]guild_id[/playerinfos] ⇒ 105906345
 +
*money: [lua][playerinfos]money[/playerinfos][/lua]
 +
*cid: [playerinfos]cid[/playerinfos] ⇒ 9765472
 +
*gender: [playerinfos]gender[/playerinfos] ⇒ 1 (male)
 +
<hr/>
 +
 
 +
===playerstat===
 +
====Paramètres====
 +
*'''text''': (general form xxx|xxx|xxx)
 +
*'''attribute''': None.
 +
====Exemples====
 +
<hr/>
 +
 
 +
===post===
 +
====Settings====
 +
*'''text''':
 +
*'''attribute''': None.
 +
====Exemples====
 +
<hr/>
 +
 
 +
===scriptinfos===
 +
''' ''scriptinfos'' ''' displays the translations associated to a keyword if it exist in the language of the user (See also the "[[ARCC traductions EN|trad tool]]" of ARK).
 +
====Paramètres====
 +
*'''text''': (general form xxx|xxx|xxx)
 +
*'''attribute''': None.
 +
====Exemples====
 
<hr/>
 
<hr/>
  
Line 115: Line 312:
 
''' ''scripturl'' ''' cats action, action number and extension to be send to the server.
 
''' ''scripturl'' ''' cats action, action number and extension to be send to the server.
 
====Settings====
 
====Settings====
−
*text: add a PHP extension to the URL gift in the atribute.
+
*'''text''': add a PHP extension to the URL gift in the attribute.
−
*attribute:  
+
*'''attribute''':  
 
** Nothing: current action number of the script.
 
** Nothing: current action number of the script.
 
** Otherwise: first letter of the letter field if not "space". In that case add a "+".
 
** Otherwise: first letter of the letter field if not "space". In that case add a "+".
Line 141: Line 338:
 
**Name_1 = [session]Name_1[/session] displays : "Name one"
 
**Name_1 = [session]Name_1[/session] displays : "Name one"
 
**Name_2 = [session]Name_2[/session] displays : "&rArr;Name two&lArr;"
 
**Name_2 = [session]Name_2[/session] displays : "&rArr;Name two&lArr;"
 +
<hr/>
 +
===t===
 +
''' ''t'' ''' displays the translations associated to a keyword if it exist in the language of the user (See also the "[[ARCC traductions EN|trad tool]]" of ARK).
 +
====Paramètres====
 +
*'''text''': (general form xxx|xxx|xxx)
 +
*'''attribute''': None.
 +
====Exemples====
 +
*[t]yes[/t] ⇒ gives for French user "Oui"
 +
*[t]text[/t] ⇒ gives for French user "Texte"
 +
But, because keyword is case sensitive:
 +
*[t]Yes[/t] ⇒ gives {Yes}
 +
*[t]Text[/t] ⇒  gives {Text}
 
<hr/>
 
<hr/>
  
Line 147: Line 356:
 
*See also ''[[#date|date]]''.
 
*See also ''[[#date|date]]''.
 
====Settings====
 
====Settings====
−
*text: If empty or zero or "now()" gives the actual time in ''days_of_the_current_year'':''GMT_hour'':''minutes'':''seconds''.
+
*'''text''': If empty or zero or "now()" gives the actual time in ''days_of_the_current_year'':''GMT_hour'':''minutes'':''seconds''.
 
:otherwise, treats the value in the text as number of seconds, and display the equivalent "hour'':''minutes'':''seconds''.
 
:otherwise, treats the value in the text as number of seconds, and display the equivalent "hour'':''minutes'':''seconds''.
−
*attribute: None.
+
*'''attribute''': None.
 +
====Exemples====
 +
*[timer][/timer] or [timer]now()[/timer] or [timer]0[/timer] ⇒ 296:13:05:18
 +
*[timer]60[/timer] ⇒ 00:01:00
 +
*[timer]3600[/timer] ⇒ 01:00:00
 +
<hr/>
 +
 
 +
===trad===
 +
''' ''trad'' ''' displays one of the translations associated to a keyword if it exist in the language of the user (See also the "[[ARCC traductions EN|trad tool]]" of ARK).
 +
====Settings====
 +
*'''text''': (general form: xxx|xxx|xxx, and internal xxx_xxx_xxx).
 +
*'''attribute''': sens if text empty
 
====Exemples====
 
====Exemples====
−
*[timer][/timer] or [timer]now()[/timer] or [timer]0[/timer] => 296:13:05:18
+
*<nowiki>[trad]Hello[/trad] ⇒ displays the local translation</nowiki>
−
*[timer]60[/timer] => 00:01:00
+
*<nowiki>[trad=Hello][/trad] ⇒ displays the local translation</nowiki>
−
*[timer]3600[/timer] => 01:00:00
 
 
<hr/>
 
<hr/>
  
Line 160: Line 379:
 
====Settings====
 
====Settings====
 
*'''text''' : URL or text to display
 
*'''text''' : URL or text to display
−
*'''attribute:'''
+
*'''attribute''':
 
**if text=<empty>: URL;
 
**if text=<empty>: URL;
 
**else, text to be displayed: name, description... of the URL.
 
**else, text to be displayed: name, description... of the URL.
Line 167: Line 386:
 
*<nowiki>[url=http://forge.ryzom.com/wiki/ARCC_Expert_EN]The ARCC[/url]</nowiki>
 
*<nowiki>[url=http://forge.ryzom.com/wiki/ARCC_Expert_EN]The ARCC[/url]</nowiki>
 
<hr/>
 
<hr/>
−
{{WIP}}
 
  
−
===expr===
 
−
<div style="margin:0em; padding:0em;border: none;background:yellow;">
 
−
*affichage du calcul
 
−
*affichage du résultat
 
−
</div>
 
−
===map===
 
−
<div style="margin:0em; padding:0em;border: none;background:yellow;">
 
−
====Paramètres====
 
−
*texte:
 
−
*attribut: significatif si texte est nul
 
−
**
 
−
====Exemples====
 
−
</div>
 
−
*[map]18176,-29492[/map]
 
−
===link===
 
−
<div style="margin:0em; padding:0em;border: none;background:yellow;">
 
−
====Paramètres====
 
−
*texte:
 
−
*attribut: significatif si texte est nul
 
−
**
 
−
====Exemples====
 
−
</div>
 
−
*[link][/link] &rArr; http://app.ryzom.com/app_arcc/index.php?action=script_Edit&event=211&script=1929
 
−
:http://app.ryzom.com/app_arcc/index.php?action=scripts_Main&event=211 (A.R.C.C. » TESTS » Bepock » UserGuide » NewEvent »  Nouvel event )
 
−
*[link]GrimSon[/link] &rArr; http://app.ryzom.com/app_arcc/index.php?action=script_Edit&event=211&script=1936
 
−
:http://app.ryzom.com/app_arcc/index.php?action=script_Edit&script=1936&version=0 (A.R.C.C. » TESTS » Bepock » UserGuide » NewEvent » NewEvent »  GrimSon)
 
−
*[link]#weGPlayerInfos_BBCodeTest[/link] &rArr; http://app.ryzom.com/app_arcc/index.php?action=script_Edit&script=2088&select=weGPlayerInfos_BBCodeTest
 
−
:http://app.ryzom.com/app_arcc/index.php?message=recipe_updated&action=script_Edit&script=2088&ryform_action=&ryform_name= (
 
−
A.R.C.C. » TESTS » Bepock » UserGuide » NewEvent » NewEvent »  BBCODE: stage weGPlayerInfos_BBCodeTest)
 
 
===validate===
 
===validate===
−
<div style="margin:0em; padding:0em;border: none;background:yellow;">
+
''' ''validate'' ''' returns a link of the actual stage in the script.
−
====Paramètres====
 
−
*texte:
 
−
*attribut: significatif si texte est nul
 
−
**
 
−
====Exemples====
 
−
</div>
 
−
===trad===
 
−
''' ''trad'' ''' displays one of the translations associated to a keyword if it exist in the language of the user (See also the "trad tool" of ARK).
 
−
<div style="margin:0em; padding:0em;border: none;background:yellow;">
 
−
====Paramètres====
 
−
*texte:
 
−
*attribut: significatif si texte est nul
 
−
**
 
−
====Exemples====
 
−
</div>
 
−
===t===
 
−
<div style="margin:0em; padding:0em;border: none;background:yellow;">
 
−
====Paramètres====
 
−
*text:
 
−
*attribute: None.
 
−
====Exemples====
 
−
</div>
 
−
===math===
 
−
<div style="margin:0em; padding:0em;border: none;background:yellow;">
 
−
====Paramètres====
 
−
*texte:
 
−
*attribut: significatif si texte est nul
 
−
**
 
−
====Exemples====
 
−
</div>
 
−
@process randint(0, 100)
 
−
 
 
−
===func===
 
−
<div style="margin:0em; padding:0em;border: none;background:yellow;">
 
−
====Paramètres====
 
−
*texte:
 
−
*attribut: significatif si texte est nul
 
−
**
 
−
====Exemples====
 
−
</div>
 
−
===itemicon===
 
−
<div style="margin:0em; padding:0em;border: none;background:yellow;">
 
−
====Paramètres====
 
−
*text:
 
−
*attribute: None.
 
−
====Exemples====
 
−
</div>
 
−
===param===
 
−
<div style="margin:0em; padding:0em;border: none;background:yellow;">
 
−
====Paramètres====
 
−
*text:
 
−
*attribute: None.
 
−
====Exemples====
 
−
</div>
 
−
===data===
 
−
<div style="margin:0em; padding:0em;border: none;background:yellow;">
 
−
====Paramètres====
 
−
*text:
 
−
*attribute: None.
 
−
====Exemples====
 
−
</div>
 
−
===get===
 
−
<div style="margin:0em; padding:0em;border: none;background:yellow;">
 
−
====Paramètres====
 
−
*text:
 
−
*attribute: None.
 
−
====Exemples====
 
−
</div>
 
−
===post===
 
−
<div style="margin:0em; padding:0em;border: none;background:yellow;">
 
−
====Paramètres====
 
−
*text:
 
−
*attribute: None.
 
−
====Exemples====
 
−
</div>
 
−
 
 
−
===playerinfos===
 
−
''' ''playerinfos'' ''' gives some informations concerning the player.
 
 
====Settings====
 
====Settings====
−
*'''text''': one of the next keys: 'name', 'fullname', 'id', 'guild', 'guild_id', 'pvp_points', 'money',  'cid', 'gender' or 'api'.
+
*'''text''': name of the link
−
<div style="margin:0em; padding:0em;border: none;background:yellow;">
 
−
** <small>next fields up to 2: values of that key if needed for api.</small>
 
 
*'''attribute''':
 
*'''attribute''':
−
**<empty>:
+
====Exemple====
−
**beginning with #:
+
''We assume that the number of the script is 2124.''
−
**other:
 
−
                        if ($attr[0] == "#") action semble être un des parametres important... àtester
 
−
                                $name = ryzom_get_param(substr($attr, 1));
 
−
                        else
 
−
                                $name = $attr;
 
−
                       
 
−
                        $db = ryDB::getInstance('webig');
 
−
                        $player_infos = $db->querySingle('players', array('name' => strtolower($name), 'deleted' => 0, 'shard' => ryzom_get_param('shard', _user()->shardid)));
 
−
                        p($player_infos);
 
−
                        if ($player_infos) {
 
−
                                $text = explode('|', $text);
 
−
                                switch ($text[0]) {
 
−
                                        case 'id':
 
−
                                                return $player_infos['id'];
 
−
                                        case 'cid':
 
−
                                                return $player_infos['cid'];
 
−
                                        case 'api':
 
−
                                                return ryzom_player_value($player_infos['id'], $text[1], '$text[2]');
 
−
http://app.ryzom.com/app_forum/index.php?page=topic/view/21035/1#1
 
−
http://app.ryzom.com/app_ryzhome/index.php?from_index=1
 
−
*attribut:
 
−
** Empty
 
−
** "#"
 
−
** <''name''>
 
−
====Exemples====
 
−
</div>
 
  
−
===gender===
+
<nowiki>[validate]==validate==[/validate] ⇒ displays a link with the name "==validate==" to the URL http://app.ryzom.com/app_arcc/index.php?action=mScript_Edit&script=2124&command_13=validate</nowiki>
−
<div style="margin:0em; padding:0em;border: none;background:yellow;">
+
<hr/>
−
====Paramètres====
 
−
*texte:
 
−
*attribut: significatif si texte est nul
 
−
**
 
−
====Exemples====
 
−
</div>
 
−
===playerbackup===
 
−
<div style="margin:0em; padding:0em;border: none;background:yellow;">
 
−
====Paramètres====
 
−
*texte:
 
−
*attribut: significatif si texte est nul
 
−
**
 
−
====Exemples====
 
−
</div>
 
−
===playerstat===
 
−
<div style="margin:0em; padding:0em;border: none;background:yellow;">
 
−
====Paramètres====
 
−
*texte:
 
−
*attribut: significatif si texte est nul
 
−
**
 
−
====Exemples====
 
−
</div>
 
−
===scriptinfos===
 
−
 
 
−
====Paramètres====
 
−
*text:
 
−
**id: return the number id of the script.
 
−
<div style="margin:0em; padding:0em;border: none;background:yellow;">
 
−
**stage: return the currentStage in the script. Does not work?
 
−
**is_valid_url
 
−
</div>
 
−
*attribute: None.
 
−
====Exemples====
 
−
[*][scriptinfos]id[/scriptinfos]
 
−
[*][scriptinfos]stage[/scriptinfos]
 
−
[*][scriptinfos]is_valid_url[/scriptinfos]
 
−
===if===
 
−
<div style="margin:0em; padding:0em;border: none;background:yellow;">
 
−
====Paramètres====
 
−
*texte:
 
−
*attribut: significatif si texte est nul
 
−
**
 
−
====Exemples====
 
−
</div>
 
−
===ifnot===
 
−
<div style="margin:0em; padding:0em;border: none;background:yellow;">
 
−
====Paramètres====
 
−
*texte:
 
−
*attribut: significatif si texte est nul
 
−
**
 
−
====Exemples====
 
−
</div>
 
−
 
 
−
==HTML==
 
−
<table>
 
−
 
 
−
<tr style="background-image:url(http://dl.dropbox.com/u/17987525/webig/inner1.png)">
 
−
<td> </td>
 
−
<td><img src="http://arcc-ryzom.rhcloud.com/images/prerite/m0385ccmcb01.sitem.png"/></td><td>Alpha :</td><td>([db=TestDB]0:0[/db]+2000)/4000</td><td><img src="http://app.ryzom.com/app_arcc/scripts/events/event_temple/progress_bar.php?value=[db=TestDB]1:0[/db]&value_max=4000+40&rand=[func]now[/func]" /></td></tr>
 
−
 
 
−
<tr style="background-image:url(http://dl.dropbox.com/u/17987525/webig/inner1.png)">
 
−
<td> </td>
 
−
<td><img src="http://arcc-ryzom.rhcloud.com/images/prerite/m0655chsca01.sitem.png" /></td><td>Beta :</td><td> [db=TestDB]1:0[/db]/4000+60</td><td><img src="http://app.ryzom.com/app_arcc/scripts/events/event_temple/progress_bar.php?value=[db=TestDB]4:0[/db]&value_max=4000&rand=[func]now[/func]" /></td></tr>
 
−
 
 
−
<tr style="background-image:url(http://dl.dropbox.com/u/17987525/webig/inner1.png)">
 
−
<td> </td>
 
−
<td><img src="http://arcc-ryzom.rhcloud.com/images/prerite/m0685ccpca01.sitem.png" /></td><td>Gamma :</td><td> [db=TestDB]2:0[/db]/4000</td><td><img src="http://app.ryzom.com/app_arcc/scripts/events/event_temple/progress_bar.php?value=[db=TestDB]2:0[/db]&value_max=4000&rand=[func]now[/func]" /></td></tr>
 
−
 
 
−
 
 
−
<tr style="background-image:url(http://dl.dropbox.com/u/17987525/webig/inner1.png)">
 
−
<td> </td>
 
−
<td><img src="http://arcc-ryzom.rhcloud.com/images/prerite/m0559ccncb01.sitem.png" /></td><td>Delta :</td><td> [db=TestDB]3:0[/db]/4000</td><td><img src="http://app.ryzom.com/app_arcc/scripts/events/event_temple/progress_bar.php?value=[db=TestDB]3:0[/db]&value_max=4000&rand=[func]now[/func]" /></td></tr>
 
−
 
 
−
</table>
 
−
 
 
−
[list=1]
 
−
[*]now:[func]now[/func]
 
−
[*]rand %:[func=rand]0|100[/func]
 
−
[*]calc:[math](10*2)[/math]
 
−
[*]session DATE:[session=DATE][func]now[/func][/session]
 
−
[*]DATE:[session]DATE[/session]
 
−
[*]date:[date]DATE[/date]
 
−
[*]rand*DATE:[math][func=rand]0|100[/func]*[session]DATE[/session][/math]
 
−
[*]rand*DATE:[math]([func=rand]0|100[/func]*[session]DATE[/session])%100[/math]
 
−
[*]
 
−
[/list]
 
−
 
 
−
[list]
 
−
[*]session DATE:[session=DATE][func]now[/func][/session]
 
−
[*]DATE:[session]DATE[/session]
 
−
[*]date:[date]DATE[/date]
 
−
 
 
−
[*]1 [date shard=atys][/date]
 
−
[*]2 [date=atys][/date]
 
−
[*]3 [date shard][/date]
 
−
[*]4 [date][/date]
 
−
[*]5 [date]1407426669[/date]
 
−
[session=DATE][func]now[/func]+1000[/session]
 
−
[*]6 [time][session]DATE[/session][/time]
 
−
[*]
 
−
[*]Samedi 8 Novembre 12:00:00 UTC (dans 3 mois)
 
−
[*]17h - Tria, Pluvia 15, 3e CA 2580
 
−
[*][time]2014-11-08 12:00[/time]
 
−
[*]1:[date shard=atys]2014-11-08 12:00[/date]
 
−
[*]2:[date=atys]2014-11-08 12:00[/date]
 
−
[*]3:[date shard]2014-11-08 12:00[/date]
 
−
[*]4:[date]2014-11-08 12:00[/date]
 
−
[*]
 
−
[*]1:[date shard=atys]2014-11-08 12:00[/date]
 
−
[*]2:[date=atys]2014-11-08 12:00[/date]
 
−
[*]3:[date shard]2014-11-08 12:00[/date]
 
−
[*]4:[date]2014-11-08 12:00[/date]
 
−
[*]
 
−
[*]1:[shard=atys]2014-11-08 12:00[/shard]
 
−
[*]2:
 
−
[*]3:[shard]2014-11-08 12:00[/shard]
 
−
[*]4:[date]2014-11-08 12:00[/date]
 
−
[*]
 
−
[*]1:[date shard=atys=2014-11-08 12:00][/date]
 
−
[*]2:[date=atys=2014-11-08 12:00][/date]
 
−
[*]3:[date shard=2014-11-08 12:00][/date]
 
−
[*]4:[date=2014-11-08 12:00][/date]
 
−
[*]
 
−
[*]
 
−
[*]
 
−
[*]
 
−
[*]
 
−
[*]
 
−
[*]
 
−
[*]
 
−
[/list]
 
−
 
 
−
 
 
−
liste des item .ps et .sitem?
 
−
 
 
−
players dans les db permet de différencier et mémoriser chaque players !
 
−
il doir en etre de meme pour guilde etc...
 
−
 
 
−
 
 
−
<div style="margin:0em; padding:0em;border: none;background:yellow;">
 
−
====Paramètres====
 
−
*texte:
 
−
*attribut: significatif si texte est nul
 
−
**
 
−
====Exemples====
 
−
</div>
 
−
 
 
−
&rArr;
 
  
 
==Autre soutils de l'ARCC==
 
==Autre soutils de l'ARCC==
 
*[[ARCC traductions EN|Traduction automatique]]
 
*[[ARCC traductions EN|Traduction automatique]]
  
−
 
+
'''[[ARCC Guide EN|←ARCC Guide EN]]'''
 +
{{In_Category|ARCC}}
 
{{TPInWikiRyzom‎}}
 
{{TPInWikiRyzom‎}}
−
 
 
[[Category:Tutorials]]  
 
[[Category:Tutorials]]  
 
[[Category:ARCC]]
 
[[Category:ARCC]]
 
[[Category:EN]]
 
[[Category:EN]]

Latest revision as of 09:33, 14 June 2018

Migration

Please use the migrated document at URL shown below.

Migrated to en:ARK, expert at 2018-06-14

Flag-DE

Übersetzung , bitte.

Flag-EN

To check the quality of the text itself

Flag-ES

Traducción, por favor.

Flag-FR

À corriger par rapport à l'anglais. Attendre qu'il n'y ait plus de "WIP" (marques jaunes)

Flag-RU

перевод, пожалуйста.


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.

Ryzom specific BBCODE

data

Settings

  • text
  • attribute

Exemples

date

date displays date in "human". See also time.

Settings

  • text: If empty or zero gives the actual date.
otherwise, seconds to add to 1970-01-01 00:00.
  • attribute: format for the date. By default if empty: "YYYY-MM-DD hh:mm"

Exemples

  • [date]0[/date] ⇒ 2014-10-24 15:31
  • [date]3600[/date] ⇒ 1970-01-01 02:00
  • [date]-3600[/date ] ⇒ 1970-01-01 00:00
  • [date="%d/%m/%Y %H:%M"]3600[/date] ⇒ "01/01/1970 02:00"

db

db store or read a value in a DB. DB is of different kind of rows sets. For instance, "player" DB will memorize the name of the player in column 0; ARCC DB, will memorize an internal number,... Columns can be named, otherwise they are referred by the sequential numeration 0 to n

Settings

  • text: (general form: xxx:xxx:xxx)
    1. store a data in a cell
    2. read the contents in a cell
A cell is defined as: line:scope where:
  1. line is a specific kind of data.
  2. scope is associated to the characteristics of the players who are:
    1. player (by default and equivalent to '0' )
    2. guild
    3. arcc
    4. civ
    5. cult
    6. org
    7. race
  • attribute: Name of the database.

Examples

  • [db=TestDB]0:0=100[/db] load 100 in the cell 0:0 of TestDB.
  • [db=TestDB]3:0[/db] read the cell 3:0

div

div is the equivalent of the HTML bloc <div>. That container can divide the page in sections containing the style and other attributes of a HTML bloc.

Settings

  • text: Any kind of data who can be included in a HTML bloc: text, images... and their format.
  • attribute: normaly an array composed by three elements:
    • class
    • id
    • style

Exemples

  • [div class="Bepock" id="bepock" style="margin:1em;padding:1em;border:none;background:#fed;color:#300;"]Blabla<br/>blabla<br/>...[/div]

displays:

Blabla
blabla
...

expr

Settings

  • text
  • attribute

Exemples

func

func allow the execution of some functions known in Ryzom.

Settings

  • text: (general form: <1st_part_of_text>|<2nd_part_of_text>|...). Parameters for the functions (except if function has no parameters, in that cas could be the function itself).
  • attribute:one of the next functions:
    • now: internal server time in tics
    • rand: random value in a range of two limits.
    • sqrt: square root.
    • log: natural logarithm.
    • pow: power of <1st_number_in_text> by <2nd_number_in_text>.
    • round: round of a number.
    • floor: floor of a number.
    • min: min between two numbers.
    • max: max between two numbers.
    • find: find in the <1st_string_in_text> the <2nd_string_in_text>: return 1 if found, otherwise, 0.
    • split: split the <1st_part_of_text> (a string) by the <2nd_part_of_text> (a char) and return the nth element of the split gift by the <3rd_part_of_text> (a number), if define otherwise the first element counting from 0.
    • substr: extract a substring from the <1st_part_of_text> (a string) begininh at the <2nd_part_of_text> (a number) till the <3rd_part_of_text> (a number), if define otherwise till the end of the given string. Chars are counted from 0.
    • unset_url_param: unset parameters.
    • building: include if not already defined an alias to the <1st_string_in_text>.

Exemples

  • now: [func]now[/func] or [func=now]100[/func]
  • rand: [func=rand]0|10[/func]
  • sqrt: [func=sqrt]64[/func] = 8
  • log: [func=log]10[/func] = 2.302585092994
  • pow: [func=pow]10|2[/func] = 100
  • round: [func=round]2.85092994[/func] = 3
  • floor: [func=floor]2.85092994[/func] = 2
  • min: [func=min]10|2[/func] = 2
  • max: [func=max]10|2[/func] = 10
  • find:
    • [func=find]AZERTYUIOP|Y[/func] = 1
    • [func=find]azertyuiop|Y[/func] = 0
  • split:
    • [func=split]A_B_C_D|_[/func] = A
    • [func=split]A_B_C_D|_|2[/func] = C
  • substr:
    • [func=substr]A_B_C_D|2[/func] = B_C_D
    • [func=substr]A_B_C_D|2|4[/func] = B_C_

gender

gender returns a text according to the gender.

Settings

  • text: text to display if the char has the gender of the attribute.
  • attribute: m or f

Exemples

We assume that the player is male.

  • [gender=m]Sir![/gender] returns Sir!
  • [gender=f]Miss![/gender] returns nothing.

get

Settings

  • text:
  • attribute: None.

Exemples

hack

Empty function!

if

if displays a text if attribute is OK

Settings

  • text: text to display if attribute is OK
  • attribute: math evaluation.

ifnot

ifnot displays a text if attribute is NOT OK

Settings

  • text: text to display if attribute is NOT OK
  • attribute: math evaluation.

img

img displays an image. Something is wrong because, I (Bepock) obtain always a " title="" /> after the image. Use [imgurl] instead: it works fine.

Settings

  • text: image_URL
  • attribute: does not work

Exemples

  • [img]http://app.ryzom.com//data/icons/32/emotion_happy.png[/img]

displays:

emotion_happy.png " title="" />

imgurl

imgurl displays an image linking to an URL.

Settings

  • text: (general form: xxx xxx xxx). 2 kinds of data:
    1. URL of the image, mandatory: clickable image;
    2. Display name of the URL when mouse goes over the image. Preceded by the underscore character ("_"), it is a text that will be translated. It remains enclosed by brackets "{}" if it is not translated.
  • attribute: URL

Exemples

  • [imgurl=http://forge.ryzom.com/wiki/ARCC_Expert_EN]http://app.ryzom.com//data/icons/32/emotion_tongue.png _The_ARCC[/imgurl]

displays:

The_ARCC

itemicon

itemicon displays a thumbnail of an item.

Paramètres

Exemples

  • [itemicon]teddyubo.sitem[/itemicon] or
  • [itemicon]teddyubo[/itemicon] displays: 0cf49e1620be972028c29a613d11ef2a.png

An anexistant or erroneous file such [itemicon]NoExist[/itemicon] displays : c37962969910e09734d859a89e32085c.png

link

link builds a internal link.

Settings

  • attribute
    • if "#", the text is the url name.
    • if empty, the text is a list of selected parameters in the script.

Exemples

We assume that the number of the script is 2124.

  • [link=#]A name for that link[/link] ⇒ displays a link with the name "A name for that link" to the URL http://app.ryzom.com/app_arcc/index.php?action=mScript_Edit&script=2124&select=0
  • [link]#A B Cl[/link] ⇒ displays the text (not a link) http://app.ryzom.com/app_arcc/index.php?action=mScript_Edit&script=2124&select=A+B+C

lua

lua passes the text to the Ryzom Lua interpreter.

Settings

  • text: Lua script.
  • attribute: None.

map

map displays a square map of 2000 units around a given point marked by a magenta flag.

Settings

  • text : name of a point (for instance city name) or Ryzom coordinates.
  • attribute: "flags" displays with green flags all outposts.

Exemples

Loria map

[map]18176,-29492[/map]

Pyr map

[map flags=markers]pyr[map]

math

math calculates basic calculations.

Settings

  • text : a basic calculations with the four arithmetical operators: +, -, *, /.
  • attribute: no significative.

Exemples

  • [math]1+2*3-4/6[/math] = 6.3333333333333
  • [math=toto][/math] and [math=toto]1+2*3-4/6t[/math] ⇒ no output
  • [math][func=round]6.45[/func][/math] = 6
  • [math][func=round]6.45[/func]*2[/math] = 12

param

Settings

  • text
  • attribute

Exemples

playerbackup

Settings

  • text :
  • attribute:

Exemples

playerinfos

playerinfos gives some informations concerning the player.

Settings

  • text: (general form: xxx|xxx|xxx) . One of the next keys: 'name', 'fullname', 'id', 'guild', 'guild_id', 'pvp_points', 'money', 'cid', 'gender' or 'api'.
    • next fields up to 2: values of that key if needed for api.
  • attribute:
    • Empty
    • #<name>
    • <name>

Exemples tested by Bepock

  • name: [playerinfos]name[/playerinfos] ⇒ Bepock (for instance)
  • fullname: [playerinfos]fullname[/playerinfos] ⇒ fullname: Bepock(Atys)
  • id: [playerinfos]id[/playerinfos] ⇒ 19089
  • guild: [playerinfos]guild[/playerinfos] ⇒ Animation
  • guild_id: [playerinfos]guild_id[/playerinfos] ⇒ 105906345
  • money: [lua][playerinfos]money[/playerinfos][/lua]
  • cid: [playerinfos]cid[/playerinfos] ⇒ 9765472
  • gender: [playerinfos]gender[/playerinfos] ⇒ 1 (male)

playerstat

Paramètres

  • text: (general form xxx|xxx|xxx)
  • attribute: None.

Exemples

post

Settings

  • text:
  • attribute: None.

Exemples

scriptinfos

scriptinfos displays the translations associated to a keyword if it exist in the language of the user (See also the "trad tool" of ARK).

Paramètres

  • text: (general form xxx|xxx|xxx)
  • attribute: None.

Exemples

scripturl

scripturl cats action, action number and extension to be send to the server.

Settings

  • text: add a PHP extension to the URL gift in the attribute.
  • attribute:
    • Nothing: current action number of the script.
    • Otherwise: first letter of the letter field if not "space". In that case add a "+".

Exemples

Launched from script 2088:

[scripturl]ryform_action=edit&ryform_name=stages%3A0[/scripturl] donne:
http://app.ryzom.com/app_arcc/index.php?action=script_Edit&script=2088&ryform_action=edit&ryform_name=stages%3A0

session

session is the simplest way to memorize data during the session, i.e. the connection. It offers also quicker answer, because it is a temporary memory not stored in the DB server.

It can be use also in some condition as a temporary array, when each Rows are named, because that is the internal behaviour of Session.

Settings

  • text: depends of the attribute.
  • attribute:
    • <empty> : text is the raw name of Session.
    • any raw name : save the text in the temporary memory of Session.

Exemples

  • Putting a value:
    • [session=Name_1]Name one[/session]
    • [session=Name_2]⇒Name two⇐[/session]
  • Getting the value stored in the session (connection)
    • Name_1 = [session]Name_1[/session] displays : "Name one"
    • Name_2 = [session]Name_2[/session] displays : "⇒Name two⇐"

t

t displays the translations associated to a keyword if it exist in the language of the user (See also the "trad tool" of ARK).

Paramètres

  • text: (general form xxx|xxx|xxx)
  • attribute: None.

Exemples

  • [t]yes[/t] ⇒ gives for French user "Oui"
  • [t]text[/t] ⇒ gives for French user "Texte"

But, because keyword is case sensitive:

  • [t]Yes[/t] ⇒ gives {Yes}
  • [t]Text[/t] ⇒ gives {Text}

timer

timer displays time in format "hh:mm:ss".

Settings

  • text: If empty or zero or "now()" gives the actual time in days_of_the_current_year:GMT_hour:minutes:seconds.
otherwise, treats the value in the text as number of seconds, and display the equivalent "hour:minutes:seconds.
  • attribute: None.

Exemples

  • [timer][/timer] or [timer]now()[/timer] or [timer]0[/timer] ⇒ 296:13:05:18
  • [timer]60[/timer] ⇒ 00:01:00
  • [timer]3600[/timer] ⇒ 01:00:00

trad

trad displays one of the translations associated to a keyword if it exist in the language of the user (See also the "trad tool" of ARK).

Settings

  • text: (general form: xxx|xxx|xxx, and internal xxx_xxx_xxx).
  • attribute: sens if text empty

Exemples

  • [trad]Hello[/trad] ⇒ displays the local translation
  • [trad=Hello][/trad] ⇒ displays the local translation

url

url is the standard way to pass an URL. That URL visually is formatted as usual in Ryzom.

Settings

  • text : URL or text to display
  • attribute:
    • if text=<empty>: URL;
    • else, text to be displayed: name, description... of the URL.

Exemples

  • [url]http://forge.ryzom.com/wiki/ARCC_Expert_EN[/url]
  • [url=http://forge.ryzom.com/wiki/ARCC_Expert_EN]The ARCC[/url]

validate

validate returns a link of the actual stage in the script.

Settings

  • text: name of the link
  • attribute:

Exemple

We assume that the number of the script is 2124.

[validate]==validate==[/validate] ⇒ displays a link with the name "==validate==" to the URL http://app.ryzom.com/app_arcc/index.php?action=mScript_Edit&script=2124&command_13=validate

Autre soutils de l'ARCC

←ARCC Guide EN

63 pages in ARCC

Ryzom Wiki: Ryzom Commons | DE • EN • ES • FR • RU | Ryzom Forge
Retrieved from "https://en.wiki.ryzom.com/wiki/Portal:Forge?from=/w/index.php?title=ARCC_Expert_EN&oldid=4898"