import { Fabric, UnitDefinition, ThisFabricUnit } from "@rbxts/fabric";

const fabric = new Fabric("game");

declare global {
    interface FabricUnits {
        ExampleUnit: ExampleUnitDefinition;
    }
}

//NOTE: you should never define the `name` field here. `name` should always be the same as the key in `FabricUnits`, which is done automatically for you.
interface ExampleUnitDefinition extends UnitDefinition<"ExampleUnit"> {
    //these three fields are for typing only, and they have to be optional so that the below implementation does not have to define them
    data?: { bar: boolean };
    _addLayerData?: { bar: true }; //if `_addLayerData` is not specified, `data` will be used.
    ref?: Player;

    foo(this: ThisFabricUnit<"ExampleUnit">): void;
}

const exampleUnitDefinition: ExampleUnitDefinition = {
    name: "ExampleUnit",

    foo() {
        this.addLayer("exampleScope", { bar: true }); //here, `bar` must equal `true`.

        //hypothetically, if `_addLayerData` was not specified, then `bar` would be able to be `true` OR `false`, since those are of type `boolean`.
    },
};

fabric.registerUnit(exampleUnitDefinition);

const unit = fabric.getOrCreateUnitByRef("ExampleUnit", game); //attach an ExampleUnit to `game`
unit.foo();
print(unit.data!.bar); // > true