Skip to main content

Conditions

Conditions can be used in systems or as Run Conditions.

Functions​

timePassed​

</>
Conditions.timePassed(
time: number--

Time in seconds

) → hasTimePassed() → boolean

A Throttle condition which checks whether the amount of time given has passed or not.

runOnce​

</>
Conditions.runOnce() → hasRanOnce() → boolean

Checks whether the condition has been called once before

onEvent​

</>
Conditions.onEvent(
instance: RBXScriptSignal | Instance | SignalLike<...any> | GenericTable | ((
Callback<U...>,
...any
) → ...any),
event: (RBXScriptSignal | string | (...any) → ())?
) → (
hasNewEvent() → boolean,
collectEvents() → () → (
number,
U...
),
getDisconnectFn() → () → ()
)

Checks for any new events and allows for the collection of those events.

Read OnEvent for more information.

isNot​

</>
Conditions.isNot(
condition: () → boolean,
...: any
) → inverseCondition() → boolean

Inverses a given condition.

Show raw api
{
    "functions": [
        {
            "name": "timePassed",
            "desc": "A Throttle condition which checks whether the amount of\ntime given has passed or not.\r",
            "params": [
                {
                    "name": "time",
                    "desc": "Time in seconds",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "hasTimePassed () -> boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 22,
                "path": "src/planck/src/conditions.luau"
            }
        },
        {
            "name": "runOnce",
            "desc": "Checks whether the condition has been called once before\r",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "hasRanOnce () -> boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 39,
                "path": "src/planck/src/conditions.luau"
            }
        },
        {
            "name": "onEvent",
            "desc": "Checks for any new events and allows for the collection of\nthose events.\\\n\\\nRead [OnEvent](../docs/design/conditions#on-event) for more information.\r",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "RBXScriptSignal | Instance | SignalLike<...any> | GenericTable | ((Callback<U...>,...any) -> ...any)"
                },
                {
                    "name": "event",
                    "desc": "",
                    "lua_type": "(RBXScriptSignal | string | (...any) -> ())?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "hasNewEvent () -> boolean"
                },
                {
                    "desc": "",
                    "lua_type": "collectEvents () -> () -> (number, U...)"
                },
                {
                    "desc": "",
                    "lua_type": "getDisconnectFn () -> () -> ()"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 107,
                "path": "src/planck/src/conditions.luau"
            }
        },
        {
            "name": "isNot",
            "desc": "Inverses a given condition.\r",
            "params": [
                {
                    "name": "condition",
                    "desc": "",
                    "lua_type": "() -> boolean"
                },
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "inverseCondition () -> boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 174,
                "path": "src/planck/src/conditions.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "Conditions",
    "desc": "Conditions can be used in systems or as Run Conditions.\r",
    "source": {
        "line": 15,
        "path": "src/planck/src/conditions.luau"
    }
}