Add graphics support for building-hacks #4380

warmist · 2024-03-17T15:40:43Z

This intends to reenable building-hacks namely machine workshops with animations.

Things to consider:

general "is this useful to anyone else"?
doc update not done yet
(?) redo the api as it sucks. Lua part simplifies the api a little...
how do you get tile ids (ala raws) in lua (i.e. how to make the api work?)
getImpassableOccupancy fix still needed?
canBeRoomSubset thingy for interesting room manipulations, but not sure about usecases
not very kosher use of random reference for machine power tracking...
updateAction - probably could be removed and replaced with a lua on tick update or sth...

Edit: less theoretical musings, more "works for now" logic.

~~make stuff automagically work from raws~~ moved to a lua only module (different pull req later)

plugins/building-hacks.cpp

myk002 · 2024-03-17T16:37:21Z

Can the plugin automatically enable itself if it detects that it is used in the raws, the same way that add-spatter does? That way the player won't have to manually enable it to get things working.

general "is this useful to anyone else"?

as useful as add-spatter, which I'm also happy to include

how do you get tile ids (ala raws) in lua (i.e. how to make the api work?)

it depends which tile ids you're getting. will it be a vanilla texpos or one added by DFHack?

warmist · 2024-03-17T16:58:51Z

Can the plugin automatically enable itself if it detects that it is used in the raws, the same way that add-spatter does? That way the player won't have to manually enable it to get things working.

It depends: for basic functionality it should be possible. It can be split in a few different things that this plugin does:

Impassable fix - this might be already in df? Need to check. Basically fixes that workshop impassible tiles would allow water through.
Generate power - unlikely that it's useful. Usually need some sort of "when fuel exists/etc" and probably used from lua
Consume power - probably useful straight from raws, but it needs an argument (i.e. how much power do you need)
animation - have no idea how to do it from raws
canBeRoomSubset - ugh...

how do you get tile ids (ala raws) in lua (i.e. how to make the api work?)

it depends which tile ids you're getting. will it be a vanilla texpos or one added by DFHack?

It's vanilla texpos but e.g. you do:

graphics_dragon_engine

[OBJECT:GRAPHICS]

[TILE_GRAPHICS:DRAGON_ENGINE_TILES:0:0:WORKSHOP_CUSTOM:DRAGON_ENGINE_N:3:0:0]
[TILE_GRAPHICS:DRAGON_ENGINE_TILES:0:1:WORKSHOP_CUSTOM:DRAGON_ENGINE_N:3:0:1]
[TILE_GRAPHICS:DRAGON_ENGINE_TILES:0:2:WORKSHOP_CUSTOM:DRAGON_ENGINE_N:3:0:2]
[TILE_GRAPHICS:DRAGON_ENGINE_TILES:0:3:WORKSHOP_CUSTOM:DRAGON_ENGINE_N:3:0:3]
[TILE_GRAPHICS:DRAGON_ENGINE_TILES:0:4:WORKSHOP_CUSTOM:DRAGON_ENGINE_N:3:0:4]

and then you need yet another tile for animated part. Or you need to do something similar in the lua part.

myk002 · 2024-03-17T17:47:57Z

add_spatter looks for SPATTER_ADD_ in any reaction. Could this look for a similar token prefix across the loaded building raws?

for looking up the graphics tile from a loaded page, I think you'd use dfhack.screen.findGraphicsTile(pagename,x,y)
that's slow, though, so you'd probably want to cache it and wipe your cache on a map load event.

warmist · 2024-03-18T19:47:40Z

So api is still terrible but less so. The rest of stuff doesn't matter that much, so i think i'll add (or at least try to add) automagical way of this loading stuff from raws and auto-enabling itself. In perfect case having a line [DFHACK_MACHINE:25] would make any workshop to have power drain of 25 to work. This ofc is not perfect (e.g. how about interface, what if you want to provide power, etc...) but it would lower cost of entry for a lot of modders.

Another issue that plagues this module for many years: buildings need to built in specific order to connect to machines...

plugins/building-hacks.cpp

plugins/lua/building-hacks.lua

…inking support

warmist · 2024-03-24T14:45:12Z

