Scrawl-canvas API
SC inline documentation
SC demo test suite
SC developer runbook
GitHub
Preparing search index...
GridFactoryFunctions
Interface GridFactoryFunctions
interface
GridFactoryFunctions
{
actionPacket
:
(
item
:
string
,
override
?:
CommonObjectInput
)
=>
any
;
addFilters
?:
(
...
items
:
(
string
|
FilterInstance
)
[]
)
=>
EntityInstance
;
checkHit
?:
(
tests
:
HitTests
)
=>
boolean
|
HitOutput
;
clearFilters
?:
()
=>
EntityInstance
;
clickAnchor
?:
()
=>
void
;
clickButton
?:
()
=>
void
;
clone
:
(
item
?:
GridFactoryInputs
)
=>
GridInstance
;
columnIndex
:
(
index
:
number
)
=>
number
;
dropArtefact
?:
()
=>
ArtefactInstance
;
fillColumn
:
(
CommonObjectInput
:
any
)
=>
GridInstance
;
fillRect
:
(
CommonObjectInput
:
any
)
=>
GridInstance
;
fillRow
:
(
CommonObjectInput
:
any
)
=>
GridInstance
;
get
:
(
item
:
string
)
=>
any
;
getTileSource
:
(
row
:
number
,
col
?:
number
)
=>
number
;
getTilesUsingSource
:
(
key
:
number
)
=>
number
[]
;
importPacket
:
(
item
:
string
|
string
[]
,
override
?:
CommonObjectInput
,
)
=>
any
;
kill
:
(
item
?:
any
)
=>
void
;
pickupArtefact
?:
(
items
:
CommonHereObjectInput
|
CommonTwoElementArrayInput
,
)
=>
ArtefactInstance
;
positionIndices
:
(
index
:
number
)
=>
[
number
,
number
]
|
[
]
;
removeFilters
?:
(
...
items
:
(
string
|
FilterInstance
)
[]
)
=>
EntityInstance
;
removeTileSource
:
(
index
:
number
)
=>
GridInstance
;
reverseByDelta
:
()
=>
ArtefactInstance
;
rowIndex
:
(
index
:
number
)
=>
number
;
saveAsPacket
:
(
item
?:
boolean
|
GridSaveInputs
)
=>
string
;
set
:
(
item
?:
GridFactoryInputs
)
=>
GridInstance
;
setAllTilesTo
:
(
index
:
number
)
=>
GridInstance
;
setDelta
:
(
item
?:
GridFactoryDeltaInputs
)
=>
GridInstance
;
setDeltaValues
:
(
item
?:
CommonObjectInput
)
=>
ArtefactInstance
;
setTileFill
:
(
item
:
number
[]
)
=>
GridInstance
;
setTileSourceTo
:
(
index
:
number
,
obj
:
GridTileObject
)
=>
GridInstance
;
setTilesTo
:
(
tiles
:
number
[]
,
val
:
number
)
=>
GridInstance
;
simpleStamp
:
(
host
:
CellInstance
,
items
?:
GridFactoryInputs
)
=>
void
;
tileIndexFromPosition
:
(
row
:
number
,
column
:
number
)
=>
number
;
updateByDelta
:
()
=>
ArtefactInstance
;
}
Hierarchy (
View Summary
)
BaseMixinFunctions
EntityMixinFunctions
GridFactoryFunctions
GridInstance
Index
Properties
action
Packet
add
Filters?
check
Hit?
clear
Filters?
click
Anchor?
click
Button?
clone
column
Index
drop
Artefact?
fill
Column
fill
Rect
fill
Row
get
get
Tile
Source
get
Tiles
Using
Source
import
Packet
kill
pickup
Artefact?
position
Indices
remove
Filters?
remove
Tile
Source
reverse
By
Delta
row
Index
save
As
Packet
set
set
All
Tiles
To
set
Delta
set
Delta
Values
set
Tile
Fill
set
Tile
Source
To
set
Tiles
To
simple
Stamp
tile
Index
From
Position
update
By
Delta
Properties
action
Packet
actionPacket
:
(
item
:
string
,
override
?:
CommonObjectInput
)
=>
any
Optional
add
Filters
addFilters
?:
(
...
items
:
(
string
|
FilterInstance
)
[]
)
=>
EntityInstance
Optional
check
Hit
checkHit
?:
(
tests
:
HitTests
)
=>
boolean
|
HitOutput
Optional
clear
Filters
clearFilters
?:
()
=>
EntityInstance
Optional
click
Anchor
clickAnchor
?:
()
=>
void
Optional
click
Button
clickButton
?:
()
=>
void
clone
clone
:
(
item
?:
GridFactoryInputs
)
=>
GridInstance
column
Index
columnIndex
:
(
index
:
number
)
=>
number
Optional
drop
Artefact
dropArtefact
?:
()
=>
ArtefactInstance
fill
Column
fillColumn
:
(
CommonObjectInput
:
any
)
=>
GridInstance
fill
Rect
fillRect
:
(
CommonObjectInput
:
any
)
=>
GridInstance
fill
Row
fillRow
:
(
CommonObjectInput
:
any
)
=>
GridInstance
get
get
:
(
item
:
string
)
=>
any
get
Tile
Source
getTileSource
:
(
row
:
number
,
col
?:
number
)
=>
number
get
Tiles
Using
Source
getTilesUsingSource
:
(
key
:
number
)
=>
number
[]
import
Packet
importPacket
:
(
item
:
string
|
string
[]
,
override
?:
CommonObjectInput
)
=>
any
kill
kill
:
(
item
?:
any
)
=>
void
Optional
pickup
Artefact
pickupArtefact
?:
(
items
:
CommonHereObjectInput
|
CommonTwoElementArrayInput
,
)
=>
ArtefactInstance
position
Indices
positionIndices
:
(
index
:
number
)
=>
[
number
,
number
]
|
[
]
Optional
remove
Filters
removeFilters
?:
(
...
items
:
(
string
|
FilterInstance
)
[]
)
=>
EntityInstance
remove
Tile
Source
removeTileSource
:
(
index
:
number
)
=>
GridInstance
reverse
By
Delta
reverseByDelta
:
()
=>
ArtefactInstance
row
Index
rowIndex
:
(
index
:
number
)
=>
number
save
As
Packet
saveAsPacket
:
(
item
?:
boolean
|
GridSaveInputs
)
=>
string
set
set
:
(
item
?:
GridFactoryInputs
)
=>
GridInstance
set
All
Tiles
To
setAllTilesTo
:
(
index
:
number
)
=>
GridInstance
set
Delta
setDelta
:
(
item
?:
GridFactoryDeltaInputs
)
=>
GridInstance
set
Delta
Values
setDeltaValues
:
(
item
?:
CommonObjectInput
)
=>
ArtefactInstance
set
Tile
Fill
setTileFill
:
(
item
:
number
[]
)
=>
GridInstance
set
Tile
Source
To
setTileSourceTo
:
(
index
:
number
,
obj
:
GridTileObject
)
=>
GridInstance
set
Tiles
To
setTilesTo
:
(
tiles
:
number
[]
,
val
:
number
)
=>
GridInstance
simple
Stamp
simpleStamp
:
(
host
:
CellInstance
,
items
?:
GridFactoryInputs
)
=>
void
tile
Index
From
Position
tileIndexFromPosition
:
(
row
:
number
,
column
:
number
)
=>
number
update
By
Delta
updateByDelta
:
()
=>
ArtefactInstance
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
action
Packet
add
Filters
check
Hit
clear
Filters
click
Anchor
click
Button
clone
column
Index
drop
Artefact
fill
Column
fill
Rect
fill
Row
get
get
Tile
Source
get
Tiles
Using
Source
import
Packet
kill
pickup
Artefact
position
Indices
remove
Filters
remove
Tile
Source
reverse
By
Delta
row
Index
save
As
Packet
set
set
All
Tiles
To
set
Delta
set
Delta
Values
set
Tile
Fill
set
Tile
Source
To
set
Tiles
To
simple
Stamp
tile
Index
From
Position
update
By
Delta
SC inline documentation
SC demo test suite
SC developer runbook
GitHub
Scrawl-canvas API
Loading...