Type Alias ModalFunctions

type ModalFunctions = {
    abortModalSelection(accept: boolean): Promise<void>;
    abortModalSelection(accept: boolean): Promise<void>;
    isInModalSelection(): Promise<boolean>;
    isInModalSelection(): Promise<boolean>;
    setModalSelection(obj: RpcObject): Promise<void>;
    setModalSelection(obj: RpcObject): Promise<void>;
    switchModalSelection(
        object?: null | RpcObject,
        path?: string | string[],
        accept: boolean,
    ): Promise<void>;
    switchModalSelection(
        object?: null | RpcObject,
        path?: string | string[],
        accept: boolean,
    ): Promise<void>;
}
Index

Methods

  • Aborts the modal selection state in Engine.

    Parameters

    • accept: boolean

      Whether to apply the selections made while in modal state

    Returns Promise<void>

    A promise of a result

  • Aborts the modal selection state in Engine.

    Parameters

    • accept: boolean

      Whether to apply the selections made while in modal state

    Returns Promise<void>

    A promise of a result

  • Returns Promise<boolean>

    whether the app is in selection modal state

  • Returns Promise<boolean>

    whether the app is in selection modal state

  • Sets an object as selection modal target.

    Parameters

    Returns Promise<void>

  • Sets an object as selection modal target.

    Parameters

    Returns Promise<void>

  • Switches the modal selection state in Engine.

    Parameters

    • Optionalobject: null | RpcObject

      If defined, will switch modal state to that model, if null, will end selection modal state

    • Optionalpath: string | string[]

      If defined, will use the given path(s) for which hypercube(s) to apply the modal state on

    • accept: boolean

      Whether to apply the selections made while in modal state

    Returns Promise<void>

    A promise of a result

  • Switches the modal selection state in Engine.

    Parameters

    • Optionalobject: null | RpcObject

      If defined, will switch modal state to that model, if null, will end selection modal state

    • Optionalpath: string | string[]

      If defined, will use the given path(s) for which hypercube(s) to apply the modal state on

    • accept: boolean

      Whether to apply the selections made while in modal state

    Returns Promise<void>

    A promise of a result