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)

Migration

Please use the migrated document at URL shown below.

function name

This function has only one parameter: the name.

The name of all functions is always initiated by a single code, but it can be modified to facilitate the writing and reading of the script, for example, and especially when the function can be called by another, including jumps and connections . (Here the function was renamed "Terminator").

Migration

Please use the migrated document at URL shown below.

weAJump_V2

The only parameter to provide is the function that will be executed next.

Include →

Function name : lInclude_v4

This function allows you to call another script for the event and after back to proccessing other stages.

WeAInclude

• 1) [expert] Reset scripts to be run (Yes / No)
• 2) Name of the script to run.

While →

Function name : weAWhile

Window (webig windows management) →

Function name : weAWindow_v3

This feature allows you to manage dialogs (open / close, size and position)

WeAWindow IG

WeAWindow ARCC

• 1) Execute action : (Activate/Close). Used to open a new window or close an existing one (see below).
• 2) Resize : (Yes / No) If yes, use the values ​​in W(3) et H(4) .
• 3) W : Width in pixels (In the example of the IG window, the value is 400)
• 4) H : Height in pixels (In the example of the IG window, the value is 300)
• 5) Move : (Yes / No) If yes, use the values ​​in X(6) et Y(7) . These values ​​are in percent relatively to the dimensions of the window Ryzom.
• 6) X en %: Relative position in X, 100% box on the right (Like here, in the example of the IG window).
• 7) Y en %: Relative position in Y, 100 % box on the top. (In the example of the IG window, the value 50 % put de box in the middle)
• 8) [expert] Webig window. The default is "Current" in basic mode. This setting determines what kind of WebIG window has to be controlled.

→ BBCode :

→$_GET[« current_window »] :

→ Webig: Is the window that opens when you do <shift> + w. This is the one that displays web apps

→ Browse Npc: Is the window that opens when talking to an NPC. So this is the one that opens when you link a script to an NPC.

→ Web Transaction: This is a hidden window that receives responses from the server. The player should never see.

• 9) windowTitle : The title of the window when that last one is visible.

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

Nom interne de la fonction : weADisplayIgMessage

WeADisplayIgMessage IG

This function allows you to post messages in chat channels (2).

Note that the use of the traduction allows you to have the text in the language of the player. For the key "Blade Runner", the text in English here is: "We call it Voight-Kampff for short" as shown in the IG picture.

WeADisplayIgMessagewindow

The following table lists the characteristics of the choice of channels offered by the function (4).

ShapeManager →

Function name : weAShapeManager_v2

WeAShapeManager IG

WeAShapeManager allows to pop objects in Ryzom. Here, a magic bag back appears levitating above the character.

WeAShapeManager Main Window

• 1) clear
• 2) shapes: Any quantity of objects may be added. They are described below:
• 3) [commun] The internal name of the function. This name is useful for jumps, loops ...

• shape: <an_object>.ps
• shapeName: Name given to the object.
• shapeUrl: THIS&bag
• texture:
• posX: X absolute position in the map of Ryzom.
• posY: Y absolute position in the map of Ryzom.
• posZ: Z absolute position in the map of Ryzom.
• posA: Angle around Z axis.
• scale: Default = 1.

Database (Save value in the database) →

Function name : weADatabase_v2

This function is used to store information in a usable local DB thereafter in the same script or another in the same event. It can also increment the numerical values.

It is best to use the assisted edition mode in a first step, as viewed here.

WeADatabase window

• 1) Database name : for the whole the event, Omega, in the example.
• 2) databaseRow : Khi, in the example.
• 3) databaseId : player, guild, arcc, civ, cult, org, race.
• 4) Conversion method : (setvalue/addvalue) : there are two modes of insertion into the database, or overwriting the previous contents or by adding another algebraic value.

• 5) param : may be different static values ​​recovered from elsewhere or calculated. Those are:

• A Blank or an <empty>. In calculation, the "empty" may be equated with "zero."
• A Constant: "-1" in "Addvalue" mode creates a decrement.
• A common parameter to the event : [param]Max_player_bag[/param] or [session]LocalTemporaryData[/session]
• A value contained in another database : [db=Player_Bag]Last[/db]
• A function : [func]now[/func]
• A calculation :

Migration

Please use the migrated document at URL shown below.

Migration

Please use the migrated document at URL shown below.

WeADeleteItems script window

• 1) Deleted items: Here a soft toy. Sheet description of the object is identical to that used for ReceiveItems (Player received item)
• 2) Several object may be added. You need at least one. ([commun] tool for multi sub-selections)
• 3) inventory: From where the object will be removed: the bag, the house, the guild hall, an animal (mektoub riding or pack) or a temporary location.
• 4) random (Yes / No): (Respectively, to what?)
• 5) [common] The internal name of the function. This name is useful for jumps, loops ...
• 6) Parameters: created by the function.

Migration

Please use the migrated document at URL shown below.

Not checked

weANpcManager window

• 1) groupName
• 2) hmagicActions: List of hmagicActions for the NPC. ([commun] tool for multi sub-selections)
• 3)  [commun] The internal name of the function. This name is useful for jumps, loops ...

Migration

Please use the migrated document at URL shown below.

WeHMagic Window

