XmlTools/Full documentation: Difference between revisions

From OniGalore
Jump to navigation Jump to search
Line 263: Line 263:


===Description===
===Description===
This operation allows you to update all values in a set of existing XML elements. The values differences must be space separated and contained within quotes.
<tt>Usage: XmlTools --update-elements --diff-old-new-val "differences old-new values"</tt>


===Example===
===Example===
Let's say you want to use tanker forward throw to a new character. You know that your new character has higher pelvis than the tanker, so you need to update all the heights of tanker animation to match those of your new character.
We also know that difference between tanker animation (old value) and your character's (new value) is -0.7970685.
'''XmlTools command:'''
<pre>XmlTools --update-elements --diff-old-new-val "-0.7970685" --element-name "Height" --parent-element-name "Heights" --files "TRAMTANCOMthrow_fw.xml"</pre>
{| style="margin: 1em auto 1em auto;" <!-- Centers table -->
! style="width: 50%;" | XML Original
! style="width: 50%;" | XML After Command
|-
|
<Oni>
      <Animation>
            ...
            <Heights>
                  <Height><span style="color:blue">9.12794</span></Height>
                  <Height><span style="color:blue">9.25521</span></Height>
                  <Height><span style="color:blue">9.401095</span></Height>
                  <Height><span style="color:blue">9.556288</span></Height>
                  <Height><span style="color:blue">9.711483</span></Height>
                  <Height><span style="color:blue">9.857368</span></Height>
                  <Height><span style="color:blue">9.984637</span></Height>
                  <Height><span style="color:blue">10.0839806</span></Height>
                  ...
            <Heights>
            ...
      </Animation>
</Oni>
|
<Oni>
      <Animation>
            ...
            <Heights>
                  <Height><span style="color:red">9.9250085</span></Height>
                  <Height><span style="color:red">10.0522785</span></Height>
                  <Height><span style="color:red">10.1981635</span></Height>
                  <Height><span style="color:red">10.3533565</span></Height>
                  <Height><span style="color:red">10.5085515</span></Height>
                  <Height><span style="color:red">10.6544365</span></Height>
                  <Height><span style="color:red">10.7817055</span></Height>
                  <Height><span style="color:red">10.8810491</span></Height>
                  ...
            <Heights>
            ...
      </Animation>
</Oni>
|}


==--invert-elements==
==--invert-elements==

Revision as of 21:27, 8 February 2014

WARNING

THIS PAGE IS CURRENTLY BEING UPDATED TO THE NEW VERSION OF XMLTOOLS.


PLEASE WAIT UNTIL IS FINISHED BEFORE USING ITS DOCUMENTATION.

Overview

This page describes all XmlTools options with examples. It is needed to avoid too much content in the XmlTools main page.

Command-line operations

Overview

--add-values

Description

This operation allows you to add new XML values to existing XML elements. The values should be space separated and contained within quotes.

Usage: XmlTools --add-values --new-val "new values"

Example

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


XmlTools command: 

XmlTools --add-values --new-val "Unkillable NonCombatant" --xpath-expression "/Oni/Objects/CHAR[@Id='3926']/OSD/Flags" --files "BINACJBOCharacter.xml"
XML Original XML After Command 
<Oni>
     <Objects>
           <CHAR Id="3926">
                 <Header>
                 <Flags />
                 <Position>-37.3426628 756 -491.6369</Position>
                 <Rotation>0 221.15564 0</Rotation>
                 </Header>
                 <OSD>
                       <Flags>NotInitiallyPresent</Flags>
                       <Class>TCTF_lite_1</Class>
                       <Name>A_L18</Name>
                       <Weapon>w8_mbo</Weapon>
                 ...
                 </OSD>
           </CHAR>
     ...
     </Objects>
</Oni>

<Oni>
     <Objects>
           <CHAR Id="3926">
                 <Header>
                 <Flags />
                 <Position>-37.3426628 756 -491.6369</Position>
                 <Rotation>0 221.15564 0</Rotation>
                 </Header>
                 <OSD>
                       <Flags>NotInitiallyPresent Unkillable NonCombatant</Flags>
                       <Class>TCTF_lite_1</Class>
                       <Name>A_L18</Name>
                       <Weapon>w8_mbo</Weapon>
                 ...
                 </OSD>
           </CHAR>
     ...
     </Objects>
</Oni>

--remove-values

Description

This operation allows you to remove XML values from existing XML elements. The values to remove should be space separated and contained within quotes.

Usage: XmlTools --remove-values --current-val "current values to remove"

Example

Let's say you want to remove the UpgradeDifficulty and InfiniteAmmo flags from D_S82 character.


XmlTools command: 

XmlTools --remove-values --current-val "UpgradeDifficulty InfiniteAmmo" --xpath-expression "/Oni/Objects/CHAR[@Id='7643']/OSD/Flags" --files "BINACJBOCharacter.xml"
XML Original XML After Command 
<Oni>
     <Objects>
           <CHAR Id="7643">
                 <Header>
                 <Flags />
                 <Position>173.626175 0 36.94594</Position>
                 <Rotation>0 134.847549 0</Rotation>
                 </Header>
                 <OSD>
                       <Flags>NotInitiallyPresent UpgradeDifficulty InfiniteAmmo</Flags>
                       <ClassTCTF_swat_1</Class>
                       <Name>D_S82</Name>
                       <Weapon>w3_phr</Weapon>
                 ...
                 </OSD>
           </CHAR>
     ...
     </Objects>
</Oni>

<Oni>
     <Objects>
           <CHAR Id="7643">
                 <Header>
                 <Flags />
                 <Position>173.626175 0 36.94594</Position>
                 <Rotation>0 134.847549 0</Rotation>
                 </Header>
                 <OSD>
                       <Flags>NotInitiallyPresent</Flags>
                       <ClassTCTF_swat_1</Class>
                       <Name>D_S82</Name>
                       <Weapon>w3_phr</Weapon>
                 ...
                 </OSD>
           </CHAR>
     ...
     </Objects>
</Oni>

--replace-value

Description

This operation allows you to replace 1 XML value from existing XML elements.

Usage: XmlTools --replace-value --current-val "currentValue" --new-val "newValue"

Example

Let's say you want to swap all the w1_tap weapons from characters to w8_mbo.


XmlTools command: 

XmlTools --replace-value --current-val "w1_tap" --new-val "w8_mbo" --element-name "Weapon" --parent-element-name "OSD" --files "BINACJBOCharacter.xml"
XML Original XML After Command 
<Oni>
     <Objects>
           <CHAR Id="7209">
                 <Header>
                 <Flags />
                 <Position>434.9334 756 -231.2183</Position>
                 <Rotation>0 258.058838 0</Rotation>
                 </Header>
                 <OSD>
                       <Flags>NotInitiallyPresent</Flags>
                       <Class>TCTF_lite_1</Class>
                       <Name>l7</Name>
                       <Weapon>w1_tap</Weapon>
                 ...
                 </OSD>
           </CHAR>
     ...
     </Objects>
</Oni>

<Oni>
     <Objects>
           <CHAR Id="7209">
                 <Header>
                 <Flags />
                 <Position>434.9334 756 -231.2183</Position>
                 <Rotation>0 258.058838 0</Rotation>
                 </Header>
                 <OSD>
                       <Flags>NotInitiallyPresent</Flags>
                       <Class>TCTF_lite_1</Class>
                       <Name>l7</Name>
                       <Weapon>w8_mbo</Weapon>
                 ...
                 </OSD>
           </CHAR>
     ...
     </Objects>
</Oni>

--replace-all-values

Description

This operation allows you to replace all the XML values from existing XML elements. The new values should be space separated and contained within quotes.

Usage: XmlTools --replace-all-values --new-val "new values"

Example

Let's say you want to replace all the flags in all characters by InfiniteAmmo and NotInitiallyPresent flags.


XmlTools command: 

XmlTools --replace-all-values --new-val "NotInitiallyPresent InfiniteAmmo" --element-name "Flags" --parent-element-name "OSD" --files "BINACJBOCharacter.xml"
XML Original XML After Command 
<Oni>
     <Objects>
           <CHAR Id="7643">
                 <Header>
                 <Flags />
                 <Position>173.626175 0 36.94594</Position>
                 <Rotation>0 134.847549 0</Rotation>
                 </Header>
                 <OSD>
                       <Flags>NoAutoDrop UpgradeDifficulty CanSpawnMultiple</Flags>
                       <ClassTCTF_swat_1</Class>
                       <Name>D_S82</Name>
                       <Weapon>w3_phr</Weapon>
                 ...
                 </OSD>
           </CHAR>
     ...
     </Objects>
</Oni>

<Oni>
     <Objects>
           <CHAR Id="7643">
                 <Header>
                 <Flags />
                 <Position>173.626175 0 36.94594</Position>
                 <Rotation>0 134.847549 0</Rotation>
                 </Header>
                 <OSD>
                       <Flags>NotInitiallyPresent InfiniteAmmo</Flags>
                       <ClassTCTF_swat_1</Class>
                       <Name>D_S82</Name>
                       <Weapon>w3_phr</Weapon>
                 ...
                 </OSD>
           </CHAR>
     ...
     </Objects>
</Oni>

--update-elements

Description

This operation allows you to update all values in a set of existing XML elements. The values differences must be space separated and contained within quotes.

Usage: XmlTools --update-elements --diff-old-new-val "differences old-new values"

Example

Let's say you want to use tanker forward throw to a new character. You know that your new character has higher pelvis than the tanker, so you need to update all the heights of tanker animation to match those of your new character.

We also know that difference between tanker animation (old value) and your character's (new value) is -0.7970685.


XmlTools command: 

XmlTools --update-elements --diff-old-new-val "-0.7970685" --element-name "Height" --parent-element-name "Heights" --files "TRAMTANCOMthrow_fw.xml"
XML Original XML After Command 
<Oni>
     <Animation>
           ...
           <Heights>
                 <Height>9.12794</Height>
                 <Height>9.25521</Height>
                 <Height>9.401095</Height>
                 <Height>9.556288</Height>
                 <Height>9.711483</Height>
                 <Height>9.857368</Height>
                 <Height>9.984637</Height>
                 <Height>10.0839806</Height>
                 ...
           <Heights>
           ...
     </Animation>
</Oni>

<Oni>
     <Animation>
           ...
           <Heights>
                 <Height>9.9250085</Height>
                 <Height>10.0522785</Height>
                 <Height>10.1981635</Height>
                 <Height>10.3533565</Height>
                 <Height>10.5085515</Height>
                 <Height>10.6544365</Height>
                 <Height>10.7817055</Height>
                 <Height>10.8810491</Height>
                 ...
           <Heights>
           ...
     </Animation>
</Oni>

--invert-elements

Description

Example

Patch file operations

Overview

@XML_TOOLS

Description

Example

@ADD_INSIDE_NODES

Description

Example

Retrieved from "https://wiki.oni2.net/w/index.php?title=XmlTools/Full_documentation&oldid=23056"