Skip to main content

IdleServiceClient

This item only works when running on the client. Client

Helps track whether or not a player is idle and if so, then can show UI or other cute things.

Functions​

Init​

</>
IdleServiceClient:Init(serviceBag: ServiceBag) → ()

Initializes the idle service on the client. Should be done via ServiceBag.

Start​

</>
IdleServiceClient:Start() → ()

Starts idle service on the client. Should be done via ServiceBag.

ObserveHumanoidMoveFromCurrentPosition​

</>
IdleServiceClient:ObserveHumanoidMoveFromCurrentPosition(minimumTimeVisible: number) → Observable

Observes a humanoid moving from the current position after a set amount of time. Can be used to close a UI when the humanoid wanders too far.

IsHumanoidIdle​

</>
IdleServiceClient:IsHumanoidIdle() → boolean

Returns whether the humanoid is idle.

IsMoving​

</>
IdleServiceClient:IsMoving() → boolean

Returns whether the humanoid is idle.

ObserveHumanoidIdle​

</>
IdleServiceClient:ObserveHumanoidIdle() → Observable<boolean>

observes if the humanoid is idle.

DoShowIdleUI​

</>
IdleServiceClient:DoShowIdleUI() → boolean

Returns whether UI should be shown (if the humanoid is idle)

ObserveShowIdleUI​

</>
IdleServiceClient:ObserveShowIdleUI() → Observable<boolean>

Observes whether to show the the idle UI

GetShowIdleUIBoolValue​

</>
IdleServiceClient:GetShowIdleUIBoolValue() → BoolValue

Returns a show idle bool value.

PushDisable​

</>
IdleServiceClient:PushDisable() → boolean

Pushes a disabling function that disables idle UI

Show raw api
{
    "functions": [
        {
            "name": "Init",
            "desc": "Initializes the idle service on the client. Should be done via [ServiceBag].",
            "params": [
                {
                    "name": "serviceBag",
                    "desc": "",
                    "lua_type": "ServiceBag"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 29,
                "path": "src/idleservice/src/Client/IdleServiceClient.lua"
            }
        },
        {
            "name": "Start",
            "desc": "Starts idle service on the client. Should be done via [ServiceBag].",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 52,
                "path": "src/idleservice/src/Client/IdleServiceClient.lua"
            }
        },
        {
            "name": "ObserveHumanoidMoveFromCurrentPosition",
            "desc": "Observes a humanoid moving from the current position after a set amount of time. Can be used\nto close a UI when the humanoid wanders too far.",
            "params": [
                {
                    "name": "minimumTimeVisible",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 83,
                "path": "src/idleservice/src/Client/IdleServiceClient.lua"
            }
        },
        {
            "name": "IsHumanoidIdle",
            "desc": "Returns whether the humanoid is idle.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 110,
                "path": "src/idleservice/src/Client/IdleServiceClient.lua"
            }
        },
        {
            "name": "IsMoving",
            "desc": "Returns whether the humanoid is idle.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 118,
                "path": "src/idleservice/src/Client/IdleServiceClient.lua"
            }
        },
        {
            "name": "ObserveHumanoidIdle",
            "desc": "observes if the humanoid is idle.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<boolean>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 126,
                "path": "src/idleservice/src/Client/IdleServiceClient.lua"
            }
        },
        {
            "name": "DoShowIdleUI",
            "desc": "Returns whether UI should be shown (if the humanoid is idle)",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 134,
                "path": "src/idleservice/src/Client/IdleServiceClient.lua"
            }
        },
        {
            "name": "ObserveShowIdleUI",
            "desc": "Observes whether to show the the idle UI",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<boolean>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 142,
                "path": "src/idleservice/src/Client/IdleServiceClient.lua"
            }
        },
        {
            "name": "GetShowIdleUIBoolValue",
            "desc": "Returns a show idle bool value.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BoolValue"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 150,
                "path": "src/idleservice/src/Client/IdleServiceClient.lua"
            }
        },
        {
            "name": "PushDisable",
            "desc": "Pushes a disabling function that disables idle UI",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 160,
                "path": "src/idleservice/src/Client/IdleServiceClient.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "IdleServiceClient",
    "desc": "Helps track whether or not a player is idle and if so, then can show UI or other cute things.",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 7,
        "path": "src/idleservice/src/Client/IdleServiceClient.lua"
    }
}