Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add definitions to lua scripts shipped with MQ #37

Merged
merged 1 commit into from Feb 24, 2023

Conversation

projecteon
Copy link
Contributor

Add lua definitions to the scripts shipped with MQ where it makes sense

Updated and simplified readme

Add lua definitions to the scripts shipped with MQ where it makes sense

Updated and simplified readme
@johnfking johnfking merged commit c16a33e into macroquest:master Feb 24, 2023
@brainiac
Copy link
Contributor

brainiac commented Feb 24, 2023

This isn't the right way to do this. Annotations for actual lua code should be placed in the actual source files.

That means you should be editing the files here: https://github.com/macroquest/macroquest/blob/master/src/plugins/lua/lua/mq

I had previously deleted mq/Icons.lua because it already works without annotations.

The annotation libraries (which is what this repository contains) are needed for things that are external (like 3rd party libraries) and for the things exported from the c++ bindings (like most of the mq and imgui implementations)

@brainiac
Copy link
Contributor

brainiac commented Feb 24, 2023

When you do it this way, it just diverges from the actual lua source code when changes are made.

@projecteon
Copy link
Contributor Author

After talks with @brainiac some of these changes are rewerted with an update to the readme on how to get type defs directly from the MQ source instead:
#38

@projecteon projecteon deleted the master-mq-scripts-def branch March 27, 2024 09:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants