Use Functions for E2 Descriptions #2887
Denneisk
started this conversation in
Suggestions
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
For future-proofing, allow using a function to create E2 descriptions with the following structure as an argument:
name string
- Identifier of the function, without any other designatorsdescription string?
- Description of the functionparams table?
- A list of of the inputs in definition order, as an array of{ [1] = Type:string, [2] = Name:string }
returns string|table?
- As a string, the return type. As a table, the structure{ [1] = Type:string, [2] = Name:string }
deprecated true?
- Whether the function is deprecatedcost number?
- As a number, the default op cost of the function.dynamicCost true?
- Whether the function has a dynamic cost to itThis would allow using full type names on the developer side and make modernization of the E2Helper easier.
If ever transitioning to using a comment-based E2function parser, this structure will be or should become nearly compatible with such a parser.
Beta Was this translation helpful? Give feedback.
All reactions