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

An InSim library for NodeJS with TypeScript support

import { SendablePacket } from './base';
import { PacketType } from './enums';
import type { PacketDataWithRequiredReqI } from './types';
/**
 * BuTtoN - button header - followed by 0 to 240 characters
 *
 * You can make up to 240 buttons appear on the host or guests (ID = 0 to 239).
 * You should set the {@link InSimFlags.ISF_LOCAL} flag (in {@link IS_ISI}) if
 * your program is not a host control system, to make sure your buttons do not
 * conflict with any buttons sent by the host.
 *
 * LFS can display normal buttons in these four screens:
 * - main entry screen
 * - race setup screen
 * - in game
 * - SHIFT+U mode
 *
 * The recommended area for most buttons is defined by:
 * - {@link IS_X_MIN}
 * - {@link IS_X_MAX}
 * - {@link IS_Y_MIN}
 * - {@link IS_Y_MAX}
 *
 * If you draw buttons in this area, the area will be kept clear to avoid
 * overlapping LFS buttons with your InSim program's buttons. Buttons outside
 * that area will not have a space kept clear. You can also make buttons visible
 * in all screens by setting the {@link Inst} property to {@link INST_ALWAYS_ON}.
 */
export declare class IS_BTN extends SendablePacket {
    static readonly INST_ALWAYS_ON = 128;
    static readonly IS_X_MIN = 0;
    static readonly IS_X_MAX = 110;
    static readonly IS_Y_MIN = 30;
    static readonly IS_Y_MAX = 170;
    static readonly MAX_CLICK_ID = 239;
    private static readonly FIXED_DATA_SIZE;
    /** 12 + text size (a multiple of 4) */
    Size: number;
    readonly Type = PacketType.ISP_BTN;
    /** Non-zero (returned in {@link IS_BTC} and {@link IS_BTT} packets) */
    ReqI: number;
    /** Connection to display the button (0 = local / 255 = all) */
    UCID: number;
    /**
     * Button ID (0 to 239)
     *
     * This value is returned in {@link IS_BTC} and {@link IS_BTT} packets.
     *
     * Host buttons and local buttons are stored separately, so there is no
     * chance of a conflict between a host control system and a local system
     * (although the buttons could overlap on screen).
     *
     * Programmers of local InSim programs may wish to consider using a
     * configurable button range and possibly screen position, in case their
     * users will use more than one local InSim program at once.
     */
    ClickID: number;
    /**
     * Mainly used internally by InSim but also provides some extra user flags
     *
     * NOTE: You should not use {@link INST_ALWAYS_ON} for most buttons.
     * This is a special flag for buttons that really must be on in all screens
     * (including the garage and options screens). You will probably need to
     * confine these buttons to the top or bottom edge of the screen, to avoid
     * overwriting LFS buttons. Most buttons should be defined without this flag,
     * and positioned in the recommended area so LFS can keep a space clear in
     * the main screens.
     */
    Inst: number;
    /** Button style flags */
    BStyle: ButtonStyle | ButtonTextColour;
    /**
     * If set, the user can click this button to type in text.
     *
     * Lowest 7 bits are the maximum number of characters to type in (0 to 95)
     * The highest bit (128) can be set to initialise dialog with the button's text
     *
     * On clicking the button, a text entry dialog will be opened, allowing the
     * specified number of characters to be typed in. The caption on the text
     * entry dialog is optionally customisable using {@link Text} in the
     * {@link IS_BTN} packet. If the first character of IS_BTN's {@link Text}
     * field is zero, LFS will read the caption up to the second zero.
     * The visible button text then follows that second zero.
     *
     * Text: 65-66-67-0 would display button text "ABC" and no caption
     *
     * Text: 0-65-66-67-0-68-69-70-71-0-0-0 would display button text "DEFG" and caption "ABC"
     */
    TypeIn: number;
    /** Left offset (0 to 200) */
    L: number;
    /** Top offset (0 to 200) */
    T: number;
    /** Width (0 to 200) */
    W: number;
    /** Height (0 to 200) */
    H: number;
    /** 0 to 240 characters of text */
    Text: string;
    constructor(data?: IS_BTN_Data);
    pack(): Uint8Array<ArrayBuffer>;
}
export declare enum ButtonStyle {
    /** Click this button to send {@link IS_BTC} */
    ISB_CLICK = 8,
    /** Light button */
    ISB_LIGHT = 16,
    /** Dark button */
    ISB_DARK = 32,
    /** Align text to left */
    ISB_LEFT = 64,
    /** Align text to right */
    ISB_RIGHT = 128
}
export declare enum ButtonTextColour {
    /** Not user editable */
    LIGHT_GREY = 0,
    /** Default: yellow */
    TITLE_COLOUR = 1,
    /** Default: black */
    UNSELECTED_TEXT = 2,
    /** Default: white */
    SELECTED_TEXT = 3,
    /** Default: green */
    OK = 4,
    /** Default: red */
    CANCEL = 5,
    /** Default: pale blue */
    TEXT_STRING = 6,
    /** Default: grey */
    UNAVAILABLE = 7
}
export type IS_BTN_Data = PacketDataWithRequiredReqI<IS_BTN>;
export declare enum TypeIn {
    /** Initialise dialog with the button's text */
    INIT_VALUE_BUTTON_TEXT = 128
}