• 1) hmagicActions List ([commun] tool for multi sub-selections)
• 2) Every hmagicActions is editable. ([commun] tool for multi sub-selections)
• 3) One can add a new hmagicActions behind each one or at the and of the list. ([commun] tool for multi sub-selections)
• 4) hmagicActions can be reordered. ([commun] tool for multi sub-selections)

• 6) valideAction:action to be performed if Hmagic is validated. The choices are the same as those proposed by the Jump.
• 7) failAction:action to be performed if Hmagic is not validated. The choices are the same as those proposed by the Jump.
• 8) [commun] Internal name of the function. This name is used especially for jumps, loops ...

Migration

Please use the migrated document at URL shown below.

weCDatas window

• 1) Left value to be checked.
• 2) Kind of test (==, !=, <, >, <=, >=)
• 3) Right value of the test
• 4) Action if the test is "True".
• 5) Action if the test is "False".
• 6)  [commun] Internal name of the function. This name is used especially for jumps, loops ...

Migration

Please use the migrated document at URL shown below.

WeCSwitch window

• 1) Left value to be checked.
• 2) Kind of test (==, !=, <, >, <=, >=)
• 3) Right value of the test
• 4) Action if the test is "True". The last line gives the default action, ie when all the previous tests were given "False".
• 5) [commun] Internal name of the function. This name is used especially for jumps, loops ...

Migration

Please use the migrated document at URL shown below.

WeCDatabase window

• 1) Database name : the event of a base (omega in the example).
• 2) databaseRow : a base row (omega, in the example)
• 3) databaseId : (global, player, guild)
• 4) testFunction: Kind of test (==, !=, <, >, <=, >=)
• 5) testValue: Right value of the test
• 6) valideAction: Action if the test is "True".
• 7) failAction: Action if the test is "False".
• 8) [commun] Internal name of the function. This name is used especially for jumps, loops ...

WeCPlayerInfos window

• 1) checks: A list of tests that will be performed in this step added by the "plus" icon. ([commun] tool for multi sub-selections)
• 2) valideAction: Action to do if all the tests are validated (True).
• 3) failAction: Action to do if at least one test is not validated (False).
• 4) resetScriptIfFailed: (Yes / No) Resetting the script if failure (at least one test is not validated).
• 5) openWindow: Window to be open to display the tests results. (None, WebIG, Browse NPC, Web Transaction).
• 6) hiddenWindow (Yes / No)
• 7) [commun] Internal name of the function. This name is used especially for jumps, loops ...

Migration

Please use the migrated document at URL shown below.

weGPlayerInfos window

• 1) info (target, targetPos, playerPos)
• 2) [commun] Internal name of the function. This name is used especially for jumps, loops ...

Migration

Please use the migrated document at URL shown below.

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

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.

Migration

Please use the migrated document at URL shown below.

WeSNpcDialog IG

This bubble are composed of two parts.

• The upper part contains an introductory text, which can be a lengthy monologue.
• The lower part contains a set of choices that enchaîneront other actions.

WeSNpcDialog window

• 1) Note that this feature enables a parameter weSNpcDialog_v2_1rpqpga2:SELECTED which returns the number of the user's choice.
• 2) {npcRowId}
• 3) This field contains the top part of the bubble. Message can be relatively long.
• 4) This field contains 8 choices available to players.
• 5) Each option can lead to a specific action.

• 5.1) The right column gives the displaying question. Using the translation tool can adapt a text for each languages of Ryzom.

If the all field is empty, there are no question in the bubble. (but how to chain to a second bubble?)

WeSNpcDialog window

• 5.2) The left column displays the actions arising from the choice of the players.

Actions are divided into:

• 5.2.1) none
• 5.2.2) resume or finish de script
• 5.2.3) open or finish the URL
• 5.2.4) jump to a stage (only after the current step as the Jump function)
• 5.2.5) run script
• 5.2.6) include script (same as Include function)

• 6) luaCheck

Migration

Please use the migrated document at URL shown below.

Timer IG

This function triggers a countdown displayed at the top of the IG window showed by filling the arrow.

Timer Window

• 1) seconds: Time countdown in seconds
• 2) abortWhenMove: Cancel action if the player moves: (Yes / No)
• 3) [commun] Internal name of the function. This name is used especially for jumps, loops ...

Migration

Please use the migrated document at URL shown below.

Mission IG

This function allows you to create missions like this.The NPC announcing the action "Replicant Kitin Eradicator", gave the mission "Eradication Mission" which is "You have to kill goo-kitins, now!".

Mission main window

• 1) Selection of a mission.
• 2) icon, name and description of the mission.
• 3) count
• 4)  [commun] Internal name of the function. This name is used especially for jumps, loops ...

Migration

Please use the migrated document at URL shown below.

Mission IG

This function allows you to sell specific objects to players. Here the NPC sell four potions for free (0 dappers). The Itemshop allows only to buy one type of item at a time.

WeSItemshopScript main window

• 1) item: Selection of a type of item.
• 2) icon, name and description of the item.
• 3) price
• 4) timer: delay to buy another item.
• 5) currency (money/pvp_points)
• 6) saveInDatabaseId: some specifc data and/or DB for that???
• 7) valideAction: Next action if the item was bought out.
• 8) openWindow: window to be open to display the tests results. (None, WebIG, Browse NPC, Web Transaction).
• 9) [commun] Internal name of the function. This name is used especially for jumps, loops ...