Lua script examples - Revision history

DPhKraken: /* Werebugs */ humanoidable_only remap

2026-01-29T06:52:48Z

Werebugs: humanoidable_only remap

Doorkeeper: /* Werebugs */

2025-12-01T14:21:45Z

Werebugs

Doorkeeper: /* Making your own RCP */ RCP -> rcp

2025-12-01T14:20:24Z

Making your own RCP: RCP -> rcp

DPhKraken: /* Tweaking creatures */ Added general Lua select example

2025-11-21T04:55:45Z

Tweaking creatures: Added general Lua select example

DPhKraken: /* Werebugs */

2025-10-19T06:57:16Z

Werebugs

DPhKraken: Repo link

2025-10-18T18:54:55Z

Repo link

DPhKraken: /* Werebugs */ Added fallback RCP

2025-10-17T18:30:34Z

Werebugs: Added fallback RCP

DPhKraken: Add version switcher, as it's version-specific

2025-07-21T21:19:47Z

Add version switcher, as it's version-specific

Cali: /* Making your own RCP */ Whether "a" or "an" is used is based on the initial sound of a word, not the initial letter. So, similar to "a European" or "a unicorn", this would be "a eurypterid" because they all have an initial consonant "y" sound.

2025-07-07T22:22:38Z

Making your own RCP: Whether "a" or "an" is used is based on the initial sound of a word, not the initial letter. So, similar to "a European" or "a unicorn", this would be "a eurypterid" because they all have an initial consonant "y" sound.

Silverwing235: /* Remove default functions */ fix self-typo

2025-07-07T14:25:32Z

Remove default functions: fix self-typo

@@ Line 525: / Line 525: @@
 		no_tweak=true,
 		material_weakness=true,
 		prioritize_bite=true,
 		force_ichor=true,

@@ Line 437: / Line 437: @@
 ===Werebugs===
-You can make a custom function to determine what RCPs are available to a given creature.
+You can make a custom function to determine what rcps are available to a given creature.
 These scripts are for an arthropoid version of a [[werebeast]].
-* ``arthropod_rcp`` is a list of RCP keys which fit this theme (plus a few worms on there for fun), which the creature function rolls on to pick its form.
+* ``arthropod_rcp`` is a list of rcp keys which fit this theme (plus a few worms on there for fun), which the creature function rolls on to pick its form.
 * ``is_bloodsucking_by_key``, along with ``rcp.must_suck_blood_through_proboscis`` and ``rcp.must_suck_blood_through_mouth`` are checked to assign {{token|BLOODSUCKER}} to it, which allows certain creature types to exhibit vampiric behavior if their berserk rampage wasn't enough [[fun]].
@@ Line 589: / Line 589: @@
 	lines[#lines+1]="[DIFFICULTY:3]"
 	lines[#lines+1]="[LAIR:SIMPLE_BURROW:50]"
-	-- pick a random bug RCP, there's no overlap with the mammal/reptile standard werebeasts
+	-- pick a random bug rcp, there's no overlap with the mammal/reptile standard werebeasts
 	finalize_random_creature_types() -- good practice to run before rolling on it
 	local rcp_key = pick_random_no_replace(arthropod_rcp) or "INSECT_MANTIS"

@@ Line 354: / Line 354: @@
 }}
-===Making your own RCP===
+===Making your own rcp===
 You don't have to be limited to the vanilla list of random creature variants. Mods can add new kinds of random creature profiles, materials, etc that can be seamlessly integrated into how it generates creatures.
