• Volume I : Quick Start Guide - Volume II : quick Archives
• Volume II : User guide - Volume II : User guide Archives
• Volume III: Advanced user guide - Volume II : expert Archives

Amosys (talk to Amosys on wiki) (On RC pj-ryzom_wiki) 23:41, 1 June 2019 (CEST)

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:

---

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:

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

---

itemicon

itemicon displays a thumbnail of an item.

Paramètres

• text: the item (SITEM file)
• attribute: None.

Exemples

• [itemicon]teddyubo.sitem[/itemicon] or
• [itemicon]teddyubo[/itemicon] displays:

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

---

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

---

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

• See also date.

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

• Traduction automatique

←ARCC Guide EN There are currently 0 elements in the category ARCC.