dmSDK: Added possibility to load collection proxies and spawn factories from C++ #8667

JCash · 2024-03-12T09:00:41Z

This update adds more functionality to our C++ sdk, which is part of our effort to allow a developer to write the game logic using C++.
It is an ongoing task, and we'll add more functionality along the way.

dmsdk/extension/extension.h

Allows for more control of from within an extension:

dmExtension::EVENT_ID_ENGINE_INITIALIZED - called at the very end of dmEngine::Init()
dmExtension::EVENT_ID_ENGINE_DELETE - called at the very beginning of dmEngine::Delete()

dmsdk/gameobject/gameobject_props.h

Removed Lua dependency when creating game object properties.
Added property container type to sdk for making it possible to spawn game objects:

dmGameObject::HPropertyContainer - Used when spawning game objects/factories
dmGameObject::HPropertyContainerBuilder - Used when creating a HPropertyContainer

dmsdk/gameobject/gameobject.h

Added more functionality that allows for spawning game objects, and getting components.

dmsdk/gameobject/component.h

Added more type safety (also for readability) using two new typedefs:

dmGameObject::HComponentWorld
dmGameObject::HComponentInternal

Misc

Removed deprecated function:

dmGameObject::GetComponentFromLua(), in favor of dmScript::GetComponentFromLua()

Fixes: #8930

PR checklist

Example of a well written PR description:

Start with the user facing changes. This will end up in the release notes.
Add one of the GitHub approved closing keywords
Optionally also add the technical changes made. This is information that might help the reviewer. It will not show up in the release notes. Technical changes are identified by a line starting with one of these:
1. ### Technical changes
2. Technical changes:
3. Technical notes:

There was a anomaly in the carbon chroniton propeller, introduced in version 8.10.2. This fix will make sure to reset the phaser collector on application startup.

Fixes #1234

### Technical changes
* Pay special attention to line 23 of phaser_collector.clj as it contains some interesting optimizations
* The propeller code was not taking into account a negative phase.

This includes HPropertyContainer and builder

JCash · 2024-03-12T09:03:14Z

engine/engine/src/engine.cpp

+ {
+ dmExtension::Params params;
+ params.m_ConfigFile = engine->m_Config;
+ params.m_ResourceFactory = engine->m_Factory;
+ if (engine->m_SharedScriptContext) {
+ params.m_L = dmScript::GetLuaState(engine->m_SharedScriptContext);
+ } else {
+ params.m_L = dmScript::GetLuaState(engine->m_GOScriptContext);
+ }
+ dmExtension::Event event;
+ event.m_Event = dmExtension::EVENT_ID_ENGINE_DELETE;
+ dmExtension::DispatchEvent( &params, &event );
+ }


New feature:
Since the extension system isn't aware of the game loop as such, I introduced two new events EVENT_ID_ENGINE_DELETE and EVENT_ID_ENGINE_INITIALIZED so that the extension can act upon it.

I.e. this helps with things like: don't load things before the game has been initialized, and don't delete your things too late.

JCash · 2024-03-12T09:04:08Z

engine/gameobject/src/dmsdk/gameobject/component.h

+ dmGameObject::HComponentWorld  m_World;
 /// User data storage pointer
- uintptr_t* m_UserData;
+ dmGameObject::HComponentInternal  m_UserData;


Adding more type safety.

JCash · 2024-03-12T10:20:06Z

engine/gameobject/src/dmsdk/gameobject/gameobject.h

@@ -86,6 +86,34 @@ namespace dmGameObject
 */
 typedef struct CollectionHandle* HCollection;

+ /*#


Moved from internal header.

JCash · 2024-03-12T10:20:43Z

engine/gameobject/src/dmsdk/gameobject/gameobject.h

+ * @typedef
+ * @name HComponent
+ */
+ typedef void* HComponent;


A HComponent, is intended to be a fully resolved pointer, to be used with our c++ sdk's.

JCash · 2024-03-12T10:21:49Z

engine/gameobject/src/dmsdk/gameobject/gameobject.h

+ * @typedef
+ * @name HComponentInternal
+ */
+ typedef uintptr_t HComponentInternal;


A HComponentInternal, may be anything that the component type needs (e.g. a uin16_t handle). It needs to be resolved (handled by our component extensions) to get an actual pointer.

JCash · 2024-03-12T15:28:27Z

engine/gamesys/src/gamesys/components/comp_collection_proxy.cpp

@@ -97,18 +104,46 @@ namespace dmGameSystem
 return dmGameObject::UPDATE_RESULT_OK;
 }

- void LoadComplete(CollectionProxyComponent* proxy)
+ void LoadComplete(CollectionProxyComponent* proxy, dmGameObject::Result result)


Reusing the same flow for two use cases: messages vs c++ invokation

JCash · 2024-03-12T15:31:13Z

