Skip to main content

propertyUtil

A utility module for working with the Property class.

Functions​

increment​

</>
propertyUtil.increment(property: Property.Property<number>) → ()

Increments the given property's value by 1.

decrement​

</>
propertyUtil.decrement(property: Property.Property<number>) → ()

Decrements the given property's value by 1 though clamping the property's value such that it does not become less than 0.

Show raw api
{
    "functions": [
        {
            "name": "increment",
            "desc": " \nIncrements the given `property`'s value by 1.",
            "params": [
                {
                    "name": "property",
                    "desc": "",
                    "lua_type": "Property.Property<number>"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 27,
                "path": "src/propertyUtil/init.luau"
            }
        },
        {
            "name": "decrement",
            "desc": " \nDecrements the given `property`'s value by 1 though clamping the `property`'s value such\nthat it does not become less than `0`.",
            "params": [
                {
                    "name": "property",
                    "desc": "",
                    "lua_type": "Property.Property<number>"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 42,
                "path": "src/propertyUtil/init.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "propertyUtil",
    "desc": " \n\nA utility module for working with the [Property](https://babypatrick100.github.io/libraries/api/Property/) class.",
    "source": {
        "line": 6,
        "path": "src/propertyUtil/init.luau"
    }
}