roblox-ts•4mo ago

Jecs Cleanup Attributes Help

I'm struggling to figure out how Jec's component traits work. I have a state machine like system that attaches a tag to an entity called "DoingATest". I've setup a function that runs on startup to setup the cleanup:

print("init cleanup");

    world.set(components.DoingATest, OnRemove, (entity) => {
        print("Doing a Test Removed from " + entity);
        world.remove(entity, components.DoTest.WaitingForClassD);
        world.remove(entity, components.DoTest.MovingToClassD);
        world.remove(entity, components.DoTest.LookingForClassD);
        world.remove(entity, components.DoTest.LookingForSCP);
        world.remove(entity, components.DoTest.TestingOnSCP);
       
   
        world.remove(entity, components.DoingATest);
        print("Cleaned up!");
    });

print("init cleanup");

    world.set(components.DoingATest, OnRemove, (entity) => {
        print("Doing a Test Removed from " + entity);
        world.remove(entity, components.DoTest.WaitingForClassD);
        world.remove(entity, components.DoTest.MovingToClassD);
        world.remove(entity, components.DoTest.LookingForClassD);
        world.remove(entity, components.DoTest.LookingForSCP);
        world.remove(entity, components.DoTest.TestingOnSCP);
       
   
        world.remove(entity, components.DoingATest);
        print("Cleaned up!");
    });

And in my runtime I am removing the tag like so

    for (const [entityID] of world
        .query(components.NPC, components.PathfindingComponent)
        .with(components.DoingATest)
        .with(components.DoTest.MovingToClassD)
        .with(components.PathfindingStatus.Failed)
        .without(components.Tasks)) {
        // clean up cause failure!
        world.remove(entityID, components.DoingATest);
        print("cleanup!");
    }

    for (const [entityID] of world
        .query(components.NPC, components.PathfindingComponent)
        .with(components.DoingATest)
        .with(components.DoTest.MovingToClassD)
        .with(components.PathfindingStatus.Failed)
        .without(components.Tasks)) {
        // clean up cause failure!
        world.remove(entityID, components.DoingATest);
        print("cleanup!");
    }

basically when pathfinding failed tag is added it removes doing a test because it failed to do the test. Here is a snip of my components:

export const components = {
    NPC: world.component(),
    DoingATest: world.component(),
    DoTest: {
        LookingForClassD: world.component(),
        MovingToClassD: world.component(),
        WaitingForClassD: world.component(),
        LookingForSCP: world.component(),
        MovingToSCP: world.component(),
        TestingOnSCP: world.component(),
    },


    PathfindingStatus: {
        Computing: world.component(),
        Success: world.component(),
        Failed: world.component(),
    },
    PathfindingComponent: world.component<{
        AgentParams?: AgentParameters;
        lastCalculate?: number;
        waypoints?: Waypoint[];
    }>(),

};

export const components = {
    NPC: world.component(),
    DoingATest: world.component(),
    DoTest: {
        LookingForClassD: world.component(),
        MovingToClassD: world.component(),
        WaitingForClassD: world.component(),
        LookingForSCP: world.component(),
        MovingToSCP: world.component(),
        TestingOnSCP: world.component(),
    },


    PathfindingStatus: {
        Computing: world.component(),
        Success: world.component(),
        Failed: world.component(),
    },
    PathfindingComponent: world.component<{
        AgentParams?: AgentParameters;
        lastCalculate?: number;
        waypoints?: Waypoint[];
    }>(),

};

I havent had issues getting OnRemove to work with other tags, is there anything I should check for in this case? Am I not understanding the purpoe of these hooks? Thanks! Side question: is there any documentation for creating custom traits?

29 Replies

BradenOP•4mo ago

Solved! I am using planck and I had it in a Phase.Startup system, moving it to directly in the components file fixed it. Not sure why

Unknown User•4mo ago

Message Not Public

BradenOP•4mo ago

It ran the print statement so it did run just maybe not on the same world?

Unknown User•4mo ago

Message Not Public

BradenOP•4mo ago

whats weird is i have another startup phase function for testing that works fine it just adds some entities to start

Unknown User•4mo ago

Message Not Public

BradenOP•4mo ago

just Phase.Startup import { Phase } from "@rbxts/planck";

Unknown User•3mo ago

Message Not Public

BradenOP•3mo ago

I used the Planck setup guide basically copy-paste

Unknown User•3mo ago

Message Not Public

BradenOP•3mo ago

https://yetanotherclown.github.io/planck/docs/setup_guides/jecs

Jecs | Planck Scheduler

Suggested setup guide for Jecs

Unknown User•3mo ago

Message Not Public

BradenOP•3mo ago

export function sharedJecsStartup(systems: System<[World]>[]) {
    if (systems && systems.size() > 0) {
        scheduler.addSystems(systems);
    }
}

export function sharedJecsStartup(systems: System<[World]>[]) {
    if (systems && systems.size() > 0) {
        scheduler.addSystems(systems);
    }
}

Unknown User•3mo ago

Message Not Public

BradenOP•3mo ago

thats what mine is each module should have

export default {
system: System,
phase: Phase
}

export default {
system: System,
phase: Phase
}

then when you require the module and add to table you must cast the type and require(module).default

Unknown User•3mo ago

Message Not Public

BradenOP•3mo ago

So don’t make those calls inside Planck systems?

Unknown User•3mo ago

Message Not Public

BradenOP•3mo ago

So if I wanted to clean up other components if another component is removed on the same entity how would I do that? It’s Phase.PostUpdate it’s in the types

Unknown User•3mo ago

Message Not Public

BradenOP•3mo ago

What is my approach doing, thats incorrect? Sorry just trying to understand. Also clear would clear everything? Is that any different from calling remove individually

Unknown User•3mo ago

Message Not Public

BradenOP•3mo ago

would a better approach be using :cached() and then clearing when changes happen

Unknown User•3mo ago

Message Not Public

BradenOP•3mo ago

so if I wanted to remove components when another component is removed, what would be an appropriate way to do that?

Unknown User•3mo ago

Message Not Public

BradenOP•3mo ago

got it, thank you!

Unknown User•3mo ago

Message Not Public

BradenOP•3mo ago

Please make another support thread instead of using this thread, that way you can provide your environment and we can help

Gaming

Programming

Jecs Cleanup Attributes Help

Did you find this page helpful?