PowerHorse Engine
    Preparing search index...

    For controlling a thread outside of it's "scope".

    Use the custom typeIs function from mekstuff-rbxts/core to check if object is a threader. You should not use this as a stand alone library, You should install mekstuff-rbxts/core to access threader.

    Index

    Constructors

    Properties

    Methods

    Constructors

    • Parameters

      • initiator: (t: threader) => void

        The function the will be running on the threader

      • Optionalactive: boolean = false

        The active state of the threader. while active is set to true, the coroutine will begin executing, setting to false will end the coroutine.

      • OptionalnoAutoClose: boolean

      Returns threader

    Properties

    active: boolean = false

    The active state of the threader. while active is set to true, the coroutine will begin executing, setting to false will end the coroutine.

    Methods

    • Closes the threader, setting active after closing will have no effect.

      Threaders are automatically closed after executing, use tryClose for attempting to close without any errors.

      Returns void

    • Returns true if the threader is closed, false if not.

      Returns boolean

    • Closes the treader if it is not already closed, returns true if closed, false otherwise.

      Returns boolean