import ScConnection from './ui/multiplayer/sc_connection.js'

public class | source

ScConnection

Extends:

cables-shared-client~Events → ScConnection

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	OWN_PINGS_TO_TIMEOUT: number
public	PINGS_TO_TIMEOUT: number
public	PING_INTERVAL: number
public get	chat: *
public get	client: *
public get	clientId: *
public get	clients: *
public get	connected: *
public get	followers: *
public get	hasOtherMultiplayerCapableClients: *
public get	inMultiplayerSession: *
public	multiplayerCapable: *
public get	netMouseCursorDelay: number
public get	netTimelineScrollDelay: number
public get	onlyRemoteClientsConnected: *
public	patchChannelName: *
public get	runningMultiplayerSession: *
public get	showGuestUsers: *
public get	state: *
public get	synced: *
public	userChannelName: *
public	userPatchChannelName: *

Private Members
private	_active: *
private	_chat: *
private	_connected: boolean
private	_connectedSince: *
private	_inSessionSince: *
private	_lastPingReceived: *
private	_lastPingSent: *
private	_log: *
private	_multiplayerUi: *
private	_paco: *
private	_pacoChannel: *
private	_pacoEnabled: boolean
private	_pacoLoopReady: boolean
private	_pacoSynced: boolean
private	_patchConnection: *
private	_scConfig: *
private	_socket: *
private	_state: *
private	_token: *
private	_verboseLog: boolean

Method Summary

Public Methods
public	canSaveInMultiplayer(): boolean
public	enableVerboseLogging()
public	getPilot(): *
public	getTimestamp(): *
public	hasPilot(): *
public	isConnected(): *
public	joinMultiplayerSession()
public	leaveMultiplayerSession()
public	reconnectRemoteViewer()
public	requestPilotPatch()
public	sendChat(text: *)
public	sendControl(name: , payload: )
public	sendCurrentVersion()
public	sendInfo(name: , text: )
public	sendNotification(title: , text: )
public	sendPaco(payload: *, name: string)
public	sendUi(name: , payload: , sendOnEmptyClientList: boolean)
public	setPacoPaused(paused: *)
public	showChat()
public	startMultiplayerSession()
public	startRemoteViewer(doneCallback: *)
public	track(eventCategory: , eventAction: , eventLabel: *, meta: {})

Private Methods
private	_handleChatChannelMsg(msg: *)
private	_handleControlChannelMessage(msg: *)
private	_handleInfoChannelMsg(msg: *)
private	_handlePacoMessage(msg: *)
private	_handleUiChannelMsg(msg: *)
private	_init(doneCallback: *)
private	_logVerbose(prefix: , channel: , msg: *)
private	_reconnectViewer(startSessionListener: *)
private	_send(channel: , topic: , payload: *)
private	_sendPing(startedSession: boolean)
private	_startPacoSend(requestedBy: *, forceResync: boolean)
private	_synchronizePatch(data: *)
private	_updateMembers()

Public Constructors

public constructor() source

Public Members

public OWN_PINGS_TO_TIMEOUT: number source

public PINGS_TO_TIMEOUT: number source

public PING_INTERVAL: number source

public get chat: * source

public get client: * source

public get clientId: * source

public get clients: * source

public get connected: * source

public get followers: * source

public get hasOtherMultiplayerCapableClients: * source

public get inMultiplayerSession: * source

public multiplayerCapable: * source

public get netMouseCursorDelay: number source

public get netTimelineScrollDelay: number source

public get onlyRemoteClientsConnected: * source

public patchChannelName: * source

public get runningMultiplayerSession: * source

public get showGuestUsers: * source

public get state: * source

public get synced: * source

public userChannelName: * source

public userPatchChannelName: * source

Private Members

private _active: * source

private _chat: * source

private _connected: boolean source

private _connectedSince: * source

private _inSessionSince: * source

private _lastPingReceived: * source

private _lastPingSent: * source

private _log: * source

private _multiplayerUi: * source

private _paco: * source

private _pacoChannel: * source

private _pacoEnabled: boolean source

private _pacoLoopReady: boolean source

private _pacoSynced: boolean source

private _patchConnection: * source

private _scConfig: * source

private _socket: * source

private _state: * source

private _token: * source

private _verboseLog: boolean source

Public Methods

public canSaveInMultiplayer(): boolean source

Return:

boolean

public enableVerboseLogging() source

public getPilot(): * source

Return:

public getTimestamp(): * source

Return:

public hasPilot(): * source

Return:

public isConnected(): * source

Return:

public joinMultiplayerSession() source

public leaveMultiplayerSession() source

public reconnectRemoteViewer() source

public requestPilotPatch() source

public sendChat(text: *) source

Params:

Name	Type	Attribute	Description
text	*

public sendControl(name: , payload: ) source

Params:

Name	Type	Attribute	Description
name	*
payload	*

public sendCurrentVersion() source

public sendInfo(name: , text: ) source

Params:

