Movatterモバイル変換


[0]ホーム

URL:


  • Preparing search index...
  • The search index is not available
node-simconnect

Class SimConnectConnection

Hierarchy

  • EventEmitter
    • SimConnectConnection

Constructors

Properties

Methods

_beginPacket_buildAndSend_handleMessage_openaICreateEnrouteATCAircraftaICreateNonATCAircraftaICreateParkedATCAircraftaICreateSimulatedObjectaIReleaseControlaIRemoveObjectaISetAircraftFlightPlanaddClientEventToNotificationGroupaddFacilityDataDefinitionFilteraddToClientDataDefinitionaddToDataDefinitionaddToFacilityDefinitioncameraSetRelative6DOFclearAllFacilityDataDefinitionFiltersclearClientDataDefinitionclearDataDefinitionclearInputGroupclearNotificationGroupclosecompleteCustomMissionActionconnectcreateClientDataemitenumerateControllersenumerateInputEventParamsenumerateInputEventseventNamesexecuteActionexecuteMissionActionflightLoadflightPlanLoadflightSavegetInputEventgetLastSentPacketIDgetMaxListenerslistenerCountlistenersmapClientDataNameToIDmapClientEventToSimEventmapInputEventToClientEventmapInputEventToClientEventEx1menumenuAddItemmenuAddSubItemmenuDeleteItemmenuDeleteSubItemononceprependListenerprependOnceListenerrawListenersremoveAllListenersremoveClientEventremoveInputEventremoveListenerrequestClientDatarequestDataOnSimObjectrequestDataOnSimObjectTyperequestFacilitiesListrequestFacilitiesListEx1requestFacilityDatarequestJetwayDatarequestNotificationGrouprequestReservedKeyrequestResponseTimesrequestSystemStatesetClientDatasetDataOnSimObjectsetInputEventsetInputGroupPrioritysetInputGroupStatesetMaxListenerssetNotificationGroupPrioritysetSystemEventStatesetSystemStatesubscribeInputEventsubscribeToFacilitiessubscribeToFacilitiesEx1subscribeToSystemEventtexttransmitClientEventtransmitClientEventExunSubscribeToFacilitiesunSubscribeToFacilitiesEx1unsubscribeFromSystemEventunsubscribeInputEventweatherCreateStationweatherCreateThermalweatherRemoveStationweatherRemoveThermalweatherRequestCloudStateweatherRequestInterpolatedObservationweatherRequestObservationAtNearestStationweatherRequestObservationAtStationweatherSetDynamicUpdateRateweatherSetModeCustomweatherSetModeGlobalweatherSetModeServerweatherSetModeThemeweatherSetObservationgetEventListenerslistenerCountononcesetMaxListeners

Constructors

constructor

Properties

PrivateReadonly_appName

_appName:string

_clientSocket

_clientSocket:SimConnectSocket

Private_openTimeout

_openTimeout:null |Timeout

PrivateReadonly_ourProtocol

_ourProtocol:Protocol

PrivateReadonly_packetDataBuffer

_packetDataBuffer:RawBuffer = ...

Private_packetsSent

_packetsSent:number

addListener

addListener:(<U>(event,listener) =>SimConnectConnection) = ...

Type declaration

Overrides EventEmitter.addListener

off

off:(<U>(event,listener) =>SimConnectConnection) = ...

Type declaration

Overrides EventEmitter.off

StaticReadonlycaptureRejectionSymbol

captureRejectionSymbol:typeofcaptureRejectionSymbol

Inherited from EventEmitter.captureRejectionSymbol

  • Defined in node_modules/@types/node/events.d.ts:291

StaticcaptureRejections

captureRejections:boolean

Sets or gets the default captureRejection value for all emitters.

Inherited from EventEmitter.captureRejections

  • Defined in node_modules/@types/node/events.d.ts:296

StaticdefaultMaxListeners

defaultMaxListeners:number

Inherited from EventEmitter.defaultMaxListeners

  • Defined in node_modules/@types/node/events.d.ts:297

