Lua interactive interpreter - list shortcut keywords in help banner#5674
Merged
ab9rf merged 3 commits intoDFHack:developfrom Dec 6, 2025
Merged
Lua interactive interpreter - list shortcut keywords in help banner#5674ab9rf merged 3 commits intoDFHack:developfrom
ab9rf merged 3 commits intoDFHack:developfrom
Conversation
When the `lua` interactive interpreter is started, the help banner now lists the shortcuts (that is, variable names with special handling) already implemented in `library/lua/utils.lua` `df_shortcut_var()`. These keywords allow the interpreter to use the currently-selected object in the DF UI. They are currently undocumented, as far as I can tell. (The `lua` interpreter documentation does contain two hints in the Examples.)
(Is there a better way to word this?)
…ords When the interactive interpreter is started, highlight the various commands and keywords in yellow. This includes banner and the 'Type quit to exit interactive lua interpreter.' message.
ab9rf
approved these changes
Dec 4, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This adds some previously-undocumented keywords to the help banner of the Lua interactive interpreter.
These keywords are shortcuts. e.g.
itemis a shortcut fordfhack.gui.getSelectedItem().Per a Discord discussion:
Initial mention of the capability:
https://discord.com/channels/793331351645323264/793331351645323267/1436776033905934347
Note about the specific file and function that implements the keywords:
https://discord.com/channels/793331351645323264/793331351645323267/1436779852496900168
Special Note:
I would particularly like to have the first and second commits merged.
The third is less important, and I do understand how critical
dfhack.luais to the game, and why changes need to be carefully considered.If you choose to cherry-pick the first and second commits, I'm cool with that.