v50 Steam/Premium information for editors
  • v50 information can now be added to pages in the main namespace. v0.47 information can still be found in the DF2014 namespace. See here for more details on the new versioning policy.
  • Use this page to report any issues related to the migration.
This notice may be cached—the current version can be found here.

Difference between revisions of "Weapon token"

From Dwarf Fortress Wiki
Jump to navigation Jump to search
m (Unrating page for DF2014 (w: 27/127))
 
(19 intermediate revisions by 14 users not shown)
Line 1: Line 1:
{{Migrated_article}}
+
{{Quality|Fine}}
{{quality|unrated}}
+
{{av}}
 +
{{Modding}}
 +
'''Weapon tokens''' define [[weapon]]s. These tokens can only be placed within an ITEM_WEAPON object definition, and most do not function in armor objects.
 +
{{clear}}
  
These tokens can only be placed within an ITEM_WEAPON object definition, most do not function in armor objects.
+
==Tokens==
 
{| {{prettytable}}
 
{| {{prettytable}}
 
|- bgcolor="#ddd"
 
|- bgcolor="#ddd"
Line 8: Line 11:
 
! Arguments
 
! Arguments
 
! Description
 
! Description
! Works in armor
 
  
 
|-
 
|-
Line 15: Line 17:
 
*singular
 
*singular
 
*plural
 
*plural
| Name of the weapon. <font color="red">Required</font>.
+
| Name of the weapon. <font color="red">Required.</font>
| {{y}}
 
  
 
|-
 
|-
Line 46: Line 47:
 
|  
 
|  
 
*[[Skill token]]
 
*[[Skill token]]
| The skill to determine effectiveness in melee with this weapon. Defaults to MACE. Skill of AXE will allow it to be used to chop down trees.
+
| The skill to determine effectiveness in melee with this weapon. Defaults to MACE. AXE skill will allow it to be used to chop down trees.  MINING skill will allow it to be used for mining. Outsider adventurers (or regular ones with no points in offensive skills) will receive a weapon with the SPEAR skill, selected at random if multiple ones have been [[modding|modded]] in. All adventurers will also start with a weapon using the DAGGER skill, again selected at random if multiple such weapons exist.
  
 
|-
 
|-
Line 59: Line 60:
 
|  
 
|  
 
*size
 
*size
| Creatures under this size (in cm^3) must use the weapon two-handed. Defaults to 50000.
+
| Creatures under this size (in cm^3) must use the weapon two-handed (or more if the creature has extra [GRASP] parts){{verify}}. Defaults to 50000.  Below this size, one-handed use of a weapon will cause a penalty to hit.
  
 
|-
 
|-
Line 70: Line 71:
 
| {{text anchor|CAN_STONE}}
 
| {{text anchor|CAN_STONE}}
 
|
 
|
| Allows the weapon to be made at a [[craftsdwarf's workshop]] from a sharp ([MAX_EDGE:10000] or higher) stone (e.g. [[obsidian]]) plus a wood log.
+
| Allows the weapon to be made at a [[craftsdwarf's workshop]] from a sharp ([MAX_EDGE:10000] or higher) stone (i.e. [[obsidian]]) plus a wood log.
  
 
|-
 
|-
Line 81: Line 82:
 
|  
 
|  
 
*value
 
*value
| Number of bar units needed for forging, as well as the amount gained from melting. <font color="red">Required</font>.
+
| Number of bar units needed for forging, as well as the amount gained from melting. <font color="red">Required.</font>
 +
 
 +
|-
 +
| {{text anchor|ATTACK_PREPARE_AND_RECOVER}}
 +
|
 +
* Preparation time
 +
* Recovery time
 +
| Determines the length of time to prepare this attack and until one can perform this attack again.  Values appear to be calculated in adventure mode ticks.
 +
 
 +
|-
 +
| {{text anchor|ATTACK_FLAG_BAD_MULTIATTACK}}
 +
|
 +
| Multiple strikes with this attack cannot be performed effectively.
 +
 
 +
|-
 +
| {{text anchor|ATTACK_FLAG_INDEPENDENT_MULTIATTACK}}
 +
|
 +
| Multiple strikes with this attack can be performed with no penalty.
  
 
|-
 
|-
Line 93: Line 111:
 
*noun:string
 
*noun:string
 
*velocity_multiplier:value
 
*velocity_multiplier:value
| You can have many ATTACK tags and one will be randomly selected for each attack, with EDGE attacks 100 times more common than BLUNT attacks. Contact area is usually high for slashing and low for bludgeoning, piercing, and poking. Penetration value tends to be low for slashing and high for stabbing. Penetration is ignored if attack is BLUNT. <font color="red">Required</font>.
+
| You can have many ATTACK tags and one will be randomly selected for each attack, with EDGE attacks 100 times more common than BLUNT attacks. Contact area is usually high for slashing and low for bludgeoning, piercing, and poking. Penetration value tends to be low for slashing and high for stabbing, and is ignored if attack is BLUNT. Verbs are for the 2nd and 3rd person action verbs used to describe the attack. Noun describes what part of the weapon is being used in the attack, or NO_SUB for none. Velocity_multiplier is a multiplier for the [[Material_science#Attack_Momentum|attack momentum]], increasing effectiveness; stab attacks use 1000 while the lash of a whip uses 5000.  <font color="red">Required.</font>
 
 
 
|}
 
|}
  
 
{{Category|Modding}}
 
{{Category|Modding}}
 
{{Category|Tokens}}
 
{{Category|Tokens}}
 +
[[ru:Weapon token]]

Latest revision as of 16:23, 2 April 2024

This article is about the current version of DF.
Note that some content may still need to be updated.


Weapon tokens define weapons. These tokens can only be placed within an ITEM_WEAPON object definition, and most do not function in armor objects.

Tokens[edit]

Token Arguments Description
NAME
  • singular
  • plural
Name of the weapon. Required.
ADJECTIVE
  • adjective
Adjective of the weapon, e.g. the "large" in "large copper dagger".
SIZE / WEIGHT
  • size
Volume of weapon in mL or cubic cm. Defaults to 100.
SHOOT_FORCE
  • value
The amount of force used when firing projectiles - velocity is presumably determined by the projectile's mass. Defaults to 0.
SHOOT_MAXVEL
  • value
The maximum speed a fired projectile can have.
SKILL The skill to determine effectiveness in melee with this weapon. Defaults to MACE. AXE skill will allow it to be used to chop down trees. MINING skill will allow it to be used for mining. Outsider adventurers (or regular ones with no points in offensive skills) will receive a weapon with the SPEAR skill, selected at random if multiple ones have been modded in. All adventurers will also start with a weapon using the DAGGER skill, again selected at random if multiple such weapons exist.
RANGED Makes this a ranged weapon that uses the specified ammo. The specified skill determines accuracy in ranged combat.
TWO_HANDED
  • size
Creatures under this size (in cm^3) must use the weapon two-handed (or more if the creature has extra [GRASP] parts)[Verify]. Defaults to 50000. Below this size, one-handed use of a weapon will cause a penalty to hit.
MINIMUM_SIZE
  • size
Minimum body size (in cm^3) to use the weapon at all (multigrasp required until TWO_HANDED value). Defaults to 40000.
CAN_STONE Allows the weapon to be made at a craftsdwarf's workshop from a sharp ([MAX_EDGE:10000] or higher) stone (i.e. obsidian) plus a wood log.
TRAINING Restricts this weapon to being made of wood.
MATERIAL_SIZE
  • value
Number of bar units needed for forging, as well as the amount gained from melting. Required.
ATTACK_PREPARE_AND_RECOVER
  • Preparation time
  • Recovery time
Determines the length of time to prepare this attack and until one can perform this attack again. Values appear to be calculated in adventure mode ticks.
ATTACK_FLAG_BAD_MULTIATTACK Multiple strikes with this attack cannot be performed effectively.
ATTACK_FLAG_INDEPENDENT_MULTIATTACK Multiple strikes with this attack can be performed with no penalty.
ATTACK
  • attacktype:BLUNT or EDGE
  • contact_area:value
  • penetration_size:value
  • verb2nd:string
  • verb3rd:string
  • noun:string
  • velocity_multiplier:value
You can have many ATTACK tags and one will be randomly selected for each attack, with EDGE attacks 100 times more common than BLUNT attacks. Contact area is usually high for slashing and low for bludgeoning, piercing, and poking. Penetration value tends to be low for slashing and high for stabbing, and is ignored if attack is BLUNT. Verbs are for the 2nd and 3rd person action verbs used to describe the attack. Noun describes what part of the weapon is being used in the attack, or NO_SUB for none. Velocity_multiplier is a multiplier for the attack momentum, increasing effectiveness; stab attacks use 1000 while the lash of a whip uses 5000. Required.