node-insim
    Preparing search index...

    Class InSim

    Hierarchy

    Index

    Constructors

    constructor

    Properties

    id defaultMaxListeners INSIM_VERSION

    Accessors

    options

    Methods

    addListener connect disconnect emit eventNames getMaxListeners listenerCount listeners off on once prependListener prependOnceListener rawListeners removeAllListeners removeListener send sendAwait sendLocalMessage sendMessage sendMessageToConnection sendMessageToPlayer setMaxListeners

    Constructors

    • Parameters

      • Optionalid: string

      Returns InSim

    Properties

    id: string

    A unique identifier of the InSim connection to a specific host

    defaultMaxListeners: number
    INSIM_VERSION: number = 9

    Currently supported InSim version

    Accessors

    Methods

    • Connect to a server via InSim.

      Parameters

      • options: Omit<Partial<Partial<PacketDataWithReqI<IS_ISI>>>, "InSimVer"> & InSimConnectionOptions

      Returns void

    • Returns number

    • Send a message which will appear on the local computer only.

      The maximum length of the message is MSL_MSG_MAX_LENGTH characters.

      Parameters

      • message: string
      • sound: MessageSound = MessageSound.SND_SILENT

      Returns void

    • Send a message or command to LFS

      If the message starts with a slash (/), it will be treated as a command. Otherwise, it will be treated as a message.

      The maximum length of the message is MSX_MSG_MAX_LENGTH characters.

      Parameters

      • message: string

      Returns void

    • Send a message to a specific connection

      Parameters

      • ucid: number
      • message: string
      • sound: MessageSound = MessageSound.SND_SILENT

      Returns void

    • Send a message to a specific player

      Parameters

      • plid: number
      • message: string
      • sound: MessageSound = MessageSound.SND_SILENT

      Returns void

    • Parameters

      • n: number

      Returns this

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods