Skip to main content

FlipManager

This item only works when running on the client. Client

Manager module responsible for handling corner flips.

Functions​

TryFlip​

</>
FlipManager:TryFlip() → ()

Performs a corner flip on any flip parts the player is touching. Parts can be marked as flip parts by:

  • Adding a Tag or Instance inside the part called CanFlip
  • Adding a callback on the part with FlipManager:BindToFlip()

If the flip part has a TeleToObject ObjectValue present and set, the player will teleport to that object rather than to the other end of the flip part.

If the flip part has a FlipSound Sound present, that sound will be played instead of the default sound.

BindToFlip​

</>
FlipManager:BindToFlip(
part: BasePart,
callback: (rootPart: BasePart) → ()
) → ()

Binds the callback function to the part, executing the callback when the player performs a corner flip on it.

** Please add this to your Scope! **

Show raw api
{
    "functions": [
        {
            "name": "TryFlip",
            "desc": "Performs a corner flip on any flip parts the player is touching.\nParts can be marked as flip parts by:\n* Adding a Tag or `Instance` inside the part called `CanFlip`\n* Adding a callback on the part with `FlipManager:BindToFlip()`\n\nIf the flip part has a `TeleToObject` `ObjectValue` present and set, the player\nwill teleport to that object rather than to the other end of the flip part.\n\nIf the flip part has a `FlipSound` `Sound` present, that sound will be played\ninstead of the default sound.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 79,
                "path": "mirror/Kit.Managers.FlipManager.luau"
            }
        },
        {
            "name": "BindToFlip",
            "desc": "Binds the `callback` function to the `part`, executing the callback when\nthe player performs a corner flip on it.\n\n** Please add this to your Scope! **",
            "params": [
                {
                    "name": "part",
                    "desc": "",
                    "lua_type": "BasePart"
                },
                {
                    "name": "callback",
                    "desc": "",
                    "lua_type": "(rootPart: BasePart) -> ()"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 156,
                "path": "mirror/Kit.Managers.FlipManager.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "FlipManager",
    "desc": "Manager module responsible for handling corner flips.",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 12,
        "path": "mirror/Kit.Managers.FlipManager.luau"
    }
}