Editing Template:TrainingTable/doc

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:
{{TOCright}}
+
=== Required Code on Every Animal Page ===
==Description==
 
This template displays an animal's trainability.
 
  
==Usage==
+
The following code is going to now be required on every [[Animals]] page. This is to "set" or "define" the properties of the specific animal when it comes to training. Whenever you use this template there are four Page Properties you have to manually set on each Animal Page. These are vital for the template to work as the template pulls information from these properties in order to properly set the values within the template.
Enter <code><nowiki>{{TrainingTable}}</nowiki></code> under the Training section.</p>
 
No other syntax or parameters are used.
 
  
==Prerequisites==
+
<pre>
The animal's page must include its trainability stat, written as one of the following:
+
<!-- Set the Declaration of Variables for the Animal Training Template-->
: <code>|trainable = none</code>
+
{{#set: Can_Train_Guard=true}}
: <code>|trainable = simple</code>
+
{{#set: Can_Train_Attack=false}}
: <code>|trainable = intermediate</code>
+
{{#set: Can_Train_Rescue=true}}
: <code>|trainable = advanced</code>
+
{{#set: Can_Train_Haul=false}}
 +
</pre>
  
The animal's page must include its body size, written like:
+
== New Template Properties ==
: <code>|bodysize = 0.55</code>
 
  
==Properties==
+
The following properties are used for the new template.
The properties displayed by this template are:
 
  
 
[[Property:Can_Train_Guard]]
 
[[Property:Can_Train_Guard]]
Line 28: Line 23:
 
[[Property:Can_Train_Haul]]
 
[[Property:Can_Train_Haul]]
  
==Example Output==
+
== Deprecated Template Properties ==
The following is output when used on Muffalo.
 
  
 +
[[Property:Can_Train_Obedience]]
  
This animal can be trained as follows:
+
[[Property:Can_Train_Release]]
{| style="border-style: solid; border-width: 0px; text-align:left;"
 
! scope="row" | Guard:
 
| &nbsp;{{#switch: {{#show: Muffalo|?Can Train Guard|link=none}} | true=[[File:check.png|24px|link=]] | false=[[File:ex.png|24px|link=]]}}
 
|-
 
! scope="row" |Attack:
 
| &nbsp;{{#switch: {{#show: Muffalo|?Can Train Attack|link=none}} | true=[[File:check.png|24px|link=]] | false=[[File:ex.png|24px|link=]]}}
 
|-
 
! scope="row" |Rescue:
 
| &nbsp;{{#switch: {{#show: Muffalo|?Can Train Rescue|link=none}} | true=[[File:check.png|24px|link=]] | false=[[File:ex.png|24px|link=]]}}
 
|-
 
! scope="row" |Haul:
 
| &nbsp;{{#switch: {{#show: Muffalo|?Can Train Haul|link=none}} | true=[[File:check.png|24px|link=]] | false=[[File:ex.png|24px|link=]]}}
 
|}
 
<small>*As of [[version/1.1.2610|version 1.1.2610]], all animals can be tamed. The percentage of likelihood of success depends on factors such as the Animals Wildness Percentage, Pawn Handling Skill, and others. More information can be found on the [[Animals#Animal_husbandry|animals]] page.</small>
 
  
==Additional Info==
+
The following values are to be set for animals as of V1.1.2610: [[User:DJRedNightGaming/AnimalTrainingPropertyValues]]
* This template displays information from properties, it does not set them, instead, they are set in [[Template:Infobox main]]. Go there for updates or adjustments.
 
  
* Trainability is partially determined by body size as specified in (RimWorld installation folder on PC) Defs\TrainableDefs\Trainables.xml
+
== Example Output ==
  
 +
{{TrainingTemplateUpdated}}
  
<includeonly>[[Category:Customized table templates]]</includeonly>
+
<!-- Set the Declaration of Variables for the Animal Training Template-->
<noinclude>[[Category:Template documentation]]</noinclude>
+
{{#set: Can_Train_Guard=true}}
 +
{{#set: Can_Train_Attack=false}}
 +
{{#set: Can_Train_Rescue=true}}
 +
{{#set: Can_Train_Haul=false}}

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: