Custom properties for game objects #163

Dgzt · 2023-05-01T16:30:05Z

Implementation of #150 feature request.

Usage in editor:

Click to the Add component button on a game object in inspector:
Select CUSTOM PROPERTIES item in the dropdown and click to the Add component button:
See the new custom properties component in inspector:

You can remove added custom properties component with the X button on the left side. And you can collapse this widget with ˇ button on the right side.
Can add new custom property key-value pair with Add button. It will create an empty key-value pair and can change their texts.
There is only one restriction: can not be 2 keys with same text. In this case if the user click out from the key field the key's value change back to the previous valid value.

Usage in runtime:

GameObject go = getYourGameObject();
CustomPropertiesComponent component = (CustomPropertiesComponent) go.findComponentByType(Component.Type.CUSTOM_PROPERTIES);
String hp = component.get("hp");
Gdx.app.log("", "HP: " + hp);

This is not braking change, you can use in any project without data lost.

JamesTKhan · 2023-05-01T19:59:49Z

Hi @Dgzt I understand this is still a work in progress but it looks like this would be adding properties map to every single GameObject rather then an optional ECS style component that can be added/removed from GameObjects. Wanted to bring that up before you got too far

Ping me on discord if you have questions about that

# Conflicts: # editor/CHANGES

antzGames · 2023-05-05T16:54:41Z

Errors in editor code:

GameObjectInspector.kt: (41, 25): Symbol is declared in module 'java.desktop' which does not export package 'sun.java2d.loops'

Removed unused import and its fine now. Starting to test.

antzGames · 2023-05-05T17:46:15Z

Here are some observations in the EDITOR:

So when you try to add more than 1 light component you get a error popup saying you cannot add a duplicate component. For custom properties, you dont get an error, it just stay on the Add Component popup. We should be consistent imo.
I cannot replicate this but the ordering of the key/value pairs sometimes just changes. Also when you save/exit/start Mundus the ordering changes. I dont consider this a big issue, but if you have an easy solution then maybe we should fix?
I tested JSON and HTML as values in the editor and then saved and reopen project. For some reason on the JSON it escapes the quotes, but on the HTML it does not. The view on the Mundus editor is ok though. See saved file example below:

{customProperties:{A:1,C:"{    \"firstName\": \"John\",    \"lastName\": \"Doe\"}",B:<a class=anchor-link href=#json-arrays aria-hidden=true title="Anchor Link">,D:5}

Output in the RUNTIME (Desktop) is:

1
<a class=anchor-link href=#json-arrays aria-hidden=true title="Anchor Link">
{    "firstName": "John",    "lastName": "Doe"}
5

I tried to test the field length limit without success. What is the field length limit?

antzGames · 2023-05-05T18:05:30Z

This breaks GWT compatibility on the runtime. Will not compile:

> Task :html:compileGwt
Compiling module com.antz.ode4libGDX.GdxDefinition
   Tracing compile failure path for type 'com.antz.ode4libGDX.screens.DemoCrashScreen'
      [ERROR] Errors in 'file:/C:/Users/antho/Downloads/GDX%20Stuff/My_GDX_Projects/ode4j-GWT-Compatible-libGDX/core/src/main/java/com/antz/ode4libGDX/screens/DemoCrashScreen.java'
         [ERROR] Line 492: CUSTOM_PROPERTIES cannot be resolved or is not a field
   [ERROR] Aborting compile due to errors in some input files
[ERROR] Error saving compilation unit to cache file: C:\Users\antho\Downloads\GDX Stuff\My_GDX_Projects\ode4j-GWT-Compatible-libGDX\html\build\gwt\cache\gwt-unitCache\gwt-unitCache-7b9fbb59f8661539c34f46974ce5fb573aac79fc-C90BB3B791D3293DB8D5BA1AB0A974D4-00000187ED130C59
java.io.IOException: Stream Closed
	at java.base/java.io.RandomAccessFile.seek0(Native Method)
	at java.base/java.io.RandomAccessFile.seek(RandomAccessFile.java:591)
	at com.google.gwt.dev.util.DiskCache.transferToStream(DiskCache.java:161)
	at com.google.gwt.dev.util.DiskCacheToken.writeObject(DiskCacheToken.java:73)

Dgzt · 2023-05-06T19:47:25Z

Thank you for your test and response!

Errors in editor code:

GameObjectInspector.kt: (41, 25): Symbol is declared in module 'java.desktop' which does not export package 'sun.java2d.loops'

Removed unused import and its fine now. Starting to test.

I don't know how I didn't see this. Thank you, removed it.

1. So when you try to add more than 1 light component you get a error popup saying you cannot add a duplicate component.  For custom properties, you dont get an error, it just stay on the `Add Component` popup.  We should be consistent imo.

Fixed.

2. I cannot replicate this but the ordering of the key/value pairs sometimes just changes.  Also when you save/exit/start Mundus the ordering changes.  I dont consider this a big issue, but if you have an easy solution then maybe we should fix?

I tried to use libGDX's OrderedMap to store sorting, but seen it doesn't work. Currently I don't know good and easy solution for it. But if someone has an idea for it just please write.

3. I tested JSON and HTML as values in the editor and then saved and reopen project.  For some reason on the JSON it escapes the quotes, but on the HTML it does not.  The view on the Mundus editor is ok though.

The libGDX's json parser does this, but them work in editor and runtime also so I think it is not problem.

4. I tried to test the field length limit without success.  What is the field length limit?

I didn't set limit for field. I think the limit is that what visui's VisTextField or libGDX's json parser can handle. I don' know how many is but more then enough for us.

This breaks GWT compatibility on the runtime. Will not compile:

> Task :html:compileGwt
Compiling module com.antz.ode4libGDX.GdxDefinition
   Tracing compile failure path for type 'com.antz.ode4libGDX.screens.DemoCrashScreen'
      [ERROR] Errors in 'file:/C:/Users/antho/Downloads/GDX%20Stuff/My_GDX_Projects/ode4j-GWT-Compatible-libGDX/core/src/main/java/com/antz/ode4libGDX/screens/DemoCrashScreen.java'
         [ERROR] Line 492: CUSTOM_PROPERTIES cannot be resolved or is not a field
   [ERROR] Aborting compile due to errors in some input files
[ERROR] Error saving compilation unit to cache file: C:\Users\antho\Downloads\GDX Stuff\My_GDX_Projects\ode4j-GWT-Compatible-libGDX\html\build\gwt\cache\gwt-unitCache\gwt-unitCache-7b9fbb59f8661539c34f46974ce5fb573aac79fc-C90BB3B791D3293DB8D5BA1AB0A974D4-00000187ED130C59
java.io.IOException: Stream Closed
	at java.base/java.io.RandomAccessFile.seek0(Native Method)
	at java.base/java.io.RandomAccessFile.seek(RandomAccessFile.java:591)
	at com.google.gwt.dev.util.DiskCache.transferToStream(DiskCache.java:161)
	at com.google.gwt.dev.util.DiskCacheToken.writeObject(DiskCacheToken.java:73)

Strange. I've tried with this:

...
import static com.mbrlabs.mundus.commons.scene3d.components.Component.Type.CUSTOM_PROPERTIES;
...

CustomPropertiesComponent component = (CustomPropertiesComponent) go.findComponentByType(CUSTOM_PROPERTIES);
...

and this also:

...
import com.mbrlabs.mundus.commons.scene3d.components.Component;
...

CustomPropertiesComponent component = (CustomPropertiesComponent) go.findComponentByType(Component.Type.CUSTOM_PROPERTIES);
...

But both work for me.

Could you post codes near line 492 in DemoCrashScreen.java? Where you used this component. I will try to reproduce this error.

antzGames · 2023-05-06T20:38:43Z

So my bad. I updated the build.gradle for core but not html project when I tested last night.

It was pointing to master snapshot sources from JTK's repo. That is why it couldnt find the new type during GWT compile.

I wouldnt worry about the ordering of the properties. So everything works fine. Good work. Thank you for doing this.

I will leave it up to @JamesTKhan to do final review and PR merge.

JamesTKhan · 2023-05-06T21:04:31Z

The sort order changing sounds a little strange. When I have some time to review I will try to replicate as I am wondering what is causing it.

…tom-properties # Conflicts: # editor/CHANGES # gdx-runtime/CHANGES

Dgzt · 2023-05-07T12:31:17Z

I think I found the reason of order problem. It called ObjectMap's putAll method instead of OrderedMap's method. I pushed the fix.

JamesTKhan · 2023-05-08T22:18:45Z

I should be able to test this out tomorrow

JamesTKhan · 2023-05-09T03:06:00Z

Looks good. I tested on Desktop and GWT and was able to retrieve data. If we find any edge case issues with it once it starts being used more we can patch it as needed. Thanks. @Dgzt I created a Wiki page using one of my old PR's and this PR to create a developer guide on how to add components to make it easier in the future. Let me know if it looks good since this is still fresh in your head.

https://github.com/JamesTKhan/Mundus/wiki/Steps-to-add-a-new-Component

Empty custom properties widget

703fdc1

Dgzt changed the title ~~Custom properties for game objects #150~~ Custom properties for game objects May 1, 2023

Dgzt linked an issue May 1, 2023 that may be closed by this pull request

ability to add meta data to GameObjects #150

Closed

Dgzt added the enhancement New feature or request label May 1, 2023

Dgzt added 2 commits May 1, 2023 17:47

Add button

4a628ce

Add custom properties map into GameObject

fe306f4

Dgzt added 12 commits May 1, 2023 20:00

Game object can store custom value and widget can load them

422d11d

Convert custom properties to ECS style component

75e1381

Delete button listener implementation

d132ac0

Can not add double empty key to map

2781fb4

Save and load custom properties

d51477b

Check key value

8035db8

Fix component delete. Load custom properties in runtime also

9128d05

Header for custom properties

f66c953

Add header

f30e3cc

Update CHANGEs

f70feab

Merge branch 'master' into game-object-custom-properties

9740b1e

# Conflicts: # editor/CHANGES

Add some helper methods into component class

3dffa6b

Dgzt marked this pull request as ready for review May 4, 2023 11:45

Implement missing clone method

8ee4561

Dgzt added 2 commits May 6, 2023 17:51

Remove unused import

5170b54

Show message if duplicated custom properties

5f9d126

Merge remote-tracking branch 'jamestkhan/master' into game-object-cus…

f3ae84a

…tom-properties # Conflicts: # editor/CHANGES # gdx-runtime/CHANGES

Fix custom properties order

3adeefb

JamesTKhan merged commit ff0d1a8 into JamesTKhan:master May 9, 2023

Dgzt deleted the game-object-custom-properties branch May 9, 2023 05:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Custom properties for game objects #163

Custom properties for game objects #163

Dgzt commented May 1, 2023 •

edited

Loading

JamesTKhan commented May 1, 2023 •

edited

Loading

antzGames commented May 5, 2023

antzGames commented May 5, 2023 •

edited

Loading

antzGames commented May 5, 2023

Dgzt commented May 6, 2023

antzGames commented May 6, 2023 •

edited

Loading

JamesTKhan commented May 6, 2023

Dgzt commented May 7, 2023

JamesTKhan commented May 8, 2023

JamesTKhan commented May 9, 2023

Custom properties for game objects #163

Custom properties for game objects #163

Conversation

Dgzt commented May 1, 2023 • edited Loading

Usage in editor:

Usage in runtime:

JamesTKhan commented May 1, 2023 • edited Loading

antzGames commented May 5, 2023

antzGames commented May 5, 2023 • edited Loading

antzGames commented May 5, 2023

Dgzt commented May 6, 2023

antzGames commented May 6, 2023 • edited Loading

JamesTKhan commented May 6, 2023

Dgzt commented May 7, 2023

JamesTKhan commented May 8, 2023

JamesTKhan commented May 9, 2023

Dgzt commented May 1, 2023 •

edited

Loading

JamesTKhan commented May 1, 2023 •

edited

Loading

antzGames commented May 5, 2023 •

edited

Loading

antzGames commented May 6, 2023 •

edited

Loading