StaticReadonlyerrorMonitor

errorMonitor:typeoferrorMonitor

This symbol shall be used to install a listener for only monitoring'error'events. Listeners installed using this symbol are called before the regular'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an'error' event is emitted, therefore the process will still crash if noregular'error' listener is installed.

Inherited from EventEmitter.errorMonitor

  • Defined in node_modules/@types/node/events.d.ts:290

Methods

Private_beginPacket

Private_buildAndSend

Private_handleMessage

Private_open

aICreateEnrouteATCAircraft

  • aICreateEnrouteATCAircraft(containerTitle,tailNumber,flightNumber,flightPlanPath,flightPlanPosition,touchAndGo,dataRequestId):number
  • Parameters

    • containerTitle:string
    • tailNumber:string
    • flightNumber:number
    • flightPlanPath:string
    • flightPlanPosition:number
    • touchAndGo:boolean
    • dataRequestId:number

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

aICreateNonATCAircraft

  • aICreateNonATCAircraft(containerTitle,tailNumber,initPos,dataRequestId):number
  • Parameters

    • containerTitle:string
    • tailNumber:string
    • initPos:InitPosition
    • dataRequestId:number

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

aICreateParkedATCAircraft

  • aICreateParkedATCAircraft(containerTitle,tailNumber,airportID,dataRequestId):number
  • Parameters

    • containerTitle:string
    • tailNumber:string
    • airportID:string
    • dataRequestId:number

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

aICreateSimulatedObject

  • aICreateSimulatedObject(containerTitle,initPos,dataRequestId):number
  • Parameters

    • containerTitle:string
    • initPos:InitPosition
    • dataRequestId:number

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

aIReleaseControl

  • aIReleaseControl(objectId,dataRequestId):number
  • Parameters

    • objectId:number
    • dataRequestId:number

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

aIRemoveObject

  • aIRemoveObject(objectId,dataRequestId):number
  • Parameters

    • objectId:number
    • dataRequestId:number

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

aISetAircraftFlightPlan

  • aISetAircraftFlightPlan(objectId,flightPlanPath,dataRequestId):number
  • Parameters

    • objectId:number
    • flightPlanPath:string
    • dataRequestId:number

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

addClientEventToNotificationGroup

  • addClientEventToNotificationGroup(notificationGroupId,clientEventId,maskable):number
  • Parameters

    • notificationGroupId:number
    • clientEventId:number
    • maskable:boolean

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

addFacilityDataDefinitionFilter

  • addFacilityDataDefinitionFilter(dataDefinitionId,filterPath,filterData):number
  • Parameters

    • dataDefinitionId:number
    • filterPath:string
    • filterData:null |RawBuffer

      use null to remove a previously applied filter

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

addToClientDataDefinition

  • addToClientDataDefinition(dataDefinitionId,offset,sizeOrType,epsilon?,datumId?):number
  • Parameters

    • dataDefinitionId:number
    • offset:number
    • sizeOrType:number
    • Optionalepsilon:number
    • OptionaldatumId:number

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

addToDataDefinition

  • addToDataDefinition(dataDefinitionId,datumName,unitsName,dataType?,epsilon?,datumId?):number
  • Parameters

    • dataDefinitionId:number
    • datumName:string
    • unitsName:null |string
    • OptionaldataType:SimConnectDataType
    • Optionalepsilon:number
    • OptionaldatumId:number

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

addToFacilityDefinition

  • addToFacilityDefinition(dataDefinitionId,fieldName):number
  • Parameters

    • dataDefinitionId:number
    • fieldName:string

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

cameraSetRelative6DOF

  • cameraSetRelative6DOF(deltaX,deltaY,deltaZ,pitchDeg,bankDeg,headingDeg):number
  • Parameters

    • deltaX:number
    • deltaY:number
    • deltaZ:number
    • pitchDeg:number
    • bankDeg:number
    • headingDeg:number

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

clearAllFacilityDataDefinitionFilters

  • clearAllFacilityDataDefinitionFilters(dataDefinitionId):number
  • Parameters

    • dataDefinitionId:number

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

clearClientDataDefinition

  • clearClientDataDefinition(dataDefinitionId):number
  • Parameters

    • dataDefinitionId:number

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

clearDataDefinition

  • clearDataDefinition(dataDefinitionId):number
  • Parameters

    • dataDefinitionId:number

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

clearInputGroup

clearNotificationGroup

  • clearNotificationGroup(notificationGroupId):number
  • Parameters

    • notificationGroupId:number

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

close

completeCustomMissionAction

  • completeCustomMissionAction(guidInstanceId):number
  • Parameters

    • guidInstanceId:Buffer

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

connect

createClientData

  • createClientData(clientDataId,size,readOnly):number
  • Parameters

    • clientDataId:number
    • size:number
    • readOnly:boolean

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

emit

enumerateControllers

enumerateInputEventParams

  • enumerateInputEventParams(inputEventHashID):number
  • Parameters

    • inputEventHashID:bigint

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

enumerateInputEvents

eventNames

  • eventNames():(string |symbol)[]
  • Returns an array listing the events for which the emitter has registeredlisteners. The values in the array are strings orSymbols.

    constEventEmitter =require('events');
    constmyEE =newEventEmitter();
    myEE.on('foo', ()=> {});
    myEE.on('bar', ()=> {});

    constsym =Symbol('symbol');
    myEE.on(sym, ()=> {});

    console.log(myEE.eventNames());
    // Prints: [ 'foo', 'bar', Symbol(symbol) ]

    Returns(string |symbol)[]

    Since

    v6.0.0

    Inherited from EventEmitter.eventNames

    • Defined in node_modules/@types/node/events.d.ts:632

executeAction

executeMissionAction

  • executeMissionAction(guidInstanceId):number
  • Parameters

    • guidInstanceId:Buffer

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

flightLoad

flightPlanLoad

flightSave

  • flightSave(fileName,title,description,flags?):number
  • Parameters

    • fileName:string
    • title:null |string
    • description:string
    • Optionalflags:number

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

getInputEvent

  • getInputEvent(dataRequestID,inputEventHashID):number
  • Parameters

    • dataRequestID:number
    • inputEventHashID:bigint

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

getLastSentPacketID

getMaxListeners

listenerCount

listeners

mapClientDataNameToID

  • mapClientDataNameToID(clientDataName,clientDataId):number
  • Parameters

    • clientDataName:string
    • clientDataId:number

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

mapClientEventToSimEvent

  • mapClientEventToSimEvent(clientEventId,eventName?):number
  • Parameters

    • clientEventId:number
    • OptionaleventName:string

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

mapInputEventToClientEvent

  • mapInputEventToClientEvent(inputGroupId,inputDefinition,clientEventDownID,downValue?,clientEventUpID?,upValue?,maskable?):number
  • Parameters

    • inputGroupId:number
    • inputDefinition:string
    • clientEventDownID:number
    • OptionaldownValue:number
    • OptionalclientEventUpID:number
    • OptionalupValue:number
    • Optionalmaskable:boolean

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

    Deprecated

    use mapInputEventToClientEventEx1 instead

mapInputEventToClientEventEx1

  • mapInputEventToClientEventEx1(inputGroupId,inputDefinition,clientEventDownID,downValue?,clientEventUpID?,upValue?,maskable?):number
  • Parameters

    • inputGroupId:number
    • inputDefinition:string
    • clientEventDownID:number
    • OptionaldownValue:number
    • OptionalclientEventUpID:number
    • OptionalupValue:number
    • Optionalmaskable:boolean

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

menu

  • menu(timeSeconds,clientEventId,title?,prompt?,...items):number
  • Parameters

    • timeSeconds:number
    • clientEventId:number
    • Optionaltitle:string
    • Optionalprompt:string
    • Rest...items:string[]

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

    Deprecated

    since MSFS (KittyHawk)

menuAddItem

  • menuAddItem(menuItem,menuEventId,data):number
  • Parameters

    • menuItem:string
    • menuEventId:number
    • data:number

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

    Deprecated

    since MSFS (KittyHawk)

menuAddSubItem

  • menuAddSubItem(menuEventId,menuItem,subMenuEventId,data):number
  • Parameters

    • menuEventId:number
    • menuItem:string
    • subMenuEventId:number
    • data:number

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

    Deprecated

    since MSFS (KittyHawk)

menuDeleteItem

  • menuDeleteItem(menuEventId):number
  • Parameters

    • menuEventId:number

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

    Deprecated

    since MSFS (KittyHawk)

menuDeleteSubItem

  • menuDeleteSubItem(menuEventId,subMenuEventId):number
  • Parameters

    • menuEventId:number
    • subMenuEventId:number

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

    Deprecated

    since MSFS (KittyHawk)

on

once

prependListener

  • prependListener(eventName,listener):SimConnectConnection
  • Adds thelistener function to thebeginning of the listeners array for theevent namedeventName. No checks are made to see if thelistener hasalready been added. Multiple calls passing the same combination ofeventNameandlistener will result in thelistener being added, and called, multipletimes.

    server.prependListener('connection', (stream)=> {
    console.log('someone connected!');
    });

    Returns a reference to theEventEmitter, so that calls can be chained.

    Parameters

    • eventName:string |symbol

      The name of the event.

    • listener:((...args) =>void)

      The callback function

        • (...args):void
        • Parameters

          • Rest...args:any[]

          Returnsvoid

    ReturnsSimConnectConnection

    Since

    v6.0.0

    Inherited from EventEmitter.prependListener

    • Defined in node_modules/@types/node/events.d.ts:597

prependOnceListener

  • prependOnceListener(eventName,listener):SimConnectConnection
  • Adds aone-timelistener function for the event namedeventName to the_beginning_ of the listeners array. The next timeeventName is triggered, thislistener is removed, and then invoked.

    server.prependOnceListener('connection', (stream)=> {
    console.log('Ah, we have our first user!');
    });

    Returns a reference to theEventEmitter, so that calls can be chained.

    Parameters

    • eventName:string |symbol

      The name of the event.

    • listener:((...args) =>void)

      The callback function

        • (...args):void
        • Parameters

          • Rest...args:any[]

          Returnsvoid

    ReturnsSimConnectConnection

    Since

    v6.0.0

    Inherited from EventEmitter.prependOnceListener

    • Defined in node_modules/@types/node/events.d.ts:613

rawListeners

  • rawListeners(eventName):Function[]
  • Returns a copy of the array of listeners for the event namedeventName,including any wrappers (such as those created by.once()).

    constemitter =newEventEmitter();
    emitter.once('log', ()=>console.log('log once'));

    // Returns a new Array with a function `onceWrapper` which has a property
    // `listener` which contains the original listener bound above
    constlisteners =emitter.rawListeners('log');
    constlogFnWrapper =listeners[0];

    // Logs "log once" to the console and does not unbind the `once` event
    logFnWrapper.listener();

    // Logs "log once" to the console and removes the listener
    logFnWrapper();

    emitter.on('log', ()=>console.log('log persistently'));
    // Will return a new Array with a single function bound by `.on()` above
    constnewListeners =emitter.rawListeners('log');

    // Logs "log persistently" twice
    newListeners[0]();
    emitter.emit('log');

    Parameters

    • eventName:string |symbol

    ReturnsFunction[]

    Since

    v9.4.0

    Inherited from EventEmitter.rawListeners

    • Defined in node_modules/@types/node/events.d.ts:532

removeAllListeners

removeClientEvent

  • removeClientEvent(notificationGroupId,clientEventId):number
  • Parameters

    • notificationGroupId:number
    • clientEventId:number

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

removeInputEvent

  • removeInputEvent(inputGroupId,inputDefinition):number
  • Parameters

    • inputGroupId:number
    • inputDefinition:string

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

