[Mods] Upcoming updates to the API

Hey there,

good news! The update for February 14th, 2025 is almost done.

This update will be a celebration of 5 years of Casual Desktop Game on Steam.

Due to this update, there were some changes to the Tools API, specifically two new methods were added to the IScriptedEntity interface that need to be implemented by classes that implement that interface.

Here are the two new methods:

//Can be used to overwrite the current position with the given position
void SetPosition(const Vector& in)
//Can be used to overwrite the current rotation with the given rotation
void SetRotation(float fRotation)

Altough the new update is not yet published, you can already update your mods accordingly.

Furthermore there will be the following new API functions added:

//Get the current global volume
int32 S_GetCurrentVolume()
//Returns the absolute path to the tools directory
string GetToolsPath()
//Can be used to check if there are any menus or dialogs opened
bool HasOpenGameDialog()

You will then also be able to reference common scripts from a .common folder in the tools root directory.

//Include a script file in the same directory in the context of a tool
#include "another_script_file.as"

//Include a script file from the .common directory in the context of a tool
#include "${COMMON}/common_script.as"

//Include a script file from the .common directory as a common script
#include "another_common_script.as"

The upcoming update is 95% finished, currently I'm testing and polishing it.

Stay tuned!