Call DidChange event when value is the same

gubebra · 2024-07-08T15:34:37.370Z

I basically want to trigger the ValueDidChange every time I assign model.value to something, even if that value is the same as before. For some context, I'm sending a string to all clients when a player scores and if he scores again the string is going to be the same, but I need the StringDidChange event to trigger on all clients to display who scored.

K

kapa.ai•7/8/24, 3:34 PM

Hi @gubebra. I'm kapa.ai, your friendly support bot. I will try to answer your question by searching through the knowledge base.

K

kapa.ai•7/8/24, 3:35 PM

----------------------
In NormalVR, the

ValueDidChange

ValueDidChange

ValueDidChange

ValueDidChange event is triggered when a value changes. If you're setting the same value again, the event might not be triggered because the value hasn't technically changed.

One workaround could be to slightly modify the value each time you set it, even if the meaningful content remains the same. For example, you could append a unique, but irrelevant, character or number to the string each time a player scores. This would ensure that the

ValueDidChange

ValueDidChange

ValueDidChange

ValueDidChange event is triggered each time, as the value is technically different each time.

Here's an example of how you might implement this in your code:

public void PlayerScored(string playerName) {  
    // Append a unique value to the player name each time they score
    model.value = playerName + "_" + System.Guid.NewGuid().ToString();

    // This will fire the valueChanged event on the model, which will update for all clients.  
}

public void PlayerScored(string playerName) {  
    // Append a unique value to the player name each time they score
    model.value = playerName + "_" + System.Guid.NewGuid().ToString();

    // This will fire the valueChanged event on the model, which will update for all clients.  
}

public void PlayerScored(string playerName) {  
    // Append a unique value to the player name each time they score
    model.value = playerName + "_" + System.Guid.NewGuid().ToString();

    // This will fire the valueChanged event on the model, which will update for all clients.  
}

public void PlayerScored(string playerName) {  
    // Append a unique value to the player name each time they score
    model.value = playerName + "_" + System.Guid.NewGuid().ToString();

    // This will fire the valueChanged event on the model, which will update for all clients.  
}

In this example, a new GUID is appended to the player name each time they score. This ensures that the value is unique each time, triggering the

ValueDidChange

ValueDidChange

ValueDidChange

ValueDidChange event. You can then handle this event and strip the appended GUID before displaying the player name.

Remember to handle the

ValueDidChange

ValueDidChange

ValueDidChange

ValueDidChange event properly in your code. Here's an example of how you might do this:

private void ValueDidChange(MyModel model, string value) {  
    // Strip the appended GUID from the value
    string playerName = value.Split('_')[0];

    // Display the player name
    DisplayPlayerScored(playerName);
}

private void ValueDidChange(MyModel model, string value) {  
    // Strip the appended GUID from the value
    string playerName = value.Split('_')[0];

    // Display the player name
    DisplayPlayerScored(playerName);
}

private void ValueDidChange(MyModel model, string value) {  
    // Strip the appended GUID from the value
    string playerName = value.Split('_')[0];

    // Display the player name
    DisplayPlayerScored(playerName);
}

private void ValueDidChange(MyModel model, string value) {  
    // Strip the appended GUID from the value
    string playerName = value.Split('_')[0];

    // Display the player name
    DisplayPlayerScored(playerName);
}

In this example, the

ValueDidChange

ValueDidChange

ValueDidChange

ValueDidChange method splits the value on the underscore character (

_

_), and takes the first part as the player name. It then calls a hypothetical

DisplayPlayerScored

DisplayPlayerScored

DisplayPlayerScored

DisplayPlayerScored method to display the player name.

K

kapa.ai•7/8/24, 3:35 PM

Please note that this is a workaround and might not be the best solution depending on your specific use case. Always consider the implications of your design decisions and choose the best solution for your needs.

For more information on how to use

ValueDidChange

ValueDidChange

ValueDidChange