removeListener

requestClientData

  • requestClientData<O,I,L>(clientDataId,dataRequestId,clientDataDefineID,period,flags,origin?,interval?,limit?):number
  • Type Parameters

    • O extendsnumber

    • I extendsnumber

    • L extendsnumber

    Parameters

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

requestDataOnSimObject

  • requestDataOnSimObject(dataRequestId,dataDefinitionId,objectId,period,flags?,origin?,interval?,limit?):number
  • Parameters

    • dataRequestId:number
    • dataDefinitionId:number
    • objectId:number
    • period:SimConnectPeriod
    • Optionalflags:DataRequestFlag
    • Optionalorigin:number
    • Optionalinterval:number
    • Optionallimit:number

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

    Remarks

    Listen forSimConnectRecvEvents.simObjectData to get the data.

    Example

    constLIVE_DATA_REQ_ID =1234;

    handle.addToDataDefinition(
    LIVE_DATA_REQ_ID,
    'STRUCT LATLONALT',
    null,
    SimConnectDataType.LATLONALT
    );

    handle.on('simObjectData',recvSimObjectData=> {
    if (recvSimObjectData.requestID ===LIVE_DATA_REQ_ID) {
    console.log(readLatLonAlt(recvSimObjectData.data));
    }
    });

requestDataOnSimObjectType

requestFacilitiesList

requestFacilitiesListEx1

requestFacilityData

  • requestFacilityData(dataDefinitionId,dataRequestId,icao,region?,type?):number
  • Parameters

    • dataDefinitionId:number
    • dataRequestId:number
    • icao:string
    • Optionalregion:string
    • Optionaltype:IcaoType

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

requestJetwayData

  • requestJetwayData(airportIcao,parkingIndices?):number
  • Parameters

    • airportIcao:string
    • OptionalparkingIndices:number[]

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

requestNotificationGroup

  • requestNotificationGroup(notificationGroupId,reserved,flags):number
  • Parameters

    • notificationGroupId:number
    • reserved:number
    • flags:number

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

requestReservedKey

  • requestReservedKey(clientEventId,keyChoice1?,keyChoice2?,keyChoice3?):number
  • Parameters

    • clientEventId:number
    • OptionalkeyChoice1:string
    • OptionalkeyChoice2:string
    • OptionalkeyChoice3:string

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

requestResponseTimes

requestSystemState

  • requestSystemState(dataRequestId,state):number
  • Parameters

    • dataRequestId:number
    • state:string

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

setClientData

  • setClientData(clientDataId,clientDataDefineID,reserved,arrayCount,unitSize,data):number
  • Parameters

    • clientDataId:number
    • clientDataDefineID:number
    • reserved:number
    • arrayCount:number
    • unitSize:number
    • data:Buffer

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

setDataOnSimObject

  • setDataOnSimObject(dataDefinitionId,objectId,data):number
  • Parameters

    • dataDefinitionId:number
    • objectId:number
    • data:{
          arrayCount:number;
          buffer:RawBuffer;
          tagged:boolean;
      } |SimConnectData[]

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

setInputEvent

  • setInputEvent(inputEventHashID,value):number
  • Parameters

    • inputEventHashID:bigint
    • value:string |number

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

setInputGroupPriority

setInputGroupState

  • setInputGroupState(inputGroupId,state):number
  • Parameters

    • inputGroupId:number
    • state:boolean

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

setMaxListeners

setNotificationGroupPriority

setSystemEventState

  • setSystemEventState(clientEventId,state):number
  • Parameters

    • clientEventId:number
    • state:boolean

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

setSystemState

  • setSystemState(state,paramInt,paramFloat,paramString):number
  • Parameters

    • state:string
    • paramInt:number
    • paramFloat:number
    • paramString:string

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

subscribeInputEvent

subscribeToFacilities

