Class: MCIProcessor

runtime/mci/processor.MCIProcessor

Table of contents

Constructors

• constructor

Methods

• applyTextStyle
• clearAllPositions
• clearPosition
• getContext
• getCustom
• getLineCount
• getResetSequence
• gotoPosition
• hasPosition
• incrementLineCount
• isPauseEnabled
• listPositions
• process
• processWithDetails
• registerAtCode
• registerTextStyle
• reset
• resetLineCount
• savePosition
• setBBS
• setContext
• setCurrentPosition
• setCustom
• setPageLength
• setPauseEnabled
• setSystem
• setTerminal
• setUser
• shouldAutoPause
• updatePosition

Constructors

constructor

• new MCIProcessor(options?)

Parameters

Name	Type
options	MCIProcessorOptions

Defined in

core/src/mci/processor.ts:58

Methods

applyTextStyle

▸ applyTextStyle(text, styleName): string

Parameters

Name	Type
text	string
styleName	string

Returns

string

Defined in

core/src/mci/processor.ts:307

---

clearAllPositions

▸ clearAllPositions(): void

Returns

void

Defined in

core/src/mci/processor.ts:295

---

clearPosition

▸ clearPosition(id): boolean

Parameters

Name	Type
id	number

Returns

boolean

Defined in

core/src/mci/processor.ts:291

---

getContext

▸ getContext(): MCIContext

Returns

MCIContext

Defined in

core/src/mci/processor.ts:236

---

getCustom

▸ getCustom(key): any

Parameters

Name	Type
key	string

Returns

any

Defined in

core/src/mci/processor.ts:271

---

getLineCount

▸ getLineCount(): number

Returns

number

Defined in

core/src/mci/processor.ts:327

---

getResetSequence

▸ getResetSequence(): string

Returns

string

Defined in

core/src/mci/processor.ts:354

---

gotoPosition

▸ gotoPosition(id): null | string

Parameters

Name	Type
id	number

Returns

null | string

Defined in

core/src/mci/processor.ts:279

---

hasPosition

▸ hasPosition(id): boolean

Parameters

Name	Type
id	number

Returns

boolean

Defined in

core/src/mci/processor.ts:287

---

incrementLineCount

▸ incrementLineCount(lines?): void

Parameters

Name	Type	Default value
lines	number	1

Returns

void

Defined in

core/src/mci/processor.ts:331

---

isPauseEnabled

▸ isPauseEnabled(): boolean

Returns

boolean

Defined in

core/src/mci/processor.ts:319

---

listPositions

▸ listPositions(): number[]

Returns

number[]

Defined in

core/src/mci/processor.ts:299

---

process

▸ process(text): string

Parameters

Name	Type
text	string

Returns

string

Defined in

core/src/mci/processor.ts:85

---

processWithDetails

▸ processWithDetails(text): MCIProcessResult

Parameters

Name	Type
text	string

Returns

MCIProcessResult

Defined in

core/src/mci/processor.ts:90

---

registerAtCode

▸ registerAtCode(code, handler): void

Parameters

Name	Type
code	string
handler	(context: MCIContext, params?: string) => undefined | string

Returns

void

Defined in

core/src/mci/processor.ts:315

---

registerTextStyle

▸ registerTextStyle(name, fn): void

Parameters

Name	Type
name	string
fn	(text: string) => string

Returns

void

Defined in

core/src/mci/processor.ts:311

---

reset

▸ reset(): void

Returns

void

Defined in

core/src/mci/processor.ts:347

---

resetLineCount

▸ resetLineCount(): void

Returns

void

Defined in

core/src/mci/processor.ts:335

---

savePosition

▸ savePosition(id): void

Parameters

Name	Type
id	number

Returns

void

Defined in

core/src/mci/processor.ts:275

---

setBBS

▸ setBBS(bbs): void

Parameters

Name	Type
bbs	Partial<BBSContext>

Returns

void

Defined in

core/src/mci/processor.ts:252

---

setContext

▸ setContext(ctx): void

Parameters

Name	Type
ctx	Partial<MCIContext>

Returns

void

Defined in

core/src/mci/processor.ts:232

---

setCurrentPosition

▸ setCurrentPosition(x, y): void

Parameters

Name	Type
x	number
y	number

Returns

void

Defined in

core/src/mci/processor.ts:303

---

setCustom

▸ setCustom(key, value): void

Parameters

Name	Type
key	string
value	any

Returns

void

Defined in

core/src/mci/processor.ts:267

---

setPageLength

▸ setPageLength(length): void

Parameters

Name	Type
length	number

Returns

void

Defined in

core/src/mci/processor.ts:343

---

setPauseEnabled

▸ setPauseEnabled(enabled): void

Parameters

Name	Type
enabled	boolean

Returns

void

Defined in

core/src/mci/processor.ts:323

---

setSystem

▸ setSystem(system): void

Parameters

Name	Type
system	Partial<SystemContext>

Returns

void

Defined in

core/src/mci/processor.ts:246

---

setTerminal

▸ setTerminal(terminal): void

Parameters

Name	Type
terminal	Partial<TerminalContext>

Returns

void

Defined in

core/src/mci/processor.ts:258

---

setUser

▸ setUser(user): void

Parameters

Name	Type
user	Partial<UserContext>

Returns

void

Defined in

core/src/mci/processor.ts:240

---

shouldAutoPause

▸ shouldAutoPause(): boolean

Returns

boolean

Defined in

core/src/mci/processor.ts:339

---

updatePosition

▸ updatePosition(id, text): null | string

Parameters

Name	Type
id	number
text	string

Returns

null | string

Defined in

core/src/mci/processor.ts:283