Lua functions - Revision history

DPhKraken: humanoidable_only remap

2026-01-29T06:55:47Z

humanoidable_only remap

Doorkeeper: RCP -> rcp, lc headings

2025-12-01T14:25:01Z

RCP -> rcp, lc headings

Putnam3145: /* Tables */ well that's just not right at all

2025-10-10T17:51:27Z

Tables: well that's just not right at all

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

2025-07-21T21:20:06Z

Add version switcher, as it's version-specific

DPhKraken: /* Generation Tables */ Pre-gen randoms

2025-07-13T04:56:24Z

Generation Tables: Pre-gen randoms

DPhKraken: /* Creature patching */ Generalized description, timing, local functions

2025-07-07T19:54:55Z

Creature patching: Generalized description, timing, local functions

DPhKraken: /* Creature patching */ Header size

2025-06-19T00:52:49Z

Creature patching: Header size

DPhKraken: /* Creatures */ Listed patching/logic insertion functions

2025-06-19T00:52:26Z

Creatures: Listed patching/logic insertion functions

DPhKraken: /* Options */ Eyes and humanoidables

2025-06-18T01:12:18Z

Options: Eyes and humanoidables

DPhKraken: /* Creatures */ Spacing

2025-06-13T19:09:41Z

Creatures: Spacing

@@ Line 677: / Line 677: @@
 |-
-| ''bool'' is_valid_random_creature(''string''&nbsp;creature, ''bool''&nbsp;do_water, ''bool''&nbsp;humanoid_only, ''bool''&nbsp;is_good, ''bool''&nbsp;beast_only)
+| ''bool'' is_valid_random_creature(''string''&nbsp;creature, ''bool''&nbsp;do_water, ''bool''&nbsp;humanoidable_only, ''bool''&nbsp;is_good, ''bool''&nbsp;beast_only)
-| Checks if ``creature`` is a valid key in certain tables depending on the arguments: aquatic (``do_water``), can be "twisted into humanoid form" (``humanoid_only``), isn't an "evil" species (``is_good``), and is an animal species (``beast_only``)
+| Checks if ``creature`` is a valid key in certain tables depending on the arguments: aquatic (``do_water``), can be "twisted into humanoid form" (``humanoidable_only``), isn't an "evil" species (``is_good``), and is an animal species (``beast_only``)
 At debug_level >= 3, will be logged.
@@ Line 757: / Line 757: @@
 |-
-| humanoid_only
+| humanoidable_only
 | get_random_creature_profile()
 build_body_from_rcp()
-| Use a rcp that can be turned into a humanoid form (``humanoidable_random_creature``), and automatically applies the ``MAKE_HUMANOID`` tweak.
+| Use a rcp that can be turned into a humanoid form (``humanoidable_random_creature``), and automatically applies the ``MAKE_HUMANOID`` tweak. Will apply the tweak even if the body is already humanoid.
 |-

@@ Line 4: / Line 4: @@
 Dwarf Fortress defines a number of functions in addition to those standard for [https://www.lua.org/manual/5.4/ Lua 5.4].
-==C++ Function Calls==
+==C++ function calls==
 {| {{prettytable}}
@@ Line 197: / Line 197: @@
 |}
-==Generation Tables==
+==Generation tables==
 The ``generate()`` function is defined in ``init/generators.lua``, and is called to generate objects.
@@ Line 659: / Line 659: @@
 |}
-==Random Creatures==
+==Random creatures==
 Creatures generated by ``vanilla_procedural`` use a number of shared functions to determine their attributes. The local ``options`` table stores most of the data used by these steps.
-===RCP Functions===
+===rcp functions===
 The random creature profile determines the basic body of a generated creature, such as "humanoid" or "[[toad]]", and provides options and data to later build the proper creature definition.
@@ Line 687: / Line 687: @@
 |}
-===Shared Functions===
+===Shared functions===
 Default creatures use ``add_regular_tokens()``, ``populate_sphere_info()``, ``get_random_creature_profile()``, ``add_body_size()`` and ``build_procgen_creature()`` as the main steps in generating raws.
@@ Line 754: / Line 754: @@
 | do_water
 | get_random_creature_profile()
-| Use an aquatic RCP (``water_based_random_creature``)
+| Use an aquatic rcp (``water_based_random_creature``)
 |-
@@ Line 760: / Line 760: @@
 | get_random_creature_profile()
 build_body_from_rcp()
-| Use a RCP that can be turned into a humanoid form (``humanoidable_random_creature``), and automatically applies the ``MAKE_HUMANOID`` tweak.
+| Use a rcp that can be turned into a humanoid form (``humanoidable_random_creature``), and automatically applies the ``MAKE_HUMANOID`` tweak.
 |-
 | beast_only
 | get_random_creature_profile()
-| Forbids generic humanoid/blob/quadruped RCPs (``not_beast_random_creature``).
+| Forbids generic humanoid/blob/quadruped rcps (``not_beast_random_creature``).
 |-
@@ Line 798: / Line 798: @@
 build_body_from_rcp()<br>
 build_description()
-| Forbids "evil" RCPs (``cannot_be_good_random_creature``).
+| Forbids "evil" rcps (``cannot_be_good_random_creature``).
-Affects options for materials, tweaks, description. Cannot have attack tweaks unless the RCP forces it.
+Affects options for materials, tweaks, description. Cannot have attack tweaks unless the rcp forces it.
 |-
@@ Line 884: / Line 884: @@
 | no_tweak
 | build_body_from_rcp()
-| Will not add any random tweaks (such as body parts or attacks) to the basic creature that aren't specified by the RCP.
+| Will not add any random tweaks (such as body parts or attacks) to the basic creature that aren't specified by the rcp.
 |-
@@ Line 902: / Line 902: @@
 | no_random_attack_tweak
 | build_body_from_rcp()
-| Will not add attack tweaks (or body parts that grant them) that aren't specified by the RCP.
+| Will not add attack tweaks (or body parts that grant them) that aren't specified by the rcp.
 |-
 | strong_attack_tweak
 | build_body_from_rcp()
-| Enables access to attack tweaks. Will always gain an attack tweak, unless the RCP already specifies it.
+| Enables access to attack tweaks. Will always gain an attack tweak, unless the rcp already specifies it.
 |-
@@ Line 1,282: / Line 1,282: @@
 |}
-===RCP Parameters===
+===rcp parameters===
 [[Category:Modding]]
 [[Category:Lua|F]]

@@ Line 123: / Line 123: @@
 |-
 | ''void'' {{text anchor|convert_array_to_set}}(''table'' tbl)
-| For each key in a table, sets the value to true.
+| Makes a set from an array, e.g. takes {"a","b","c"} and makes it {a=true,b=true,c=true} so that it can be indexed.
 |-

← Older revision		Revision as of 21:20, 21 July 2025
Line 1:		Line 1:
		+	{{av}}
	{{Modding}}		{{Modding}}

@@ Line 206: / Line 206: @@
 ===Custom===
-When the game uses ``generate()`` to generate objects, all functions in the following tables are run in sequence. Global variable ``random_object_parameters`` is only ever populated with values once per world generation, once the terrain is finalized and before history can begin. This is the initial generation call, and this is where objects can be registered that will then be populated throughout the world. Later ``generate()`` calls are used for more specific purposes, such as when a {{token|NIGHT_CREATURE_EXPERIMENTER}} histfig designs an [[experiment]].
+{{main|Lua scripting#Object generation}}
 Functions stored and called through these tables are not supplied with arguments.
@@ Line 217: / Line 223: @@
 |-
 | preprocess
-| Includes two functions by default:<br>
+| Run at the start of each ``generate()`` call, after unit testing.
 ``preprocess.demon()``, which populates the distribution of ``demon_type`` string inputs<br>
 ``preprocess.bogeyman_polymorph()``, which generates the [[bogeyman]]'s polymorph [[Interaction token|interactions]] if bogeymen exist<br>
 |-
 | do_once
-| Runs immediately after all functions in preprocess, and before all other generation steps. Only runs if ``random_object_parameters.main_world_randoms = true``, for added safety.
+| Runs immediately after all functions in preprocess, and before all other generation steps. Only runs if ``random_object_parameters.main_world_randoms == true`` (in prehistory once the map is finalized)
-Recommended for generating custom objects.<br>
+Recommended for generating most custom objects.<br>
 Includes one function by default:<br>
 ``do_once.rcp_mat_emission()``, adds the ``RCP_MATERIAL_EMISSION`` [[Interaction token|interaction]]
@@ Line 608: / Line 620: @@
 ===Materials===
 {| {{prettytable}}

@@ Line 307: / Line 307: @@
 |}
 ====Creature patching====
-{{Main|Lua scripting#Logic insertion}}
+{{Main|Lua scripting#Tweaks}}
 {| {{prettytable}}
 |- style='background-color:#ddd'
-! width="20%" | Table
+! width="10%" | Table
-! width="80%" | Inputs
+! width="30%" | Inputs
 |-
 | btc1_tweaks
 | function(lines, options, add_to_body, add_to_body_unique, add_tweak_candidate)
 |-
 | feature_tweaks
 | function(rcp, options, add_to_body, add_to_body_unique, add_tweak_candidate)
 |-
 | post_attack_tweaks
 | function(lines, options, is_in_body)
 |-
 | post_gait_tweaks
 | function(lines, options)
 |}

@@ Line 304: / Line 304: @@
 | function(subregion, tok)
 | [[Titan]]
 |-
 | btc1_tweaks
 | function(lines, options, add_to_body, add_to_body_unique, add_tweak_candidate)
 |}

@@ Line 697: / Line 697: @@
 | humanoid_only
 | get_random_creature_profile()
-| Use a RCP that can be turned into a humanoid form (``humanoidable_random_creature``)
+build_body_from_rcp()
 |-
@@ Line 977: / Line 978: @@
 |-
+|
 beak<br>
 brain<br>
@@ Line 1,021: / Line 1,023: @@
 |-
+|
 glowing_eyes<br>
 fingers<br>

@@ Line 259: / Line 259: @@
 |-
 | creatures.demon
-| function(demon_type,difficulty,tok)
+| function(demon_type, difficulty, tok)
 | [[Demon]]
@@ Line 275: / Line 275: @@
 |-
 | creatures.fb
-| function(layer_type,tok)
+| function(layer_type, tok)
 | [[Forgotten beast]]
@@ Line 297: / Line 297: @@
 werebeast_origin_interactions{{Tooltip|*|Called by vanilla_procedural, not by init/generators}}
 | function(tok)
-function(tok,name,options)
+function(tok, name, options)
 | [[Werebeast]]
 |-
 | creatures.titan
-| function(subregion,tok)
+| function(subregion, tok)
 | [[Titan]]
 |-
 | btc1_tweaks
-| function(lines,options,add_to_body,add_to_body_unique,add_tweak_candidate)
+| function(lines, options, add_to_body, add_to_body_unique, add_tweak_candidate)
 | [[Lua scripting#Logic insertion]]