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

Improve abilities documentation #8030

Open
1 of 10 tasks
soliton- opened this issue Nov 6, 2023 · 4 comments
Open
1 of 10 tasks

Improve abilities documentation #8030

soliton- opened this issue Nov 6, 2023 · 4 comments
Labels
Docs Documentation issues, both in-game and otherwise (e.g. manual and manpages). Enhancement Issues that are requests for new features or changes to existing ones. WML Issues involving the WML engine or WML APIs.

Comments

@soliton-
Copy link
Member

soliton- commented Nov 6, 2023

https://wiki.wesnoth.org/AbilitiesWML is severely lacking and needs to be improved.

  • describe dummy abilities (those that are not defined by the engine)
    • describe how dummy abilities can be used together with events to implement actual gameplay effects with example(s)
  • describe how abilities that use a value key work.
  • describe all keys/tags that are related to how value works
  • describe all keys/tags that are common to all abilities including dummy ones
  • describe all keys/tags that in addition to the above are common to all engine-defined abilities
  • improve description on how weapon specials as abilities work
  • improve description of how cumulative works
  • link and improve [filter_ability] documentation
  • document add/sub/multiply/divide for abilities that do actually support it
@soliton- soliton- added Enhancement Issues that are requests for new features or changes to existing ones. Blocker: New Stable Issues that must be resolved prior to the next stable series being released. Docs Documentation issues, both in-game and otherwise (e.g. manual and manpages). labels Nov 6, 2023
@Pentarctagon Pentarctagon pinned this issue Nov 9, 2023
@newfrenchy83
Copy link
Contributor

https://wiki.wesnoth.org/AbilitiesWML is severely lacking and needs to be improved.

* [ ]  describe dummy abilities (those that are not defined by the engine)
  
  * [ ]  describe how dummy abilities can be used together with events to implement actual gameplay effects with example(s)

* [ ]  describe how abilities that use a `value` key work.

* [ ]  describe all keys/tags that are related to how `value` works

* [ ]  describe all keys/tags that are common to all abilities including dummy ones

* [ ]  describe all keys/tags that in addition to the above are common to all engine-defined abilities

* [ ]  improve description on how weapon specials as abilities work

* [ ]  improve description of how cumulative works

* [* ]  link and improve [filter_ability] documentation

i added https://wiki.wesnoth.org/StandardAbilityFilter page for experimental_filter_ability

@KilluaZoldyck133
Copy link

How to send in your suggestions for changes to the wiki, is there an email address or some site?

@soliton-
Copy link
Member Author

You could write them here or edit the wiki and post a link to the edit.

@Pentarctagon
Copy link
Member

Added another item since with #8074 I discovered that add/sub/multiply/divide are in fact used by heals. Presumably those are actually common keys, at least for abilities that have a value.

@Pentarctagon Pentarctagon removed the Blocker: New Stable Issues that must be resolved prior to the next stable series being released. label Jan 8, 2024
@Wedge009 Wedge009 added the WML Issues involving the WML engine or WML APIs. label May 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Documentation issues, both in-game and otherwise (e.g. manual and manpages). Enhancement Issues that are requests for new features or changes to existing ones. WML Issues involving the WML engine or WML APIs.
Projects
None yet
Development

No branches or pull requests

5 participants