Editor Scripting API

    Class Subprocess

    Class which allows you to trigger a subproccess outside of Lens Studio (e.g. a command line command).

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    constructor

    Properties

    command onError onExit onStart onStateChange stderr stdin stdout

    Methods

    create getTypeName isOfType isSame kill start

    Constructors

    Properties

    command: string

    The command for the subprocess.

    onError: signal1<number, void>

    A handle for getting callback when a subprocess' state has errored.

    onExit: signal2<number, number, void>

    A handle for getting callback when a subprocess' state has exited.

    Callback will receive two arguments in order: Exit code (usually 0 means success) Exit status (0 on normal exit, 1 on crash)

    onStart: signal0<void>

    A handle for getting callback when a subprocess is started

    onStateChange: signal1<number, void>

    A handle for getting callback when a subprocess' state has changed.

    Callback will receive a number describing a state.

    Possible states: Not running 0 Starting 1 Running 2

    stderr: signal1<Buffer, void>

    A handle for getting callback when a subprocess' state has received stderr.

    stdin: Writable

    A handle for getting callback when a subprocess' state has received stdin.

    stdout: signal1<Buffer, void>

    A handle for getting callback when a subprocess' state has received stdout.

    Methods

    • Parameters

      • type: string

      Returns boolean

    • Kills a subprocess.

      Returns void

    • Starts a subprocess.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    MMNEPVFCICPMFPCPTTAAATR