Difference between revisions of "Groups/Custom groups"

From Minetest Developer Wiki
Jump to navigation Jump to search
(→‎Subgames: add soil)
 
(25 intermediate revisions by 2 users not shown)
Line 1: Line 1:
This page lists the various groups which are mainly used in subgames and mods.
+
{{LuaTips}}
 +
This page lists the various groups which are used in various games and mods, but are more or less specific to those. Keep in mind the meaning of most of these groups is not “standardized”, the actual meaning depends on the particular game/mod implementation. For generic groups, see [[Groups#Special groups]] and [[Groups/Shared groups]].
  
 
('''Note''': If not group rating is specified, a rating of 1 is assumed.)
 
('''Note''': If not group rating is specified, a rating of 1 is assumed.)
  
== Subgames ==
+
== Games ==
 
=== Minetest Game ===
 
=== Minetest Game ===
Version: 0.4.12
+
Version: 0.4.14
  
These are the custom groups used by Minetest Game. Many groups listed here have also been adopted by mods and subgames which are not directly related to Minetest Game, but be careful, the intention may not always be equal!
+
These are the custom groups used by Minetest Game. Many groups listed here have also been adopted by mods and games which are not directly related to Minetest Game, but be careful, the intention may not always be equal!
 +
 
 +
==== Damage groups ====
 +
Used by weapons and tools, and by entities to determine damage on a successful hit.
 +
 
 +
* <code>fleshy</code>: Living things like animals and the player. This could imply some blood effects when hitting.
 +
 
 +
Note: <code>fleshy</code> is currently the only damage group used in Minetest Game, all tools and weapons in Minetest Game only affect the <code>fleshy</code> group.
  
 
==== Digging time groups ====
 
==== Digging time groups ====
The following groups determine digging times. The rating can be between 1 and 3; higher ratings result in slower digging.
+
The following groups determine digging times. The rating can be between 1 and 3; higher ratings result in faster digging.
  
 
* <code>crumbly</code>: dirt, sand
 
* <code>crumbly</code>: dirt, sand
Line 16: Line 24:
 
* <code>snappy</code>: something that can be cut using fine tools; eg. leaves, small plants, wire, sheets of metal
 
* <code>snappy</code>: something that can be cut using fine tools; eg. leaves, small plants, wire, sheets of metal
 
* <code>choppy</code>: something that can be cut using force; eg. trees, wooden planks
 
* <code>choppy</code>: something that can be cut using force; eg. trees, wooden planks
* <code>fleshy</code>: Living things like animals and the player. This could imply some blood effects when hitting.
 
 
* <code>explody</code>: Especially prone to explosions
 
* <code>explody</code>: Especially prone to explosions
 
* <code>oddly_breakable_by_hand</code>: Can be added to nodes that shouldn't logically be breakable by the hand but are. Somewhat similar to dig_immediate, but times are more like <code>{[1]=3.50,[2]=2.00,[3]=0.70}</code> and this does not override the speed of a tool if the tool can dig at a faster speed than this suggests for the hand.
 
* <code>oddly_breakable_by_hand</code>: Can be added to nodes that shouldn't logically be breakable by the hand but are. Somewhat similar to dig_immediate, but times are more like <code>{[1]=3.50,[2]=2.00,[3]=0.70}</code> and this does not override the speed of a tool if the tool can dig at a faster speed than this suggests for the hand.
Line 28: Line 35:
 
* <code>flora</code>: node will slowly spread when placed on a “soil”-group node but it will turn into a dry shrub when it is placed on desert sand. Usually used for small plants.
 
* <code>flora</code>: node will slowly spread when placed on a “soil”-group node but it will turn into a dry shrub when it is placed on desert sand. Usually used for small plants.
 
* <code>soil</code>: node is some sort of soil which supports the growth and spread of plants of all sorts, including farmable plants
 
* <code>soil</code>: node is some sort of soil which supports the growth and spread of plants of all sorts, including farmable plants
* <code>soil=1</code>: basic soil: Supports growth of saplings and spread of <code>flora</code> nodes. These plants can of course also grow on soil of higher ratings.
+
** <code>soil=1</code>: basic soil: Supports growth of saplings and spread of <code>flora</code> nodes. These plants can of course also grow on soil of higher ratings.
* <code>soil=2</code>: dry farming soil: Node has been cultivated by a hoe, but is not wet yet.
+
** <code>soil=2</code>: dry farming soil: Node has been cultivated by a hoe, but is not wet yet.
* <code>soil=3</code>: wet farming soil: Supports the growth of farming plants like wheat and cotton
+
** <code>soil=3</code>: wet farming soil: Supports the growth of farming plants like wheat and cotton
 +
* <code>cools_lava</code>: node turns adjacent lava sources into obsidian and adjacent flowing lava into stone
 +
* <code>lava</code>: node is lava.
 +
* <code>water</code>: node is water. Used by the buckets mod. Also acts like <code>cools_lava</code>
  
 
===== Fire =====
 
===== Fire =====
Line 44: Line 54:
 
* <code>sand</code>: node is sand.
 
* <code>sand</code>: node is sand.
 
* <code>stone</code>: node is stone.
 
* <code>stone</code>: node is stone.
* <code>wood</code>: node is wood.
+
* <code>wood</code>: node is a type of wooden planks.
 
* <code>wool</code>: node is wool (default rating: <code>1</code>).
 
* <code>wool</code>: node is wool (default rating: <code>1</code>).
 
* <code>leaves</code>: node represents leaves or needles from a tree.
 
* <code>leaves</code>: node represents leaves or needles from a tree.
 +
* <code>stick</code>: item is a stick.
 +
* <code>coal</code>: item is some kind of coal lump.
 +
* <code>water_bucket</code>: Item is a bucket filled with some kind of water.
  
 
===== Color =====
 
===== Color =====
 
* <code>dye</code>: item is a dye.
 
* <code>dye</code>: item is a dye.
* <code>basecolor_white</code>, <code>excolor_yellow</code>, <code>unicolor_dark_blue_s50</code>, and the like: Declares the color of an item. For all groups that are defined by the dye mod see the [https://github.com/minetest/minetest_game/blob/master/mods/dye/init.lua init.lua] of it.
+
* <code>basecolor_white</code>, <code>excolor_yellow</code>, <code>unicolor_dark_blue_s50</code>, and the like: Declares the color of an item. See [https://github.com/minetest/minetest_game/blob/master/game_api.txt game_api.txt].
  
 
'''Note''': The various color groups in the dyes mod can be considered as a standard in the modding community. They are also in widespread use, independently of Minetest Game
 
'''Note''': The various color groups in the dyes mod can be considered as a standard in the modding community. They are also in widespread use, independently of Minetest Game
  
==== Shelves ====
+
==== Functional ====
 +
* <code>not_in_creative_inventory</code>: the item is not added to the creative inventory. '''Note''': This group is also widespread across other games and mods.
 
* <code>vessel</code>: item is a vessel (small liquids container) and can be put in a [http://wiki.minetest.net/Vessels_Shelf vessels shelf].
 
* <code>vessel</code>: item is a vessel (small liquids container) and can be put in a [http://wiki.minetest.net/Vessels_Shelf vessels shelf].
 
* <code>book</code>: item is a book and can be put in a [http://wiki.minetest.net/Bookshelf bookshelf].
 
* <code>book</code>: item is a book and can be put in a [http://wiki.minetest.net/Bookshelf bookshelf].
 
==== Functional ====
 
* <code>not_in_creative_inventory</code>: the item is not added to the creative inventory. '''Note''': This group is also widespread across other subgames and mods which are unrelated to Minetest Game.
 
  
 
==== Informational ====
 
==== Informational ====
Line 67: Line 78:
 
* <code>plant</code>: node is a small-sized plant.
 
* <code>plant</code>: node is a small-sized plant.
 
* <code>flower</code>: node is a flower.
 
* <code>flower</code>: node is a flower.
* <code>liquid</code>: node is a liquid. Ratings: water=<code>3</code>, lava=<code>2</code>.
+
* <code>pane</code>: node is a “pane” like Glass Pane or Iron bar. Defined by the <code>xpanes</code> mod.
* <code>lava</code>: node is lava. Used by the obsidian ABM
+
* <code>wall</code>: node is a wall, used to connect to other nodes of the wall group together
* <code>water</code>: node is water. Used by the buckets mod and for the obsidian ABM
+
* <code>bed</code>: node/item is a bed
* <code>hot</code>: node is hot (used by lava, rating <code>3</code>).
+
* <code>door</code>: node/item is a door
* <code>melty</code>: node can be melted (used by steelblock, rating <code>3</code>).
+
* <code>liquid</code>: node is a liquid
 +
** <code>liquid=2</code>: lava (see also: <code>lava</code>)
 +
** <code>liquid=3</code>: water (see also: <code>water</code>)
  
== Mods ==
 
 
=== Pedology ===
 
=== Pedology ===
 
https://forum.minetest.net/viewtopic.php?f=11&t=9429
 
https://forum.minetest.net/viewtopic.php?f=11&t=9429
Line 106: Line 118:
  
 
== Editing this page ==
 
== Editing this page ==
Feel free to add your own subgames and mods. There are some guidelines for editing:
+
Feel free to add your own games and mods. There are some guidelines for editing:
  
* Do not add groups which are intended to be used only internally by the mod or subgame
+
* Do not add groups which are intended to be used only internally by the mod or game
 
* Don't forget to mention the meaning of the group rating. If you omit it, we assume the group rating to be always 1 or it does not matter.
 
* Don't forget to mention the meaning of the group rating. If you omit it, we assume the group rating to be always 1 or it does not matter.
* Specify the mod's / subgame's version number, if possible, so the users can see whether this page is still up to date
+
* Specify the mod's / game's version number, if possible, so the users can see whether this page is still up to date
 
[[Category:Misc]]
 
[[Category:Misc]]

Latest revision as of 15:25, 13 May 2019

Mbox information.png This page contains community-written advice, tips, tricks or recommendations about modding. Your mileage may vary.

This page lists the various groups which are used in various games and mods, but are more or less specific to those. Keep in mind the meaning of most of these groups is not “standardized”, the actual meaning depends on the particular game/mod implementation. For generic groups, see Groups#Special groups and Groups/Shared groups.

(Note: If not group rating is specified, a rating of 1 is assumed.)

Games

Minetest Game

Version: 0.4.14

These are the custom groups used by Minetest Game. Many groups listed here have also been adopted by mods and games which are not directly related to Minetest Game, but be careful, the intention may not always be equal!

Damage groups

Used by weapons and tools, and by entities to determine damage on a successful hit.

  • fleshy: Living things like animals and the player. This could imply some blood effects when hitting.

Note: fleshy is currently the only damage group used in Minetest Game, all tools and weapons in Minetest Game only affect the fleshy group.

Digging time groups

The following groups determine digging times. The rating can be between 1 and 3; higher ratings result in faster digging.

  • crumbly: dirt, sand
  • cracky: tough but crackable stuff like stone.
  • snappy: something that can be cut using fine tools; eg. leaves, small plants, wire, sheets of metal
  • choppy: something that can be cut using force; eg. trees, wooden planks
  • explody: Especially prone to explosions
  • oddly_breakable_by_hand: Can be added to nodes that shouldn't logically be breakable by the hand but are. Somewhat similar to dig_immediate, but times are more like {[1]=3.50,[2]=2.00,[3]=0.70} and this does not override the speed of a tool if the tool can dig at a faster speed than this suggests for the hand.

ABMs

Groups which are mainly used by ABMs for block interaction:

  • tree: node is the trunk of a tree (like “Tree”, “Jungle Tree”, etc.). Prevents blocks in leafdecay group from decaying.
  • leafdecay: node decays if no block in the tree group is in a radius of the rating.
  • leafdecay_drop: if node decays because of leafdecay, it will always drop as an item.
  • flora: node will slowly spread when placed on a “soil”-group node but it will turn into a dry shrub when it is placed on desert sand. Usually used for small plants.
  • soil: node is some sort of soil which supports the growth and spread of plants of all sorts, including farmable plants
    • soil=1: basic soil: Supports growth of saplings and spread of flora nodes. These plants can of course also grow on soil of higher ratings.
    • soil=2: dry farming soil: Node has been cultivated by a hoe, but is not wet yet.
    • soil=3: wet farming soil: Supports the growth of farming plants like wheat and cotton
  • cools_lava: node turns adjacent lava sources into obsidian and adjacent flowing lava into stone
  • lava: node is lava.
  • water: node is water. Used by the buckets mod. Also acts like cools_lava
Fire

Used by the fire mod:

  • flammable: can be set on fire. Higher values mean more flammable.
  • puts_out_fire: if in a node with this group is near fire the fire gets extinguished.
  • igniter: sets flammable nodes on fire. Rating defines the radius.

Crafting

These groups are mostly used in crafting recipes:

  • sand: node is sand.
  • stone: node is stone.
  • wood: node is a type of wooden planks.
  • wool: node is wool (default rating: 1).
  • leaves: node represents leaves or needles from a tree.
  • stick: item is a stick.
  • coal: item is some kind of coal lump.
  • water_bucket: Item is a bucket filled with some kind of water.
Color
  • dye: item is a dye.
  • basecolor_white, excolor_yellow, unicolor_dark_blue_s50, and the like: Declares the color of an item. See game_api.txt.

Note: The various color groups in the dyes mod can be considered as a standard in the modding community. They are also in widespread use, independently of Minetest Game

Functional

  • not_in_creative_inventory: the item is not added to the creative inventory. Note: This group is also widespread across other games and mods.
  • vessel: item is a vessel (small liquids container) and can be put in a vessels shelf.
  • book: item is a book and can be put in a bookshelf.

Informational

Misc. groups where their main purpose seems to group similar things together. They may be used for many different tasks

  • sapling: node is a sapling.
  • plant: node is a small-sized plant.
  • flower: node is a flower.
  • pane: node is a “pane” like Glass Pane or Iron bar. Defined by the xpanes mod.
  • wall: node is a wall, used to connect to other nodes of the wall group together
  • bed: node/item is a bed
  • door: node/item is a door
  • liquid: node is a liquid
    • liquid=2: lava (see also: lava)
    • liquid=3: water (see also: water)

Pedology

https://forum.minetest.net/viewtopic.php?f=11&t=9429

Version: 3.0

  • wet: Node is wet, rating ranges from 1-5 (higher = wetter). If this group is not present, the node is seen as dry.
  • oozing: Node will slowly transfert its wetness towards neighboring “sucky” nodes. Rating does not matter.
  • sucky: Node is able to receive wetness from neighboring wet and oozing nodes. Rating does not matter.
  • sun_dry: Node will dry off over time when exposed to sunlight. Rating must be 1.

This was only a quick overview. Refer to the mod's README.md for a more detailed and up-to-date information.

Realistic Suffocation

https://forum.minetest.net/viewtopic.php?f=9&t=15304

Version: 1.0.0

This mod introduces 2 groups:

  • disable_suffocation: This mod won't add suffocation (drowning damage for solid full cube blocks) to nodes in this group (rating: 1)
  • real_suffocation: This group is added by this mod to all nodes it modified (added drowning damage) (rating: 1)

Slime blocks and liquids

https://forum.minetest.net/viewtopic.php?f=11&t=10423

Version: 1.0.0

This mod introduces one digging group:

  • slimey: For blocks made out of slime. Rating ranges from 1-3 (higher = more slimey)

Editing this page

Feel free to add your own games and mods. There are some guidelines for editing:

  • Do not add groups which are intended to be used only internally by the mod or game
  • Don't forget to mention the meaning of the group rating. If you omit it, we assume the group rating to be always 1 or it does not matter.
  • Specify the mod's / game's version number, if possible, so the users can see whether this page is still up to date