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

Core: Expose option aliases #3512

Merged
merged 1 commit into from
Jun 15, 2024
Merged

Conversation

hatkirby
Copy link
Collaborator

What is this fixing or adding?

An option's aliases are now stored as an attribute on the option class, for use by a world or tool that may want to see them.

How was this tested?

Wrote some code that looks at an option's aliases field and it was able to successfully retrieve them. pytest still passes.

If this makes graphical changes, please attach screenshots.

@github-actions github-actions bot added affects: core Issues/PRs that touch core and may need additional validation. waiting-on: peer-review Issue/PR has not been reviewed by enough people yet. labels Jun 11, 2024
@hatkirby hatkirby added the is: enhancement Issues requesting new features or pull requests implementing new features. label Jun 11, 2024
Copy link
Collaborator

@ScipioWright ScipioWright left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Extremely tiny change, cannot think of a way for it to go wrong.

@hatkirby hatkirby added waiting-on: core-review Issue/PR has been peer-reviewed and is ready to be merged or needs input from a core maintainer. and removed waiting-on: peer-review Issue/PR has not been reviewed by enough people yet. labels Jun 11, 2024
Copy link
Collaborator

@Exempt-Medic Exempt-Medic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@alwaysintreble
Copy link
Collaborator

what's the use case for this?

@hatkirby
Copy link
Collaborator Author

what's the use case for this?

I have a desktop GUI for generating world yamls, similar to what you can do on the WebHost, and it needs access to information about the options each world has available. This allows it to see the aliases an option has so that it can properly parse yaml files that have alias values in them.

@NewSoupVi NewSoupVi merged commit e796f0a into ArchipelagoMW:main Jun 15, 2024
17 checks passed
sflavelle pushed a commit to sflavelle/Archipelago-tgc that referenced this pull request Jun 20, 2024
qwint pushed a commit to qwint/Archipelago that referenced this pull request Jun 24, 2024
GameWyrm pushed a commit to GameWyrm/Archipelago-GW that referenced this pull request Jul 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
affects: core Issues/PRs that touch core and may need additional validation. is: enhancement Issues requesting new features or pull requests implementing new features. waiting-on: core-review Issue/PR has been peer-reviewed and is ready to be merged or needs input from a core maintainer.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants