Chroma Engine

  • Home
  • Articles
  • Api Documentation
Search Results for

    Show / Hide Table of Contents
    • Chroma
      • Audio
      • AudioSource
      • BoxCollider
      • Camera
      • CircleCollider
      • Color
      • Component
      • Coroutine
      • Coroutine.CoroutineFunction
      • Entity
      • ExecutionOrder
      • Input
      • Input.ConnectionState
      • Input.Gamepad
      • Input.GamepadAxis
      • Input.GamepadButton
      • Input.JoystickHatState
      • Input.Key
      • Input.Mouse
      • Log
      • Mathf
      • ParticleEmitter
      • RuntimeException
      • Scene
      • SpriteRenderer
      • StateMachine<T>
      • Time
      • Transform
      • Vector2
      • Vector3
      • Vector4

    Class Coroutine

    Coroutine based on the IEnumerator system.

    Inheritance
    System.Object
    Coroutine
    Namespace: Chroma
    Assembly: Chroma.Mono.dll
    Syntax
    public class Coroutine

    Properties

    Active

    Whether the coroutine is active.

    Declaration
    public bool Active { get; }
    Property Value
    Type Description
    System.Boolean

    Finished

    Whether the coroutine has completed. Independent of Active.

    Declaration
    public bool Finished { get; }
    Property Value
    Type Description
    System.Boolean

    Methods

    Pause()

    Pauses the coroutine.

    Declaration
    public void Pause()

    Restart()

    Restarts the coroutine.

    Declaration
    public void Restart()

    Resume()

    Resumes the coroutine.

    Declaration
    public void Resume()

    Set(Coroutine.CoroutineFunction)

    Sets the function which the coroutine executes.

    Declaration
    public void Set(Coroutine.CoroutineFunction function)
    Parameters
    Type Name Description
    Coroutine.CoroutineFunction function

    Function returning an IEnumerator, yield return represent time values in seconds.

    Start()

    Starts the coroutine.

    Declaration
    public void Start()

    Stop()

    Stops the coroutine.

    Declaration
    public void Stop()
    ☀
    ☾
    In This Article
    Back to top
    Generated by DocFX
    ☀
    ☾