ix

Top-level library containing all Helix libraries.

A large majority of the framework is split into respective libraries that reside within ix.

Tables

type

 View source »

A table of variable types that are used throughout the framework. It represents types as a table with the keys being the name of the type, and the values being some number value. You should never directly use these number values! Using the values from this table will ensure backwards compatibility if the values in this table change.

This table also contains the numerical values of the types as keys. This means that if you need to check if a type exists, or if you need to get the name of a type, you can do a table lookup with a numerical value. Note that special types are not included since they are not real types that can be compared with.

Fields

  • string

    A regular string. In the case of ix.command.Add, this represents one word.

  • text

    A regular string. In the case of ix.command.Add, this represents all words concatenated into a string.

  • number

    Any number.

  • steamid

    A string that matches the Steam ID format of STEAM_X:X:XXXXXXXX.

  • character

    Any player's character that matches the given query string in ix.util.FindPlayer.

  • bool

    A string representation of a bool - false and 0 will return false, anything else will return true.

  • color

    A color represented by its red/green/blue/alpha values.

  • vector

    A 3D vector represented by its x/y/z values.

  • optional

    This is a special type that can be bitwise OR'd with any other type to make it optional. Currently only supported in ix.command.Add.

  • array

    This is a special type that can be bitwise OR'd with any other type to make it an array of that type. Currently only supported in ix.option.Add.

Example Usage

-- checking if type exists
print(ix.type[2] != nil)
> true

-- getting name of type
print(ix.type[ix.type.string])
> "string"

See Also