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

An InSim library for NodeJS with TypeScript support

import { Packet } from './base';
import type { ObjectIndex } from './enums';
import { PacketType } from './enums';
/**
 * Conn Interface Mode
 */
export declare class IS_CIM extends Packet {
    readonly Size = 8;
    readonly Type = PacketType.ISP_CIM;
    readonly ReqI = 0;
    /** Connection's unique id (0 = local) */
    UCID: number;
    /** Mode identifier */
    Mode: InterfaceMode;
    /** Submode identifier */
    SubMode: NormalInterfaceSubmode | GarageInterfaceSubmode | ShiftUInterfaceSubmode;
    /** Selected object type */
    SelType: ObjectIndex;
    private readonly Sp3;
}
export declare enum InterfaceMode {
    /** Not in a special mode */
    CIM_NORMAL = 0,
    /** In the options menu */
    CIM_OPTIONS = 1,
    /** In the host's options menu */
    CIM_HOST_OPTIONS = 2,
    /** In the garage */
    CIM_GARAGE = 3,
    /** In the car selection menu */
    CIM_CAR_SELECT = 4,
    /** In the track selection menu */
    CIM_TRACK_SELECT = 5,
    /** In the free view mode (SHIT + U) */
    CIM_SHIFTU = 6
}
export declare enum GarageInterfaceSubmode {
    /** Info tab */
    GRG_INFO = 0,
    /** Colours tab */
    GRG_COLOURS = 1,
    /** Brakes / TC tab */
    GRG_BRAKE_TC = 2,
    /** Suspension tab */
    GRG_SUSP = 3,
    /** Steering tab */
    GRG_STEER = 4,
    /** Final Drive tab */
    GRG_DRIVE = 5,
    /** Tyres tab */
    GRG_TYRES = 6,
    /** Downforce tab */
    GRG_AERO = 7,
    /** Undocumented */
    GRG_PASS = 8
}
export declare enum NormalInterfaceSubmode {
    /** Not in a specific view */
    NRM_NORMAL = 0,
    /** User is viewing the car's wheel temperature (F9) */
    NRM_WHEEL_TEMPS = 1,
    /** User is viewing the car's wheel damage (F10) */
    NRM_WHEEL_DAMAGE = 2,
    /** User is viewing the setting pane for the car (F11) */
    NRM_LIVE_SETTINGS = 3,
    /** User is viewing the pit instructions pane (F12) */
    NRM_PIT_INSTRUCTIONS = 4
}
export declare enum ShiftUInterfaceSubmode {
    /** No buttons displayed */
    FVM_PLAIN = 0,
    /** Buttons displayed (not editing) */
    FVM_BUTTONS = 1,
    /** Edit mode */
    FVM_EDIT = 2
}