Class EditSession

An edit session instance. Edit sessions can be attached to a project to collaborate on it with multiple users via P2P connections.

Index

Constructors

constructor

new EditSession(): EditSession
Returns EditSession
- Defined in types/custom/project.d.ts:124

Properties

active

active: boolean

chat_history

chat_history: []

client_count

client_count: number

clients

clients: {}

data_queue

data_queue: []

hosting

hosting: boolean

Project

Project: ModelProject

Methods

addChatMessage

addChatMessage(message: any): any
Parameters
- message: any
Returns any
- Defined in types/custom/project.d.ts:152

catchUp

catchUp(): void
Returns void
- Defined in types/custom/project.d.ts:146

copyToken

copyToken(): void
Returns void
- Defined in types/custom/project.d.ts:139

initConnection

initConnection(conn: any): void
Parameters
- conn: any
Returns void
- Defined in types/custom/project.d.ts:141

initNewModel

initNewModel(force?: boolean): void
Parameters
- Optionalforce: boolean
Returns void
- Defined in types/custom/project.d.ts:140

join

join(username: string, token: string): void
Parameters
- username: string
- token: string
Returns void
- Defined in types/custom/project.d.ts:136

processChatMessage

processChatMessage(data: any): void
Parameters
- data: any
Returns void
- Defined in types/custom/project.d.ts:153

processData

processData(tag: any): void
Parameters
- tag: any
Returns void
- Defined in types/custom/project.d.ts:145

quit

quit(): void
Returns void
- Defined in types/custom/project.d.ts:137

receiveData

receiveData(tag: any): void
Parameters
- tag: any
Returns void
- Defined in types/custom/project.d.ts:144

sendAll

sendAll(type: string, data: any): void
Parameters
- type: string
- data: any
Returns void
- Defined in types/custom/project.d.ts:142

sendChat

sendChat(text?: string): void
Send a chat message
Parameters
- Optionaltext: string
  Text to send. If omitted, the current text in the chat panel input is sent
Returns void
- Defined in types/custom/project.d.ts:151

sendEdit

sendEdit(entry: UndoEntry): void
Parameters
- entry: UndoEntry
Returns void
- Defined in types/custom/project.d.ts:143

setState

setState(active: boolean): void
Parameters
- active: boolean
Returns void
- Defined in types/custom/project.d.ts:138

start

start(username?: string): void
Parameters
- Optionalusername: string
Returns void
- Defined in types/custom/project.d.ts:135

updateClientCound

updateClientCound(): void
Returns void
- Defined in types/custom/project.d.ts:134