Difference between revisions of "Modding Tutorials/PatchOperations"

From RimWorld Wiki
Jump to navigation Jump to search
(Overhaul pass with custom styling and transclusions)
(→‎Extenuating circumstances for "Success": Fixed broken code using the PRE box)
 
(19 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 +
{{DISPLAYTITLE:PatchOperations}}
 
{{BackToTutorials}}
 
{{BackToTutorials}}
  
 
PatchOperations are a feature that allows you to modify the content of XML Defs. Prior to RimWorld alpha 17, modders could only modify Defs by creating new ones that overwrote the original; this often resulted in compatibility issues as if more than one mod tried to overwrite the same Def, only the last mod in the load order would succeed as prior ones would themselves be overwritten.
 
PatchOperations are a feature that allows you to modify the content of XML Defs. Prior to RimWorld alpha 17, modders could only modify Defs by creating new ones that overwrote the original; this often resulted in compatibility issues as if more than one mod tried to overwrite the same Def, only the last mod in the load order would succeed as prior ones would themselves be overwritten.
  
−
<div style="float: right;">
+
<div class="TableOfContentsContainer">
 +
<div class="TableOfContentsContainer-toc">
 
__TOC__
 
__TOC__
 
</div>
 
</div>
 +
<div class="TableOfContentsContainer-content">
 
= Basics =
 
= Basics =
  
Line 18: Line 21:
 
</source>
 
</source>
  
−
Just as with XML Defs, folder and file names do not matter and you can freely name and organize your patche files in whatever manner you wish. Individual patches themselves are a standard XML file with <tt><Patch></tt> as the root tag:
+
Just as with XML Defs, folder and file names do not matter and you can freely name and organize your patch files in whatever manner you wish. Individual patches themselves are a standard XML file with <tt><Patch></tt> as the root tag:
  
 
<source lang="xml">
 
<source lang="xml">
Line 30: Line 33:
  
 
== XPath ==
 
== XPath ==
−
Most PatchOperations must be targeted at one or more XML nodes inside the master XML document. This is done via [https://developer.mozilla.org/en-US/docs/Web/XPath XML Patch Language] or XPath.
+
Most PatchOperations must be targeted at one or more XML nodes inside the master XML document. This is done via [https://developer.mozilla.org/en-US/docs/Web/XPath XML Path Language] or XPath.
  
 
Note that an XPath is targeting the structure of the XML document after it's been parsed by RimWorld's parser, thus it has nothing to do with the actual file or folder paths. For example, if you wanted to add a stat value to the vanilla Wall building, you might use an XPath like so:
 
Note that an XPath is targeting the structure of the XML document after it's been parsed by RimWorld's parser, thus it has nothing to do with the actual file or folder paths. For example, if you wanted to add a stat value to the vanilla Wall building, you might use an XPath like so:
Line 36: Line 39:
 
<code>Defs/ThingDef[defName="Wall"]/statBases</code>
 
<code>Defs/ThingDef[defName="Wall"]/statBases</code>
  
−
* The first segment of any XPath targeting an XML Def will be <tt>Defs/</tt> as all XML Defs use the <tt><Defs></tt> root tag.
+
* The first segment of any XPath targeting an XML Def will be <code>Defs/</code> as all XML Defs use the <code><Defs></code> root tag.
−
* The square brackets denote a predicate, or conditional match. In this case, we are looking for <tt>ThingDef</tt>s that have a child tag <tt>defName</tt> equal to "Wall".
+
* The square brackets denote a predicate, or conditional match. In this case, we are looking for <code>ThingDef</code>s that have a child tag <code>defName</code> equal to "Wall".
  
−
You can target Defs that do not have a <tt>defName</tt> (such as abstract bases) by targeting their identifying attributes. For example, if you wanted to add another Stuff category to the abstract base Def for all shelves, you might use the following xpath:
+
=== Targeting Attributes ===
 +
 
 +
You can target Defs that do not have a <code>defName</code> (such as abstract bases) by targeting their identifying attributes. For example, if you wanted to add another Stuff category to the abstract base Def for all shelves, you might use the following xpath:
  
 
<code>Defs/ThingDef[@Name="ShelfBase"]/stuffCategories</code>
 
<code>Defs/ThingDef[@Name="ShelfBase"]/stuffCategories</code>
  
−
Additional XPath resources:
+
You can use the same technique to target all Defs that inherit from a common base. For example, you could use the following xpath to target all <code>ThingDef</code>s that inherit from <code>ApparelBase</code>:
−
* Ludeon Forum Thread: {{LudeonThread|32785}}
+
 
 +
<code>Defs/ThingDef[@ParentName="ApparelBase"]</code>
 +
 
 +
=== Additional XPath Resources ===
 +
 
 +
* [https://developer.mozilla.org/en-US/docs/Web/XPath Mozilla Developer Network]
 
* [https://www.w3schools.com/xml/xml_xpath.asp W3Schools XPath Tutorial]
 
* [https://www.w3schools.com/xml/xml_xpath.asp W3Schools XPath Tutorial]
 
* [https://stackoverflow.com/questions/tagged/xpath StackOverflow XPath Tag]
 
* [https://stackoverflow.com/questions/tagged/xpath StackOverflow XPath Tag]
 +
* Ludeon Forum Thread: {{LudeonThread|32785}}
 +
</div>
 +
</div>
  
 
= PatchOperation Types =
 
= PatchOperation Types =
Line 87: Line 100:
  
 
==PatchOperationAdd==
 
==PatchOperationAdd==
−
Inserts the specified <code>value</code>s as a child node of the XML nodes targeted by the operation's <code>xpath</code>. By default, the new nodes will be inserted after (appended to) any existing child nodes. You can use <code><order>Prepend</order></code> in the patch operation (order is Append by default).
+
Inserts the specified <code>value</code>s as a child node of the XML nodes targeted by the operation's <code>xpath</code>. By default, the new nodes will be inserted after any existing child nodes (<code>Append</code>). You can use <code><order>Prepend</order></code> in the patch operation to insert them before existing child nodes instead.
  
 
Note: PatchOperationAdd will not overwrite any existing tags. If one of your <code>value</code>s overlaps with an existing node and you are not targeting a list node, then it will cause an error on game load.
 
Note: PatchOperationAdd will not overwrite any existing tags. If one of your <code>value</code>s overlaps with an existing node and you are not targeting a list node, then it will cause an error on game load.
Line 410: Line 423:
 
   <value>
 
   <value>
 
     <li Class="MyNamespace.MyModExtension">
 
     <li Class="MyNamespace.MyModExtension">
−
       <key>Value</exampleValue>
+
       <key>Value</key>
 
     </li>
 
     </li>
 
   </value>
 
   </value>
Line 423: Line 436:
 
   <modExtensions>
 
   <modExtensions>
 
     <li Class="MyNamespace.MyModExtension">
 
     <li Class="MyNamespace.MyModExtension">
−
       <key>Value</exampleValue>
+
       <key>Value</key>
 
     </li>
 
     </li>
 
   </modExtensions>
 
   </modExtensions>
Line 515: Line 528:
 
</source>
 
</source>
  
−
As mentioned, you can use {{Modding_Tutorials/MayRequire}} on child operations of a PatchOperationSequence, but you should test them individually before adding them to said Sequence:
+
As mentioned, you can use [[Modding_Tutorials/MayRequire|MayRequire]] on child operations of a PatchOperationSequence, but you should test them individually before adding them to said Sequence:
  
 
<source lang="xml">
 
<source lang="xml">
Line 521: Line 534:
 
   <operations>
 
   <operations>
 
     <li Class="PatchOperationAdd" MayRequire="Ludeon.Rimworld.Biotech"> <!-- Only runs if Biotech is active -->
 
     <li Class="PatchOperationAdd" MayRequire="Ludeon.Rimworld.Biotech"> <!-- Only runs if Biotech is active -->
−
       <xpath>Defs/ThingDef[defName="MechGestator"]/recipes<xpath>
+
       <xpath>Defs/ThingDef[defName="MechGestator"]/recipes</xpath>
 
       <value>
 
       <value>
 
         <li>MyCustomMech</li>
 
         <li>MyCustomMech</li>
Line 541: Line 554:
  
 
'''WARNING''': Unlike all other mod-compatibility features in RimWorld, PatchOperationFindMod uses the mod ''name'' and not its <code>packageId</code>.
 
'''WARNING''': Unlike all other mod-compatibility features in RimWorld, PatchOperationFindMod uses the mod ''name'' and not its <code>packageId</code>.
 +
 +
'''NOTE''': For expansions, PatchOperationFindMod uses the <code>label</code> value defined in the <code>ExpansionDef</code> for the DLC.  At present, this means they are identified by just their single word names: Royalty, Ideology, Biotech, Anomaly.
 +
 +
'''NOTE''': PatchOperationFindMod should only be used if you are implementing ''optional'' compatibility for the target mod, i.e. if your mod can work with or without the mod in question. If you are creating a compatibility mod specifically for a target mod that would be meaningless without that mod present, then it's better to simply specify that mod in your About.xml as a dependency and forgo the use of PatchOperationFindMod and avoid the potential issues introduced by using PatchOperationSequence.
  
 
The following example adds a mod extension to the targeted Defs if RimQuest is loaded ([https://github.com/Mehni/MoreFactionInteraction/blob/ab3ab2a22ee529ee4e38a471fe150fd48fd07ce9/Patches/MoreFactionInteraction.xml#L64 See original]):
 
The following example adds a mod extension to the targeted Defs if RimQuest is loaded ([https://github.com/Mehni/MoreFactionInteraction/blob/ab3ab2a22ee529ee4e38a471fe150fd48fd07ce9/Patches/MoreFactionInteraction.xml#L64 See original]):
Line 644: Line 661:
  
 
A tutorial for this process does not exist yet, but you can check out the following references of custom PatchOperations:
 
A tutorial for this process does not exist yet, but you can check out the following references of custom PatchOperations:
−
9 [https://github.com/15adhami/XmlExtensions XML Extensions] - An entire framework mod containing many useful custom PatchOperations.
+
* [https://github.com/15adhami/XmlExtensions XML Extensions] - An entire framework mod containing many useful custom PatchOperations.
−
- [https://github.com/CombatExtended-Continued/CombatExtended/blob/Development/Source/CombatExtended/CombatExtended/PatchOperationMakeGunCECompatible.cs PatchOperationMakeGunCECompatible] - Used by Combat Extended to automatically apply multiple changes to a single firearm for compatibility.
+
* [https://github.com/CombatExtended-Continued/CombatExtended/blob/Development/Source/CombatExtended/CombatExtended/PatchOperationMakeGunCECompatible.cs PatchOperationMakeGunCECompatible] - Used by Combat Extended to automatically apply multiple changes to a single firearm for compatibility.
−
- [https://gist.github.com/Lanilor/e326e33e268e78f68a2f5cd3cdbbe8c0 PatchOperationAddOrReplace] - An example of a custom variant of PatchOperationAdd that replaces an existing value.</br>
+
* [https://gist.github.com/Lanilor/e326e33e268e78f68a2f5cd3cdbbe8c0 PatchOperationAddOrReplace] - An example of a custom variant of PatchOperationAdd that replaces an existing value.</br>
  
 
== "Success" Option ==
 
== "Success" Option ==
Line 657: Line 674:
 
* Always - This patch operation always succeeds, i.e. it suppresses all errors that might have occurred. This used to be used in PatchOperationSequence along with PatchOperationTest in order to conditionally run patches, but is now obsolete.
 
* Always - This patch operation always succeeds, i.e. it suppresses all errors that might have occurred. This used to be used in PatchOperationSequence along with PatchOperationTest in order to conditionally run patches, but is now obsolete.
 
* Normal - Errors are handled normally
 
* Normal - Errors are handled normally
−
* Invert - Errors are considered a success and success is considered a failure. This used to be used in PatchOperationSequences to test the negative of a PatchOperationTest; you should now use <code><nomatch></code> on PatchOperationConditional
+
* Invert - Errors are considered a success and success is considered a failure. This used to be used in PatchOperationSequences to test the negative of a PatchOperationTest; you should now use <code><nomatch></code> on PatchOperationConditional.
 
* Never - This patch operation always fails. Generally only used in testing to see if a Sequence is working correctly, should never be used in published mods.
 
* Never - This patch operation always fails. Generally only used in testing to see if a Sequence is working correctly, should never be used in published mods.
 +
 +
=== Extenuating circumstances for "Success" ===
 +
There are, in very specific circumstances, a valid reason to use a <code><success>Always</success></code> statement.
 +
 +
For instance, consider the following opening lines for a Patch: <pre>
 +
<Operation Class="PatchOperationConditional">
 +
<xpath>/Defs/JoyKindDef[defName="Sierra_Drinking_Milkshake"]</xpath>
 +
<match Class="PatchOperationReplace">
 +
<success">Always</success>
 +
<xpath>/Defs/ThingDef[defName = "Laban" or defName = "AmbrosiaLaban" or defName = "ChocolateLaban" or defName = "StrawberryLaban" or defName = "MedicinalLaban"]/ingestible/joyKind</xpath>
 +
<value>
 +
<joyKind>Sierra_Drinking_Milkshake</joyKind>
 +
</value>
 +
</match>
 +
</Operation>
 +
</pre>
 +
 +
This Patch detects if a specific Mod's Joy Kind Def exists and, if it does, changes the Recreation Type received by consuming a Thing Def from another Mod; the Patch exists in neither Mod's folder, coming from a third-party Mod that is completely separate.
 +
 +
"Sierra Drinking Milkshake" (<code>"Sierra_Drinking_Milkshake"</code>) is added by the [https://steamcommunity.com/sharedfiles/filedetails/?id=2595980371 Milkshake Digital Deluxe Mod], and Laban (<code>"Laban"</code>) is added by the [https://steamcommunity.com/sharedfiles/filedetails/?id=2595938070 Laban Mod].
 +
 +
Now, imagine that neither the author of the Laban Mod or the Milkshake Mod created this Patch. Instead, a fan of both Mods included this in a compilation of Patches that alters dozens of Mods.
 +
 +
This Patch is in a third-party Mod that is neither of the constituent Mods that it patches. If a player had the Milkshake Mod loaded loaded, but ''did not'' have the Laban Mod, this Patch would attempt to to change the Joy Kind Def of consuming Laban to something that does not exist, and would cause the Laban Thing Def to cause errors when consumed, ''and'' cause the Patch to fail.
 +
 +
Therefore, because a large third-party Patch has to patch two Mods that it is not integrated with directly, and uploading a single Patch as a single Mod versus a compilation is inefficient, then it must be concluded that using "<code><success>Always</success></code>" '''''is acceptable in this extenuating circumstance'''''.
 +
 +
Outside of situations like this, using the "Success" statement is still not recommended.
  
 
== Tips and Tricks ==
 
== Tips and Tricks ==
Line 683: Line 728:
 
* It's very easy to confuse Insert vs Add; Insert will "add" the <code>value</code> as a ''sibling'' of the target node(s), while Add will "insert" the <code>value</code> as a ''child'' of the target node(s).
 
* It's very easy to confuse Insert vs Add; Insert will "add" the <code>value</code> as a ''sibling'' of the target node(s), while Add will "insert" the <code>value</code> as a ''child'' of the target node(s).
 
* Remember that XPath targets the XML data structure, not the file path.
 
* Remember that XPath targets the XML data structure, not the file path.
 +
* Nodes in XML other than <code>li</code> list items must be unique at each level. If you Add or Insert a duplicate node, that will generate a red error on load and cause that Def to fail to load.
 
* If you're still stumped, feel free to join the [https://discord.gg/RimWorld RimWorld Discord server] and ask questions in the <code>#mod-development</code> channel.
 
* If you're still stumped, feel free to join the [https://discord.gg/RimWorld RimWorld Discord server] and ask questions in the <code>#mod-development</code> channel.
  
Line 689: Line 735:
 
{{:Modding_Tutorials/Obsolete}}
 
{{:Modding_Tutorials/Obsolete}}
  
−
The best tutorial on PatchOperations created by Zhentar: [https://gist.github.com/Zhentar/4a1b71cea45b9337f70b30a21d868782 Introduction to PatchOperation]
+
The original tutorial on PatchOperations created by Zhentar: [https://gist.github.com/Zhentar/4a1b71cea45b9337f70b30a21d868782 Introduction to PatchOperation]
  
 
[[Category:Modding]]
 
[[Category:Modding]]
 
[[Category:Modding tutorials]]
 
[[Category:Modding tutorials]]

Latest revision as of 01:01, 14 July 2024

< Modding Tutorials

PatchOperations are a feature that allows you to modify the content of XML Defs. Prior to RimWorld alpha 17, modders could only modify Defs by creating new ones that overwrote the original; this often resulted in compatibility issues as if more than one mod tried to overwrite the same Def, only the last mod in the load order would succeed as prior ones would themselves be overwritten.

Basics[edit]

PatchOperations are written as XML nodes that go into your mod's Patches folder: 

MyModFolder
├ About
├ Defs
└ Patches
  └ MyPatchFile.xml

Just as with XML Defs, folder and file names do not matter and you can freely name and organize your patch files in whatever manner you wish. Individual patches themselves are a standard XML file with <Patch> as the root tag: 

<?xml version="1.0" encoding="utf-8"?>
<Patch>

  <!-- PatchOperations go here -->

</Patch>

XPath[edit]

Most PatchOperations must be targeted at one or more XML nodes inside the master XML document. This is done via XML Path Language or XPath.

Note that an XPath is targeting the structure of the XML document after it's been parsed by RimWorld's parser, thus it has nothing to do with the actual file or folder paths. For example, if you wanted to add a stat value to the vanilla Wall building, you might use an XPath like so:

Defs/ThingDef[defName="Wall"]/statBases

  • The first segment of any XPath targeting an XML Def will be Defs/ as all XML Defs use the <Defs> root tag.
  • The square brackets denote a predicate, or conditional match. In this case, we are looking for ThingDefs that have a child tag defName equal to "Wall".

Targeting Attributes[edit]

You can target Defs that do not have a defName (such as abstract bases) by targeting their identifying attributes. For example, if you wanted to add another Stuff category to the abstract base Def for all shelves, you might use the following xpath:

Defs/ThingDef[@Name="ShelfBase"]/stuffCategories

You can use the same technique to target all Defs that inherit from a common base. For example, you could use the following xpath to target all ThingDefs that inherit from ApparelBase:

Defs/ThingDef[@ParentName="ApparelBase"]

Additional XPath Resources[edit]

PatchOperation Types[edit]

Basic XML node operations:
XML attribute operations:
Special operations:
Conditional operations:

PatchOperationAdd[edit]

Inserts the specified values as a child node of the XML nodes targeted by the operation's xpath. By default, the new nodes will be inserted after any existing child nodes (Append). You can use <order>Prepend</order> in the patch operation to insert them before existing child nodes instead.

Note: PatchOperationAdd will not overwrite any existing tags. If one of your values overlaps with an existing node and you are not targeting a list node, then it will cause an error on game load.

Before Patch operation After 
<ExampleDef>
  <defName>SampleDef</defName>
  <aaa>Some text</aaa>
</ExampleDef>
 
<Operation Class="PatchOperationAdd">
  <xpath>Defs/ExampleDef[defName="SampleDef"]</xpath>
  <value>
    <bbb>New text</bbb>
  </value>
</Operation>
 
<ExampleDef>
  <defName>SampleDef</defName>
  <aaa>Some text</aaa>
  <bbb>New text</bbb>
</ExampleDef>
<ExampleDef>
  <defName>SampleDef</defName>
  <exampleList>
    <li>Bar</li>
  </exampleList>
</ExampleDef>
 
<Operation Class="PatchOperationAdd">
  <xpath>Defs/ExampleDef[defName="SampleDef"]/exampleList</xpath>
  <order>Prepend</order>
  <value>
    <li>Foo</li>
  </value>
</Operation>
 
<ExampleDef>
  <defName>SampleDef</defName>
  <exampleList>
    <li>Foo</li>
    <li>Bar</li>
  </exampleList>
</ExampleDef>

PatchOperationInsert[edit]

Inserts the specified values as a sibling above the selected node(s). You can specify <order>Append</order> to insert it after the targeted node(s) instead (default is Prepend).

Before Patch operation After 
<ExampleDef>
  <defName>Rainbow</defName>
  <colors>
    <li>Red</li>
    <li>Yellow</li>
    <li>Green</li>
    <li>Blue</li>
    <li>Violet</li>
  </colors>
</ExampleDef>
 
<Operation Class="PatchOperationInsert">
  <xpath>Defs/ExampleDef[defName="Rainbow"]/colors/li[text()="Yellow"]</xpath>
  <value>
    <li>Orange</li>
  </value>
</Operation>
 
<ExampleDef>
  <defName>Rainbow</defName>
  <colors>
    <li>Red</li>
    <li>Orange</li>
    <li>Yellow</li>
    <li>Green</li>
    <li>Blue</li>
    <li>Violet</li>
  </colors>
</ExampleDef>
<ExampleDef>
  <defName>Fish</defName>
  <lines>
    <li>one fish</li>
    <li>two fish</li>
  </lines>
</ExampleDef>
 
<Operation Class="PatchOperationInsert">
  <xpath>Defs/ExampleDef[defName="Fish"]/lines/li[text()="two fish"]</xpath>
  <order>Append</order>
  <value>
    <li>red fish</li>
    <li>blue fish</li>
  </value>
</Operation>
 
<ExampleDef>
  <defName>Fish</defName>
  <lines>
    <li>one fish</li>
    <li>two fish</li>
    <li>red fish</li>
    <li>blue fish</li>
  </lines>
</ExampleDef>

PatchOperationRemove[edit]

Removes the targeted node.

Before Patch operation After 
<ExampleDef>
  <defName>Sample</defName>
  <foo>Uno</foo>
  <bar>Dos</bar>
  <baz>Tres</baz>
</ExampleDef>
 
<Operation Class="PatchOperationRemove">
  <xpath>Defs/ExampleDef[defName="Sample"]/bar</xpath>
</Operation>
 
<ExampleDef>
  <defName>Sample</defName>
  <foo>Uno</foo>
  <baz>Tres</baz>
</ExampleDef>

PatchOperationReplace[edit]

Replaces the selected node(s) with your values.

Before Patch operation After 
<ExampleDef>
  <defName>Sample</defName>
  <foo>Uno</foo>
  <bar>Dos</bar>
  <baz>Tres</baz>
</ExampleDef>
 
<Operation Class="PatchOperationReplace">
  <xpath>Defs/ExampleDef[defName="Sample"]/baz</xpath>
  <value>
    <baz>Drei</baz>
  </value>
</Operation>
 
<ExampleDef>
  <defName>Sample</defName>
  <foo>Uno</foo>
  <bar>Dos</bar>
  <baz>Drei</baz>
</ExampleDef>

PatchOperationAttributeAdd[edit]

Adds the specified attribute to the targeted node(s), but only if that attribute is not yet present.

Before Patch operation After 
<ExampleDef>
  <defName>Sample</defName>
  <foo>Uno</foo>
  <bar>Dos</bar>
  <baz>Tres</baz>
</ExampleDef>
 
<Operation Class="PatchOperationAttributeAdd">
  <xpath>Defs/ExampleDef[defName="Sample"]</xpath>
  <attribute>Name</attribute>
  <value>SampleBase</value>
</Operation>
 
<ExampleDef Name="SampleBase">
  <defName>Sample</defName>
  <foo>Uno</foo>
  <bar>Dos</bar>
  <baz>Tres</baz>
</ExampleDef>

PatchOperationAttributeSet[edit]

Adds the specified attribute to the targeted node(s), or overwrites the existing value if the specified attribute already exists.

Before Patch operation After 
<ExampleDef Name="SampleSource">
  <defName>Sample</defName>
  <foo>Uno</foo>
  <bar>Dos</bar>
  <baz>Tres</baz>
</ExampleDef>
 
<Operation Class="PatchOperationAttributeSet">
  <xpath>Defs/ExampleDef[defName="Sample"]</xpath>
  <attribute>Name</attribute>
  <value>SampleBase</value>
</Operation>
 
<ExampleDef Name="SampleBase">
  <defName>Sample</defName>
  <foo>Uno</foo>
  <bar>Dos</bar>
  <baz>Tres</baz>
</ExampleDef>

PatchOperationAttributeRemove[edit]

Removes the specified attribute from the targeted node(s).

Before Patch operation After 
<ExampleDef Name="SampleBase">
  <defName>Sample</defName>
  <foo>Uno</foo>
  <bar>Dos</bar>
  <baz>Tres</baz>
</ExampleDef>
 
<Operation Class="PatchOperationAttributeRemove">
  <xpath>Defs/ExampleDef[defName="Sample"]</xpath>
  <attribute>Name</attribute>
</Operation>
 
<ExampleDef>
  <defName>Sample</defName>
  <foo>Uno</foo>
  <bar>Dos</bar>
  <baz>Tres</baz>
</ExampleDef>

PatchOperationAddModExtension[edit]

Main article: Modding Tutorials/DefModExtension

Adds the specified DefModExtension to the targeted Def. Automatically creates a <modExtensions> node if one doesn't already exist.

Before Patch operation After 
<ExampleDef Name="SampleBase">
  <defName>Sample</defName>
  <foo>Uno</foo>
  <bar>Dos</bar>
  <baz>Tres</baz>
</ExampleDef>
 
<Operation Class="PatchOperationAddModExtension">
  <xpath>Defs/ExampleDef[defName="Sample"]</xpath>
  <value>
    <li Class="MyNamespace.MyModExtension">
      <key>Value</key>
    </li>
  </value>
</Operation>
 
<ExampleDef Name="SampleBase">
  <defName>Sample</defName>
  <foo>Uno</foo>
  <bar>Dos</bar>
  <baz>Tres</baz>
  <modExtensions>
    <li Class="MyNamespace.MyModExtension">
      <key>Value</key>
    </li>
  </modExtensions>
</ExampleDef>

PatchOperationSetName[edit]

Changes the name of a node. Most useful for changing the names of the nodes in "dictionary"-style nodes without changing their contents, such as for stat blocks or recipe products.

Before Patch operation After 
<ThingDef>
  <defName>ExampleThing</defName>
  <!-- many nodes omitted -->
  <statBases>
    <Insulation_Cold>10</Insulation_Cold>
  </statBases>
</ThingDef>
 
<Operation Class="PatchOperationSetName">
  <xpath>Defs/ThingDef[defName="ExampleThing"]/statBases/Insulation_Cold</xpath>
  <name>Insulation_Heat</name>
</Operation>
 
<ThingDef>
  <defName>ExampleRecipe</defName>
  <!-- many nodes omitted -->
  <statBases>
    <Insulation_Heat>10</Insulation_Heat>
  </statBases>
</ThingDef>
<RecipeDef>
  <defName>ExampleRecipe</defName>
  <!-- many nodes omitted -->
  <products>
    <WoodLog>30</WoodLog>
  </products>
</RecipeDef>
 
<Operation Class="PatchOperationSetName">
  <xpath>Defs/RecipeDef[defName="ExampleRecipe"]/products/WoodLog</xpath>
  <name>Steel</name>
</Operation>
 
<RecipeDef>
  <defName>ExampleRecipe</defName>
  <!-- many nodes omitted -->
  <products>
    <Steel>30</Steel>
  </products>
</RecipeDef>

PatchOperationSequence[edit]

Contains one or more additional PatchOperations, which are executed in order. If any of them fail, then the Sequence stops and will not run any additional PatchOperations.

WARNING: PatchOperations within an XML file will run in order even without a PatchOperationSequence and using a PatchOperationSequence can obfuscate or hide errors, making it difficult to debug if your child PatchOperations have errors. Do not use PatchOperationSequence unless you are sequencing multiple PatchOperations with a single PatchOperationConditional or PatchOperationFindMod or you are using MayRequire on child PatchOperations, and even then it's strongly recommended you write your PatchOperations as independent Operations first to ensure they are working as intended. 

<Operation Class="PatchOperationSequence">
  <operations>
    <li Class="PatchOperationAdd">
      <xpath>Defs/ExampleDef[defName="Sample"]/statBases</xpath>
      <value>
        <Mass>10</Mass>
      </value>
    </li>
    <li Class="PatchOperationSetName">
      <xpath>Defs/ExampleDef[defName="Sample"]/statBases/Flammability</xpath>
      <name>ToxicEnvironmentResistance</name>
    </li>
    <!-- etc -->
  </operations>
</Operation>

As mentioned, you can use MayRequire on child operations of a PatchOperationSequence, but you should test them individually before adding them to said Sequence: 

<Operation Class="PatchOperationSequence">
  <operations>
    <li Class="PatchOperationAdd" MayRequire="Ludeon.Rimworld.Biotech"> <!-- Only runs if Biotech is active -->
      <xpath>Defs/ThingDef[defName="MechGestator"]/recipes</xpath>
      <value>
        <li>MyCustomMech</li>
      </value>
    </li>
    <li Class="PatchOperationAdd" MayRequire="MyProject.OtherModPackageId"><!-- Only runs if the specific mod is active -->
      <xpath>Defs/ThingDef[defName="OtherModWorkbench"]/recipes</xpath>
      <value>
        <li>MyCustomResource</li>
      </value>
    </li>
  </operations>
</Operation>

PatchOperationFindMod[edit]

Checks whether any of the specified mods or DLCs are loaded and allows you to run an additional PatchOperation for match or nomatch results.

WARNING: Unlike all other mod-compatibility features in RimWorld, PatchOperationFindMod uses the mod name and not its packageId.

NOTE: For expansions, PatchOperationFindMod uses the label value defined in the ExpansionDef for the DLC. At present, this means they are identified by just their single word names: Royalty, Ideology, Biotech, Anomaly.

NOTE: PatchOperationFindMod should only be used if you are implementing optional compatibility for the target mod, i.e. if your mod can work with or without the mod in question. If you are creating a compatibility mod specifically for a target mod that would be meaningless without that mod present, then it's better to simply specify that mod in your About.xml as a dependency and forgo the use of PatchOperationFindMod and avoid the potential issues introduced by using PatchOperationSequence.

The following example adds a mod extension to the targeted Defs if RimQuest is loaded (See original): 

<Operation Class="PatchOperationFindMod">
  <mods>
    <li>RimQuest</li>
  </mods>
  <match Class="PatchOperationAddModExtension">
    <xpath>Defs/IncidentDef[defName="MFI_DiplomaticMarriage" or defName="MFI_HuntersLodge" or defName="MFI_Quest_PeaceTalks"]</xpath>
    <value>
      <li Class = "RimQuest.RimQuest_ModExtension">
        <canBeARimQuest>false</canBeARimQuest>
      </li>
    </value>
  </match>
</Operation>

The following example replaces the tabWindowClass of the Factions button when Relations Tab is not loaded: 

<Operation Class="PatchOperationFindMod">
  <mods>
    <li>Relations Tab</li>
  </mods>
  <nomatch Class="PatchOperationReplace">
    <xpath>/Defs/MainButtonDef[defName="Factions"]/tabWindowClass</xpath>
    <value>
      <tabWindowClass>MyNameSpace.MyTabWindowClass</tabWindowClass>
    </value>
  </nomatch>
</Operation>

PatchOperationConditional[edit]

Tests for the existence/validity of the specified node(s) and allows you to run optional match or nomatch PatchOperations in response.

The following example adds a <comps> node to the Caravan Def if it does not exist already, then adds a custom comp to said list: 

<?xml version="1.0" encoding="utf-8" ?>
<Patch>

  <!-- add comps field to Caravan WorldObjectDef if it doesn't exist -->
  <Operation Class="PatchOperationConditional">
    <xpath>Defs/WorldObjectDef[defName="Caravan"]/comps</xpath>
    <nomatch Class="PatchOperationAdd">
      <xpath>Defs/WorldObjectDef[defName="Caravan"]</xpath>
      <value>
        <comps />
      </value>
    </nomatch>
  </Operation>

  <!-- add pyromaniac caravan handler comp to Caravan WorldObjectDef -->
  <Operation Class="PatchOperationAdd">
    <xpath>Defs/WorldObjectDef[defName="Caravan"]/comps</xpath>
    <value>
      <li Class="BetterPyromania.WorldObjectCompProperties_Pyromania">
        <fuelCount>20</fuelCount>
        <cooldown>30000</cooldown>
        <needThreshold>0.5</needThreshold>
      </li>
    </value>
  </Operation>

</Patch>

PatchOperationTest[edit]

!
Obsolete
The following content was written for a previous version of RimWorld or is otherwise no longer fully relevant today. Please be mindful of any potential inaccuracies.

Tests for the existence/validity of an xpath. Useful as a way to intentionally stop a PatchOperationSequence.

NOTE: Conditionally applying patches in this way is considered obsolete. Using PatchOperationConditional is a much better idea as the use of <success>Always</success> here will also suppress legitimate errors, making Sequences difficult to debug.

The following example patch is from Apparello, by Shinzy. 

<Operation Class="PatchOperationSequence">
  <!-- Must use <success>Always</success> because of the PatchOperationTest -->
  <success>Always</success>
  <!-- check for worn graphics and if none found, add one -->
  <operations>
    <li Class="PatchOperationTest">
      <xpath>Defs/ThingDef[defName = "Apparel_Pants"]/apparel/wornGraphicPath</xpath>
      <success>Invert</success>
    </li>
    <li Class="PatchOperationAdd">
      <xpath>Defs/ThingDef[defName = "Apparel_Pants"]/apparel</xpath>
      <value>
        <wornGraphicPath>Accessorello/Pants/Pants</wornGraphicPath>
      </value>
    </li>
  </operations>
</Operation>

Miscellaneous[edit]

Custom PatchOperations[edit]

Custom PatchOperation types can be created in C# by subclassing Verse.PatchOperation, which is useful for performing a patch based on ModSettings values or other custom behavior.

A tutorial for this process does not exist yet, but you can check out the following references of custom PatchOperations:

"Success" Option[edit]

!
Obsolete
The following content was written for a previous version of RimWorld or is otherwise no longer fully relevant today. Please be mindful of any potential inaccuracies.

The <success>...</success> node determines how errors are handled, usually in a PatchOperationSequence. Note that use of this tag should be considered obsolete; its use was common before PatchOperationConditional was implemented, but it should no longer be required and can cause confusion as it can suppress legitimate errors from showing up.

Options available are:

  • Always - This patch operation always succeeds, i.e. it suppresses all errors that might have occurred. This used to be used in PatchOperationSequence along with PatchOperationTest in order to conditionally run patches, but is now obsolete.
  • Normal - Errors are handled normally
  • Invert - Errors are considered a success and success is considered a failure. This used to be used in PatchOperationSequences to test the negative of a PatchOperationTest; you should now use <nomatch> on PatchOperationConditional.
  • Never - This patch operation always fails. Generally only used in testing to see if a Sequence is working correctly, should never be used in published mods.

Extenuating circumstances for "Success"[edit]

There are, in very specific circumstances, a valid reason to use a <success>Always</success> statement.

For instance, consider the following opening lines for a Patch: 

	<Operation Class="PatchOperationConditional">
		<xpath>/Defs/JoyKindDef[defName="Sierra_Drinking_Milkshake"]</xpath>
		<match Class="PatchOperationReplace">
			<success">Always</success>
			<xpath>/Defs/ThingDef[defName = "Laban" or defName = "AmbrosiaLaban" or defName = "ChocolateLaban" or defName = "StrawberryLaban" or defName = "MedicinalLaban"]/ingestible/joyKind</xpath>
			<value>
				<joyKind>Sierra_Drinking_Milkshake</joyKind>
			</value>
		</match>
	</Operation>

This Patch detects if a specific Mod's Joy Kind Def exists and, if it does, changes the Recreation Type received by consuming a Thing Def from another Mod; the Patch exists in neither Mod's folder, coming from a third-party Mod that is completely separate.

"Sierra Drinking Milkshake" ("Sierra_Drinking_Milkshake") is added by the Milkshake Digital Deluxe Mod, and Laban ("Laban") is added by the Laban Mod.

Now, imagine that neither the author of the Laban Mod or the Milkshake Mod created this Patch. Instead, a fan of both Mods included this in a compilation of Patches that alters dozens of Mods.

This Patch is in a third-party Mod that is neither of the constituent Mods that it patches. If a player had the Milkshake Mod loaded loaded, but did not have the Laban Mod, this Patch would attempt to to change the Joy Kind Def of consuming Laban to something that does not exist, and would cause the Laban Thing Def to cause errors when consumed, and cause the Patch to fail.

Therefore, because a large third-party Patch has to patch two Mods that it is not integrated with directly, and uploading a single Patch as a single Mod versus a compilation is inefficient, then it must be concluded that using "<success>Always</success>" is acceptable in this extenuating circumstance.

Outside of situations like this, using the "Success" statement is still not recommended.

Tips and Tricks[edit]

  • Patching is run after all XML Defs are loaded into memory and in mod list order. If you are encountering compatibility issues with another mod's PatchOperations, you can use loadBefore and loadAfter in your About.xml to help players resolve these issues.
  • Patching is done before Def inheritance takes place. This means that you cannot target tags that are inherited from a parent, but also that if you alter a parent, all of its children will inherit the patched value.
  • You can override a value inherited from a parent Def without changing that value for all Defs by using Inherit="False":
<Operation Class="PatchOperationAdd">
  <xpath>/Defs/ThingDef[defName = "Apparel_KidPants"]</xpath>
  <value>
    <thingCategories Inherit="False">
      <li>NewValue</li>
    </thingCategories>
  </value>
</Operation>
  • You can use or in predicates to target multiple nodes: Defs/ThingDef[defName="Cassowary" or defName = "Emu" or defName = "Ostrich" or defName = "Turkey"] This is generally better than using multiple PatchOperations so long as you are making the same changes to each target.
  • You can use /text() to target the text contents of a tag instead of the whole tag for operations like PatchOperationReplace. This is especially useful if you do not want to accidentally remove attributes.

Common Issues / Troubleshooting[edit]

  • XPath and XML nodes in general is case-sensitive and must be exact. Copying values such as defName fields is strongly recommended to avoid errors.
  • Malformed XML such as unclosed or mismatched tags can cause the XML parser to crash completely, which can result in a blank screen on startup or a "Recovered from a fatal error" screen and the removal of all active mods. If this occurs, run all of your XML through an XML validator to ensure that it is structurally correct. Checking your Player.log file can help in diagnosing the exact cause as well.
  • It's very easy to confuse Insert vs Add; Insert will "add" the value as a sibling of the target node(s), while Add will "insert" the value as a child of the target node(s).
  • Remember that XPath targets the XML data structure, not the file path.
  • Nodes in XML other than li list items must be unique at each level. If you Add or Insert a duplicate node, that will generate a red error on load and cause that Def to fail to load.
  • If you're still stumped, feel free to join the RimWorld Discord server and ask questions in the #mod-development channel.

References and Links[edit]

!
Obsolete
The following content was written for a previous version of RimWorld or is otherwise no longer fully relevant today. Please be mindful of any potential inaccuracies.

The original tutorial on PatchOperations created by Zhentar: Introduction to PatchOperation

Retrieved from "https://rimworldwiki.com/index.php?title=Modding_Tutorials/PatchOperations&oldid=147837"