XmlTools/Full documentation: Difference between revisions

This page lists all XmlTools commands with examples. It is the full version of the summary of XmlTools options found on the [[XmlTools|main page]]. The main page also offers a beginner's guide to this program's syntax and links to pages that explain the concepts behind XML modding.

Oni's game data contains various bitsets that are used to indicate the on/off status of attributes that can pertain to that object. For instance, characters in the game can have various flags such as Unkillable turned on for them. In OniSplit's XML output of this data, the flags are given names and listed within quotes as a single string. --add-values and --remove-values were designed to edit these XML representations of bitsets.

Let's say you want to add the Unkillable and the NonCombatant flag to the character A_L18.

Let's say you have a level built in a 3D modeling program and you have already set the positions in the BINACBJOCharacter file for all the characters that are to be spawned during the gameplay. However, for some reason you need to change the position of the level in the modeling program, which means that the character spawn locations are now incorrect. --update-elements provides the way to correct them.

Let's say that you know that the difference between the old level's position and the new level's position is, in Oni's world units, {130, 80, 0} (in x, y, z order).

Let's say you want to invert the helicopter animation from Oni's final level. If you notice, in that level the helicopter comes up from below to land on the satellite dish platform, and then it goes down again. If we invert the helicopter animation, it will come down from above, and then go back up again (which is exactly what was done in the Old China mod).

XmlTools has a special set of commands that can be listed within a plain-text file to be executed all at once. One of these commands allows you to use any of the above command-line operations, and another command allows you to use JavaScript to modify the XML (for especially complex situations).

This operation allows to specify options related with the XmlTools program. Currently only allows to specify the minimum XmlTools version necessary to apply the patch file.

Note that by "2.0" it means that it is also compatible with XmlTools 2.0a, 2.0b etc.

This operation allows to insert new XML inside existing XML nodes. The XML to insert must be contained between <tt><xml></tt> and <tt></xml></tt> tags as seen bellow.

Let's say your want do add a new glass particle to the SWAT Griffin ONCC.

! style="width: 50%;" | XML Original

! style="width: 50%;" | XML After Command

This operation allows to remove existing XML nodes.

Let's say your want do remove the glass particle from the SWAT Griffin ONCC.

! style="width: 50%;" | XML Original

! style="width: 50%;" | XML After Command

This operation allows you to use any of the [[XmlTools#Command-line_operations|command line operations]] in a patch file.

Note: For command line input operations which use quotes ("") replace the double quotes with single quotes (<nowiki>''</nowiki>). If any XPath expression also includes single quotes you can double them to allow XmlTools to process the command.

Let's say your want to perform the same operation in [[#Example|--add-values example]]. This operation adds the Unkillable and the NonCombatant flag to A_L18 character.

Note that in the XPath expression we replace each single quote by two single quotes (allows XmlTools differentiate from the other single quotes around command line options).

The resulting XML file is exactly the same of [[#Example|--add-values example]].

This operation allows you to use [[wikipedia:JavaScript|JavaScript]] to edit XML.  

 

You can use this for complex logics and mathematical operations which aren't supported in other native operations.

 

<u>You should only use this option as '''last resort'''</u> if you are using it for [[Anniversary_Edition/Framework#XML_patching|AE Patches]], because it is '''MUCH slower''' than all the other native options. Try <u>maintain your code as optimized as possible</u>, as the user code also highly affects the XmlTools performance while applying the patch.

You can exit prematurely from the JavaScript code using the <tt>return</tt> keyword. It is also possible output JavaScript variables to the console using the echo function: <tt>echo(var);</tt>. This function allows you to debug the code that you develop.

The <tt>$xmlData</tt> global variable contains the XML of the current file. After you modify the XML, update this variable again with the new XML in order to XmlTools update correctly the file.

XmlTools uses the [http://www.petetracey.com/jsxml/index.html JSXML XML Tools] JavaScript libraries to allow you to edit the XML. You can read it documentation in its [http://www.petetracey.com/jsxml/documentation.html website] or [http://script10k.oni2.net/documentation/xmltools/jsxml-documentation.htm here].

Let's say your want to add one additional ammo and cell to all characters that are from TCTF team.

       for (var i=0; (charactersNode.childElement(i)); i++){ <span style="color:green">// the condition checks if the ith element exists (!= undefined)</span>

               <span style="color:green">// Check if it is TCTF</span>

                     <span style="color:green">// Add +1 to the current amount of ammo and cells to use</span>

       $xmlData=myBuilder.generateXML(); <span style="color:green">// update the global variable with the new XML</span>

! style="width: 50%;" | XML Original

! style="width: 50%;" | XML After Command