node-insim/dist/types/packets/IS_TTC.d.ts

An InSim library for NodeJS with TypeScript support

import { SendablePacket } from './base';
import { PacketType } from './enums';
import type { PacketDataWithRequiredReqI } from './types';
/**
 * General purpose 8 byte packet (Target To Connection)
 *
 * To request an {@link IS_AXM} for a connection's layout editor selection send this
 * {@link IS_TTC}:
 *
 * - ReqI: non-zero         (returned in the reply)
 * - SubT: {@link TTC_SEL}  (request an {@link IS_AXM} for the current selection)
 * - UCID: connection       (0 = local / non-zero = guest)
 */
export declare class IS_TTC extends SendablePacket {
    readonly Size = 8;
    readonly Type = PacketType.ISP_TTC;
    /** 0 unless it is an info request or a reply to an info request */
    ReqI: number;
    /** Subtype */
    SubT: TargetToConnectionType;
    /** Connection's unique id (0 = local) */
    UCID: number;
    /** May be used in various ways depending on SubT */
    B1: number;
    /** May be used in various ways depending on SubT */
    B2: number;
    /** May be used in various ways depending on SubT */
    B3: number;
    constructor(data?: IS_TTC_Data);
}
export type IS_TTC_Data = PacketDataWithRequiredReqI<IS_TTC>;
export declare enum TargetToConnectionType {
    /** Not used */
    TTC_NONE = 0,
    /** Info request: send {@link IS_AXM} for a layout editor selection */
    TTC_SEL = 1,
    /** Info request: send {@link IS_AXM} every time the selection changes */
    TTC_SEL_START = 2,
    /** Instruction: switch off {@link IS_AXM} requested by {@link TTC_SEL_START} */
    TTC_SEL_STOP = 3
}