Class DrawingLogger

A vertical list of Lines.

Hierarchy

DrawingLogger

Index

Constructors

Properties

behavior counter direction lines logTime maxLines offset queue

Methods

Destroy addLine clear destroyEntry dismiss enter getEntry getId print printTokens removeById setMaxBehavior setOffset update

Constructors

constructor

new DrawingLogger(): DrawingLogger
Returns DrawingLogger

Properties

`Private` behavior

behavior: MaxLogBehavior = "wait"

`Private` counter

counter: number = 0

direction

direction: LogDirection = "up"

The direction to render logs in.

`Private` lines

lines: LineEntry[] = []

logTime

logTime: number = 10

The amount of time that logs are displayed for (in seconds).

maxLines

maxLines: number = 10

The maximum number of lines to display at once.

`Private` offset

offset: Vector2 = ...

`Private` queue

queue: LineEntry[] = []

Methods

Destroy

Destroy(): void
Stops the logger and removes all lines.

Once called, addLine will do nothing.

Returns void
- Defined in class/logger.ts:192

addLine

addLine(line: Line): string
Add a Line to the queue.

Returns
Displayed line id.
Parameters
- line: Line
Returns string
- Defined in class/logger.ts:71

clear

clear(): void
Remove all lines, including those in the queue.

Returns void
- Defined in class/logger.ts:132

`Private` destroyEntry

destroyEntry(entry: LineEntry): void
Parameters
- entry: LineEntry
Returns void
- Defined in class/logger.ts:90

dismiss

dismiss(id: string): boolean
Dismiss a line by its id.

Returns
true if found, false otherwise.
Parameters
- id: string
Returns boolean
- Defined in class/logger.ts:114

`Private` enter

enter(entry: LineEntry): void
Parameters
- entry: LineEntry
Returns void
- Defined in class/logger.ts:96

`Private` getEntry

getEntry(line: Line): {
    enteredAt: DateTime;
    id: string;
    line: Line;
    visible: boolean;
}
Parameters
- line: Line
Returns {
    enteredAt: DateTime;
    id: string;
    line: Line;
    visible: boolean;
}
- enteredAt: DateTime
- id: string
- line: Line
- visible: boolean
- Defined in class/logger.ts:58

`Private` getId

getId(): string
Returns string
- Defined in class/logger.ts:54

print

print(...args: unknown[]): string
Show arbitrary data as a colorized line.
Parameters
- Rest ...args: unknown[]
Returns string
- Defined in class/logger.ts:86

printTokens

printTokens(tokens: Token[]): string
Parameters
- tokens: Token[]
Returns string
- Defined in class/logger.ts:79

`Private` removeById

removeById(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in class/logger.ts:103

setMaxBehavior

setMaxBehavior(behavior: MaxLogBehavior): DrawingLogger
Set the behavior for when maxLines is reached.

"drop" will push the oldest line out, while "wait" will wait for space.
Parameters
- behavior: MaxLogBehavior
Returns DrawingLogger
- Defined in class/logger.ts:38

setOffset

setOffset(x: number, y?: number): DrawingLogger
Set the offset in pixels from the corner to display logs.
Parameters
- x: number
- y: number = x
Returns DrawingLogger
- Defined in class/logger.ts:47

`Private` update

update(): void
Returns void
- Defined in class/logger.ts:139

Generated using TypeDoc