subscribeToFacilitiesEx1

  • subscribeToFacilitiesEx1(type,newElemInRangeRequestID,oldElemOutRangeRequestID):number
  • Parameters

    • type:FacilityListType
    • newElemInRangeRequestID:number
    • oldElemOutRangeRequestID:number

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

subscribeToSystemEvent

  • subscribeToSystemEvent(clientEventId,eventName):number
  • Parameters

    • clientEventId:number
    • eventName:string

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

text

  • text(type,timeSeconds,clientEventId,message):number
  • Parameters

    • type:TextType
    • timeSeconds:number
    • clientEventId:number
    • message:string

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

    Deprecated

    since MSFS (KittyHawk)

transmitClientEvent

  • transmitClientEvent(objectId,clientEventId,data,notificationGroupId,flags):number
  • Parameters

    • objectId:number
    • clientEventId:number
    • data:number
    • notificationGroupId:number
    • flags:EventFlag

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

transmitClientEventEx

  • transmitClientEventEx(objectId,clientEventId,notificationGroupId,flags,data0?,data1?,data2?,data3?,data4?):number
  • Parameters

    • objectId:number
    • clientEventId:number
    • notificationGroupId:number
    • flags:EventFlag
    • data0:number = 0
    • data1:number = 0
    • data2:number = 0
    • data3:number = 0
    • data4:number = 0

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

unSubscribeToFacilities

unSubscribeToFacilitiesEx1

  • unSubscribeToFacilitiesEx1(type,unsubscribeNewInRange,unsubscribeOldOutRange):number
  • Parameters

    • type:FacilityListType
    • unsubscribeNewInRange:boolean
    • unsubscribeOldOutRange:boolean

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

unsubscribeFromSystemEvent

  • unsubscribeFromSystemEvent(clientEventId):number
  • Parameters

    • clientEventId:number

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

unsubscribeInputEvent

  • unsubscribeInputEvent(inputEventHashID):number
  • Parameters

    • inputEventHashID:bigint

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

weatherCreateStation

  • weatherCreateStation(dataRequestId,ICAO,name,lat,lon,alt):number
  • Parameters

    • dataRequestId:number
    • ICAO:string
    • name:string
    • lat:number
    • lon:number
    • alt:number

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

    Deprecated

    since MSFS (KittyHawk)

weatherCreateThermal

  • weatherCreateThermal(dataRequestId,lat,lon,alt,radius,height,coreRate,coreTurbulence,sinkRate,sinkTurbulence,coreSize,coreTransitionSize,sinkLayerSize,sinkTransitionSize):number
  • Parameters

    • dataRequestId:number
    • lat:number
    • lon:number
    • alt:number
    • radius:number
    • height:number
    • coreRate:number
    • coreTurbulence:number
    • sinkRate:number
    • sinkTurbulence:number
    • coreSize:number
    • coreTransitionSize:number
    • sinkLayerSize:number
    • sinkTransitionSize:number

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

    Deprecated

    since MSFS (KittyHawk)

weatherRemoveStation

  • weatherRemoveStation(dataRequestId,ICAO):number
  • Parameters

    • dataRequestId:number
    • ICAO:string

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

    Deprecated

    since MSFS (KittyHawk)

weatherRemoveThermal

  • weatherRemoveThermal(objectId):number
  • Parameters

    • objectId:number

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

    Deprecated

    since MSFS (KittyHawk)

weatherRequestCloudState

  • weatherRequestCloudState(dataRequestId,minLat,minLon,minAlt,maxLat,maxLon,maxAlt,flags?):number
  • Parameters

    • dataRequestId:number
    • minLat:number
    • minLon:number
    • minAlt:number
    • maxLat:number
    • maxLon:number
    • maxAlt:number
    • Optionalflags:number

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

    Deprecated

    since MSFS (KittyHawk)

weatherRequestInterpolatedObservation

  • weatherRequestInterpolatedObservation(dataRequestId,lat,lon,alt):number
  • Parameters

    • dataRequestId:number
    • lat:number
    • lon:number
    • alt:number

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

    Deprecated

    since MSFS (KittyHawk)

