How would I type check for a specific set of allowed strings?

[DaDude_89 (KasCode)]

I’m trying to do something similar to what Roblox already seems to do with Instance.new():

It auto-fills for all the available instance types. Is there a way to efficiently do this, for example from a table of allowed strings?

The best I was able to think of was this:

function WorldFx:TriggerClient(name: "Fireworks" | "ButtonPush", ...)

But if I have 10 types for example? 100? This becomes a pain very quickly.

Any help or info is appreciated!

[LerpSoh (MattressBuyer)]

You could just make a module script and require it to export all they type from there. If you don’t want hundred of clutter type-check on your function parameter. An example follow by nicemike40 post: Exported types in Luau - #4 by nicemike40

Module script

export type name = "Fireworks" | "ButtonPush"
return nil

Your Module script

local types = require(path.to.ModuleScript)

local WorldFx = {}

local WorldFx:TriggerClient(name: types.name, ...)
      --things to do
end

return WorldFx

Happy type checking!

[colbert2677 (ImagineerColbert)]

You’re compounding two separate features. The typechecking is what you’re writing on the parameters and also what you’re seeing above the description of the function. The scroll list is part of auto complete; you can’t configure argument auto complete for your own functions.

[DaDude_89 (KasCode)]

Thank you @LerpSoh and @colbert2677!

I guess doing this just won’t be worth it… I wonder if Lua or Luau itself might come out with some special table-unpacking to use for types, though that seems unlikely.

Lerps example is probably the best-case scenario for doing this, if anybody sees this topic in the future. Otherwise, I’m just going to trust my own spelling abilities lol

[Revelted]

For typechecking, I suggest looking at this:

Finding closest answer to string

Using a string similarity algorithm is one method for locating the string in a table of strings that most closely resembles a target string. For calculating the similarity between two strings, a variety of algorithms are available, including: The Levenshtein distance algorithm determines how many insertions, deletions, or substitutions are necessary to change one string into another. The similarities between the strings increase with decreasing distance. The size of the intersection of two set…

Thats my small input haha