Class: PositionMarkerProcessor

runtime/mci/codes/position.PositionMarkerProcessor

Table of contents

Constructors

• constructor

Methods

• clearAllPositions
• clearPosition
• exportMarkers
• getCurrentPosition
• getMarkerCount
• getPosition
• gotoPosition
• gotoPositionOnly
• hasPosition
• importMarkers
• listPositions
• processMarkerCode
• savePosition
• setCurrentColor
• setCurrentPosition
• updatePosition

Constructors

constructor

• new PositionMarkerProcessor()

Methods

clearAllPositions

▸ clearAllPositions(): void

Returns

void

Defined in

core/src/mci/codes/position.ts:115

---

clearPosition

▸ clearPosition(id): boolean

Parameters

Name	Type
id	number

Returns

boolean

Defined in

core/src/mci/codes/position.ts:111

---

exportMarkers

▸ exportMarkers(): Record<number, PositionMarker>

Returns

Record<number, PositionMarker>

Defined in

core/src/mci/codes/position.ts:184

---

getCurrentPosition

▸ getCurrentPosition(): PositionState

Returns

PositionState

Defined in

core/src/mci/codes/position.ts:132

---

getMarkerCount

▸ getMarkerCount(): number

Returns

number

Defined in

core/src/mci/codes/position.ts:123

---

getPosition

▸ getPosition(id): undefined | PositionMarker

Parameters

Name	Type
id	number

Returns

undefined | PositionMarker

Defined in

core/src/mci/codes/position.ts:70

---

gotoPosition

▸ gotoPosition(id): null | string

Parameters

Name	Type
id	number

Returns

null | string

Defined in

core/src/mci/codes/position.ts:78

---

gotoPositionOnly

▸ gotoPositionOnly(id): null | string

Parameters

Name	Type
id	number

Returns

null | string

Defined in

core/src/mci/codes/position.ts:94

---

hasPosition

▸ hasPosition(id): boolean

Parameters

Name	Type
id	number

Returns

boolean

Defined in

core/src/mci/codes/position.ts:74

---

importMarkers

▸ importMarkers(markers): void

Parameters

Name	Type
markers	Record<number, PositionMarker>

Returns

void

Defined in

core/src/mci/codes/position.ts:192

---

listPositions

▸ listPositions(): number[]

Returns

number[]

Defined in

core/src/mci/codes/position.ts:119

---

processMarkerCode

▸ processMarkerCode(text): Object

Parameters

Name	Type
text	string

Returns

Object

Name	Type
markersFound	number[]
result	string

Defined in

core/src/mci/codes/position.ts:142

---

savePosition

▸ savePosition(id, state?): void

Parameters

Name	Type
id	number
state?	Partial<PositionState>

Returns

void

Defined in

core/src/mci/codes/position.ts:52

---

setCurrentColor

▸ setCurrentColor(foreground?, background?, attributes?): void

Parameters

Name	Type
foreground?	number
background?	number
attributes?	number

Returns

void

Defined in

core/src/mci/codes/position.ts:136

---

setCurrentPosition

▸ setCurrentPosition(x, y): void

Parameters

Name	Type
x	number
y	number

Returns

void

Defined in

core/src/mci/codes/position.ts:127

---

updatePosition

▸ updatePosition(id, text): null | string

Parameters

Name	Type
id	number
text	string

Returns

null | string

Defined in

core/src/mci/codes/position.ts:104