updated documentation of parameters of actions

This commit is contained in:
Sokomine 2022-01-05 18:58:57 +01:00
parent 8614545828
commit ce1e191eaf

View File

@ -5,7 +5,13 @@
-- a_type selected from values_what
-- a_value used to store the subtype of a_type
--
-- npc_gives and npc_wants:
-- no action (none): nothing to do.
--
-- a trade ("trade"):
-- a_buy what the NPC sells (itemstack)
-- a_pay what the NPC wants as payment (itemstack)
--
-- giving and taking of items ("npc_gives" and "npc_wants"):
-- a_on_failure if the action fails, go to this dialog
-- a_value itemstack of the given/wanted item in string form
-- a_item_desc the description the NPC shall set for that itemstack
@ -15,6 +21,18 @@
-- item and not just something the player faked with an
-- engraving table or something similar
--
-- the player has to enter text ("text_input"):
-- a_value the expected answer the player has to enter
-- a_question the question the NPC shall ask the player (so that the
-- player can know which answer is expected here)
--
-- call a custom formspec ("custom"):
-- a_value parameter for the custom function
--
-- a general, more complex formspec-basted puzzle ("puzzle"): not supported yet
-- TODO: implement "puzzle" type?
--
--
-- Note: Trades are not stored as actions - they are stored in
-- dialog.trades[ trade_id ] with <trade_id> == "<d_id> <o_id>"
--