puzzlescript
Options
All
Public
Public/Protected
All
Inherited
Only exported
Menu
TerminalUI
constructor
PIXEL_
HEIGHT
PIXEL_
WIDTH
SPRITE_
HEIGHT
SPRITE_
WIDTH
engine
game
Data
has
Visual
Ui
inspector
Col
inspector
Row
is
Dumping
Screen
rendered
Pixels
window
Offset
Col
Start
window
Offset
Height
window
Offset
Row
Start
window
Offset
Width
_draw
Pixel
a11y
Write
can
Show
Message
AsCells
cell
Pos
ToXY
check
IfCell
Can
BeDrawn
OnScreen
clear
Screen
create
Message
Sprites
create
Message
Text
Screen
debug
Render
Screen
destroy
draw
Cells
draw
Cells
After
Recentering
dump
Screen
get
Current
Level
Cells
get
Game
Data
get
Has
Visual
Ui
get
Max
Size
get
Pixels
For
Cell
has
Again
That
Needs
ToRun
move
Inspector
move
Inspector
To
press
press
Action
press
Down
press
Left
press
Restart
press
Right
press
Undo
press
Up
render
Level
Screen
render
Message
Screen
render
Screen
set
Game
set
Game
Engine
set
Has
Visual
Ui
set
Level
set
Pixel
set
Small
Terminal
tick
will
All
Levels
Fit
OnScreen
write
Debug
ansi
Styles
supports16m
Colors
clear
Line
And
Write
Text
At
clear
Screen
draw
Pixel
Char
get
Restore
Cursor
get
Terminal
Size
set
BgColor
set
FgColor
set
Move
To
set
Show
Cursor
write
BgColor
write
FgColor
Hierarchy
BaseUI
TerminalUI
Index
Constructors
constructor
Properties
PIXEL_
HEIGHT
PIXEL_
WIDTH
SPRITE_
HEIGHT
SPRITE_
WIDTH
engine
game
Data
has
Visual
Ui
inspector
Col
inspector
Row
is
Dumping
Screen
rendered
Pixels
window
Offset
Col
Start
window
Offset
Height
window
Offset
Row
Start
window
Offset
Width
Methods
_draw
Pixel
a11y
Write
can
Show
Message
AsCells
cell
Pos
ToXY
check
IfCell
Can
BeDrawn
OnScreen
clear
Screen
create
Message
Sprites
create
Message
Text
Screen
debug
Render
Screen
destroy
draw
Cells
draw
Cells
After
Recentering
dump
Screen
get
Current
Level
Cells
get
Game
Data
get
Has
Visual
Ui
get
Max
Size
get
Pixels
For
Cell
has
Again
That
Needs
ToRun
move
Inspector
move
Inspector
To
press
press
Action
press
Down
press
Left
press
Restart
press
Right
press
Undo
press
Up
render
Level
Screen
render
Message
Screen
render
Screen
set
Game
set
Game
Engine
set
Has
Visual
Ui
set
Level
set
Pixel
set
Small
Terminal
tick
will
All
Levels
Fit
OnScreen
write
Debug
Constructors
constructor
new
TerminalUI
(
)
:
TerminalUI
Returns
TerminalUI
Properties
PIXEL_
HEIGHT
PIXEL_
HEIGHT
:
number
PIXEL_
WIDTH
PIXEL_
WIDTH
:
number
Protected
SPRITE_
HEIGHT
SPRITE_
HEIGHT
:
number
Protected
SPRITE_
WIDTH
SPRITE_
WIDTH
:
number
Protected
engine
engine
:
Optional
<
GameEngine
>
Protected
game
Data
game
Data
:
Optional
<
GameData
>
Protected
has
Visual
Ui
has
Visual
Ui
:
boolean
Protected
inspector
Col
inspector
Col
:
number
Protected
inspector
Row
inspector
Row
:
number
Protected
is
Dumping
Screen
is
Dumping
Screen
:
boolean
Protected
rendered
Pixels
rendered
Pixels
:
Array
<
Array
<
object
>
>
Protected
window
Offset
Col
Start
window
Offset
Col
Start
:
number
Protected
window
Offset
Height
window
Offset
Height
:
Optional
<
number
>
Protected
window
Offset
Row
Start
window
Offset
Row
Start
:
number
Protected
window
Offset
Width
window
Offset
Width
:
Optional
<
number
>
Methods
_draw
Pixel
_draw
Pixel
(
x
:
number
, y
:
number
, fgHex
:
string
, bgHex
:
Optional
<
string
>
, chars
:
string
)
:
void
Parameters
x:
number
y:
number
fgHex:
string
bgHex:
Optional
<
string
>
chars:
string
Returns
void
a11y
Write
a11y
Write
(
text
:
string
)
:
void
Parameters
text:
string
Returns
void
can
Show
Message
AsCells
can
Show
Message
AsCells
(
)
:
boolean
Returns
boolean
Protected
cell
Pos
ToXY
cell
Pos
ToXY
(
cell
:
Cell
)
:
object
Parameters
cell:
Cell
Returns
object
cell
StartX
:
number
cell
StartY
:
number
is
OnScreen
:
boolean
Protected
check
IfCell
Can
BeDrawn
OnScreen
check
IfCell
Can
BeDrawn
OnScreen
(
cellStartX
:
number
, cellStartY
:
number
)
:
boolean
Parameters
cellStartX:
number
cellStartY:
number
Returns
boolean
clear
Screen
clear
Screen
(
)
:
void
Returns
void
Protected
create
Message
Sprites
create
Message
Sprites
(
messageStr
:
string
)
:
Set
<
GameSprite
>
[]
[]
Parameters
messageStr:
string
Returns
Set
<
GameSprite
>
[]
[]
Protected
create
Message
Text
Screen
create
Message
Text
Screen
(
messageStr
:
string
)
:
string
[]
Parameters
messageStr:
string
Returns
string
[]
debug
Render
Screen
debug
Render
Screen
(
)
:
void
Returns
void
destroy
destroy
(
)
:
void
Returns
void
draw
Cells
draw
Cells
(
cells
:
Iterable
<
Cell
>
, dontRestoreCursor
:
boolean
, renderScreenDepth
?:
number
)
:
void
Parameters
cells:
Iterable
<
Cell
>
dontRestoreCursor:
boolean
Default value
renderScreenDepth:
number
= 0
Returns
void
Protected
draw
Cells
After
Recentering
draw
Cells
After
Recentering
(
cells
:
Iterable
<
Cell
>
, renderScreenDepth
:
number
)
:
void
Parameters
cells:
Iterable
<
Cell
>
renderScreenDepth:
number
Returns
void
dump
Screen
dump
Screen
(
)
:
void
Returns
void
get
Current
Level
Cells
get
Current
Level
Cells
(
)
:
Cell
[]
[]
Returns
Cell
[]
[]
get
Game
Data
get
Game
Data
(
)
:
GameData
Returns
GameData
get
Has
Visual
Ui
get
Has
Visual
Ui
(
)
:
boolean
Returns
boolean
Protected
get
Max
Size
get
Max
Size
(
)
:
object
Returns
object
columns
:
number
rows
:
number
Protected
get
Pixels
For
Cell
get
Pixels
For
Cell
(
cell
:
Cell
)
:
IColor
[]
[]
Parameters
cell:
Cell
Returns
IColor
[]
[]
Protected
has
Again
That
Needs
ToRun
has
Again
That
Needs
ToRun
(
)
:
boolean
Returns
boolean
move
Inspector
move
Inspector
(
direction
:
RULE_DIRECTION
)
:
void
Parameters
direction:
RULE_DIRECTION
Returns
void
move
Inspector
To
move
Inspector
To
(
cell
:
Cell
)
:
void
Parameters
cell:
Cell
Returns
void
press
press
(
dir
:
RULE_DIRECTION
)
:
void
Parameters
dir:
RULE_DIRECTION
Returns
void
press
Action
press
Action
(
)
:
void
Returns
void
press
Down
press
Down
(
)
:
void
Returns
void
press
Left
press
Left
(
)
:
void
Returns
void
press
Restart
press
Restart
(
)
:
void
Returns
void
press
Right
press
Right
(
)
:
void
Returns
void
press
Undo
press
Undo
(
)
:
void
Returns
void
press
Up
press
Up
(
)
:
void
Returns
void
Protected
render
Level
Screen
render
Level
Screen
(
levelRows
:
Cell
[]
[]
, renderScreenDepth
:
number
)
:
void
Parameters
levelRows:
Cell
[]
[]
renderScreenDepth:
number
Returns
void
render
Message
Screen
render
Message
Screen
(
message
:
string
)
:
void
Parameters
message:
string
Returns
void
render
Screen
render
Screen
(
clearCaches
:
boolean
, renderScreenDepth
?:
number
)
:
void
Parameters
clearCaches:
boolean
Default value
renderScreenDepth:
number
= 0
Returns
void
set
Game
set
Game
(
gameData
:
string
)
:
void
Parameters
gameData:
string
Returns
void
set
Game
Engine
set
Game
Engine
(
engine
:
GameEngine
)
:
void
Parameters
engine:
GameEngine
Returns
void
set
Has
Visual
Ui
set
Has
Visual
Ui
(
flag
:
boolean
)
:
void
Parameters
flag:
boolean
Returns
void
set
Level
set
Level
(
levelNum
:
number
)
:
void
Parameters
levelNum:
number
Returns
void
Protected
set
Pixel
set
Pixel
(
x
:
number
, y
:
number
, hex
:
string
, fgHex
:
Optional
<
string
>
, chars
:
string
)
:
string
Parameters
x:
number
y:
number
hex:
string
fgHex:
Optional
<
string
>
chars:
string
Returns
string
set
Small
Terminal
set
Small
Terminal
(
yesNo
:
boolean
)
:
void
Parameters
yesNo:
boolean
Returns
void
tick
tick
(
)
:
ITickResult
Returns
ITickResult
will
All
Levels
Fit
OnScreen
will
All
Levels
Fit
OnScreen
(
gameData
:
GameData
)
:
boolean
Parameters
gameData:
GameData
Returns
boolean
write
Debug
write
Debug
(
text
:
string
, category
:
number
)
:
void
Parameters
text:
string
category:
number
Returns
void
Generated using
TypeDoc