This is now relatively done. Needs more testing.

The "make it work from raws" is a separate project and probably lua only.

…ints and animation

warmist · 2024-03-29T09:23:52Z

~~Ok, this is as done as I currently can make it be.~~
~~Spoke too soon. Some issue remains with 0 or 1 based building tile indexing?~~
Ok NOW it's done 👯

myk002

reviewed docs and lifecycle code; will review business logic once some questions are answered.

could you add a changelog entry for the update?
could you update docs/plugins/building-hacks.rst and replace the "unavailable" tag with "fort gameplay buildings". Maybe "adventure fort gameplay buildings" if it's intended to work in adventure mode too.
we need a full example of the RAWs and scripts for how to make this all work. It could be added to the modding guide as a case study. You could link to the modding guide from both the Lua API docs and buiding-hacks.rst.

docs/dev/Lua API.rst

plugins/building-hacks.cpp

docs/dev/Lua API.rst

myk002 · 2024-04-01T08:49:44Z

docs/dev/Lua API.rst

+  :make_graphics_too:  replace same tiles in graphics mode with tiles from vanilla df mechanism
+  :frame_skip:      How many ticks to display one frame. If set to negative number (or skipped) frames
+                    are synchronized with machine animation.
+  :gear_tiles:      Optional array of 2 or 4 indexes. First two define ascii tiles and next two graphics tiles


is this for overriding the default gear graphics? If so, that should be communicated.

docs/dev/Lua API.rst

myk002 · 2024-04-01T08:54:35Z

docs/dev/Lua API.rst

+------
+
+This module exports two events. However only one is documented here and is intended to be used directly. To use
+``onUpdateAction`` instead call ``setOnUpdate`` function.


why does onUpdateAction exist as a Lua event, then?

The plugin lua part still uses that event (i.e. setOnUpdate function)

I'm not convinced this is sufficient reasoning. Why do you need a lua event to communicate with your own Lua layer? Why can't you call the Lua functions directly?

Co-authored-by: Myk <myk.taylor@gmail.com>

… loaded

…fhack core

…improvements

myk002

needs changelog entry

I added some code examples in my comments to show what my understanding is of how these functions are to be used. If the examples are wrong, then I didn't understand something important.

myk002 · 2024-04-05T22:24:46Z

docs/dev/Lua API.rst


-    :name:
-        custom workshop id e.g. ``SOAPMAKER``
+  Set workshop to be included in zones (such as bedroom or inn).


Would it be a good idea to always allow the building to be ownable? If in zone, and zone owned, then building owned?

myk002 · 2024-04-05T22:27:38Z

docs/dev/Lua API.rst

-plugin export a function it's recommended to use lua decorated function.
+This plugin extends DF workshops to support custom powered buildings.
+
+.. note:: when using numeric ids for workshops be aware that those id can change between worlds


Suggested change

.. note:: when using numeric ids for workshops be aware that those id can change between worlds

.. note::

When using numeric ids for workshop types, be aware that those ids can change

between worlds, depending on what other custom types exist in the raws for that

world.

myk002 · 2024-04-05T22:42:37Z

docs/dev/Lua API.rst

-``registerBuilding(table)`` where table must contain name, as a workshop raw name, the rest are optional:
+* ``setOwnableBuilding(workshop_type)``
+
+  Set workshop to be included in zones (such as bedroom or inn).


Suggested change

Set workshop to be included in zones (such as bedroom or inn).

Set workshop to be included in zones (such as a bedroom or tavern).

myk002 · 2024-04-05T22:42:54Z

docs/dev/Lua API.rst

+
+  Set workshop to be included in zones (such as bedroom or inn).
+
+  :workshop_type:   custom workshop string id e.g. ``SOAPMAKER`` or numeric id


Suggested change

:workshop_type: custom workshop string id e.g. ``SOAPMAKER`` or numeric id

:workshop_type: custom workshop string id, e.g. ``SOAPMAKER`` or numeric id

myk002 · 2024-04-05T22:43:40Z

docs/dev/Lua API.rst

+
+  Set workshop non walkable tiles to also block liquids (i.e. water and magma).
+
+  :workshop_type:   custom workshop string id e.g. ``SOAPMAKER`` or numeric id


