Class default

Hierarchy

default
- default

Implements

default

Index

Constructors

Properties

active cursor game line session sshCommandManager stream

Methods

allowCtrlCClose allowHistory displayMessage executeWithMessageRedirect flush processData processLine start stop write writeMarker

Constructors

constructor

new default(session: ISshSession, stream: ISshStream, game: Game, username: string, serverName: string): default
Parameters
- session: ISshSession
- stream: ISshStream
- game: Game
- username: string
- serverName: string
Returns default
Overrides default.constructor
- Defined in src/game/multiplayer/dedicatedServer/ssh/DefaultShell.ts:25

Properties

`Protected` active

active: boolean = false

`Protected` cursor

cursor: number = 0

`Readonly` game

game: Game

`Protected` line

line: string = ""

`Readonly` session

session: ISshSession

`Readonly` sshCommandManager

sshCommandManager: ISshCommandManager

`Readonly` stream

stream: ISshStream

Methods

`Protected` allowCtrlCClose

allowCtrlCClose(): boolean
Check if Ctrl+C is allowed to close the shell

Returns
True if you want ctrl+c to close the shell

Returns boolean
Overrides default.allowCtrlCClose
- Defined in src/game/multiplayer/dedicatedServer/ssh/DefaultShell.ts:92

allowHistory

allowHistory(): void
Returns void
Inherited from default.allowHistory
- Defined in src/game/multiplayer/dedicatedServer/ssh/Shell.ts:74

displayMessage

displayMessage(_: default, message: IMessage): void
Parameters
- _: default
- message: IMessage
Returns void
Inherited from default.displayMessage
- Defined in src/game/multiplayer/dedicatedServer/ssh/Shell.ts:260

executeWithMessageRedirect

executeWithMessageRedirect(executor: (() => Promise<void>)): Promise<void>
Parameters
- executor: (() => Promise<void>)
  - - (): Promise<void>
    - Returns Promise<void>
Returns Promise<void>
Implementation of default.executeWithMessageRedirect

Inherited from default.executeWithMessageRedirect
- Defined in src/game/multiplayer/dedicatedServer/ssh/Shell.ts:245

flush

flush(): void
Returns void
Implementation of default.flush

Inherited from default.flush
- Defined in src/game/multiplayer/dedicatedServer/ssh/Shell.ts:90

processData

processData(data: string): Promise<undefined | false | default>
Parameters
- data: string
Returns Promise<undefined | false | default>
Inherited from default.processData
- Defined in src/game/multiplayer/dedicatedServer/ssh/Shell.ts:98

processLine

processLine(line: string): Promise<undefined | false | default>
Processes a line sent for the session

Returns
A shell to push a new action shell, false to exit the session, undefined to keep the active shell going
Parameters
- line: string
Returns Promise<undefined | false | default>
Overrides default.processLine
- Defined in src/game/multiplayer/dedicatedServer/ssh/DefaultShell.ts:47

start

start(): Promise<boolean>
Returns Promise<boolean>
Inherited from default.start
- Defined in src/game/multiplayer/dedicatedServer/ssh/Shell.ts:46

stop

stop(): void
Returns void
Inherited from default.stop
- Defined in src/game/multiplayer/dedicatedServer/ssh/Shell.ts:61

write

write(data: string): void
Parameters
- data: string
Returns void
Implementation of default.write

Inherited from default.write
- Defined in src/game/multiplayer/dedicatedServer/ssh/Shell.ts:86

writeMarker

writeMarker(): Promise<void>
Writes the marker

Returns Promise<void>
Overrides default.writeMarker
- Defined in src/game/multiplayer/dedicatedServer/ssh/DefaultShell.ts:34

Generated using TypeDoc