Editing Modding Tutorials/DefModExtension

Jump to navigation Jump to search

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
 +
{{stub}}
 
{{BackToTutorials}}
 
{{BackToTutorials}}
  
−
A DefModExtension is a way to add fields to Defs. DefModExtensions are a simple way to extend functionality to a Def. A DefModExtension doesn't directly add fields to classes as that's technically impossible to do at runtime. The implementation is that the ''Def'' class has a ''public List<DefModExtension>'' which can easily be extended.
+
A DefModExtension is a way to add fields to Defs. DefModExtensions are a simple way to extend functionality to a Def.
  
 
'''Benefits''':<br/>
 
'''Benefits''':<br/>
Line 16: Line 17:
 
<nowiki>-</nowiki> Can't save data.<br/>
 
<nowiki>-</nowiki> Can't save data.<br/>
 
<nowiki>-</nowiki> Only works on Defs.<br/>
 
<nowiki>-</nowiki> Only works on Defs.<br/>
−
<nowiki>-</nowiki> A DefModExtension does not know what Def it belongs to. (There are ways around this, like setting a Def field in your DefModExtension and populating it in XML/C#)<br/>
 
  
 
=Requirements=
 
=Requirements=
Line 28: Line 28:
 
<source lang="csharp">
 
<source lang="csharp">
 
using Verse;
 
using Verse;
 +
using RimWorld;
  
 
namespace ExampleNameSpace
 
namespace ExampleNameSpace
 
{
 
{
−
     public class ExampleModExtension : DefModExtension
+
     public class RimQuest_ModExtension : DefModExtension
 
     {
 
     {
 
         public bool canBeARimQuest = true;
 
         public bool canBeARimQuest = true;
Line 38: Line 39:
 
</source>
 
</source>
 
That's it. DefModExtensions can of course contain any field you wish: a C# Type, a Thingfilter, a list -- but for the sake of a simple example, we'll use a bool.
 
That's it. DefModExtensions can of course contain any field you wish: a C# Type, a Thingfilter, a list -- but for the sake of a simple example, we'll use a bool.
−
 
−
==Using the DefModExtension==
 
−
You can use the DefModExtension on any Def with that extension. Their usage is much the same way as any other field in a Def. The biggest difference is in the syntax; instead of ''bool value = def.field'', it's ''bool value = def.GetModExtension<ExampleModExtension>().field''
 
−
<source lang=csharp>
 
−
using Verse;
 
−
using RimWorld;
 
−
 
−
namespace ExampleNameSpace
 
−
{
 
−
    public class OurExampleClass
 
−
    {
 
−
        private static bool IsAcceptableQuest(IncidentDef incidentDef)
 
−
        {
 
−
            if (incidentDef.letterDef == LetterDefOf.NegativeEvent)
 
−
                return false;
 
−
 
−
            if (incidentDef.HasModExtension<ExampleModExtension>())
 
−
                return incidentDef.GetModExtension<ExampleModExtension>().canBeARimQuest;
 
−
 
−
            return true;
 
−
        }
 
−
    }
 
−
}
 
−
</source>
 
−
Or if you like your code shorter, you can use null conditionals and null coalescing:
 
−
<source lang = "csharp">
 
−
            return incidentDef.letterDef != LetterDefOf.NegativeEvent
 
−
                && (incidentDef.GetModExtension<ExampleModExtension>()?.canBeARimQuest ?? true);
 
−
                //will return value of mod extension if not null, otherwise assumed true.
 
−
</source>
 
−
 
−
==Adding it to your def==
 
−
<source lang = "xml">
 
−
<Defs>
 
−
    <ExampleDef>
 
−
        <defName>Example</defName>
 
−
        <modExtensions>
 
−
            <li Class="ExampleNameSpace.ExampleModExtension">
 
−
                <canBeARimQuest>false</canBeARimQuest>
 
−
            </li>
 
−
        </modExtensions>
 
−
    </ExampleDef>
 
−
</Defs>
 
−
</source>
 
−
 
−
===Using xpath to add it to a def===
 
−
If you wanted to xpath patch a mod extension onto an existing def, you'd use PatchOperationAddModExtension, which is like PatchOperationAdd but saves having to check if modExtensions has already been added/having to include it in your value field:
 
−
<source lang = "xml">
 
−
<Patch>
 
−
    <Operation Class="PatchOperationAddModExtension">
 
−
        <xpath>Defs/ExampleDef[defName="Example"]</xpath>
 
−
        <value>
 
−
            <li Class="ExampleNameSpace.ExampleModExtension">
 
−
                <canBeARimQuest>false</canBeARimQuest>
 
−
            </li>
 
−
        </value>
 
−
    </Operation>
 
−
</Patch>
 
−
</source>
 
  
 
=See also=
 
=See also=
 
[https://ludeon.com/forums/index.php?topic=46351.0 Ludeon thread on Mod Extensions]<br>
 
[https://ludeon.com/forums/index.php?topic=46351.0 Ludeon thread on Mod Extensions]<br>
−
[https://github.com/jecrell/RimQuest/commit/54413b821233316c4057db87031aa6e528ab2db6 The pull request on which the code in this article is based on]
+
[https://github.com/jecrell/RimQuest/commit/54413b821233316c4057db87031aa6e528ab2db6 The pull request the code this article is based on]
  
 
[[Category: Modding]]
 
[[Category: Modding]]
 
[[Category: Modding tutorials]]
 
[[Category: Modding tutorials]]

Please note that all contributions to RimWorld Wiki are considered to be released under the CC BY-SA 3.0 (see RimWorld Wiki:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

Cancel Editing help (opens in new window)

Template used on this page:

This page is a member of 1 hidden category:

Retrieved from "https://rimworldwiki.com/wiki/Modding_Tutorials/DefModExtension"