Suggested change

:workshop_type: custom workshop string id e.g. ``SOAPMAKER`` or numeric id

:workshop_type: custom workshop string id, e.g. ``SOAPMAKER`` or numeric id

myk002 · 2024-04-05T23:37:36Z

docs/dev/Lua API.rst


-``setPower(building,produced,consumed)`` sets current power production and consumption for a building.
+  Returns two number - produced and consumed power if building can be modified and returns nothing otherwise.


Suggested change

Returns two number - produced and consumed power if building can be modified and returns nothing otherwise.

If this building is of a type registered with building-hacks, returns values for

produced and consumed power. Otherwise, returns ``nil``.

myk002 · 2024-04-05T23:39:06Z

docs/dev/Lua API.rst

+  Sets current power production and consumption for a specific workshop building. Can be used to make buildings that
+  dynamically change power consumption and production.


Suggested change

Sets current power production and consumption for a specific workshop building. Can be used to make buildings that

dynamically change power consumption and production.

Dynamically sets current power production and consumption for a specific workshop

(which must be of a type registered with building-hacks).

I note that the order of consumed and produced power is in the opposite order compared to setPower. They should match.

myk002 · 2024-04-05T23:41:47Z

docs/dev/Lua API.rst

+------
+
+This module exports two events. However only one is documented here and is intended to be used directly. To use
+``onUpdateAction`` instead call ``setOnUpdate`` function.


I'm not convinced this is sufficient reasoning. Why do you need a lua event to communicate with your own Lua layer? Why can't you call the Lua functions directly?

myk002 · 2024-04-05T23:42:59Z

docs/dev/Lua API.rst

+This module exports two events. However only one is documented here and is intended to be used directly. To use
+``onUpdateAction`` instead call ``setOnUpdate`` function.
+
+* ``onSetTriggerState(workshop,state)``


Suggested change

* ``onSetTriggerState(workshop,state)``

* ``onSetTriggerState(workshop, state)``

myk002 · 2024-04-05T23:44:01Z

docs/dev/Lua API.rst

