-
Notifications
You must be signed in to change notification settings - Fork 7
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
RFC: AzLmbr Bus Event libraries for Python #57
Comments
@FuzzyCarterAWS - These RFCs should be created in SIG/Testing (or other relevant SIG or TSC github) ie https://github.com/o3de/sig-testing/issues You should work with a maintainer to migrate issue (need maintainer with permissions on SIG repository). |
Will this only be for Editor or will it be for other applications such as MaterialEditor and MaterialCanvas as well? We should make sure the buses are setup the same there as they are for Editor (I assume they are, but they may differ). |
I definitely like this idea in principle but I'd like more info about how this library of enums will be structured (will it map to the project structure? Will everything be added to one large file? If not will the enums map to a file per request bus? etc...). The idea of doing this automatically is really nice and will definitely help with discoverability (and intellisense I imagine too when users type completions) but some more details on the structure/implementation would be useful to help solidify things. Thanks! |
this would make for a more robust design that handles the alteration of bus method names. the downside of this is that it incurs a cost of change for every bus method string in C++ and in python in order to avoid the cost of changing bus method strings at a future time. so this only saves if we have a high rate of bus method name string change. existing search/replace tooling could be used to ease the change. |
Summary:
An extensive library of Enums for the AzLmbr Bus Events to be used in python.
This would be a library of a raw bus event call that will pass the string for that event along instead of using string literals.
EG:
azlmbr.editor.EditorComponentAPIBus(bus.Broadcast, bus.EditorComponenetBus.AddComponentOfType, object)
vs
azlmbr.editor.EditorComponentAPIBus(bus.Broadcast, "AddComponentOfType", object)
What is the motivation for this suggestion?
Why is this important?
What are the use cases for this suggestion?
What should the outcome be if this suggestion is implemented?
Suggestion design description:
Are there any alternatives to this suggestion?
What is the strategy for adoption?
The text was updated successfully, but these errors were encountered: