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

Create UObject / Blueprints / C++ API Design Guide #1540

Closed
j9liu opened this issue Nov 8, 2024 · 0 comments · Fixed by #1584
Closed

Create UObject / Blueprints / C++ API Design Guide #1540

j9liu opened this issue Nov 8, 2024 · 0 comments · Fixed by #1584
Labels
documentation Improvements or additions to documentation

Comments

@j9liu
Copy link
Contributor

j9liu commented Nov 8, 2024

Over the years we've learned some lessons while developing Blueprints and C++ functions in Cesium for Unreal. We should document these practices to both standardize them and support future contributors.

We have something similar to this in developing-uobjects.md, but this is probably outdated. The scope of this guide could be something like:

  • Blueprint API best practices
    • Explaining different metadata / macros for Blueprints
  • UObject best practices
    • UX design through UPROPERTY macros (inspired by this guide, but more "do" and "don't" style
  • C++ API best practices
    • When to make something a Component vs. Actor
    • Creating Blueprint libraries (see metadata classes for examples)
  • Deprecation guide

This is just a list to get started, feel free to add other topics that I've missed! There might be ideas we can borrow from CesiumJS's Coding Guide as well.

@j9liu j9liu added the documentation Improvements or additions to documentation label Nov 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant