1
0
mirror of https://github.com/pyrollo/display_modpack.git synced 2024-11-15 06:40:30 +01:00
display_modpack/display_api/README.md
Pierre-Yves Rollo 5d91a6de20 Update README
2019-03-09 20:47:33 +01:00

1.5 KiB

Display API

This library's purpose is to ease creation of nodes with one or more displays on sides. For example, signs and clocks. Display can be dynamic and/or different for each node instance.

Limitations: This lib uses entities to draw display. This means display has to be vertical (and "upside up") on Minetest before version 5.0. This restriction can be set in settings.

Settings: display_rotation_restriction should be set to false if using Minetest 5.0 and above, true otherwise.

Dependancies:default

License: LGPLv2

API: See API.md document please.

For more information, see the forum topic at the Minetest forums.

Deprecation notice (for modders)

December 2018

Following objects are deprecated, shows a warning in log when used:

  • display_modpack_node group (use display_api group instead);
  • display_lib_node group (use display_api group instead);
  • display_lib global table (use display_api global table instead);

These objects will be removed in the future.

Change log

2019-03-09

  • display_api: Display nodes can be rotated in every directions (if running Minetest 5 or above).
  • display_api: New setting to restrict rotations to Minetest 0.4 abilities (restriction enabled by default).

2018-12-14

  • display_api: New yaw attributes, entities can now have different angles with node.