weatherRequestObservationAtNearestStation

  • weatherRequestObservationAtNearestStation(dataRequestId,lat,lon):number
  • Parameters

    • dataRequestId:number
    • lat:number
    • lon:number

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

    Deprecated

    since MSFS (KittyHawk)

weatherRequestObservationAtStation

  • weatherRequestObservationAtStation(dataRequestId,ICAO):number
  • Parameters

    • dataRequestId:number
    • ICAO:string

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

    Deprecated

    since MSFS (KittyHawk)

weatherSetDynamicUpdateRate

  • weatherSetDynamicUpdateRate(rate):number
  • Parameters

    • rate:number

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

    Deprecated

    since MSFS (KittyHawk)

weatherSetModeCustom

weatherSetModeGlobal

weatherSetModeServer

  • weatherSetModeServer(port,seconds):number
  • Parameters

    • port:number
    • seconds:number

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

    Deprecated

    since MSFS (KittyHawk)

weatherSetModeTheme

  • weatherSetModeTheme(themeName):number
  • Parameters

    • themeName:string

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

    Deprecated

    since MSFS (KittyHawk)

weatherSetObservation

  • weatherSetObservation(seconds,metar):number
  • Parameters

    • seconds:number
    • metar:string

    Returnsnumber

    sendId of packet (can be used to identify packet when exception event occurs)

    Deprecated

    since MSFS (KittyHawk)

StaticgetEventListeners

  • getEventListeners(emitter,name):Function[]
  • Returns a copy of the array of listeners for the event namedeventName.

    ForEventEmitters this behaves exactly the same as calling.listeners onthe emitter.

    ForEventTargets this is the only way to get the event listeners for theevent target. This is useful for debugging and diagnostic purposes.

    const {getEventListeners,EventEmitter } =require('events');

    {
    constee =newEventEmitter();
    constlistener = ()=>console.log('Events are fun');
    ee.on('foo',listener);
    getEventListeners(ee,'foo');// [listener]
    }
    {
    constet =newEventTarget();
    constlistener = ()=>console.log('Events are fun');
    et.addEventListener('foo',listener);
    getEventListeners(et,'foo');// [listener]
    }

    Parameters

    • emitter:EventEmitter |DOMEventTarget
    • name:string |symbol

    ReturnsFunction[]

    Since

    v15.2.0

    Inherited from EventEmitter.getEventListeners

    • Defined in node_modules/@types/node/events.d.ts:262

StaticlistenerCount

  • listenerCount(emitter,eventName):number
  • A class method that returns the number of listeners for the giveneventNameregistered on the givenemitter.

    const {EventEmitter,listenerCount } =require('events');
    constmyEmitter =newEventEmitter();
    myEmitter.on('event', ()=> {});
    myEmitter.on('event', ()=> {});
    console.log(listenerCount(myEmitter,'event'));
    // Prints: 2

    Parameters

    • emitter:EventEmitter

      The emitter to query

    • eventName:string |symbol

      The event name

    Returnsnumber

    Since

    v0.9.12

    Deprecated

    Since v3.2.0 - UselistenerCount instead.

    Inherited from EventEmitter.listenerCount

    • Defined in node_modules/@types/node/events.d.ts:234