-This script generates a single creature based on a [[Wikipedia:Eurypterid|eurypterid]]. It has a unique RCP, set in the function itself.
+This script generates a single creature based on a [[Wikipedia:Eurypterid|eurypterid]]. It has a unique rcp, set in the function itself.
 {{Scriptdata
@@ Line 412: / Line 412: @@
 {{Scriptdata
-|title=Global RCP
+|title=Global rcp
 |script=
 random_creature_types.EURYPTERID={

@@ Line 786: / Line 786: @@
 ===Tweaking creatures===
+Common Lua features allow you to extend functions by mirroring the original function and then overwriting it, akin to the ``SELECT`` tags. This function extends ``add_regular_tokens()`` to add {{token|GENERAL_MATERIAL_FORCE_MULTIPLIER}} to all generated creatures.
 <!--Consolidate the creature patching stuff in a single header-->
-This function is run in ``build_body_from_rcp()`` right before tweaks are determined. If a generated creature's size is greater than 500,000 Γ (about as much as an [[elephant]]), this patch adds {{token|POWER}} and the like to make forgotten beasts, titans, etc capable of impersonating [[Deity|deities]] and ruling [[civilization]]s.
+This function is run in ``build_body_from_rcp()`` right before tweaks are determined (See [[Lua functions#Creature patching]]). If a generated creature's size is greater than 500,000 Γ (about as much as an [[elephant]]), this patch adds {{token|POWER}} and the like to make forgotten beasts, titans, etc capable of impersonating [[Deity|deities]] and ruling [[civilization]]s.
 {{Scriptdata

@@ Line 591: / Line 591: @@
 	-- pick a random bug RCP, there's no overlap with the mammal/reptile standard werebeasts
 	finalize_random_creature_types() -- good practice to run before rolling on it
-	local rcp_key = pick_random_no_replace(arthropod_rcp)
+	local rcp_key = pick_random_no_replace(arthropod_rcp) or "INSECT_MANTIS"
-	local rcp=random_creature_types[rcp_key] or random_creature_types.INSECT_MANTIS
+	local rcp=random_creature_types[rcp_key]
 	local custom_desc_str = "it is crazed for blood and flesh"

@@ Line 2: / Line 2: @@
 {{Modding}}
 {{Main|Lua scripting}}
-Snippets of vanilla generation can be found in [[:Category:Lua script pages]], and all vanilla scripts can be found in ``data/vanilla/vanilla_procedural/scripts/``.
+Snippets of vanilla generation can be found in [[:Category:Lua script pages]], and all vanilla scripts can be found in ``[https://github.com/Putnam3145/DF-Raws/tree/master/vanilla_procedural/scripts data/vanilla/vanilla_procedural/scripts/]``.
 __TOC__
 <!--Needs a special line break-->

← Older revision		Revision as of 21:19, 21 July 2025
Line 1:		Line 1:
		+	{{av}}
	{{Modding}}		{{Modding}}
	{{Main\|Lua scripting}}		{{Main\|Lua scripting}}

@@ Line 357: / Line 357: @@
 You don't have to be limited to the vanilla list of random creature variants. Mods can add new kinds of random creature profiles, materials, etc that can be seamlessly integrated into how it generates creatures.
-This script generates a single creature based on an [[Wikipedia:Eurypterid|eurypterid]]. It has a unique RCP, set in the function itself.
+This script generates a single creature based on a [[Wikipedia:Eurypterid|eurypterid]]. It has a unique RCP, set in the function itself.
 {{Scriptdata
@@ Line 404: / Line 404: @@
 }}
 <br><br>
-Adding an eurypterid profile to ``random_creature_profiles`` allows any creature to access it, if their profile is determined randomly.
+Adding a eurypterid profile to ``random_creature_profiles`` allows any creature to access it, if their profile is determined randomly.
 This script gives it proper flippers in its body base function. It's also associated with water-based random creatures, so it can potentially generate as an aquatic [[forgotten beast]] species.

@@ Line 300: / Line 300: @@
 ===Remove default functions===
-Just as easily as new functions and table entries can be added, default entries can be overridden so that they cannot generate. This snippet removes the default forgotten beasts.
+Just as easily as new functions and table entries can be added, default entries can be overwritten so that they cannot generate. This snippet removes the default forgotten beasts.
 See [[Lua functions#Generation Tables]] for a list of the tables the default functions are stored in.