ValueDidChange and other events in NormalVR, you can refer to the official documentation (https://normcore.io/documentation/realtime/synchronizing-custom-data#creating-a-realtimecomponent-subclass).
----------------------
Note: you can ask me a follow up question by @ mentioning me again

----------------------

K

kapa.ai•7/8/24, 3:35 PM

@599054560270483456 kapa.ai is still learning and improving, please let us know how it did by reacting below

M

Mechabit•7/8/24, 3:35 PM

the bot doesn't know but there's a better option

M

Mechabit•7/8/24, 3:36 PM

set the equality check parameter to false when you make the model

M

Mechabit•7/8/24, 3:36 PM

it's not in the docs but was added recently

G

gubebraOP•7/8/24, 3:37 PM

Interesting, when defining the RealtimeProperty?

M

Mechabit•7/8/24, 3:37 PM

yeah, use intelisense in your IDE to get the property name

M

Mechabit•7/8/24, 3:38 PM

RealtimePropertyAttribute(uint propertyID, bool reliable, bool createDidChangeEvent = false, bool includeEqualityCheck = true)

M

Mechabit•7/8/24, 3:39 PM

set the last one to false

G

gubebraOP•7/8/24, 3:39 PM

[RealtimeProperty(1, true, true, false )] private string _text;

[RealtimeProperty(1, true, true, false )] private string _text;

[RealtimeProperty(1, true, true, false )] private string _text;

[RealtimeProperty(1, true, true, false )] private string _text;

Like this?

M

Mechabit•7/8/24, 3:40 PM

yeah

G

gubebraOP•7/8/24, 3:44 PM

It's almost working, I get the event fired for the person that changed the string but not the other clients

M

Mechabit•7/8/24, 3:45 PM

make sure they have registered to the event before you change it

G

gubebraOP•7/8/24, 3:46 PM

I don't know if I've done something wrong it's a really simple script:

using System.Collections;
using System.Collections.Generic;
using System;
using UnityEngine;
using Normal.Realtime;

public class TextEvent : RealtimeComponent<TextEventModel>
{
    protected override void OnRealtimeModelReplaced(TextEventModel previousModel, TextEventModel currentModel)
    {
        if (previousModel != null)
        {
            previousModel.textDidChange -= TextDidChange;
        }

        if (currentModel != null)
        {
            currentModel.textDidChange += TextDidChange;
        }
    }

    private void TextDidChange(TextEventModel model, string value)
    {
        Debug.Log("text: " + value); // this is not being called
        UIManager.Instance.notificationFront(value, model.duration);
    }

    public void SetTextSynced(string text, float duration)
    {
        model.duration = duration;
        model.text = text;
    }
}

using System.Collections;
using System.Collections.Generic;
using System;
using UnityEngine;
using Normal.Realtime;

public class TextEvent : RealtimeComponent<TextEventModel>
{
    protected override void OnRealtimeModelReplaced(TextEventModel previousModel, TextEventModel currentModel)
    {
        if (previousModel != null)
        {
            previousModel.textDidChange -= TextDidChange;
        }

        if (currentModel != null)
        {
            currentModel.textDidChange += TextDidChange;
        }
    }

    private void TextDidChange(TextEventModel model, string value)
    {
        Debug.Log("text: " + value); // this is not being called
        UIManager.Instance.notificationFront(value, model.duration);
    }

    public void SetTextSynced(string text, float duration)
    {
        model.duration = duration;
        model.text = text;
    }
}

using System.Collections;
using System.Collections.Generic;
using System;
using UnityEngine;
using Normal.Realtime;

public class TextEvent : RealtimeComponent<TextEventModel>
{
    protected override void OnRealtimeModelReplaced(TextEventModel previousModel, TextEventModel currentModel)
    {
        if (previousModel != null)
        {
            previousModel.textDidChange -= TextDidChange;
        }

        if (currentModel != null)
        {
            currentModel.textDidChange += TextDidChange;
        }
    }

    private void TextDidChange(TextEventModel model, string value)
    {
        Debug.Log("text: " + value); // this is not being called
        UIManager.Instance.notificationFront(value, model.duration);
    }

    public void SetTextSynced(string text, float duration)
    {
        model.duration = duration;
        model.text = text;
    }
}

using System.Collections;
using System.Collections.Generic;
using System;
using UnityEngine;
using Normal.Realtime;

public class TextEvent : RealtimeComponent<TextEventModel>
{
    protected override void OnRealtimeModelReplaced(TextEventModel previousModel, TextEventModel currentModel)
    {
        if (previousModel != null)
        {
            previousModel.textDidChange -= TextDidChange;
        }

        if (currentModel != null)
        {
            currentModel.textDidChange += TextDidChange;
        }
    }

    private void TextDidChange(TextEventModel model, string value)
    {
        Debug.Log("text: " + value); // this is not being called
        UIManager.Instance.notificationFront(value, model.duration);
    }

    public void SetTextSynced(string text, float duration)
    {
        model.duration = duration;
        model.text = text;
    }
}

using UnityEngine;
using Normal.Realtime;
using Normal.Realtime.Serialization;

[RealtimeModel]
public partial class TextEventModel
{
    [RealtimeProperty(1, true, true, false )] private string _text;
    [RealtimeProperty(2, true )] private float _duration;
}

using UnityEngine;
using Normal.Realtime;
using Normal.Realtime.Serialization;

[RealtimeModel]
public partial class TextEventModel
{
    [RealtimeProperty(1, true, true, false )] private string _text;
    [RealtimeProperty(2, true )] private float _duration;
}

using UnityEngine;
using Normal.Realtime;
using Normal.Realtime.Serialization;

[RealtimeModel]
public partial class TextEventModel
{
    [RealtimeProperty(1, true, true, false )] private string _text;
    [RealtimeProperty(2, true )] private float _duration;
}

using UnityEngine;
using Normal.Realtime;
using Normal.Realtime.Serialization;

[RealtimeModel]
public partial class TextEventModel
{
    [RealtimeProperty(1, true, true, false )] private string _text;
    [RealtimeProperty(2, true )] private float _duration;
}

M

Mechabit•7/8/24, 3:52 PM

you probably want to check the value on model replaced in case it's already set when you join

G

gubebraOP•7/8/24, 4:13 PM

Still not working. I'm changing the model value here a lot of times and no luck. Do you now which version of Nomcore has this feature?

M

Mechabit•7/8/24, 4:17 PM

2.9.3

G

gubebraOP•7/8/24, 4:20 PM

Yeah I have version 2.10.4

G

gubebraOP•7/8/24, 4:22 PM

Is that expected behaviour? Because the event is called for the person that changed the variable.

M

Mechabit•7/8/24, 4:28 PM

no, it should call the event

G

gubebraOP•7/8/24, 4:34 PM

Should I file a bug then?

M

Mechabit•7/8/24, 5:20 PM

could do, as an alternative you can add an int property that you increment when you want to fire an event

Ggubebra It's almost working, I get the event fired for the person that changed the strin...

M

maxweisel•7/8/24, 5:36 PM

did you make a new build for all clients after updating normcore and enabling this flag?

G

gubebraOP•7/8/24, 5:40 PM

Yes, I actually have 2 editors open with the project

M

maxweisel•7/8/24, 5:41 PM

if you're able to make a repro in a blank project, I'd love to take a look

G

gubebraOP•7/8/24, 5:53 PM

I'll try

G

gubebraOP•7/10/24, 2:03 PM

@Max I managed to repro on a blank project, here's the video

G

gubebraOP•7/10/24, 2:03 PM

G

gubebraOP•7/10/24, 2:06 PM

Here're the project files

TestText.zip3.22MB

M

maxweisel•7/10/24, 4:37 PM

@NormalMark want to take a look at this when you get a sec?

N

NormalMark•7/16/24, 9:01 PM

Hey, thanks for putting this test project together! We identified the issue and we're working on a fix

G

gubebraOP•7/16/24, 10:01 PM

Great to hear thanks!

Ggubebra Click to see attachment

A

Ata•1/6/25, 9:34 AM

Hello, I know it's been a while since this chat was created, but I’m experiencing the exact same issue. Did you manage to find a solution for it? My clone can only trigger once, just like in the video above. @NormalMark @maxweisel

U

Utku•1/6/25, 2:05 PM

Heyo, I can confirm that clients won't receive change events. This is a simple model that I used to check whether the generated code is wrong or not. In the generated code, the event fires for the owner, but not in the clients. I see that, Read function in the generated code there is still a check for "changed" to Fire or not the event. I think there shouldn't be a check for the PlayerID.

M

maxweisel•1/6/25, 2:07 PM

which version of Normcore are you on? we fixed a bug around this recently

Mmaxweisel which version of Normcore are you on? we fixed a bug around this recently

A

Ata•1/6/25, 2:16 PM

2.12.1

M

maxweisel•1/6/25, 2:16 PM

Will you try on the latest version?

Mmaxweisel Will you try on the latest version?

A

Ata•1/6/25, 2:54 PM

It still not working

M

maxweisel•1/6/25, 2:56 PM

@NormalMark will you take a look?

N

NormalMark•1/7/25, 11:06 PM

@Ata @Utku Hey, thanks for the detailed report. Yes there is indeed a bug that generates an unnecessary change check.

Can you test if this build of Normcore works as expected? https://drive.google.com/file/d/1DNR69VYZ04jKBGwPAWfBjWVJm17pJb0T/view?usp=sharing

Google Docs

Normcore-DidChangeEvent-NoEqualityTestFix.zip

A

Ata•1/8/25, 8:23 AM

@NormalMark After integrating this version into the project, nothing had changed, it was the same as the previous version. However when I deleted the Library folder and reopened the project, it updated and worked flawlessly. Thank you for resolving the issue.

N

NormalMark•1/8/25, 3:08 PM

Glad to hear it! We'll try to land this fix in our next release