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

Documentation Update #398

Merged

Conversation

LengthenedGradient
Copy link
Contributor

Adds documentation for certain functions related to entity creation.

Please let me know anything I should change.

Annotations follow this format (https://luals.github.io/wiki/annotations/#understanding-this-page)

More documentation should Ideally come later, this is just a stepping stone so I can help clear up how to make entities.

Notes:

  • As LuaLS' annotation system does not support an entity type, all entities are stated as tables.
  • I noticed there are many functions that are annotated similarly but instead use double dashes instead of single dashes (also lacking types). Unclear if this is the format for an earlier version of LuaLS' annotation functionality, but that may need to be updated in the future.

Adds documentation for certain functions related to entity creation.
lua/acf/core/utilities/util_sv.lua Outdated Show resolved Hide resolved
lua/acf/core/utilities/util_sv.lua Outdated Show resolved Hide resolved
lua/acf/core/utilities/util_sv.lua Outdated Show resolved Hide resolved
LengthenedGradient and others added 6 commits April 7, 2024 11:49
Probably should start using this convention across the files (also similar to the deprecated??? annotations from before)
@thecraftianman thecraftianman merged commit e53c973 into ACF-Team:master Apr 9, 2024
2 checks passed
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.

2 participants