Staticon

  • on(emitter,eventName,options?):AsyncIterableIterator<any>
  • const {on,EventEmitter } =require('events');

    (async ()=> {
    constee =newEventEmitter();

    // Emit later on
    process.nextTick(()=> {
    ee.emit('foo','bar');
    ee.emit('foo',42);
    });

    forawait (consteventofon(ee,'foo')) {
    // The execution of this inner block is synchronous and it
    // processes one event at a time (even with await). Do not use
    // if concurrent execution is required.
    console.log(event);// prints ['bar'] [42]
    }
    // Unreachable here
    })();

    Returns anAsyncIterator that iterateseventName events. It will throwif theEventEmitter emits'error'. It removes all listeners whenexiting the loop. Thevalue returned by each iteration is an arraycomposed of the emitted event arguments.

    AnAbortSignal can be used to cancel waiting on events:

    const {on,EventEmitter } =require('events');
    constac =newAbortController();

    (async ()=> {
    constee =newEventEmitter();

    // Emit later on
    process.nextTick(()=> {
    ee.emit('foo','bar');
    ee.emit('foo',42);
    });

    forawait (consteventofon(ee,'foo', {signal:ac.signal })) {
    // The execution of this inner block is synchronous and it
    // processes one event at a time (even with await). Do not use
    // if concurrent execution is required.
    console.log(event);// prints ['bar'] [42]
    }
    // Unreachable here
    })();

    process.nextTick(()=>ac.abort());

    Parameters

    • emitter:EventEmitter
    • eventName:string

      The name of the event being listened for

    • Optionaloptions:StaticEventEmitterOptions

    ReturnsAsyncIterableIterator<any>

    that iterateseventName events emitted by theemitter

    Since

    v13.6.0, v12.16.0

    Inherited from EventEmitter.on

    • Defined in node_modules/@types/node/events.d.ts:217

Staticonce

  • once(emitter,eventName,options?):Promise<any[]>
  • Creates aPromise that is fulfilled when theEventEmitter emits the givenevent or that is rejected if theEventEmitter emits'error' while waiting.ThePromise will resolve with an array of all the arguments emitted to thegiven event.

    This method is intentionally generic and works with the web platformEventTarget interface, which has no special'error' eventsemantics and does not listen to the'error' event.

    const {once,EventEmitter } =require('events');

    asyncfunctionrun() {
    constee =newEventEmitter();

    process.nextTick(()=> {
    ee.emit('myevent',42);
    });

    const [value] =awaitonce(ee,'myevent');
    console.log(value);

    consterr =newError('kaboom');
    process.nextTick(()=> {
    ee.emit('error',err);
    });

    try {
    awaitonce(ee,'myevent');
    }catch (err) {
    console.log('error happened',err);
    }
    }

    run();

    The special handling of the'error' event is only used whenevents.once()is used to wait for another event. Ifevents.once() is used to wait for the'error' event itself, then it is treated as any other kind of event withoutspecial handling:

    const {EventEmitter,once } =require('events');

    constee =newEventEmitter();

    once(ee,'error')
    .then(([err])=>console.log('ok',err.message))
    .catch((err)=>console.log('error',err.message));

    ee.emit('error',newError('boom'));

    // Prints: ok boom

    AnAbortSignal can be used to cancel waiting for the event:

    const {EventEmitter,once } =require('events');

    constee =newEventEmitter();
    constac =newAbortController();

    asyncfunctionfoo(emitter,event,signal) {
    try {
    awaitonce(emitter,event, {signal });
    console.log('event emitted!');
    }catch (error) {
    if (error.name ==='AbortError') {
    console.error('Waiting for the event was canceled!');
    }else {
    console.error('There was an error',error.message);
    }
    }
    }

    foo(ee,'foo',ac.signal);
    ac.abort();// Abort waiting for the event
    ee.emit('foo');// Prints: Waiting for the event was canceled!

    Parameters

    • emitter:NodeEventTarget
    • eventName:string |symbol
    • Optionaloptions:StaticEventEmitterOptions

    ReturnsPromise<any[]>

    Since

    v11.13.0, v10.16.0

    Inherited from EventEmitter.once

    • Defined in node_modules/@types/node/events.d.ts:157
  • once(emitter,eventName,options?):Promise<any[]>
  • Parameters

    • emitter:DOMEventTarget
    • eventName:string
    • Optionaloptions:StaticEventEmitterOptions

    ReturnsPromise<any[]>

    Inherited from EventEmitter.once

    • Defined in node_modules/@types/node/events.d.ts:158

StaticsetMaxListeners

Settings

On This Page

Generated usingTypeDoc


[8]ページ先頭

©2009-2025 Movatter.jp