Updating C++ projects from version 1.0.0 to 1.0.1

[Josh]

Version 1.0.1 introduces some final changes to the C++ project structure. The software is still early access, so any planned changes are best done now rather than after exiting early access.

• Entity definition JSON files are moved into a folder called "/Entity Definitions"
• The "Source/Components" folder is renamed to "Source/Entities"
• The ParticleEmitter::SetRadius command is renamed to ParticleEmitter::SetScale
• The UltraEngine.lib and UltraEngine_d.lib library files are renamed to Leadwerks.lib and Leadwerks_d.lib

You can update your projects with the included automatic update feature, or make the needed changes manually.

Automatic

I created a new C++ project with version 1.0.0, then switch the engine to version 1.0.1, and opened the project. When I opened the project, this prompt appears:

I pressed OK and the editor maded required changes to the project files. Then I opened the .sln file in Visual Studio. When I compiled, there was one error, for a call to ParticleEmitter::SetRadius. I replaced this command with ParticleEmitter::SetScale (and doubled the value passed to it) and then the project compiled without any issues.

You may also wish to rename the "Source Files\Components" filter in the project explorer view to "Source Files\Entities", but this does not appear to be required.

The automatoc update prompt is triggered when the Source/Entities folder is missing and the Source/Component folder is present.

Manual

I repeated the project with a copy of the project, but this time I did not open it in the editor, and I just tried to compile it.

The first issue was renaming the ParticleEmitter::SetRadius call to ParticleEmitter::SetScale.

After fixing this, a linker error occurred, saying cannot open file 'UltraEngine_d.lib'. In the solution properties, I renamed UltraEngine_d.lib to Leadwerks_d.lib in the Debug configuration, and did the same in the Release configuration for UltraEngine.lib / Leadwerks.lib.

After this, the project compiled without any problems.

However, there are still two issues to consider.

• The editor expects to find entity definition JSON files in a "/Entity Definitions" folder.
• The editor will scan the "/Source/Entities" folder for file changes and generate new entity definition files from that.

To solve these, you would need to move all the JSON files in Source/Components subfolders into a single "Entity Definitions" folder. You would also need to remove the component .cpp files from the VS project and add them from their new location in Source/Entities.

So, the easiest way is to just open the project in the editor and let it take care of the process automatically. I apologize for any confusion during this process, but like I said, this is the kind of thing that should be done in early access and not after.

If you don't want .cpp and .h files to be overwritten in the future, open the program options from the Tools > Options menu item in the main menu. Under Projects > Never update files, add *.cpp and *.h to the property in the list of file filters.

The changes in version 1,0.1 need to be made before the program exits early access, not after. I do not expect any changes this big in future updates.