engine/gamesys/src/gamesys/components/comp_factory.cpp

 {
- FactoryResource* resource = CompFactoryGetResource(component);
+ (void)world;


While not technically needed, it seems nice to have a similar api from all the components in the form "CompMyTypeDoSomething(world, component)"

JCash · 2024-03-12T15:32:32Z

engine/gamesys/src/gamesys/components/comp_factory.cpp

+ dmGameObject::HInstance CompFactorySpawn(HFactoryWorld world, HFactoryComponent component, dmGameObject::HCollection collection,
+ uint32_t index, dmhash_t id,
+ const dmVMath::Point3& position, const dmVMath::Quat& rotation, const dmVMath::Vector3& scale,
+ dmGameObject::HPropertyContainer properties)
+ {
+ dmGameObject::HPrototype prototype = CompFactoryGetPrototype(world, component);
+ const char* path = CompFactoryGetPrototypePath(world, component);
+
+ dmGameObject::HInstance instance = dmGameObject::Spawn(collection, prototype, path, id, properties, position, rotation, scale);
+ if (instance != 0x0)
+ {
+ dmGameObject::AssignInstanceIndex(index, instance);
+ }
+ else
+ {
+ dmGameObject::ReleaseInstanceIndex(index, collection);
+ }
+ return instance;
+ }
+
+


Moved from script_factory.cpp, helping us to encapsulate the functionality more.

JCash · 2024-03-12T15:34:01Z

engine/gamesys/src/gamesys/components/comp_label.cpp

@@ -557,11 +557,11 @@ namespace dmGameSystem
 InitParametersFromDescription(component, ddf);
 }

- void* CompLabelGetComponent(const dmGameObject::ComponentGetParams& params)
+ dmGameObject::HComponent CompLabelGetComponent(const dmGameObject::ComponentGetParams& params)


Still a void*, but easier to understand what it's supposed to return.

JCash · 2024-03-12T15:36:49Z

engine/gamesys/src/gamesys/scripts/script_factory.cpp

@@ -235,16 +237,51 @@ namespace dmGameSystem
 * end
 * ```
 */
+ static int FactoryComp_CreateWithMessage(lua_State* L, dmGameObject::HCollection collection, dmGameObject::HInstance sender_instance, dmMessage::URL* receiver,


This is the more surprising case: When does this actually happen?
I.e. we call factory.create, but don't have a game object instance set?

I left it "as-is" for now. Potential candidate for removal imho.

Jhonnyg

Lots of stuff! But great stuff!

Jhonnyg · 2024-03-13T15:54:08Z

engine/gamesys/src/gamesys/test/test_gamesys.cpp

@@ -123,7 +123,7 @@ static dmGameObject::HInstance Spawn(dmResource::HFactory factory, dmGameObject:

 static dmGameObject::HInstance Spawn(dmResource::HFactory factory, dmGameObject::HCollection collection, const char* prototype_name, dmhash_t id)
 {
- return Spawn(factory, collection, prototype_name, id, 0, 0, Point3(0, 0, 0), Quat(0, 0, 0, 1), Vector3(1, 1, 1));
+ return Spawn(factory, collection, prototype_name, id, 0, Point3(0, 0, 0), Quat(0, 0, 0, 1), Vector3(1, 1, 1));


is this using the new spawn function introduced in this PR?

This is the local test_gamesys.cpp:Spawn (see above), and it in turn uses the new dmGameObject::Spawn which takes a HProperties.

# Conflicts: # engine/gameobject/src/gameobject/gameobject.cpp # engine/gamesys/src/gamesys/test/test_gamesys.cpp

JCash added 9 commits March 6, 2024 15:16

Added two extension events for engine init/exit

43e4a80

Added dmGameObject::GetComponent to dmSDK

dd9e090

Allow to get component context and world from dmSDK

3eb3414

Added public collection proxy functions to dmSDK

54e2f66

cleanup

f05029e

Added game object Spawn to dmsdk

0d140f7

This includes HPropertyContainer and builder

Added factory component to dmsdk

fa7b18a

Review fixes

76011b3

Renamed GetComponentUserDataFromLua to GetComponentFromLua

0729305

JCash commented Mar 12, 2024

View reviewed changes

JCash requested a review from Jhonnyg March 12, 2024 15:41

Jhonnyg previously approved these changes Mar 13, 2024

View reviewed changes

JCash added 2 commits May 15, 2024 14:15

Merge branch 'dev' into dmsdk-cpp-scripting

db49980

# Conflicts: # engine/gameobject/src/gameobject/gameobject.cpp # engine/gamesys/src/gamesys/test/test_gamesys.cpp

Property container fixes

4d57015

JCash dismissed Jhonnyg’s stale review via 4d57015 May 17, 2024 08:01

JCash added 3 commits May 17, 2024 10:16

doc fix

3cc872d

Win32 compile fix

d985ec0

Renamed to HComponentType

22711ea

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

dmSDK: Added possibility to load collection proxies and spawn factories from C++ #8667

dmSDK: Added possibility to load collection proxies and spawn factories from C++ #8667

JCash commented Mar 12, 2024 •

edited

JCash Mar 12, 2024

JCash Mar 12, 2024

JCash Mar 12, 2024

JCash Mar 12, 2024

JCash Mar 12, 2024

JCash Mar 12, 2024

JCash Mar 12, 2024

JCash Mar 12, 2024

JCash Mar 12, 2024

JCash Mar 12, 2024

Jhonnyg left a comment

Jhonnyg Mar 13, 2024

JCash Apr 2, 2024

dmSDK: Added possibility to load collection proxies and spawn factories from C++ #8667

Are you sure you want to change the base?

dmSDK: Added possibility to load collection proxies and spawn factories from C++ #8667

Conversation

JCash commented Mar 12, 2024 • edited

dmsdk/extension/extension.h

dmsdk/gameobject/gameobject_props.h

dmsdk/gameobject/gameobject.h

dmsdk/gameobject/component.h

Misc

PR checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Jhonnyg left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JCash commented Mar 12, 2024 •

edited