Annotating Enums without numbers

[NickGrease]

The Documentation:

My (successful) attempt:

---@meta
---@enum ComponentType
ComponentType = {
    Position = "",
    Plan = "",
    Asleep = "",
    BoundingSphere = "",
    BoundingBox = "",
    Velocity = "",
    Physics = "",
    ...
}

Result:

I'm just wondering if there's a 'better' way when the enum values are not known. ComponentType has around 150 members, and I can't be sure they are sequential or even what number they start at, not that that is an issue, I just need the auto-complete.

[C3pa]

Your example doesn't look like something enums are used for. I'd try using ---@class annotation here.

For example:

---@class Component
---@field Position vector3 Description here
---@field Plan someType
--- ...

Ideally you would use ---@enum annotations when you want to mark a named set of constants.

[NickGrease]

My apologies, I didn't do a very good job explaining. I was trying to annotate the developers documentation (first image) so that I could get auto complete, but I wasn't sure what to do without the values so I just used empty strings. In the end I realized I was overthinking it and just assigned them values 1-150 since the actual values are maintained internally, it really didn't matter what values I used for the annotations - if that makes sense.

[C3pa]

I was trying to annotate the developers documentation (first image) so that I could get auto complete, but I wasn't sure what to do without the values so I just used empty strings. In the end I realized I was overthinking it and just assigned them values 1-150 since the actual values are maintained internally,

The ---@class suggestion still seems like the best way to go 😉. With it you annotate all the available fields and their types, but you don't specify their values.

[NickGrease]

Thanks for your help C3pa, after a bit of trial and error, its working like a charm now!