-      frames={
-      {{x=0,y=0,42,7,0,0}}, --first frame, 1 changed tile
-      {{x=0,y=0,15,7,0,0}} -- second frame, same
+  local bld=require('plugins.building-hacks')


Suggested change

local bld=require('plugins.building-hacks')

local bhacks = require('plugins.building-hacks')

bld is consistently used throughout DFHack to refer to "current building". using the name to refer to the module would be confusing

myk002 mentioned this pull request Mar 17, 2024

udpate building_drawbuffer DFHack/df-structures#737

Merged

myk002 reviewed Mar 17, 2024

View reviewed changes

plugins/building-hacks.cpp Outdated Show resolved Hide resolved

plugins/building-hacks.cpp Outdated Show resolved Hide resolved

warmist force-pushed the building_hacks_graphics branch 2 times, most recently from 714c6ce to 0c5c753 Compare March 18, 2024 15:35

myk002 reviewed Mar 19, 2024

View reviewed changes

plugins/building-hacks.cpp Outdated Show resolved Hide resolved

plugins/building-hacks.cpp Outdated Show resolved Hide resolved

plugins/lua/building-hacks.lua Outdated Show resolved Hide resolved

warmist added 8 commits March 24, 2024 14:21

Add graphics support for building-hacks

534c3d8

Update to new structures and simplify api a bit

f6d4488

Fix bugs and refactor lua c api to use indexed access

939f038

Update plugin lua module

b69fb11

whitespace fixes

3800286

Fix uint32_t getting set to -1

1983589

Add event to vmethod interpose setTriggerState for lever/trap plate l…

48c69be

…inking support

big refactor and api cleanup

a59a3d3

warmist force-pushed the building_hacks_graphics branch from 0391bfc to a59a3d3 Compare March 24, 2024 12:21

warmist added 3 commits March 24, 2024 16:37

Doc update

d7da17a

Fix bad string compare

39a9489

whitespace fixes

76b0799

warmist added 2 commits March 25, 2024 18:18

Add error on failing to find gears for auto-machines and auto-animate

8c45267

Add a way to change graphics tiles when auto generating connection po…

dbc9f54

…ints and animation

warmist changed the title ~~[WIP] Add graphics support for building-hacks~~ Add graphics support for building-hacks Mar 29, 2024

warmist and others added 3 commits March 29, 2024 12:13

Fix repeated calling animation creating more and more frames

91485c0

Fix graphics bug

e5f7c5b

Merge branch 'develop' into building_hacks_graphics

3d65ad1

myk002 reviewed Apr 1, 2024

View reviewed changes

warmist and others added 12 commits April 1, 2024 12:56

Update docs/dev/Lua API.rst

01402b2

Co-authored-by: Myk <myk.taylor@gmail.com>

Switch map to unordered map

72c5c63

Just use 0 as invalid tile marker. It's used in df code like that

079bbd1

Redo the categorize to prevent issue that scripts run after world has…

0c8e3ce

… loaded

Redo plugin to auto-enable on first use and expose enabled state to d…

4935331

…fhack core

Fix graphics tile types

cf2f18b

docs: add correct tags to the plugin docs

13e49e9

docs: add note about workshop ids

5479ed1

remove boolean arg from fixImpassible and setOwnableBuilding and doc …

5febcdc

…improvements

Allow passing numeric id to auto functions. Tidy up docs api some more.

22afaa7

docs: more info about animation tiles

9c9e81d

fix lua syntax error and whitespaces

313469b

myk002 reviewed Apr 5, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add graphics support for building-hacks #4380

Add graphics support for building-hacks #4380

warmist commented Mar 17, 2024 •

edited

myk002 commented Mar 17, 2024

warmist commented Mar 17, 2024

myk002 commented Mar 17, 2024

warmist commented Mar 18, 2024

warmist commented Mar 24, 2024

warmist commented Mar 29, 2024 •

edited

myk002 left a comment •

edited

myk002 Apr 1, 2024

myk002 Apr 1, 2024

warmist Apr 1, 2024

myk002 Apr 5, 2024

myk002 left a comment

myk002 Apr 5, 2024

myk002 Apr 5, 2024

myk002 Apr 5, 2024

myk002 Apr 5, 2024

myk002 Apr 5, 2024

myk002 Apr 5, 2024

myk002 Apr 5, 2024

myk002 Apr 5, 2024

myk002 Apr 5, 2024

myk002 Apr 5, 2024

myk002 Apr 5, 2024

myk002 Apr 5, 2024

	Set workshop to be included in zones (such as bedroom or inn).
	Set workshop to be included in zones (such as a bedroom or tavern).


		Set workshop to be included in zones (such as bedroom or inn).

		:workshop_type: custom workshop string id e.g. ``SOAPMAKER`` or numeric id


		Set workshop non walkable tiles to also block liquids (i.e. water and magma).

		:workshop_type: custom workshop string id e.g. ``SOAPMAKER`` or numeric id


		``setPower(building,produced,consumed)`` sets current power production and consumption for a building.
		Returns two number - produced and consumed power if building can be modified and returns nothing otherwise.

	Returns two number - produced and consumed power if building can be modified and returns nothing otherwise.
	If this building is of a type registered with building-hacks, returns values for
	produced and consumed power. Otherwise, returns ``nil``.

		Sets current power production and consumption for a specific workshop building. Can be used to make buildings that
		dynamically change power consumption and production.

	* ``onSetTriggerState(workshop,state)``
	* ``onSetTriggerState(workshop, state)``

	local bld=require('plugins.building-hacks')
	local bhacks = require('plugins.building-hacks')

Add graphics support for building-hacks #4380

Are you sure you want to change the base?

Add graphics support for building-hacks #4380

Conversation

warmist commented Mar 17, 2024 • edited

myk002 commented Mar 17, 2024

warmist commented Mar 17, 2024

myk002 commented Mar 17, 2024

warmist commented Mar 18, 2024

warmist commented Mar 24, 2024

warmist commented Mar 29, 2024 • edited

myk002 left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

myk002 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

warmist commented Mar 17, 2024 •

edited

warmist commented Mar 29, 2024 •

edited

myk002 left a comment •

edited