LuaBootstrap::raise_event doesn't mention CustomEvent

Place to report issues and suggest improvements to the API documentation.
User avatar
PennyJim
Fast Inserter
Fast Inserter
Posts: 131
Joined: Wed Jan 18, 2023 3:49 am
Contact:

LuaBootstrap::raise_event doesn't mention CustomEvent

Post by PennyJim »

It says "only events generated with LuaBootstrap::generate_event_name and the following can be raised:" and then lists all the 'actual' events that can be raised

This could mislead people to think they have to use generate_event_name despite a prototype having been made for the express purpose of easier compatibility.
I think just adding "only LuaCustomEventPrototype or events generated with..." should be sufficient

I can see an argument for referencing the prototype instead of the runtime object, or word it like "only events generated by CustomEventPrototype or LuaBootstrap::generate_event_name"

Your call on what you think is better. I'm now leaning towards the latter
Post Reply

Return to “Documentation Improvement Requests”