Types/CollisionMask - Revision history

BilkaBot: Removed old prototype docs

2024-10-25T14:32:18Z

Removed old prototype docs

← Older revision		Revision as of 14:32, 25 October 2024
Line 2:		Line 2:

	</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>		</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>



	~~The collision mask is specified as an Array ([[Types/table]]) of strings. Every entry is a specification of one layer the object collides with or a special collision option.~~

	~~Supplying an empty table means that no layers and no collision options are set.~~

	The base game provides common collision mask functions in a Lua file in the core lualib: [https://github.com/wube/factorio-data/blob/master/core/lualib/collision-mask-util.lua collision-mask-util.lua].

	~~== Layers ==~~

	* "ground-tile"
	* "water-tile"
	* "resource-layer"
	* "doodad-layer"
	* "floor-layer"
	* "rail-layer"
	* "transport-belt-layer"
	* "item-layer"
	* "ghost-layer"
	* "object-layer"
	* "player-layer"
	* "train-layer"
	* "layer-<code>N</code>" where <code>N</code> is between 13 and 55, inclusive (layer-13 through layer-55)

	Layer-13 through layer-55 are currently unused by the core game. If a mod is going to use one of the unused layers it's recommended to use the <code>collision_mask_util.get_first_unused_layer()</code> from the above linked library. If the library is not used, it is recommended start at the higher layers because the base game will take from the lower ones.

	~~== Collision options ==~~
	~~These are not collision masks, instead they control other aspects of collision, but they are still specified here.~~
	~~=== "not-colliding-with-itself" ===~~
	Any 2 entities that both have this option enabled on their prototype and have an identical collision mask layers list will not collide. Other collision mask options are not included in the identical layer list check. This does mean that 2 different prototypes with the same collision mask layers and this option enabled will not collide.

	~~=== "consider-tile-transitions" ===~~

	~~Uses the prototypes position rather than its collision box when doing collision checks with tile prototypes. Allows the prototype to overlap colliding tiles up until its center point.~~
	~~This is only respected for character movement and cars driven by players.~~

	~~=== "colliding-with-tiles-only" ===~~
	~~Any prototype with this collision option will only be checked for collision with other prototype's collision masks if they are a tile.~~

	~~== Default collision masks ==~~
	~~The default collision masks of all entity types can be found [[Prototype/Entity#collision_mask\|here]].~~

	~~Example (Most common collision mask of buildings):~~
	~~<syntaxhighlight lang="lua">collision_mask = { "item-layer", "object-layer", "player-layer", "water-tile"}</syntaxhighlight>~~

BilkaBot: Updated styling of prototype doc migration note

2023-09-21T10:42:23Z

Updated styling of prototype doc migration note

← Older revision		Revision as of 10:42, 21 September 2023
Line 1:		Line 1:
	'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/types/CollisionMask.html https://lua-api.factorio.com/latest/types/CollisionMask.html]		<div class="stub"><p>'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/types/CollisionMask.html https://lua-api.factorio.com/latest/types/CollisionMask.html]

	This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].		</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>

BilkaBot: Protected "Types/CollisionMask": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2023-08-16T17:51:31Z

Protected "Types/CollisionMask": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

← Older revision		Revision as of 17:51, 16 August 2023
(No difference)

BilkaBot: Migrated prototype doc to separate website

2023-08-16T17:51:31Z

Migrated prototype doc to separate website

← Older revision		Revision as of 17:51, 16 August 2023
Line 1:		Line 1:
			'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/types/CollisionMask.html https://lua-api.factorio.com/latest/types/CollisionMask.html]

			This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].



	The collision mask is specified as an Array ([[Types/table]]) of strings. Every entry is a specification of one layer the object collides with or a special collision option.		The collision mask is specified as an Array ([[Types/table]]) of strings. Every entry is a specification of one layer the object collides with or a special collision option.

Xorimuth: /* Layers */ Reorder list based on internal implementation order

2021-11-05T16:06:55Z

Layers: Reorder list based on internal implementation order

← Older revision		Revision as of 16:06, 5 November 2021
Line 12:		Line 12:
	* "doodad-layer"		* "doodad-layer"
	* "floor-layer"		* "floor-layer"
			* "rail-layer"
			* "transport-belt-layer"
	* "item-layer"		* "item-layer"
	* "ghost-layer"		* "ghost-layer"
Line 17:		Line 19:
	* "player-layer"		* "player-layer"
	* "train-layer"		* "train-layer"
	* "rail-layer"
	* "transport-belt-layer"
	* "layer-<code>N</code>" where <code>N</code> is between 13 and 55, inclusive (layer-13 through layer-55)		* "layer-<code>N</code>" where <code>N</code> is between 13 and 55, inclusive (layer-13 through layer-55)

Bilka: mention collision_mask_util.get_first_unused_layer when choosing layers to use in mods

2021-08-20T10:33:09Z

mention collision_mask_util.get_first_unused_layer when choosing layers to use in mods

← Older revision		Revision as of 10:33, 20 August 2021
Line 21:		Line 21:
	* "layer-<code>N</code>" where <code>N</code> is between 13 and 55, inclusive (layer-13 through layer-55)		* "layer-<code>N</code>" where <code>N</code> is between 13 and 55, inclusive (layer-13 through layer-55)

	Layer-13 through layer-55 are currently unused by the core game. If a mod is going to use one of the unused layers it's recommended to start at the higher layers because the base game will take from the lower ones.		Layer-13 through layer-55 are currently unused by the core game. If a mod is going to use one of the unused layers it's recommended to use the <code>collision_mask_util.get_first_unused_layer()</code> from the above linked library. If the library is not used, it is recommended start at the higher layers because the base game will take from the lower ones.

	== Collision options ==		== Collision options ==

Bilka: 1.1 addition of more collision masks

2020-12-03T15:36:39Z

1.1 addition of more collision masks

@@ Line 2: / Line 2: @@
 Supplying an empty table means that no layers and no collision options are set.
 == Layers ==
-Layer-11 through layer-15 are currently unused by the core game.
+* "ground-tile"
 == Collision options ==

Bilka: idk man

2020-09-24T06:44:05Z

idk man

← Older revision		Revision as of 06:44, 24 September 2020
Line 30:		Line 30:

	Uses the prototypes position rather than its collision box when doing collision checks with tile prototypes. Allows the prototype to overlap colliding tiles up until its center point.		Uses the prototypes position rather than its collision box when doing collision checks with tile prototypes. Allows the prototype to overlap colliding tiles up until its center point.
	This is only respected for ~~unit pathfinding,~~ character movement and cars driven by players.		This is only respected for character movement and cars driven by players.

	=== "colliding-with-tiles-only" ===		=== "colliding-with-tiles-only" ===

Bilka: consider tile transitions desc expansion

2020-09-24T06:38:48Z

consider tile transitions desc expansion

← Older revision		Revision as of 06:38, 24 September 2020
Line 30:		Line 30:

	Uses the prototypes position rather than its collision box when doing collision checks with tile prototypes. Allows the prototype to overlap colliding tiles up until its center point.		Uses the prototypes position rather than its collision box when doing collision checks with tile prototypes. Allows the prototype to overlap colliding tiles up until its center point.
			This is only respected for unit pathfinding, character movement and cars driven by players.

	=== "colliding-with-tiles-only" ===		=== "colliding-with-tiles-only" ===

Bilka: note on empty table

2020-05-15T10:38:33Z

note on empty table

← Older revision		Revision as of 10:38, 15 May 2020
Line 1:		Line 1:
	The collision mask is specified as an Array ([[Types/table]]) of strings. Every entry is a specification of one layer the object collides with or a special collision option.		The collision mask is specified as an Array ([[Types/table]]) of strings. Every entry is a specification of one layer the object collides with or a special collision option.

			Supplying an empty table means that no layers and no collision options are set.

	== Layers ==		== Layers ==