Skip to main content

NumberSequenceUtils

Utility functions involving NumberSequences on Roblox

Functions​

getValueGenerator​

</>
NumberSequenceUtils.getValueGenerator(numberSequence: NumberSequence) → (number) → number

Gets the current NumberSequence value for a given t

forEachValue​

</>
NumberSequenceUtils.forEachValue(
sequence: NumberSequence,
callback: function
) → NumberSequence

Scales a number sequence value by the set amount

scale​

</>
NumberSequenceUtils.scale(
sequence: NumberSequence,
scale: number
) → NumberSequence

Scales a number sequence value by the set amount

stripe​

</>
NumberSequenceUtils.stripe(
stripes: number,
backgroundTransparency: number,--

[0, 1]

stripeTransparency: number,--

[0, 1]

percentStripeThickness: number,--

[0, 1]

percentOffset: number
) → NumberSequence

Generates a number sequence with stripes, which can be used in a variety of ways.

Show raw api
{
    "functions": [
        {
            "name": "getValueGenerator",
            "desc": "Gets the current NumberSequence value for a given t",
            "params": [
                {
                    "name": "numberSequence",
                    "desc": "",
                    "lua_type": "NumberSequence"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "(number) -> number"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 20,
                "path": "src/numbersequenceutils/src/Shared/NumberSequenceUtils.lua"
            }
        },
        {
            "name": "forEachValue",
            "desc": "Scales a number sequence value by the set amount",
            "params": [
                {
                    "name": "sequence",
                    "desc": "",
                    "lua_type": "NumberSequence"
                },
                {
                    "name": "callback",
                    "desc": "",
                    "lua_type": "function"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "NumberSequence"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 97,
                "path": "src/numbersequenceutils/src/Shared/NumberSequenceUtils.lua"
            }
        },
        {
            "name": "scale",
            "desc": "Scales a number sequence value by the set amount",
            "params": [
                {
                    "name": "sequence",
                    "desc": "",
                    "lua_type": "NumberSequence"
                },
                {
                    "name": "scale",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "NumberSequence"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 116,
                "path": "src/numbersequenceutils/src/Shared/NumberSequenceUtils.lua"
            }
        },
        {
            "name": "stripe",
            "desc": "Generates a number sequence with stripes, which can be used in a variety of ways.",
            "params": [
                {
                    "name": "stripes",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "backgroundTransparency",
                    "desc": "[0, 1]",
                    "lua_type": "number"
                },
                {
                    "name": "stripeTransparency",
                    "desc": "[0, 1]",
                    "lua_type": "number"
                },
                {
                    "name": "percentStripeThickness",
                    "desc": "[0, 1]",
                    "lua_type": "number"
                },
                {
                    "name": "percentOffset",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "NumberSequence"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 137,
                "path": "src/numbersequenceutils/src/Shared/NumberSequenceUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "NumberSequenceUtils",
    "desc": "Utility functions involving NumberSequences on Roblox",
    "source": {
        "line": 5,
        "path": "src/numbersequenceutils/src/Shared/NumberSequenceUtils.lua"
    }
}