Editor Scripting API
    Preparing search index...

    Class Watcher

    Monitors a filesystem path for file changes such as additions, modifications, moves, and removals.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    isWatching onAdded onModified onMoved onRemoved path

    Methods

    create getTypeName isOfType isSame start stop

    Constructors

    Properties

    isWatching: boolean

    Indicates whether the watcher is currently active.

    onAdded: signal1<Path, void>

    Signal emitted when a file is added at the watched path.

    onModified: signal1<Path, void>

    Signal emitted when a file is modified at the watched path.

    onMoved: signal2<Path, Path, void>

    Signal emitted when a file is moved at the watched path.

    onRemoved: signal1<Path, void>

    Signal emitted when a file is removed from the watched path.

    path: Path

    The filesystem path being monitored by this watcher.

    Methods

    • Creates a new Watcher instance for the specified path.

      Parameters

      Returns Watcher

    • Returns true if the object is of the specified type.

      Parameters

      • type: string

      Returns boolean

    • Begins watching the configured path for filesystem events.

      Returns void

    • Stops watching the configured path for filesystem events.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods