Editing Modding Tutorials/ThingDef

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:
−
{{BackToTutorials}}
+
'''ThingDef''' is a def type for making entities, such as buildings and pawns (NPCs).
  
−
'''ThingDef''' is one of the many [[Modding_Tutorials/XML_Defs|Defs]] used in RimWorld. Almost every "tangible" (and some intangible) things you see in RimWorld are backed by a ThingDef.
 
  
−
=What you'll learn=
+
==Buildings==
−
You will learn the '''structure''' of ThingDef, how to use a decompiler to learn what a tag does, and along the way you'll learn the meaning of a few select tags.
+
Buildings are static entities. They usually require construction and perform a special function.
  
−
=What you will '''not''' learn=
+
===Elements===
−
The goal of this tutorial is not to tell you what each XML tag does. ThingDef alone has 200+ valid XML tags, not counting hundreds of subtags. There are simply too many to document, and a lot of them are self-explanatory.
 
  
−
* If you want a list of all XML tags (not just ThingDef) you'll want [https://ludeon.com/forums/index.php?topic=21440.0 milon's autodocumentation project]. Note that it only includes tags ''in use by'' RimWorld, not necessarily ''all tags available''.
+
==Pawns==
−
* If you want to see what an earnest attempt at documenting the XML looks like, you'll want the [https://github.com/RimWorldMod/RimworldModdingFiles XML Documentation Database]. Last updated for A15.
+
Pawns are NPCs.
−
* If you want to see what a documentation attempt on this wiki looks like, [https://rimworldwiki.com/index.php?title=Modding_Tutorials/ThingDef&oldid=62403 view the history of this article] and see that was last up to date in Alpha 9.
 
  
−
Fact of the matter is this: there is no documentation that will tell you the meaning and usage of every tag. There probably never will. If there is, it will be out-of-date soon enough.
+
==Items==
 +
Items are anything that can be hauled, such as weapons, debris, or resources.
  
−
=Requirements=
+
==Plants==
−
* A [[Modding Tutorials/Decompiling_source_code|decompiler]] is advised.
+
Plants grow in growing areas, in the landscape, in a hydroponics table, or in a plant pot.
  
−
[[File:ThingDef.PNG|300px|thumb|right|ILSpy v4.0 showing the decompiled ThingDef class, with the analyzer expanded on the smallVolume field. To the left a few of available fields are visible.]]
+
===Elements===
  
−
=Introduction=
+
==Filth==
−
There are hundreds of XML tags. Some of them are rudimentary tags required for basic operation. Most of them are self-explanatory, and you can always use the Find In Files functionality of [[Modding Tutorials/Recommended software|your favourite text editor]] to see what it is used by, and what values already exist. Sometimes, this does not suffice. This tutorial is for those times.
+
Filth is just an image that is overlaid above the floor. It contributes to the "ugly environment" thought in pawns.
  
−
=An example=
+
==Global elements==
−
Let's take a look at the ''intricate'' tag. This tag serves as an example because unlike "DeteriorationRate" or "stackLimit" it's not immediately obvious what it does. This tutorial assumed you just used the Find In Files functionality of [[Modding Tutorials/Recommended software|your favourite text editor]] and learned just one thing: Only the [[Component]] and [[Advanced component]] have this tag, and it's set to true.
+
These elements can be used in all ThingDef types.
  
−
<source lang = "xml">
+
{| class="wikitable sortable"
−
<Defs>
+
! scope="col"| Element
−
    <ThingDef>
+
! scope="col"|Function
−
        <defName>ComponentIndustrial</defName>
+
! scope="col"| Available options
−
        <intricate>true</intricate>
+
|----
−
    </ThingDef>
+
! scope="row"| category
−
</Defs>
+
|Designates a category to be used internally.
−
</source>
+
|Building, Pawn, Plant, Item, Filth
−
 
+
|----
−
[[File:Intricate.PNG|300px|thumb|right|The search result for intricate.]]
+
! scope="row"| eType
−
 
+
|Provides a more specific description of an object. This may be equal to the category's name.
−
Take your favourite [[Modding Tutorials/Decompiling source code|decompiler]] and search for ''intricate''. Now right-click the result and hit ''analyze''. The analyzer in my decompiler shows it's read in three places, and assigned nowhere. The decompiler doesn't show any assigning of this value because it's set in the XML. We can see it's read by ''PlayerItemAccessibilityUtility.CacheAccessibleThings'' and twice by ''Thing.SmeltProducts''. Taking a closer look at the ''Thing+<SmeltProducts>c__Iterator4.MoveNext'', this is an inner method for the enumerator<ref>The what? An enumerable is a fancy type of list and the MoveNext means "go to the next item on the list". Apologies to those who have a background in computer science.</ref>. That in itself doesn't do much, so let's take a look at ''SmeltProducts'' itself.
+
|Varies per category
−
 
+
|----
−
[[File:SmeltProducts.PNG|300px|thumb|right|The view for SmeltProducts.]]
+
! scope="row"| thingClass
−
 
+
|Provides an attachment to an internal class in the code.
−
We can see here that ''SmeltProducts'' in turn is used for some economy related DebugOutput, and by MakeRecipeProducts. We can dive further down the rabbithole, but by now it is a reasonable assumption that ''SmeltProducts'' is used to determine what products you get from smelting. But what's the ''intricate'' tag? Well, ''SmeltProducts'' loops over the ingredients in the costList (i.e. the required ingredients to make an item) and checks if it's ''intricate''. If it's not intricate, it will return the ingredient.
+
|Varies per category
−
 
+
|----
−
In other words, the ''intricate'' tag means that ThingDef won't survive a trip to the smelter. You don't get your components back if you smelt down an [[Assault rifle]].
+
! scope="row"| selectable
−
 
+
|Specifies whether or not the item can be selected in the atlas.
−
'''You can find the meaning of every XML tag this way.''' Some might be easier than others, but you can find (or make an educated guess) to the meaning of every XML tag.
+
|true, false
−
 
+
|----
−
=Adding more tags=
+
! scope="row"| useStandardHealth
−
This requires C#. The current recommended way for maximum compatibility is by using a [[Modding_Tutorials/DefModExtension|DefModExtension]].
+
|Determines whether or not health will be calculated normally. (?)
−
 
+
|true, false
−
=See also=
+
|----
−
* [https://ludeon.com/forums/index.php?topic=21440.0 milon's autodocumentation project]. Note that it only includes tags ''in use by'' RimWorld, not necessarily ''all tags available''
+
! scope="row"| label
−
* [https://github.com/RimWorldMod/RimworldModdingFiles XML Documentation Database]. Last updated for A15.
+
|User-friendly name of a Thing
 +
|String
 +
|----
 +
! scope="row"| textureFolderPath
 +
|Specifies location of the textures (root folder is assumed to be Textures)
 +
|String
 +
|----
 +
! scope="row"| altitudeLayer
 +
|Influences whether pawns can walk through the Thing or must travel around it.
 +
|Filth, DoorMoveable, BuildingTall, FloorEmplacement, Waist, Item, LowPlant, Projectile, Floor, PawnState
 +
|----
 +
! scope="row"| flammability
 +
|Influences how likely it is for the Thing to catch fire and take damage.
 +
|0 to 1.0
 +
|----
 +
! scope="row"| maxHealth
 +
|Sets the maximum health of the Thing (if applicable).
 +
|Any value above 0
 +
|----
 +
! scope="row"| tickerType
 +
|Decides the tick type.
 +
|Never, Normal (60 Ticks a second), Rare (1 Tick every 4.17 seconds or 1 tick every 250 normal ticks)
 +
|----
 +
|}
  
 
[[Category:Defs]]
 
[[Category:Defs]]
−
[[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/ThingDef"