BaseClass with EnableOnLoad(false) still loads ticks, events, etc. by registering them without the attributes #2476

AvarianKnight · 2024-04-20T05:39:19Z

What happened?

If a class inherits from BaseClass and has the attribute [EnableOnLoad(false)] calling register functions Tick += or EventHandlers[eventName] += will still schedule the tick & will still bind the event handler.

I would assume this works the same for exports but I couldn't figure out how to register them via Exports.Add in mono_rt2

Expected result

The class class inheriting BaseClass should only add Event/Tick/Nui whenever script.Enable() is called

Reproduction steps

Client.cs

using CitizenFX.Core;
using CitizenFX.RedM.Native;

public class Main : BaseScript
{
    Client m_client;

    public Main()
    {
        m_client = new Client();
    }

    void CallUi()
    {
        Natives.SendNuiMessage("{}");
    }

    [Tick]
    async Coroutine ToggleScript()
    {
        await Wait(5000);
        Debug.WriteLine("Enable");
        m_client.Enable();
        CallUi();
        await Wait(5000);
        Debug.WriteLine("Disable");
        m_client.Disable();
        CallUi();
    }
}

[EnableOnLoad(false)]
public class Client : BaseScript
{
    bool m_printed = false;

    async Coroutine TickFunction()
    {
        if (!m_printed)
        {
            Events.TriggerEvent("TestEvent");
            m_printed = true;
            Debug.WriteLine("Tick gets called!");
        }
    }

    async Coroutine EventFunction()
    {
        Debug.WriteLine("Event gets called");
    }

    override protected void OnDisable()
    {
        m_printed = false;
    }

    override protected void OnEnable()
    {
        m_printed = false;
    }

    public Client()
    {
        Tick += TickFunction;
        EventHandlers["TestEvent"] += EventFunction;

        RegisterNuiCallback("NuiBaseCB", new Action<IDictionary<string, object>, Callback>((IDictionary<string, object> nuiData, Callback cb) =>
        {
            cb("base cb 1");
        }));


        BaseScript.AddNuiCallback("NuiStaticBaseCB", new Action<IDictionary<string, object>, Callback>((IDictionary<string, object> nuiData, Callback cb) =>
        {
            cb("static cb 2");
        }));
    }

    [NuiCallback("NuiCB")]
    void EventCallback(IDictionary<string, object> nuiData, Callback cb)
    {
        cb($"attribute cb 3");
    }
}

index.html

<!doctype html>
<html>
	<script>
		const callbackTests = ["NuiCB", "NuiBaseCB", "NuiStaticBaseCB" ];

		window.addEventListener("message", () => {
			for (const test of callbackTests) {
				console.log(`Triggering ${test}`);
				fetch(`https://${GetParentResourceName()}/${test}`, {
					method: 'POST',
					headers: {
						'Content-Type': 'application/json; charset=UTF-8',
					},
					body: JSON.stringify({
						ItemId: 'my-item-2',
						Test: {
							TestValue: "test",
						}
					})
				}).then(resp => resp.json()).then(resp => console.log(resp));
			}
		})

	</script>
</html>

Importancy

There's a workaround

Area(s)

ScRT: C#

Specific version(s)

N/A

Additional information

A simple fix for this would probably be to remove the Schedule() call for Ticks and remove the EventsManager.AddEventhandler call, and returning after m_nuiCallbacks if the script is not enabled.

Initialize() should probably only set the state to State.Initialized and call Enable() again after it finishes initializing attribute values and let Enable() handle scheduling the Tick/Nui/Event/Export/Commands.

The text was updated successfully, but these errors were encountered:

thorium-cfx · 2024-04-24T10:41:18Z

I read the conversation that led to this issue and to that the answer is: yep [EnableOnLoad(false)] implies not activating all instances' ticks, events, etc. at construction. So this is indeed a bug due to an oversight.

This'll need to be fixed/tweaked

AvarianKnight added bug triage Needs a preliminary assessment to determine the urgency and required action labels Apr 20, 2024

github-actions bot added the ScRT: C# Issues/PRs related to either C# scripting runtimes label Apr 20, 2024

AvarianKnight mentioned this issue Apr 24, 2024

feat(mono-rt2): add NuiEvent attribute #2463

Merged

4 tasks

thorium-cfx added status:fix-pending Issue has been triaged and ready to be picked up to be fixed and removed triage Needs a preliminary assessment to determine the urgency and required action labels Apr 24, 2024

thorium-cfx changed the title ~~Unexpected behavior for BaseClass~~ BaseClass with EnableOnLoad(false) still loads ticks, events, etc. by registering them without the attributes Apr 24, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

BaseClass with EnableOnLoad(false) still loads ticks, events, etc. by registering them without the attributes #2476

BaseClass with EnableOnLoad(false) still loads ticks, events, etc. by registering them without the attributes #2476

AvarianKnight commented Apr 20, 2024

thorium-cfx commented Apr 24, 2024 •

edited

BaseClass with EnableOnLoad(false) still loads ticks, events, etc. by registering them without the attributes #2476

BaseClass with EnableOnLoad(false) still loads ticks, events, etc. by registering them without the attributes #2476

Comments

AvarianKnight commented Apr 20, 2024

What happened?

Expected result

Reproduction steps

Importancy

Area(s)

Specific version(s)

Additional information

thorium-cfx commented Apr 24, 2024 • edited

thorium-cfx commented Apr 24, 2024 •

edited