mirror of https://github.com/joe7575/tubelib2.git synced 2024-07-04 15:05:23 +02:00

A library for mods which need connecting tubes / pipes / cables or similar

Go to file

Cam B 60acf03638 Inline documentation update		2021-01-23 17:50:53 +00:00
locale	WiFi pairing improved	2018-12-22 11:19:34 +01:00
textures	further improvements	2018-10-16 20:21:41 +02:00
COPYING.txt	copying file added	2020-04-26 14:15:47 +02:00
depends.txt	v0.6 intllib support added, max tube length bugfix	2018-12-20 16:28:23 +01:00
description.txt	first commit	2018-10-05 21:55:40 +02:00
design.txt	v0.5 node meta data removed, memory cache added instead of	2018-12-16 18:53:19 +01:00
init.lua	Generator function 'get_tube_line' added, storage improvements	2020-05-31 20:39:46 +02:00
internal1.lua	v1.8 * 'special nodes' as alternative to 'secondary nodes' introduced	2020-02-09 10:55:39 +01:00
internal2.lua	Separated out valid sides into a new table, provided additional functions for valid sides	2021-01-23 17:03:20 +00:00
intllib.lua	v0.6 intllib support added, max tube length bugfix	2018-12-20 16:28:23 +01:00
intllib.sh	v0.6 intllib support added, max tube length bugfix	2018-12-20 16:28:23 +01:00
LICENSE.txt	v0.5 node meta data removed, memory cache added instead of	2018-12-16 18:53:19 +01:00
mod.conf	first commit	2018-10-05 21:55:40 +02:00
README.md	Revert version, not my job	2021-01-21 23:24:16 +00:00
screenshot.png	first commit	2018-10-05 21:55:40 +02:00
storage.lua	Generator function 'get_tube_line' added, storage improvements	2020-05-31 11:32:12 +02:00
tube_api.lua	Inline documentation update	2021-01-23 17:50:53 +00:00
tube_test.lua	Generator function 'get_tube_line' added, storage improvements	2020-05-31 11:32:12 +02:00

README.md

Tube Library 2 [tubelib2]

A library for mods which need connecting tubes / pipes / cables or similar.

This mod is not useful for its own. It does not even have any nodes. It only comes with a few test nodes to play around with the tubing algorithm.

Browse on:

Download:

Description

Tubelib2 distinguished two kinds of nodes:

primary nodes are tube like nodes (pipes, cables, ...)
secondary nodes are all kind of nodes, which can be connected by means of primary nodes

Tubelib2 specific 6D directions (1 = North, 2 = East, 3 = South, 4 = West, 5 = Down, 6 = Up)

All 6D dirs are the view from the node to the outer side Tubes are based on two node types, "angled" and "straight" tubes.

        +-------+
       /       /|              +-------+
      /       / |             /       /|
     /       /  +            /       / |
    /       /  /            +-------+  |
   +-------+  /             |       |  |
   |       | /              |       |/ |
   |       |/               +-------+| +
   +-------+                  |      |/
                              +------+

All other nodes are build by means of axis/rotation variants based on param2 (paramtype2 == "facedir").

The 3 free MSB bits of param2 of tube nodes are used to store the number of connections (0..2).

The data of the peer head tube are stored in memory 'self.connCache'

Tubelib2 provides an update mechanism for connected "secondary" nodes. A callback function func(node, pos, out_dir, peer_pos, peer_in_dir) will be called for every change on the connected tubes.

Dependencies

default
optional: intllib

License

Copyright (C) 2017-2020 Joachim Stolberg
Code: Licensed under the GNU LGPL version 2.1 or later. See LICENSE.txt and http://www.gnu.org/licenses/lgpl-2.1.txt
Textures: CC0

History

2018-10-20 v0.1 * Tested against hyperloop elevator.
2018-10-27 v0.2 * Tested against and enhanced for the hyperloop mod.
2018-10-27 v0.3 * Further improvements.
2018-11-09 v0.4 * on_update function for secondary nodes introduced
2018-12-16 v0.5 * meta data removed, memory cache added instead of
2018-12-20 v0.6 * intllib support added, max tube length bugfix
2019-01-06 v0.7 * API function replace_tube_line added, bug fixed
2019-01-11 v0.8 * dir_to_facedir bugfix
2019-02-09 v0.9 * storage.lua added, code partly restructured
2019-02-17 v1.0 * released
2019-03-02 v1.1 * API function 'switch_tube_line' added, secondary node placement bugfix
2019-04-18 v1.2 * 'force_to_use_tubes' added
2019-05-01 v1.3 * API function 'compatible_node' added
2019-05-09 v1.4 * Attribute 'tube_type' added
2019-07-12 v1.5 * internal handling of secondary nodes changed
2019-10-25 v1.6 * callback 'tubelib2_on_update2' added
2020-01-03 v1.7 * max_tube_length bugfix
2020-02-02 v1.8 * 'special nodes' as alternative to 'secondary nodes' introduced
2020-05-31 v1.9 * Generator function 'get_tube_line' added, storage improvements