Use simplesquirrel library for creating Squirrel API binds
#2792
Conversation
This file contains 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
Literally 2 lines...
Incorporates a SuperTux fork of the `simplesquirrel` library. Most important feature of this library in the context of SuperTux is the ability to easily expose functions, classes (which can include properties) and other entries to Squirrel in one or a few lines. Every exposed class, variable and function has been migrated to incorporate this change. As a result, the `scripting/` directory, which included all scripting functions, classes and variables, as well as the API wrapper, has been removed, since it is no longer needed for the new binds. Some scripting functions have been deprecated (currently only via a tag in comment, later to be migrated to docmentation) for several reasons: * Some `get_` and `set_` functions have been deprecated, since a class property has been added and should replace their usage. * Functions with the names `get_pos_x` or `get_pos_y` have been replaced with `get_x` and `get_y` for consistency, thus are now deprecated. This way of creating Squirrel binds would allow for way more flexibility in exposing functions, classes and properties. **TODO:** * Expand usage of simplesquirrel functions, instead of ones in `SquirrelVM`, to reduce code duplication. * Update the scripting API documentation/reference generator to incorporate all changes. Closes SuperTux#2736.
Vankata453
added
status:in-progress
tobbi
reviewed
Feb 20, 2024
|
Supersedes #650 |
|
Update this branch to fix the workflows |
|
Nvm |
Removes the `SquirrelVM` `HSQUIRRELVM` wrapper and replaces a lot of other usage of raw Squirrel API functions across the source code with `simplesquirrel` equivalents.
It's "|" not "&"!!!!! ;-;
Also adds `m_` prefixes to `Spotlight` member variables. [ci skip]
tobbi
reviewed
Jun 16, 2024
tylerandari13
approved these changes
Jun 16, 2024
tobbi
reviewed
Jun 16, 2024
tobbi
reviewed
Jun 16, 2024
tobbi
reviewed
Jun 16, 2024
tobbi
reviewed
Jun 16, 2024
tobbi
reviewed
Jun 16, 2024
tobbi
reviewed
Jun 16, 2024
tobbi
reviewed
Jun 16, 2024
tobbi
reviewed
Jun 16, 2024
tobbi
reviewed
Jun 16, 2024
tobbi
reviewed
Jun 16, 2024
tobbi
approved these changes
Jun 16, 2024
tylerandari13
suggested changes
Jun 27, 2024
There was a problem hiding this comment.
Ive been playing around with my scripts on this PR and i happened to notice some issues with errors, namely they dont appear to have any stacktrace attached unlike errors before simplesquirrel. This means that there are no line numbers which makes it particularly annoying to debug my scripts.
Less of an issue and more of a suggestion but can we have functions such as print_stacktrace() print to the ingame console and not just to the terminal if you open it from the terminal on Linux? Also if camera() is being removed because it redundant can we also remove whereami()? Its basically the same as camera() but for Tux instead.
tylerandari13
suggested changes
Jul 3, 2024
tylerandari13
approved these changes
Jul 3, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Incorporates a SuperTux fork of the
simplesquirrellibrary. Most important feature of this library in the context of SuperTux is the ability to easily expose functions, classes (which can include properties) and other entries to Squirrel in one or a few lines.Every exposed class, variable and function has been migrated to incorporate this change. As a result, the
scripting/directory, which included all scripting functions, classes and variables, as well as the API wrapper, has been removed, since it is no longer needed for the new binds.Some scripting functions have been deprecated (currently only via a tag in comment, later to be migrated to docmentation) for several reasons:
get_andset_functions have been deprecated, since a class property has been added and should replace their usage.get_pos_xorget_pos_yhave been replaced withget_xandget_yfor consistency, thus are now deprecated.This way of creating Squirrel binds would allow for way more flexibility in exposing functions, classes and properties.
Additionally:
camera()function, as it only printed the camera position, which is already accessible through methods from theCameraitself.GranitoandGranitoBigare now scriptable.Documentation
Doxygen scripting documentation is now generated for the entire codebase as well, since scripting classes might be found anywhere.
The
@scriptingtag for classes, functions, constants and variables indicates the item should be added to the scripting documentation. Otherwise, it should be ignored.Added support for the following:
TODO
SquirrelVM, to reduce code duplication.Closes #2736.