Name	Type	Attribute	Description
name	*
text	*

public sendNotification(title: , text: ) source

Params:

Name	Type	Attribute	Description
title	*
text	*

public sendPaco(payload: *, name: string) source

Params:

Name	Type	Attribute	Description
payload	*
name	string	optional default: paco

public sendUi(name: , payload: , sendOnEmptyClientList: boolean) source

Params:

Name	Type	Attribute	Description
name	*
payload	*
sendOnEmptyClientList	boolean	optional default: false

public setPacoPaused(paused: *) source

Params:

Name	Type	Attribute	Description
paused	*

public showChat() source

public startMultiplayerSession() source

public startRemoteViewer(doneCallback: *) source

Params:

Name	Type	Attribute	Description
doneCallback	*

public track(eventCategory: , eventAction: , eventLabel: *, meta: {}) source

Params:

Name	Type	Attribute	Description
eventCategory	*
eventAction	*
eventLabel	*
meta	{}	optional default: {}

Private Methods

private _handleChatChannelMsg(msg: *) source

Params:

Name	Type	Attribute	Description
msg	*

private _handleControlChannelMessage(msg: *) source

Params:

Name	Type	Attribute	Description
msg	*

private _handleInfoChannelMsg(msg: *) source

Params:

Name	Type	Attribute	Description
msg	*

private _handlePacoMessage(msg: *) source

Params:

Name	Type	Attribute	Description
msg	*

private _handleUiChannelMsg(msg: *) source

Params:

Name	Type	Attribute	Description
msg	*

private _init(doneCallback: *) source

Params:

Name	Type	Attribute	Description
doneCallback	*

private _logVerbose(prefix: , channel: , msg: *) source

Params:

Name	Type	Attribute	Description
prefix	*
channel	*
msg	*

private _reconnectViewer(startSessionListener: *) source

Params:

Name	Type	Attribute	Description
startSessionListener	*

private _send(channel: , topic: , payload: *) source

Params:

Name	Type	Attribute	Description
channel	*
topic	*
payload	*

private _sendPing(startedSession: boolean) source

Params:

Name	Type	Attribute	Description
startedSession	boolean	optional default: false

private _startPacoSend(requestedBy: *, forceResync: boolean) source

Params:

Name	Type	Attribute	Description
requestedBy	*
forceResync	boolean	optional default: false

private _synchronizePatch(data: *) source

Params:

Name	Type	Attribute	Description
data	*

ScConnection

Extends:

Constructor Summary

Member Summary

Method Summary

Public Constructors

public constructor() source

Public Members

public OWN_PINGS_TO_TIMEOUT: number source

public PINGS_TO_TIMEOUT: number source

public PING_INTERVAL: number source

public get chat: * source

public get client: * source

public get clientId: * source

public get clients: * source

public get connected: * source

public get followers: * source

public get hasOtherMultiplayerCapableClients: * source

public get inMultiplayerSession: * source

public multiplayerCapable: * source

public get netMouseCursorDelay: number source

public get netTimelineScrollDelay: number source

public get onlyRemoteClientsConnected: * source

public patchChannelName: * source

public get runningMultiplayerSession: * source

public get showGuestUsers: * source

public get state: * source

public get synced: * source

public userChannelName: * source

public userPatchChannelName: * source

Private Members

private _active: * source

private _chat: * source

private _connected: boolean source

private _connectedSince: * source

private _inSessionSince: * source

private _lastPingReceived: * source

private _lastPingSent: * source

private _log: * source

private _multiplayerUi: * source

private _paco: * source

private _pacoChannel: * source

private _pacoEnabled: boolean source

private _pacoLoopReady: boolean source

private _pacoSynced: boolean source

private _patchConnection: * source

private _scConfig: * source

private _socket: * source

private _state: * source

private _token: * source

private _verboseLog: boolean source

Public Methods

public canSaveInMultiplayer(): boolean source

Return:

public enableVerboseLogging() source

public getPilot(): * source

Return:

public getTimestamp(): * source

Return:

public hasPilot(): * source

Return:

public isConnected(): * source

Return:

public joinMultiplayerSession() source

public leaveMultiplayerSession() source

public reconnectRemoteViewer() source

public requestPilotPatch() source

public sendChat(text: *) source

Params:

public sendControl(name: *, payload: *) source

Params:

public sendCurrentVersion() source

public sendInfo(name: *, text: *) source

Params:

public sendNotification(title: *, text: *) source

Params:

public sendPaco(payload: *, name: string) source

Params:

public sendUi(name: *, payload: *, sendOnEmptyClientList: boolean) source

Params:

public sendControl(name: , payload: ) source

public sendInfo(name: , text: ) source

public sendNotification(title: , text: ) source

public sendUi(name: , payload: , sendOnEmptyClientList: boolean) source

public track(eventCategory: , eventAction: , eventLabel: *, meta: {}) source

private _logVerbose(prefix: , channel: , msg: *) source

private _send(channel: , topic: , payload: *) source