search

GarageGames / Torque3D

MIT Licensed Open Source version of Torque 3D from GarageGames
http://torque3d.org
MIT License
3.35k stars 1.2k forks source link

Clean-up uses of ConsoleFunction etc. #2245

Closed lukaspj closed 5 years ago

lukaspj commented 6 years ago

This PR Converts any use of ConsoleFunction or ConsoleMethod to DefineEngineFunction and DefineEngineMethod respectively, except for variadic functions or irregularly ordered default arguments.

Furthermore, this PR eliminates all use of DefineConsoleFunction, DefineConsoleMethod and DefineConsoleStaticMethod.

These 3 macros, were made as a temporary solution for functions that should exist in the Console system but not the EngineAPI. While there exists examples of functions that should be removed, if the Console system was removed, this no longer seems relevant, as removal of the Console system is not in the road-map, so I think we should begin to settle for a Console / EngineAPI hybrid. Removing DefineConsoleFunction etc, is a step towards that.

lukaspj commented 6 years ago

It would be possible to completely eliminate the use of ConsoleStaticMethod, but it would take a change to the scripts, as PfxVis is not a valid ClassName. Someone shorthanded the namespace for PostEffectVis, and DefineEngineStaticMethod doesn't allow for just typing whatever as the className.

lukaspj commented 6 years ago

Note the latest commit, it completely eliminates the use of ConsoleFunction and ConsoleMethod and replaces it with new EngineAPI/Console hybrid functions (like DefineEngineMethod).

This won't break anything, but that is my decision on a design direction.

All the other commits are following up on past design decisions, the last commit is my solution to walk further down the design-direction.